`rig.io.osc`

v1.0.0 · stable maturity: stable 12 fields 0 required

Fields

Field	Type		Meaning
`listenEnabled`	bool	optional	Optional. UDP listen active; absent = false
`listenPort`	int	optional	UDP listen port; required when `listenEnabled`
`sendEnabled`	bool	optional	Optional. Send active; absent = false
`sendHost`	string	optional	Send target host; required when `sendEnabled`
`sendPort`	int	optional	Send port; required when `sendEnabled`
`addressPrefix`	string	optional	Optional. Address prefix
`tcpListen`	bool	optional	Optional. TCP listen; absent = false
`tcpPort`	int	optional	Optional. TCP port; absent or 0 = `listenPort`
`tcpConnect`	bool	optional	Optional. Dial `sendHost:sendPort` and send on that TCP connection; absent = false
`streamFraming`	enum0 · 1	optional	Optional. `0` size prefix (4-byte big-endian), `1` SLIP. Absent = 0
`multicastGroup`	string	optional	Optional. IPv4 multicast group. Absent = unicast
`multicastTtl`	integer0 – 255	optional	Optional. Multicast TTL 0..255. Absent = 1

OSC listen / send endpoints. Format when present. UDP is the default transport. TCP and multicast are off unless their fields are set.

Listen and send sides are independent - enable one, both, or neither, and emit only the fields the enabled side needs.

Message queues and sockets are host runtime.

JSON Schema

Resolves at https://rig.works/schemas/rig.io.osc.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.io.osc.schema.json",
  "title": "rig.io.osc",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "listenEnabled": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "listenPort": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "sendEnabled": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "sendHost": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "sendPort": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "addressPrefix": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "tcpListen": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "tcpPort": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "tcpConnect": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "streamFraming": {
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "multicastGroup": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "multicastTtl": {
      "type": "integer",
      "minimum": 0,
      "maximum": 255
    }
  },
  "x-rig-maturity": "stable"
}

Seen in

show-control.json