Packages

package osc

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

Type Members

  1. trait BrowserClientPlatform extends AnyRef
  2. trait BrowserReceiverPlatform extends AnyRef
  3. trait BrowserTransmitterPlatform extends AnyRef
  4. final case class Bundle(timeTag: TimeTag, packets: Packet*) extends Packet with Product with Serializable
  5. trait Channel extends ConfigLike with Closeable
  6. type Client = Bidi with Input with Output
  7. sealed trait Dump extends AnyRef
  8. class Message extends Packet
  9. sealed trait Packet extends AnyRef
  10. trait PacketCodec extends AnyRef
  11. trait Server extends Bidi
  12. final case class TimeTag(raw: Long) extends Product with Serializable
  13. sealed trait Transport extends AnyRef

Value Members

  1. case object Browser extends Transport with Product with Serializable

    A simple direct invocation protocol for communication client-side within a browser.

    A simple direct invocation protocol for communication client-side within a browser. Encoding and decoding goes through JavaScript's Uint8Array.

  2. case object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  3. object Bundle extends Serializable
  4. object Channel
  5. object Client
  6. object Dump
  7. object Implicits
  8. object Message
  9. object Packet
  10. 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.

  11. object Receiver
  12. object Server
  13. case object TCP extends Transport with Product with Serializable

    TCP as a transport for OSC.

    TCP as a transport for OSC. At the moment, packets are encoded in the OSC 1.0 format, regardless of of the configuration's packet codec. That means the 32-bit Int size followed by the actual plain packet is encoded. The OSC 1.1 draft suggests SLIP (cf. http://www.faqs.org/rfcs/rfc1055.html). This may be configurable in the future.

  14. object TimeTag extends Serializable
  15. object Transmitter
  16. object Transport
  17. case object UDP extends Transport with Product with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped