Skip to main content

Mixer Channels

Mixer channels are accessed via the Mixer Console, not through track object .channel property. Use console.getChannelList(type) to retrieve different channel lists.

See Channel Object for MusicTrack and AudioTrack channels (accessed via the .channel property).

Channel Types​

Each channel list entry has a channelType string that identifies its role.

Channel List Types:

TypeContentsExample channelType values
1Normal mixer channelsAudioSynth, AudioTrack, AudioAux, MusicTrack, AudioEffect, AudioGroup, AudioVCA
2Sub-output bussesAudioOutput
3Master output + listen busAudioOutput, AudioListenBus
4Hardware inputsAudioInput
var console = context.functions.root.environment.find("MixerConsole");
var normal = console.getChannelList(1); // All mixer channels
var subOuts = console.getChannelList(2); // Sub-output busses
var master = console.getChannelList(3); // Master + listen bus
var hwInputs = console.getChannelList(4); // Hardware inputs

Each getChannelList(type) returns an object for iterating and accessing channels:

Properties​

PropertyTypeWritableExampleDescription
numChannelsnumberNo16Total count of channels in the list.
numSelectedChannelsnumberNo1Count of selected channels in the list.

Methods​

MethodReturnsParametersDescription
getChannel(index)objectindex (number, req): 0-based index.Returns the channel at the given index.
getSelectedChannel(index)objectindex (number, req): 0-based index.Returns the selected channel at the given index.

AudioGroup​

Bus/subgroup channel (e.g. "Bus 1").

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioGroup"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
muteflagYes0Mute state.
namestringNo"Channel01"Internal channel name.
overviewobjectNo—Channel overview object.
pannumberYes0.5Pan position.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"Bus 1"Display name.
volumenumberYes1Fader level.
MethodReturnsParametersDescription
connectTo(targetChannel)numbertargetChannel (object, req): Destination channel.Route to another output. Returns 1 on success.
focus()—(none)Scroll the mixer view to bring this channel into focus.
openEditor()number(none)Open the Channel Editor. Returns 1 when opened.
getDestinationChannel()object(none)Returns the current output destination.

AudioOutput​

Master or sub-output bus (e.g. "Main").

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioOutput"Channel type identifier.
mediaTypestringNo"Audio"Media type.
namestringNo"Channel01"Internal name.
titlestringNo"Main"Display name.
environmentstringNo"SongEnvironment"Environment identifier.
editorobjectNo—Channel editor object
overviewobjectNo—Channel overview object
parentobjectNo—Parent bus object.
MethodReturnsParametersDescription
connectTo(targetChannel)numbertargetChannel (object, req): Destination channel.Route to another output. Returns 1 on success.
focus()—(none)Scroll the mixer view to bring this channel into focus.
openEditor()number(none)Open the Channel Editor for this output. Returns 1 when opened.

Parent chain: AudioOutput → Channels → AudioMixer (not MusicTrackDevice).

AudioSynth​

Instrument/synth channel.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioSynth"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
muteflagYes0Mute state.
namestringNo"Channel04"Internal channel name.
overviewobjectNo—Channel overview object.
pannumberYes0.5Pan position.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"SampleOne 3"Display name.
volumenumberYes1Fader level.

| Method | Returns | Parameters | Description | |---|---|---|---|---| | connectTo(targetChannel) | number | targetChannel (object, req): Destination channel. | Route to another output. Returns 1 on success. | | focus() | — | (none) | Scroll the mixer view to bring this channel into focus. | | openEditor() | number | (none) | Open the Channel Editor. Returns 1 when opened. | | getDestinationChannel() | object | (none) | Returns the current output destination. |

AudioAux​

Aux channel.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioAux"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
muteflagYes0Mute state.
namestringNo"Channel01"Internal channel name.
overviewobjectNo—Channel overview object.
pannumberYes0.5Pan position.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"Aux 1"Display name.
volumenumberYes1Fader level.
MethodReturnsParametersDescription
connectTo(targetChannel)numbertargetChannel (object, req): Destination channel.Route to another output (returns 1, but routing does not change — aux channels are receive-only).
focus()—(none)Scroll the mixer view to bring this channel into focus.
openEditor()number(none)Open the Channel Editor. Returns 1 when opened.
getDestinationChannel()—(none)—

AudioEffect​

FX channel.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioEffect"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
muteflagYes0Mute state.
namestringNo"Channel01"Internal channel name.
overviewobjectNo—Channel overview object.
pannumberYes0.5Pan position.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"FX 1"Display name.
volumenumberYes1Fader level.

| Method | Returns | Parameters | Description | |---|---|---|---|---| | connectTo(targetChannel) | number | targetChannel (object, req): Destination channel. | Route to another output. Returns 1 on success. | | focus() | — | (none) | Scroll the mixer view to bring this channel into focus. | | openEditor() | number | (none) | Open the Channel Editor. Returns 1 when opened. | | getDestinationChannel() | object | (none) | Returns the current output destination. |

AudioVCA​

VCA channel.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioVCA"Channel type identifier.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
muteflagYes0Mute state.
namestringNo"Channel01"Internal channel name.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"VCA 1"Display name.
volumenumberYes1Fader level.
MethodReturnsParametersDescription
focus()—(none)Scroll the mixer view to bring this channel into focus.

AudioListenBus​

Listen bus channel.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioListenBus"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
namestringNo"Channel01"Internal channel name.
overviewobjectNo—Channel overview object.
parentobjectNo—Parent bus object.
titlestringNo"Listen Bus"Display name.
volumenumberYes1Fader level.
MethodReturnsParametersDescription
focus()—(none)Scroll the mixer view to bring this channel into focus.
openEditor()number(none)Open the Channel Editor. Returns 1 when opened.

AudioInput​

Hardware input channel. Represents a physical audio interface/mixer input.

PropertyTypeWritableExampleDescription
channelTypestringNo"AudioInput"Channel type identifier.
editorobjectNo—Channel editor object.
environmentstringNo"SongEnvironment"Environment identifier.
labelstringNoSame as titleDisplay label (alias).
maxVolumenumberNo3.162Maximum fader value.
mediaTypestringNo"Audio"Media type.
namestringNo"Channel01"Internal channel name.
overviewobjectNo—Channel overview object.
parentobjectNo—Parent bus object.
soloflagYes0Solo state.
titlestringNo"Desk Mic"Display name.
volumenumberYes1Fader level.
MethodReturnsParametersDescription
focus()—(none)Scroll the mixer view to bring this channel into focus.
openEditor()number(none)Open the Channel Editor. Returns 1 when opened.

Focus Example​

var console = context.functions.root.environment.find("MixerConsole");
var list = console.getChannelList(1);

// Focus a specific channel by its display name
for (var i = 0; i < list.numChannels; i++) {
var ch = list.getChannel(i);
if (ch.title === "VCA 1") {
ch.focus();
break;
}
}