Packages

  • package root
    Definition Classes
    root
  • package de
    Definition Classes
    root
  • package sciss
    Definition Classes
    de
  • package osc
    Definition Classes
    sciss
  • object PacketCodec

    A packet codec defines how the translation between Java objects and OSC atoms is accomplished.

    A packet codec defines how the translation between Java objects and OSC atoms is accomplished. For example, by default, when an OSC message is assembled for transmission, the encoder will translate ajava.lang.Integer argument into a four byte integer with typetag 'i'. Or when a received message is being decoded, finding an atom typetagged 'f', the decoder will create a java.lang.Float out of it.

    This example sounds trivial, but the codec is also able to handle type conversions. For instance, in the strict OSC 1.0 specification, only 32bit numeric atoms are defined ('i' and 'f'). A codec with mode MODE_STRICT_V1 will reject a java.lang.Double in the encoding process and not be able to decode a typetag 'd'. A codec with mode MODE_MODEST automatically breaks down everything the 32bit, so a java.lang.Double gets encoded as 32bit 'f' and a received atom tagged 'd' becomes a java.lang.Float. Other configurations exist.

    Another important function of the codec is to specify the charset encoding of strings, something that was overseen in the OSC 1.0 spec. By default, UTF-8 is used so all special characters can be safely encoded.

    Last but not least, using the putDecoder and putEncoder methods, the codec can be extended to support additional Java classes or OSC typetags, without the need to subclass PacketCodec.

    Definition Classes
    osc
  • BufferOverflow
  • Builder
  • Exception
  • MalformedPacket
  • UnsupportedAtom

sealed trait Builder extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def arrays(): Builder

    Enables support for the OSC 1.0 extended spec's array tags.

    Enables support for the OSC 1.0 extended spec's array tags. An 'array' is written out as a type tag '[' (without associated value), followed by the normal encoding of the array elements, and finally another type tag ']' (without associated value).

    On the Scala side, we wish to enforce a immutable type, hence collection.immutable.IndexedSeq was chosen over Array for the decoder, while the encoder accepts any Iterable

  2. abstract def booleans(): Builder
  3. abstract def booleansAsInts(): Builder
  4. abstract def build: PacketCodec
  5. abstract def decode[A](tag: Byte, dec: Decoder[A]): Builder
  6. abstract def doubles(): Builder
  7. abstract def doublesAsFloats(): Builder
  8. abstract def encode[A](clazz: Class[A], enc: Encoder[A]): Builder
  9. abstract def impulse(): Builder
  10. abstract def longs(): Builder
  11. abstract def longsAsInts(): Builder
  12. abstract def none(): Builder
  13. abstract def packetsAsBlobs(): Builder
  14. abstract def symbols(): Builder
  15. abstract def timeTags(): Builder
  16. abstract def v1_0(): Builder

    Resets the builder to strict OSC 1.0 spec, meaning that it accepts only the pairs Int - i, Float - f, String - s, and ByteBuffer - b.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val charsetName: String

    The character encoding to use for Strings.

    The character encoding to use for Strings. Defaults to "UTF-8"

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def doublePrecision(): Builder
  8. final def doubleToSinglePrecision(): Builder
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def scsynth(): Builder

    Resets the builder to SuperCollider server spec.

    Resets the builder to SuperCollider server spec. That is, strict OSC 1.0, plus array support, down-casting of 64-bit numbers to 32-bit, encoding booleans as integers, and packet arguments as blobs, and.

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def v1_1(): Builder

    Resets the builder to strict OSC 1.1 spec, meaning that it accepts only the OSC 1.0 pairs, as well as Boolean - T and F, None - N, Unit - I, Timetag - t.

    Resets the builder to strict OSC 1.1 spec, meaning that it accepts only the OSC 1.0 pairs, as well as Boolean - T and F, None - N, Unit - I, Timetag - t.

    Note that this does not affect the way that packets are encoded with on a TCP stream (see the TCP documentation for more information).

  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped