Channel / Park#

Methods#

POST#

Park an output channel or channels at a specified level.

POST /api/channel

Payload is a JSON object with the following attributes:

Attribute

Value Type

Description

Value Example

universe

string

See Universe Key String Format

"dmx:1"

channels

string

Comma separated list of channel numbers.

"1-3,5"

level

integer

Level to set the channel(s) to: 0-255.

128

DELETE#

Unpark an output channel or channels.

DELETE /api/channel

Payload is a JSON object with the following attributes:

Attribute

Value Type

Description

Value Example

universe

string

See Universe Key String Format

"dmx:1"

channels

string

Comma separated list of channel numbers.

"1-3,5"

Universe Key String Format#

A universe key string takes the form:

  • protocol:index for protocols dmx, pathport, sacn, art-net;

  • protocol:kinetPowerSupplyNum:kinetPort for protocol kinet;

  • protocol:remoteDeviceType:remoteDeviceNum for protocol rio-dmx;

  • protocol:remoteDeviceType:remoteDeviceNum:port for protocols edn, edn-spi.

Where:

  • kinetPowerSupplyNum is an integer;

  • kinetPort is an integer;

  • remoteDeviceType can be rio08, rio44 or rio80, edn10 or edn20;

  • remoteDeviceNum is an integer;

  • port is an integer.

For example:

  • "dmx:1"

  • "rio-dmx:rio44:1"