API Tree - AES67 Devices

• root
  • getroot
  • get/audio
  • get/control
  • get/control/gpos
  • get/control/gpos/{gpoID}/_label
  • get/control/gpos/{gpoID}/_state
  • get/control/gpos/{gpoID}/channel
  • get/general
  • get/general/capabilities
  • get/general/capabilities/_extendedfeature
  • get/general/capabilities/_limited16x16
  • get/general/capabilities/_maxrxstreams
  • get/general/capabilities/_maxtxstreams
  • get/general/capabilities/_rxload
  • get/general/capabilities/_txload
  • get/general/ptp
  • get/general/ptp/announce
  • get/general/ptp/delaymechanism
  • get/general/ptp/domain
  • get/general/ptp/fs
  • get/general/ptp/ip_dscp
  • get/general/ptp/prio1
  • get/general/ptp/prio2
  • get/general/ptp/slaveonly
  • get/general/ptp/state
  • get/general/ptp/state/_clockoffset
  • get/general/ptp/state/_clockstate
  • get/general/ptp/state/_clockstateid
  • get/general/ptp/state/_grandmasterid
  • get/general/ptp/state/_state
  • get/general/ptp/state/_state1
  • get/general/ptp/state/_state2
  • get/general/ptp/state/_syncmaster
  • get/general/ptp/syncinterval
  • get/range
• audio/routing
  • get/audio/routing
  • get/audio/routing/inputs
  • get/audio/routing/inputs/{inputID}
  • get/audio/routing/inputs/{inputID}/_channels
  • get/audio/routing/inputs/{inputID}/_device
  • get/audio/routing/inputs/{inputID}/_hasagain
  • get/audio/routing/inputs/{inputID}/_hasp48
  • get/audio/routing/inputs/{inputID}/_name
  • get/audio/routing/outputs
  • get/audio/routing/outputs/{outputID}/_name
  • get/audio/routing/routes
  • get/audio/routing/routes/{routeID}
• control
  • get/control
  • get/control/gpis
  • get/control/gpis/{gpiID}/_label
  • get/control/gpis/{gpiID}/_state
  • get/control/gpis/{gpiID}/channel
  • get/control/gpos
  • get/control/gpos/{gpoID}/_label
  • get/control/gpos/{gpoID}/_state
  • get/control/gpos/{gpoID}/channel
• general
  • get/general
  • get/general/capabilities
  • get/general/capabilities/_extendedfeature
  • get/general/capabilities/_limited16x16
  • get/general/capabilities/_maxrxstreams
  • get/general/capabilities/_maxtxstreams
  • get/general/capabilities/_rxload
  • get/general/capabilities/_txload
  • get/general/ptp
  • get/general/ptp/announce
  • get/general/ptp/delaymechanism
  • get/general/ptp/domain
  • get/general/ptp/fs
  • get/general/ptp/ip_dscp
  • get/general/ptp/prio1
  • get/general/ptp/prio2
  • get/general/ptp/slaveonly
  • get/general/ptp/state
  • get/general/ptp/state/_clockoffset
  • get/general/ptp/state/_clockstate
  • get/general/ptp/state/_clockstateid
  • get/general/ptp/state/_grandmasterid
  • get/general/ptp/state/_state
  • get/general/ptp/state/_state1
  • get/general/ptp/state/_state2
  • get/general/ptp/state/_syncmaster
  • get/general/ptp/syncinterval
  • get/general/_activewebsockets
  • get/general/_api_version
  • get/general/_firmware_version
  • get/general/_hardwareserial
  • get/general/_hourmeter
  • get/general/_maxwebsockets
  • get/general/_systemtime
  • get/general/_uptime
  • get/general/_temperature
• stream
  • get/streams
  • get/streams/_available
  • get/streams/_rx-errors
  • get/streams/rx-streams
  • get/streams/rx-streams/{streamID}
  • get/streams/rx-streams/{streamID}/_id
  • get/streams/rx-streams/{streamID}/_running
  • get/streams/rx-streams/{streamID}/_rxerrors
  • get/streams/rx-streams/{streamID}/_status
  • get/streams/rx-streams/{streamID}/_statustext
  • get/streams/rx-streams/{streamID}/channels
  • get/streams/rx-streams/{streamID}/codec
  • get/streams/rx-streams/{streamID}/delay
  • get/streams/rx-streams/{streamID}/enabled
  • get/streams/rx-streams/{streamID}/name
  • get/streams/rx-streams/{streamID}/sdp
  • get/streams/rx-streams/{streamID}/source
  • get/streams/rx-streams/{streamID}/source2
  • get/streams/rx-streams/{streamID}/syntonized
  • get/streams/rx-streams/{streamID}/usesecondary
  • get/streams/tx-streams
  • get/streams/tx-streams/{streamID}
  • get/streams/tx-streams/{streamID}/_id
  • get/streams/tx-streams/{streamID}/_rtsp-uri
  • get/streams/tx-streams/{streamID}/_running
  • get/streams/tx-streams/{streamID}/_sdp
  • get/streams/tx-streams/{streamID}/_status
  • get/streams/tx-streams/{streamID}/_statustext
  • get/streams/tx-streams/{streamID}/address
  • get/streams/tx-streams/{streamID}/address2
  • get/streams/tx-streams/{streamID}/address2enable
  • get/streams/tx-streams/{streamID}/addressenable
  • get/streams/tx-streams/{streamID}/channels
  • get/streams/tx-streams/{streamID}/codec
  • get/streams/tx-streams/{streamID}/dscp
  • get/streams/tx-streams/{streamID}/enabled
  • get/streams/tx-streams/{streamID}/info
  • get/streams/tx-streams/{streamID}/name
  • get/streams/tx-streams/{streamID}/payload
  • get/streams/tx-streams/{streamID}/port
  • get/streams/tx-streams/{streamID}/samples-per-packet
  • get/streams/tx-streams/{streamID}/sap
  • get/streams/tx-streams/{streamID}/ttl
• audio/pots
  • get/audio/routing/outputs/{outputID}
  • get/audio/routing/outputs/{outputID}/_channels
  • get/audio/routing/outputs/{outputID}/_device

API docs by Redocly

DHD control api - AES67 Modules (0.8.0)

Download OpenAPI specification:Download

E-mail: dhd@dhd.audio Terms of Service

This is the basic api tree for DHD AES67 Ravenna Interfaces with firmware 10.4 and newer.

DHD developer

root

Root of the control api tree

root

Query the whole system tree

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/

Response samples

• 200

Content type

application/json

{

• "audio": {

  • "routing": {

    • "inputs": {

      • "0": {

        • "_channels": 1,
        • "_device": "Mic I/O 1",
        • "_hasagain": true,
        • "_hasp48": true,
        • "_name": "Mic Front"

        }

      },
    • "outputs": {

      • "0": {

        • "_channels": 2,
        • "_device": "Headphone I/O 1",
        • "_name": "HP1"

        }

      },
    • "routes": {

      • "0": "198"

      }

    }

  },
• "control": {

  • "gpis": {

    • "0": {

      • "_label": "GPI1",
      • "_state": false,
      • "channel": "1.2.3"

      }

    },
  • "gpos": {

    • "0": {

      • "_label": "GPO1",
      • "_state": true,
      • "channel": "2.3.4"

      }

    }

  },
• "general": {

  • "_activewebsockets": 0,
  • "_api_version": "1.0.0",
  • "_firmware_version": "10.3.0.17",
  • "_hardwareserial": "",
  • "_hourmeter": 0,
  • "_maxwebsockets": 5,
  • "_systemtime": 0,
  • "_uptime": 0,
  • "_temperature": 60,
  • "capabilities": {

    • "_extendedfeature": true,
    • "_limited16x16": false,
    • "_maxrxstreams": 32,
    • "_maxtxstreams": 32,
    • "_rxload": 0,
    • "_txload": 25

    },
  • "ptp": {

    • "announce": 0,
    • "delaymechanism": "E2E",
    • "domain": 0,
    • "fs": 48000,
    • "ip_dscp": 56,
    • "prio1": 127,
    • "prio2": 127,
    • "slaveonly": false,
    • "state": {

      • "_clockoffset": [

        • [

          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544,
          • 30440993.544

          ]

        ],
      • "_clockstate": "FREERUN",
      • "_clockstateid": 1,
      • "_grandmasterid": "000a63fffe054faf",
      • "_state": "Leader",
      • "_state1": 1,
      • "_state2": 1,
      • "_syncmaster": "000a63fffe054faf"

      },
    • "syncinterval": -3

    }

  },
• "streams": {

  • "_available": [

    • [

      • {

        • "address": "234.100.0.1",
        • "address2": "234.101.0.1",
        • "channels": 8,
        • "codec": "L24",
        • "info": "text",
        • "name": "xc3@Audio.SX2.KPYR",
        • "samples-per-packet": 6

        }

      ]

    ],
  • "_rx-errors": 0,
  • "rx-streams": {

    • "0": {

      • "_id": "e6104bad-fa8d-464a-83dc-d7c3b60164f5",
      • "_running": false,
      • "_rxerrors": 0,
      • "_status": 2,
      • "_statustext": "No RTP data arriving",
      • "channels": 2,
      • "codec": "L24",
      • "delay": 192,
      • "enabled": true,
      • "name": "mystream24",
      • "sdp": "",
      • "source": "PGM@Audio.SX2.test",
      • "source2": "",
      • "syntonized": true,
      • "usesecondary": false

      }

    },
  • "tx-streams": {

    • "0": {

      • "_id": "f7bef41a-dfcf-44cf-a4df-5a1044d474a7",
      • "_rtsp-uri": "rtsp://10.5.27.168:554/by-name/2ch%20stero",
      • "_running": false,
      • "_sdp": "",
      • "_status": 1,
      • "_statustext": "",
      • "address": "239.27.168.1",
      • "address2": "239.1.126.33",
      • "address2enable": true,
      • "addressenable": true,
      • "channels": 2,
      • "codec": "L24",
      • "dscp": 34,
      • "enabled": false,
      • "info": "",
      • "name": "2ch stero",
      • "payload": 96,
      • "port": 5004,
      • "samples-per-packet": 48,
      • "sap": true,
      • "ttl": 42

      }

    }

  }

}

/audio

Query the system audio node with all parameters

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio

Response samples

• 200

Content type

application/json

{

• "routing": {

  • "inputs": {

    • "0": {

      • "_channels": 1,
      • "_device": "Mic I/O 1",
      • "_hasagain": true,
      • "_hasp48": true,
      • "_name": "Mic Front"

      }

    },
  • "outputs": {

    • "0": {

      • "_channels": 2,
      • "_device": "Headphone I/O 1",
      • "_name": "HP1"

      }

    },
  • "routes": {

    • "0": "198"

    }

  }

}

/control

The control system.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control

Response samples

• 200

Content type

application/json

{

• "gpis": {

  • "0": {

    • "_label": "GPI1",
    • "_state": false,
    • "channel": "1.2.3"

    }

  },
• "gpos": {

  • "0": {

    • "_label": "GPO1",
    • "_state": true,
    • "channel": "2.3.4"

    }

  }

}

/control/gpos

The multicast GPOs of the system.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_label": "GPO1",
  • "_state": true,
  • "channel": "2.3.4"

  }

}

/control/gpos/{gpoID}/_label

GPO label from config.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/_label

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/_label

Response samples

• 200

Content type

application/json

"GPO1"

/control/gpos/{gpoID}/_state

GPO state.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/_state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/_state

Response samples

• 200

Content type

application/json

true

/control/gpos/{gpoID}/channel

GPO multicast channel ID.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/channel

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/channel

Response samples

• 200

Content type

application/json

"2.3.4"

/general

General system information.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general

Response samples

• 200

Content type

application/json

{

• "_activewebsockets": 0,
• "_api_version": "1.0.0",
• "_firmware_version": "10.3.0.17",
• "_hardwareserial": "",
• "_hourmeter": 0,
• "_maxwebsockets": 5,
• "_systemtime": 0,
• "_uptime": 0,
• "_temperature": 60,
• "capabilities": {

  • "_extendedfeature": true,
  • "_limited16x16": false,
  • "_maxrxstreams": 32,
  • "_maxtxstreams": 32,
  • "_rxload": 0,
  • "_txload": 25

  },
• "ptp": {

  • "announce": 0,
  • "delaymechanism": "E2E",
  • "domain": 0,
  • "fs": 48000,
  • "ip_dscp": 56,
  • "prio1": 127,
  • "prio2": 127,
  • "slaveonly": false,
  • "state": {

    • "_clockoffset": [

      • [

        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544

        ]

      ],
    • "_clockstate": "FREERUN",
    • "_clockstateid": 1,
    • "_grandmasterid": "000a63fffe054faf",
    • "_state": "Leader",
    • "_state1": 1,
    • "_state2": 1,
    • "_syncmaster": "000a63fffe054faf"

    },
  • "syncinterval": -3

  }

}

/general/capabilities

aes67 module capabilities.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities

Response samples

• 200

Content type

application/json

{

• "_extendedfeature": true,
• "_limited16x16": false,
• "_maxrxstreams": 32,
• "_maxtxstreams": 32,
• "_rxload": 0,
• "_txload": 25

}

/general/capabilities/_extendedfeature

Extended feature license available.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_extendedfeature

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_extendedfeature

Response samples

• 200

Content type

application/json

true

/general/capabilities/_limited16x16

Limited 16x16 channel mode (on XC3 core 52-7010 modules).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_limited16x16

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_limited16x16

Response samples

• 200

Content type

application/json

false

/general/capabilities/_maxrxstreams

Maximum number of receive streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_maxrxstreams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_maxrxstreams

Response samples

• 200

Content type

application/json

32

/general/capabilities/_maxtxstreams

Maximum number of transmit streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_maxtxstreams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_maxtxstreams

Response samples

• 200

Content type

application/json

32

/general/capabilities/_rxload

Current RX load.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_rxload

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_rxload

Response samples

• 200

Content type

application/json

0

0

/general/capabilities/_txload

Current TX load.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_txload

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_txload

Response samples

• 200

Content type

application/json

25

/general/ptp

Current PTP configuration and status.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp

Response samples

• 200

Content type

application/json

{

• "announce": 0,
• "delaymechanism": "E2E",
• "domain": 0,
• "fs": 48000,
• "ip_dscp": 56,
• "prio1": 127,
• "prio2": 127,
• "slaveonly": false,
• "state": {

  • "_clockoffset": [

    • [

      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544

      ]

    ],
  • "_clockstate": "FREERUN",
  • "_clockstateid": 1,
  • "_grandmasterid": "000a63fffe054faf",
  • "_state": "Leader",
  • "_state1": 1,
  • "_state2": 1,
  • "_syncmaster": "000a63fffe054faf"

  },
• "syncinterval": -3

}

/general/ptp/announce

Current PTP announce interval.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/announce

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/announce

Response samples

• 200

Content type

application/json

0

0

/general/ptp/delaymechanism

Current delay mechanism (E2E or P2P).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/delaymechanism

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/delaymechanism

Response samples

• 200

Content type

application/json

"E2E"

/general/ptp/domain

Current PTP domain.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/domain

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/domain

Response samples

• 200

Content type

application/json

0

0

/general/ptp/fs

Current sample rate (Hz).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/fs

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/fs

Response samples

• 200

Content type

application/json

48000

/general/ptp/ip_dscp

Current IP DSCP value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/ip_dscp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/ip_dscp

Response samples

• 200

Content type

application/json

56

/general/ptp/prio1

Current PTP priority 1 value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/prio1

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/prio1

Response samples

• 200

Content type

application/json

127

/general/ptp/prio2

Current PTP priority 2 value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/prio2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/prio2

Response samples

• 200

Content type

application/json

127

/general/ptp/slaveonly

Forces the module to be only PTP slave / follower.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/slaveonly

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/slaveonly

Response samples

• 200

Content type

application/json

false

/general/ptp/state

Current PTP state details.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state

Response samples

• 200

Content type

application/json

{

• "_clockoffset": [

  • [

    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544

    ]

  ],
• "_clockstate": "FREERUN",
• "_clockstateid": 1,
• "_grandmasterid": "000a63fffe054faf",
• "_state": "Leader",
• "_state1": 1,
• "_state2": 1,
• "_syncmaster": "000a63fffe054faf"

}

/general/ptp/state/_clockoffset

PTP clock offset / jitter (40 data points at 1/sec).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockoffset

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockoffset

Response samples

• 200

Content type

application/json

[

• [

  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544

  ]

]

/general/ptp/state/_clockstate

PTP clock state (FREERUN / LOCKED).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockstate

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockstate

Response samples

• 200

Content type

application/json

"FREERUN"

/general/ptp/state/_clockstateid

PTP clock state ID.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockstateid

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockstateid

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_grandmasterid

PTP grandmaster ID.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_grandmasterid

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_grandmasterid

Response samples

• 200

Content type

application/json

"000a63fffe054faf"

/general/ptp/state/_state

PTP state (Leader/Follower).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state

Response samples

• 200

Content type

application/json

"Leader"

/general/ptp/state/_state1

PTP state1.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state1

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state1

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_state2

PTP state2.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state2

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_syncmaster

Current PTP clock leader.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_syncmaster

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_syncmaster

Response samples

• 200

Content type

application/json

"000a63fffe054faf"

/general/ptp/syncinterval

Current PTP sync interval.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/syncinterval

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/syncinterval

Response samples

• 200

Content type

application/json

-3

/range

All value ranges and units, delivered as json objects. Self-documenting, so no documentation given.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/range

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/range

audio/routing

Audio routings

/audio/routing

The audio routing system of the device.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing

Response samples

• 200

Content type

application/json

{

• "inputs": {

  • "0": {

    • "_channels": 1,
    • "_device": "Mic I/O 1",
    • "_hasagain": true,
    • "_hasp48": true,
    • "_name": "Mic Front"

    }

  },
• "outputs": {

  • "0": {

    • "_channels": 2,
    • "_device": "Headphone I/O 1",
    • "_name": "HP1"

    }

  },
• "routes": {

  • "0": "198"

  }

}

/audio/routing/inputs

Input/source list for routings.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_channels": 1,
  • "_device": "Mic I/O 1",
  • "_hasagain": true,
  • "_hasp48": true,
  • "_name": "Mic Front"

  }

}

/audio/routing/inputs/{inputID}

Input/source details. The ID is working with offsets to keep a separation between source types.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}

Response samples

• 200

Content type

application/json

{

• "_channels": 1,
• "_device": "Mic I/O 1",
• "_hasagain": true,
• "_hasp48": true,
• "_name": "Mic Front"

}

/audio/routing/inputs/{inputID}/_channels

Number of channels the input contains.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}/_channels

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}/_channels

Response samples

• 200

Content type

application/json

1

/audio/routing/inputs/{inputID}/_device

The device/module where the input is located.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}/_device

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}/_device

Response samples

• 200

Content type

application/json

"Mic I/O 1"

/audio/routing/inputs/{inputID}/_hasagain

If the input has an analog gain / preamp.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}/_hasagain

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}/_hasagain

Response samples

• 200

Content type

application/json

true

/audio/routing/inputs/{inputID}/_hasp48

If the input has P48V phantom power.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}/_hasp48

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}/_hasp48

Response samples

• 200

Content type

application/json

true

/audio/routing/inputs/{inputID}/_name

Input label.

Authorizations:

token

path Parameters

inputID required

any ID of input object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/inputs/{inputID}/_name

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/inputs/{inputID}/_name

Response samples

• 200

Content type

application/json

"Mic Front"

/audio/routing/outputs

Output/sink list for routings.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/outputs

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/outputs

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_channels": 2,
  • "_device": "Headphone I/O 1",
  • "_name": "HP1"

  }

}

/audio/routing/outputs/{outputID}/_name

Output label.

Authorizations:

token

path Parameters

outputID required

any ID of output object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/outputs/{outputID}/_name

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/outputs/{outputID}/_name

Response samples

• 200

Content type

application/json

"HP1"

/audio/routing/routes

The list of active routes. It is a list of sinks (as keys), which have their individual sources (as values). Sources can be available multiple times.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/routes

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/routes

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_channels": 2,
  • "_device": "Headphone I/O 1",
  • "_name": "HP1"

  }

}

/audio/routing/routes/{routeID}

A defined route. The ID of the route is the ID of the output. Use "off" to disable a route.

Authorizations:

token

path Parameters

routeID required

any ID of route object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/routes/{routeID}

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/routes/{routeID}

Response samples

• 200

Content type

application/json

"198"

control

Control system

/control

The control system.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control

Response samples

• 200

Content type

application/json

{

• "gpis": {

  • "0": {

    • "_label": "GPI1",
    • "_state": false,
    • "channel": "1.2.3"

    }

  },
• "gpos": {

  • "0": {

    • "_label": "GPO1",
    • "_state": true,
    • "channel": "2.3.4"

    }

  }

}

/control/gpis

The multicast GPIs of the system.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpis

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpis

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_label": "GPI1",
  • "_state": false,
  • "channel": "1.2.3"

  }

}

/control/gpis/{gpiID}/_label

GPI label from config.

Authorizations:

token

path Parameters

gpiID required

any ID of GPI object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpis/{gpiID}/_label

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpis/{gpiID}/_label

Response samples

• 200

Content type

application/json

"GPI1"

/control/gpis/{gpiID}/_state

GPI state.

Authorizations:

token

path Parameters

gpiID required

any ID of GPI object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpis/{gpiID}/_state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpis/{gpiID}/_state

Response samples

• 200

Content type

application/json

false

/control/gpis/{gpiID}/channel

GPI multicast channel ID.

Authorizations:

token

path Parameters

gpiID required

any ID of GPI object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpis/{gpiID}/channel

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpis/{gpiID}/channel

Response samples

• 200

Content type

application/json

"1.2.3"

/control/gpos

The multicast GPOs of the system.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_label": "GPO1",
  • "_state": true,
  • "channel": "2.3.4"

  }

}

/control/gpos/{gpoID}/_label

GPO label from config.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/_label

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/_label

Response samples

• 200

Content type

application/json

"GPO1"

/control/gpos/{gpoID}/_state

GPO state.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/_state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/_state

Response samples

• 200

Content type

application/json

true

/control/gpos/{gpoID}/channel

GPO multicast channel ID.

Authorizations:

token

path Parameters

gpoID required

any ID of GPO object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/control/gpos/{gpoID}/channel

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/control/gpos/{gpoID}/channel

Response samples

• 200

Content type

application/json

"2.3.4"

general

General system information

/general

General system information.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general

Response samples

• 200

Content type

application/json

{

• "_activewebsockets": 0,
• "_api_version": "1.0.0",
• "_firmware_version": "10.3.0.17",
• "_hardwareserial": "",
• "_hourmeter": 0,
• "_maxwebsockets": 5,
• "_systemtime": 0,
• "_uptime": 0,
• "_temperature": 60,
• "capabilities": {

  • "_extendedfeature": true,
  • "_limited16x16": false,
  • "_maxrxstreams": 32,
  • "_maxtxstreams": 32,
  • "_rxload": 0,
  • "_txload": 25

  },
• "ptp": {

  • "announce": 0,
  • "delaymechanism": "E2E",
  • "domain": 0,
  • "fs": 48000,
  • "ip_dscp": 56,
  • "prio1": 127,
  • "prio2": 127,
  • "slaveonly": false,
  • "state": {

    • "_clockoffset": [

      • [

        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544,
        • 30440993.544

        ]

      ],
    • "_clockstate": "FREERUN",
    • "_clockstateid": 1,
    • "_grandmasterid": "000a63fffe054faf",
    • "_state": "Leader",
    • "_state1": 1,
    • "_state2": 1,
    • "_syncmaster": "000a63fffe054faf"

    },
  • "syncinterval": -3

  }

}

/general/capabilities

aes67 module capabilities.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities

Response samples

• 200

Content type

application/json

{

• "_extendedfeature": true,
• "_limited16x16": false,
• "_maxrxstreams": 32,
• "_maxtxstreams": 32,
• "_rxload": 0,
• "_txload": 25

}

/general/capabilities/_extendedfeature

Extended feature license available.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_extendedfeature

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_extendedfeature

Response samples

• 200

Content type

application/json

true

/general/capabilities/_limited16x16

Limited 16x16 channel mode (on XC3 core 52-7010 modules).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_limited16x16

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_limited16x16

Response samples

• 200

Content type

application/json

false

/general/capabilities/_maxrxstreams

Maximum number of receive streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_maxrxstreams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_maxrxstreams

Response samples

• 200

Content type

application/json

32

/general/capabilities/_maxtxstreams

Maximum number of transmit streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_maxtxstreams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_maxtxstreams

Response samples

• 200

Content type

application/json

32

/general/capabilities/_rxload

Current RX load.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_rxload

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_rxload

Response samples

• 200

Content type

application/json

0

0

/general/capabilities/_txload

Current TX load.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/capabilities/_txload

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/capabilities/_txload

Response samples

• 200

Content type

application/json

25

/general/ptp

Current PTP configuration and status.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp

Response samples

• 200

Content type

application/json

{

• "announce": 0,
• "delaymechanism": "E2E",
• "domain": 0,
• "fs": 48000,
• "ip_dscp": 56,
• "prio1": 127,
• "prio2": 127,
• "slaveonly": false,
• "state": {

  • "_clockoffset": [

    • [

      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544,
      • 30440993.544

      ]

    ],
  • "_clockstate": "FREERUN",
  • "_clockstateid": 1,
  • "_grandmasterid": "000a63fffe054faf",
  • "_state": "Leader",
  • "_state1": 1,
  • "_state2": 1,
  • "_syncmaster": "000a63fffe054faf"

  },
• "syncinterval": -3

}

/general/ptp/announce

Current PTP announce interval.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/announce

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/announce

Response samples

• 200

Content type

application/json

0

0

/general/ptp/delaymechanism

Current delay mechanism (E2E or P2P).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/delaymechanism

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/delaymechanism

Response samples

• 200

Content type

application/json

"E2E"

/general/ptp/domain

Current PTP domain.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/domain

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/domain

Response samples

• 200

Content type

application/json

0

0

/general/ptp/fs

Current sample rate (Hz).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/fs

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/fs

Response samples

• 200

Content type

application/json

48000

/general/ptp/ip_dscp

Current IP DSCP value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/ip_dscp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/ip_dscp

Response samples

• 200

Content type

application/json

56

/general/ptp/prio1

Current PTP priority 1 value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/prio1

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/prio1

Response samples

• 200

Content type

application/json

127

/general/ptp/prio2

Current PTP priority 2 value.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/prio2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/prio2

Response samples

• 200

Content type

application/json

127

/general/ptp/slaveonly

Forces the module to be only PTP slave / follower.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/slaveonly

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/slaveonly

Response samples

• 200

Content type

application/json

false

/general/ptp/state

Current PTP state details.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state

Response samples

• 200

Content type

application/json

{

• "_clockoffset": [

  • [

    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544,
    • 30440993.544

    ]

  ],
• "_clockstate": "FREERUN",
• "_clockstateid": 1,
• "_grandmasterid": "000a63fffe054faf",
• "_state": "Leader",
• "_state1": 1,
• "_state2": 1,
• "_syncmaster": "000a63fffe054faf"

}

/general/ptp/state/_clockoffset

PTP clock offset / jitter (40 data points at 1/sec).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockoffset

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockoffset

Response samples

• 200

Content type

application/json

[

• [

  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544,
  • 30440993.544

  ]

]

/general/ptp/state/_clockstate

PTP clock state (FREERUN / LOCKED).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockstate

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockstate

Response samples

• 200

Content type

application/json

"FREERUN"

/general/ptp/state/_clockstateid

PTP clock state ID.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_clockstateid

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_clockstateid

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_grandmasterid

PTP grandmaster ID.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_grandmasterid

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_grandmasterid

Response samples

• 200

Content type

application/json

"000a63fffe054faf"

/general/ptp/state/_state

PTP state (Leader/Follower).

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state

Response samples

• 200

Content type

application/json

"Leader"

/general/ptp/state/_state1

PTP state1.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state1

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state1

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_state2

PTP state2.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_state2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_state2

Response samples

• 200

Content type

application/json

1

/general/ptp/state/_syncmaster

Current PTP clock leader.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/state/_syncmaster

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/state/_syncmaster

Response samples

• 200

Content type

application/json

"000a63fffe054faf"

/general/ptp/syncinterval

Current PTP sync interval.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/ptp/syncinterval

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/ptp/syncinterval

Response samples

• 200

Content type

application/json

-3

/general/_activewebsockets

Number of active WebSocket connections.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_activewebsockets

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_activewebsockets

Response samples

• 200

Content type

application/json

0

0

/general/_api_version

API version.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_api_version

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_api_version

Response samples

• 200

Content type

application/json

"1.0.0"

/general/_firmware_version

Firmware version.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_firmware_version

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_firmware_version

Response samples

• 200

Content type

application/json

"10.3.0.17"

/general/_hardwareserial

Hardware serial.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_hardwareserial

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_hardwareserial

Response samples

• 200

Content type

application/json

""

/general/_hourmeter

Device hour meter.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_hourmeter

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_hourmeter

Response samples

• 200

Content type

application/json

0

0

/general/_maxwebsockets

Maximum number of active WebSocket connections.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_maxwebsockets

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_maxwebsockets

Response samples

• 200

Content type

application/json

5

/general/_systemtime

Current system time.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_systemtime

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_systemtime

Response samples

• 200

Content type

application/json

0

0

/general/_uptime

System uptime.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_uptime

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_uptime

Response samples

• 200

Content type

application/json

0

0

/general/_temperature

Current module temperature.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/general/_temperature

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/general/_temperature

Response samples

• 200

Content type

application/json

60

stream

Stream state and settings

/streams

Stream-related information.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams

Response samples

• 200

Content type

application/json

{

• "_available": [

  • [

    • {

      • "address": "234.100.0.1",
      • "address2": "234.101.0.1",
      • "channels": 8,
      • "codec": "L24",
      • "info": "text",
      • "name": "xc3@Audio.SX2.KPYR",
      • "samples-per-packet": 6

      }

    ]

  ],
• "_rx-errors": 0,
• "rx-streams": {

  • "0": {

    • "_id": "e6104bad-fa8d-464a-83dc-d7c3b60164f5",
    • "_running": false,
    • "_rxerrors": 0,
    • "_status": 2,
    • "_statustext": "No RTP data arriving",
    • "channels": 2,
    • "codec": "L24",
    • "delay": 192,
    • "enabled": true,
    • "name": "mystream24",
    • "sdp": "",
    • "source": "PGM@Audio.SX2.test",
    • "source2": "",
    • "syntonized": true,
    • "usesecondary": false

    }

  },
• "tx-streams": {

  • "0": {

    • "_id": "f7bef41a-dfcf-44cf-a4df-5a1044d474a7",
    • "_rtsp-uri": "rtsp://10.5.27.168:554/by-name/2ch%20stero",
    • "_running": false,
    • "_sdp": "",
    • "_status": 1,
    • "_statustext": "",
    • "address": "239.27.168.1",
    • "address2": "239.1.126.33",
    • "address2enable": true,
    • "addressenable": true,
    • "channels": 2,
    • "codec": "L24",
    • "dscp": 34,
    • "enabled": false,
    • "info": "",
    • "name": "2ch stero",
    • "payload": 96,
    • "port": 5004,
    • "samples-per-packet": 48,
    • "sap": true,
    • "ttl": 42

    }

  }

}

/streams/_available

A list of discovered streams. Contains JSON objects with address information, channels, codec, name, samples-per-packet and info.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/_available

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/_available

Response samples

• 200

Content type

application/json

[

• [

  • {

    • "address": "234.100.0.1",
    • "address2": "234.101.0.1",
    • "channels": 8,
    • "codec": "L24",
    • "info": "text",
    • "name": "xc3@Audio.SX2.KPYR",
    • "samples-per-packet": 6

    }

  ]

]

/streams/_rx-errors

RX packet error counter over all RX streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/_rx-errors

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/_rx-errors

Response samples

• 200

Content type

application/json

0

0

/streams/rx-streams

RX streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_id": "e6104bad-fa8d-464a-83dc-d7c3b60164f5",
  • "_running": false,
  • "_rxerrors": 0,
  • "_status": 2,
  • "_statustext": "No RTP data arriving",
  • "channels": 2,
  • "codec": "L24",
  • "delay": 192,
  • "enabled": true,
  • "name": "mystream24",
  • "sdp": "",
  • "source": "PGM@Audio.SX2.test",
  • "source2": "",
  • "syntonized": true,
  • "usesecondary": false

  }

}

/streams/rx-streams/{streamID}

A specific RX stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}

Response samples

• 200

Content type

application/json

{

• "_id": "e6104bad-fa8d-464a-83dc-d7c3b60164f5",
• "_running": false,
• "_rxerrors": 0,
• "_status": 2,
• "_statustext": "No RTP data arriving",
• "channels": 2,
• "codec": "L24",
• "delay": 192,
• "enabled": true,
• "name": "mystream24",
• "sdp": "",
• "source": "PGM@Audio.SX2.test",
• "source2": "",
• "syntonized": true,
• "usesecondary": false

}

/streams/rx-streams/{streamID}/_id

UUID of the stream as used in NMOS.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/_id

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/_id

Response samples

• 200

Content type

application/json

"e6104bad-fa8d-464a-83dc-d7c3b60164f5"

/streams/rx-streams/{streamID}/_running

Information if the stream is running.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/_running

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/_running

Response samples

• 200

Content type

application/json

false

/streams/rx-streams/{streamID}/_rxerrors

Information if the stream has rx errors.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/_rxerrors

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/_rxerrors

Response samples

• 200

Content type

application/json

0

0

/streams/rx-streams/{streamID}/_status

Stream status information. 1=ok (green), 2=warning (yellow), 3=error (red).

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/_status

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/_status

Response samples

• 200

Content type

application/json

2

/streams/rx-streams/{streamID}/_statustext

Stream status description.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/_statustext

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/_statustext

Response samples

• 200

Content type

application/json

"No RTP data arriving"

/streams/rx-streams/{streamID}/channels

Number of channels contained within the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/channels

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/channels

Response samples

• 200

Content type

application/json

2

/streams/rx-streams/{streamID}/codec

Codec used for the stream (L16/L24/AM824).

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/codec

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/codec

Response samples

• 200

Content type

application/json

"L24"

/streams/rx-streams/{streamID}/delay

Stream delay in milliseconds.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/delay

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/delay

Response samples

• 200

Content type

application/json

192

/streams/rx-streams/{streamID}/enabled

Enable the stream to actually receive data.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/enabled

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/enabled

Response samples

• 200

Content type

application/json

true

/streams/rx-streams/{streamID}/name

Name of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/name

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/name

Response samples

• 200

Content type

application/json

"mystream24"

/streams/rx-streams/{streamID}/sdp

Session Description Protocol (SDP) for the stream, can be placed here. Will be cleared after application.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/sdp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/sdp

Response samples

• 200

Content type

application/json

""

/streams/rx-streams/{streamID}/source

Source of the stream (name).

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/source

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/source

Response samples

• 200

Content type

application/json

"PGM@Audio.SX2.test"

/streams/rx-streams/{streamID}/source2

Source2 of the stream (name) for redundancy.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/source2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/source2

Response samples

• 200

Content type

application/json

""

/streams/rx-streams/{streamID}/syntonized

Run stream in syntonized mode.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/syntonized

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/syntonized

Response samples

• 200

Content type

application/json

true

/streams/rx-streams/{streamID}/usesecondary

Use secondary source of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/rx-streams/{streamID}/usesecondary

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/rx-streams/{streamID}/usesecondary

Response samples

• 200

Content type

application/json

false

/streams/tx-streams

TX streams.

Authorizations:

token

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams

Response samples

• 200

Content type

application/json

{

• "0": {

  • "_id": "f7bef41a-dfcf-44cf-a4df-5a1044d474a7",
  • "_rtsp-uri": "rtsp://10.5.27.168:554/by-name/2ch%20stero",
  • "_running": false,
  • "_sdp": "",
  • "_status": 1,
  • "_statustext": "",
  • "address": "239.27.168.1",
  • "address2": "239.1.126.33",
  • "address2enable": true,
  • "addressenable": true,
  • "channels": 2,
  • "codec": "L24",
  • "dscp": 34,
  • "enabled": false,
  • "info": "",
  • "name": "2ch stero",
  • "payload": 96,
  • "port": 5004,
  • "samples-per-packet": 48,
  • "sap": true,
  • "ttl": 42

  }

}

/streams/tx-streams/{streamID}

A specific TX stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}

Response samples

• 200

Content type

application/json

{

• "_id": "f7bef41a-dfcf-44cf-a4df-5a1044d474a7",
• "_rtsp-uri": "rtsp://10.5.27.168:554/by-name/2ch%20stero",
• "_running": false,
• "_sdp": "",
• "_status": 1,
• "_statustext": "",
• "address": "239.27.168.1",
• "address2": "239.1.126.33",
• "address2enable": true,
• "addressenable": true,
• "channels": 2,
• "codec": "L24",
• "dscp": 34,
• "enabled": false,
• "info": "",
• "name": "2ch stero",
• "payload": 96,
• "port": 5004,
• "samples-per-packet": 48,
• "sap": true,
• "ttl": 42

}

/streams/tx-streams/{streamID}/_id

UUID of the stream as used in NMOS.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_id

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_id

Response samples

• 200

Content type

application/json

"f7bef41a-dfcf-44cf-a4df-5a1044d474a7"

/streams/tx-streams/{streamID}/_rtsp-uri

RTSP URI of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_rtsp-uri

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_rtsp-uri

Response samples

• 200

Content type

application/json

"rtsp://10.5.27.168:554/by-name/2ch%20stero"

/streams/tx-streams/{streamID}/_running

Information if the stream is running.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_running

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_running

Response samples

• 200

Content type

application/json

false

/streams/tx-streams/{streamID}/_sdp

Session Description Protocol (SDP) of the stream, based on configured parameters.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_sdp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_sdp

Response samples

• 200

Content type

application/json

""

/streams/tx-streams/{streamID}/_status

Stream status information. 1=ok (green), 2=warning (yellow), 3=error (red).

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_status

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_status

Response samples

• 200

Content type

application/json

1

/streams/tx-streams/{streamID}/_statustext

Stream status description.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/_statustext

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/_statustext

Response samples

• 200

Content type

application/json

""

/streams/tx-streams/{streamID}/address

Primary stream address.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/address

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/address

Response samples

• 200

Content type

application/json

"239.27.168.1"

/streams/tx-streams/{streamID}/address2

Secondary stream address for redundancy.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/address2

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/address2

Response samples

• 200

Content type

application/json

"239.1.126.33"

/streams/tx-streams/{streamID}/address2enable

Enable or disable the secondary stream address.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/address2enable

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/address2enable

Response samples

• 200

Content type

application/json

true

/streams/tx-streams/{streamID}/addressenable

Enable or disable the primary stream address.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/addressenable

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/addressenable

Response samples

• 200

Content type

application/json

true

/streams/tx-streams/{streamID}/channels

Number of channels contained within the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/channels

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/channels

Response samples

• 200

Content type

application/json

2

/streams/tx-streams/{streamID}/codec

Codec used for the stream (L16/L24).

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/codec

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/codec

Response samples

• 200

Content type

application/json

"L24"

/streams/tx-streams/{streamID}/dscp

Differentiated Services Code Point (DSCP) for the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/dscp

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/dscp

Response samples

• 200

Content type

application/json

34

/streams/tx-streams/{streamID}/enabled

Enable the stream to actually receive data.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/enabled

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/enabled

Response samples

• 200

Content type

application/json

false

/streams/tx-streams/{streamID}/info

Optional information about the stream, will be announced as well.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/info

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/info

Response samples

• 200

Content type

application/json

""

/streams/tx-streams/{streamID}/name

Name of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/name

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/name

Response samples

• 200

Content type

application/json

"2ch stero"

/streams/tx-streams/{streamID}/payload

Payload of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/payload

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/payload

Response samples

• 200

Content type

application/json

96

/streams/tx-streams/{streamID}/port

Outbound port of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/port

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/port

Response samples

• 200

Content type

application/json

5004

/streams/tx-streams/{streamID}/samples-per-packet

Samples per packet of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/samples-per-packet

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/samples-per-packet

Response samples

• 200

Content type

application/json

48

/streams/tx-streams/{streamID}/sap

Enable / disable SAP announcement of the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/sap

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/sap

Response samples

• 200

Content type

application/json

true

/streams/tx-streams/{streamID}/ttl

Time to live (TTL) for the stream.

Authorizations:

token

path Parameters

streamID required

any ID of stream object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/streams/tx-streams/{streamID}/ttl

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/streams/tx-streams/{streamID}/ttl

Response samples

• 200

Content type

application/json

42

audio/pots

/audio/routing/outputs/{outputID}

Output/sink details.

Authorizations:

token

path Parameters

outputID required

any ID of output object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/outputs/{outputID}

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/outputs/{outputID}

Response samples

• 200

Content type

application/json

{

• "_channels": 2,
• "_device": "Headphone I/O 1",
• "_name": "HP1"

}

/audio/routing/outputs/{outputID}/_channels

Number of channels the output contains.

Authorizations:

token

path Parameters

outputID required

any ID of output object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/outputs/{outputID}/_channels

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/outputs/{outputID}/_channels

Response samples

• 200

Content type

application/json

2

/audio/routing/outputs/{outputID}/_device

The device/module where the output is located.

Authorizations:

token

path Parameters

outputID required

any ID of output object to return

Responses

REST path for GET and POST requests

http://{device}/modules/{ID}/api/rest/audio/routing/outputs/{outputID}/_device

WebSocket path for real-time communication

http://{device}/modules/{ID}/api/ws/audio/routing/outputs/{outputID}/_device

Response samples

• 200

Content type

application/json

"Headphone I/O 1"