Skip to content

channel properties

Below are the available channel properties are described. All channel properties need to be accessed by their property followed by the target index channel in [ ] square brackets

// with a fixed integer

channel.talk[1] = channel.talk.off

// or with a variable

var target_channel = 1
channel.talk[target_channel] = channel.talk.off

channel.assign

Property for channel assignment. needs to be assigned with the api call to user.id or group.id

channel.override

Property for listen overide . needs to be assigned with the api call to group.id

channel.talk

Property for talk state. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels talk to
channel.talk.off disabled
channel.talk.auto enabled - by automation
channel.talk.latch enabled - by latch
channel.talk.on enabled
channel.talk.ptt enabled - by momentary
channel.talk[1] = channel.talk.on // enables the talk on channel 1

channel.listen

Property for listen state. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels listen to
channel.listen.off off
channel.listen.on on

channel.call

Property for call state. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels call to
channel.call.off off
channel.call.on call
channel.call.alert alert call
channel.call.mickill kill mics on remote channel

channel.cue

Property for cue state. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels cue to
channel.cue.idle idle
channel.cue.off stop active cues
channel.cue.att send attention
channel.cue.wait send wait
channel.cue.go send go
channel.cue.hold send hold

channel.level

Property for level. needs to be assigned with an integer in the level range -36 to 24 or one of its predefined values

value name represents the channels level to
channel.level.min the minimum level -36 dB
channel.level.0db 0dB
channel.level.max the maximum level 24 dB

channel.output

Property for cue state. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels pan to
channel.output.both both outputs
channel.output.1 output 1
channel.output.2 output 2
channel.output.headset output 1 (MCX headset)
channel.output.speaker output 2 (MCX speaker)

channel.priority

Property for priority. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels priority
channel.priority.low low
channel.priority.normal normal
channel.priority.high high

channel.gpiocontrol

Property for gpio control. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels gpio control value
channel.gpiocontrol.off off
channel.gpiocontrol.on on

channel.talkmode"

Property for talk mode. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels talkmode to
channel.talkmode.disabled disabled
channel.talkmode.momentary momentary
channel.talkmode.latch latch
channel.talkmode.mom latch/momentary

channel.listenmode"

Property for listen mode. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels listen mode
channel.listenmode.default default
channel.listenmode.nolistenontalk no listen on talk
channel.listenmode.ignoreisolate ignore isolate
channel.listenmode.fixed fixed

channel.callmode"

Property for call mode. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels callmode to
channel.callmode.disabled disabled
channel.callmode.recvonly receive only
channel.callmode.sendonly send only
channel.callmode.sendreceive send and receive

channel.cuemode"

Property for cue mode. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels cue mode
channel.cuemode.normal normal
channel.cuemode.ignore ignore
channel.cuemode.autoanswer auto answer

channel.channelmode

Property for channel mode. needs to be called with an [index] and can be assigned with one of its values.

value name represents the channels channelmode
channel.channelmode.normal normal
channel.channelmode.noreply no reply
channel.channelmode.directreply direct reply
channel.channelmode.autoreply auto reply
channel.channelmode.autotalk autotalk
channel.channelmode.solotalk solo talk
channel.channelmode.gpiocontrol gpio control
channel.channelmode.flex flex
Back to top