Spark API - Audio

BitFire Spark API - Audio
CommandActionDescriptionExamples
A_GAIN [ch|bus] [gain] Set the gain on a CH or BUS. GAIN is an offset in dB. Values less than -64 are interpreted as -inf dB. Set the gain of ch 1 to +6dB
A_GAIN 1 6
A_GAIN_REL [ch|bus] [gain] Adjust the gain on a CH or BUS by an offset. GAIN is an offset in dB added to the current gain. Subtract 10dB from current gain of CH 1
A_GAIN_REL 1 -10
A_SEND [dst_bus] [ch|bus] [send] Send a CH or BUS to a DST_BUS. DST_BUS is the destination bus.
SEND is an integer in dB between -64 and +6. Values less than -64 are interpreted as -inf dB.
Bus sends are post-fader of the bus main.
When sending a bus into another bus, the target bus number must be less than the source bus number.
Send CH 1 into Bus 1 at unity (0dB)
A_SEND 101 1 0

Send Bus 2 into Bus 1 at +6dB
A_SEND 101 102 6
A_SEND_REL [dst_bus] [ch|bus] [send] Adjust send of CH or BUS to a DST_BUS. DST_BUS is the destination bus.
SEND is an offset to apply to the current send value.
Add 10dB to send of CH 1 into Bus 1
A_SEND_REL 101 1 10

Subtract 10dB from send of CH 2 into Bus 3
A_SEND_REL 103 2 -10
A_BUS_MAIN [bus] [level] Set the main level of BUS to LEVEL by an offset. BUS is a destination bus.
LEVEL is an integer in dB between -64 and +6. Values less than -60 are interpreted as -inf dB.
Set the main bus level to unity (0dB)
A_BUS_MAIN 101 0

Set the main bus level to +6dB
A_BUS_MAIN 102 +6
A_BUS_MAIN_REL [bus] [level] Adjust the main level of BUS by an offset. BUS is a destination bus.
LEVEL is an offset to apply to the current send value.
Add to the current main of bus 101 by 10dB
A_BUS_MAIN 101 10

Subtract from the current main of bus 102 by 10dB
A_BUS_MAIN 102 -10
A_MUTE [ch|bus] Toggle mute of CH or BUS.
A_MUTE [ch|bus] [state] Set mute of CH or BUS to STATE STATE is 1 for muted, 0 for unmuted. Mute channel 2
A_MUTE 2 1

Unmute channel 3
A_MUTE 3 0

Mute bus 1
A_MUTE 101 1
A_MUTE_DUR [ch|bus] [dur] Toggle mute CH or BUS over DUR ms. CH|BUS channel or bus.
DUR is a duration in ms. Must be at least 1ms.
Toggle mute channel 1 over 300ms
A_MUTE_DUR 1 300
A_MUTE_DUR [ch|bus] [dur] [state] Mute CH or BUS over DUR ms. CH|BUS channel or bus.
DUR is a duration in ms. Must be at least 1ms.
STATE is either 1 to mute, or 0 to unmute.
No action is taken if target is already muted/unmuted.
Mute channel 1 over 300ms
A_MUTE_DUR 1 300 1

Unmute channel 1 over 300ms
A_MUTE_DUR 1 300 0
A_SET_INPUT [ch] [src_num] [src_ch] Route channel SRC_CH of input SRC_NUM into mixer channel CH. CH is the mixer channel.
IN_SRC is the input into the mixer (i.e. SDI source).
SRC_CH is the channel of the IN_SRC to route.
Route Channel 3 of INPUT 2 into Mixer Channel 1
A_SET_INPUT 1 2 3
A_MUTE_GROUP [group] Toggle mute group GROUP on/off. GROUP the mute group to toggle. Toggle mute group 1
A_MUTE_GROUP 1
A_MUTE_GROUP [group] [state] Set mute group GROUP on/off. GROUP the mute group to toggle.
STATE is 1 for on, 0 for off.
Set mute group 2 on
A_MUTE_GROUP 2 1

Set mute group 3 off
A_MUTE_GROUP 3 0
A_MUTE_GROUP_DUR [group] [dur] Toggle mute group GROUP over DUR ms. GROUP is a mute group.
DUR is a duration in ms. Must be at least 1ms.
Toggle mute of all members of group 1 over 300ms
A_MUTE_GROUP_DUR 1 300
A_MUTE_GROUP_DUR [group] [dur] [state] Mute GROUP over DUR ms. GROUP channel or bus.
DUR is a duration in ms. Must be at least 1ms.
STATE is either 1 to mute, or 0 to unmute.
No action is taken if target is already muted/unmuted.
Mute of all members of group 1 over 300ms
A_MUTE_GROUP_DUR 1 300 1

Unmute of all members of group 1 over 300ms
A_MUTE_GROUP_DUR 1 300 0
A_MUTE_GROUP_MEMBERS [group] [ch|bus…] Set the members of mute group GROUP. GROUP the mute group.
CH and BUS… is a comma separated list of channels to set.
Set the members of mute group 8 to ch 1,2,3 and bus 4.
A_MUTE_GROUP_MEMBERS 8 1,2,3,104
A_MUTE_GROUP_SET_MEMBER [group] [ch|bus] Toggle membership of CH or BUS on mute group GROUP. Removes all other members from the group. GROUP the mute group.
CH or BUS is the member to set.
Toggle membership of ch 1 on mute group 8.
A_MUTE_GROUP_SET_MEMBER 8 1

Toggle membership of bus 2 on mute group 8.
A_MUTE_GROUP_SET_MEMBER 8 102
A_MUTE_GROUP_SET_MEMBER [group] [ch|bus] [state] Add/remove CH or BUS to/from mute group GROUP. GROUP the mute group.
CH or BUS is the member to set.
STATE is 1 to add, 0 to remove.
Add channel 2 to mute group 8
A_MUTE_GROUP_SET_MEMBER 8 2 1

Remove channel 3 from mute group 7
A_MUTE_GROUP_SET_MEMBER 7 3 0

Add bus 1 to mute group 6
A_MUTE_GROUP_SET_MEMBER 6 101 1
A_CHANNEL_LINK [ch]
Link CH and its pair together. When linked, the sends of both channels will be kept the same.
CH is the channel to link.
Link channel 1 + 2
A_CHANNEL_LINK 1

Link channel 3 + 4
A_CHANNEL_LINK 4
A_CHANNEL_UNLINK [ch] Unlink CH from its pair. CH is the channel to unlink. Unlink channel 1+2
A_CHANNEL_UNLINK 1

Unlink channel 3+4
A_CHANNEL_UNLINK 4
A_BUS_LINK [bus] Link BUS and its pair together. When linked, the sends and mains across both buses will be kept the same. A_GAIN controls become available for the bus.
BUS is the bus to link.
Link bus 1 and bus 2
A_BUS_LINK 101

Link bus 3 and bus 4
A_BUS_LINK 104
A_BUS_UNLINK [bus] Unlink BUS from its pair. Unink bus 1 and bus 2
A_BUS_UNLINK 101

Unlink bus 3 and bus 4
A_BUS_UNLINK 104
A_PAN [bus] [ch|bus] [value] Pan the channel across two buses.
This is only available if the bus is linked.
BUS is the bus to apply the pan on.
CH|BUS is the channel or bus to pan.
VALUE is a number between -64 and 64. 0 is unity
Pan channel 1 hard right on bus 1 / bus 2
A_PAN 101 1 64

Pan channel 2 hard left on bus 1 / bus 2
A_PAN 101 2 -64
A_MONITOR_MASTER [bus] Set the target of the monitors to BUS BUS is the id of the target bus.
If a BUS is linked, the two monitors monitor the two busses (stereo). If not linked, then both monitors monitor the one bus (dual mono).
Set target of monitor to bus 1
A_MONITOR_MASTER 101

Set target of monitor to bus 4
A_MONITOR_MASTER 104
A_SOLO [ch|bus] Toggle solo on a CH or BUS in the monitor CH or BUS is the member to solo. Solo channel 1
A_SOLO 1

Solo bus 6
A_SOLO 106
A_EQ_GAIN [LOW|MID|HIGH] [ch] [gain] Set the low/mid/high GAIN for CH LOW|MID|HIGH is the gain region to modify.
CH is the channel to update.
GAIN is the gain to set. This is a number between -20dB and +6dB.
A_COMP [PROPERTY] [CH] [VAL] Set PROPERTY of CH’s compressor to VAL PROPERTY is STATE, THRESH, RATIO, RELEASE, OR ATTACK.
CH is the channel to update.
VAL depends upon property:
STATE - VAL is 1 for on or 0 for off
THRESH - VAL is a value in dB between -60 and +10 (inclusive)
RATIO - VAL is in dB and is between 1 and 10 (inclusive)
RELEASE - VAL is a value in ms and is between 1 and 1000 (inclusive)
ATTACK - VAL is a value in ms between 1 and 20 (inclusive)
Toggle the STATE of Channel 6’s compressor
A_COMP STATE 6

Set the THRESHOLD of Channel 2’s Compressor to -10dB
A_COMP THRESHOLD 2 -10

Set the RATIO of Channel 1’s compressor to 3:1
A_COMP RATIO 1 3

Set the RELEASE of Channel 1’s compressor to 200 ms
A_COMP RELEASE 1 200

Set the ATTACK of Channel 1’s compressor to 10ms
A_COMP ATTACK 1 10
A_GATE [PROPERTY] [CH] [VAL] Set PROPERTY of CH’s gate to VAL PROPERTY is STATE, THRESH, RELEASE, OR ATTACK.
CH is the channel to update.
VAL depends upon property:
STATE - VAL is 1 for on or 0 for off
THRESH - VAL is a value in dB between -60 and +10 (inclusive)
RELEASE - VAL is a value in ms and is between 1 and 1000 (inclusive)
ATTACK - VAL is a value in ms between 1 and 20 (inclusive)
Turn on Channel 3’s gate
A_GATE STATE 3 1

Set the THRESHOLD of Channel 2’s gate to -5dB
A_GATE THRESHOLD 2 -5

Set the RELEASE of Channel 2’s gate to 50ms
A_GATE RELEASE 2 50

Set the ATTACK of Channel 1’s gate to 15ms
A_GATE ATTACK 1 15
A_LIM [PROPERTY] [CH] [VAL] Set PROPERTY of CH’s limiter to VAL PROPERTY is STATE, THRESH, RELEASE, OR ATTACK.
CH is the channel to update.
VAL depends upon property:
STATE - VAL is 1 for on or 0 for off
THRESH - VAL is a value in dB between -60 and +10 (inclusive)
RELEASE - VAL is a value in ms and is between 1 and 1000 (inclusive)
ATTACK - VAL is a value in ms between 1 and 20 (inclusive)
Turn off Channel 4’s limiter
A_LIM STATE 4 0

Set the THRESHOLD of Channel 2’s limiter to +5dB
A_LIM THRESHOLD 2 5

Set the RELEASE of Channel 1’s limiter to 300ms
A_LIM RELEASE 1 300

Set the ATTACK of Channel 6’s limiter to 5ms
A_LIM ATTACK 6 5

Use Cases

Download PDF Guide