Audio Router Commands

Created by Jason Carr, Modified on Thu, 14 Mar at 9:23 AM by Jason Carr

Using a connected TCP socket to the configured port (default: 1074) you can instruct the Audio Router to perform tasks and also to give you information.

Simply connect to the port and you can use these commands. To send multiple commands, separate them with a comma (,)

Command Parameters Example Description 
SET MUTE
ON/OFF
UniqueId/ALL
SET MUTE ON 25
Mute channel 25.
SET MUTE OFF ALL
Unmute all channels.
Sets the muted status of the channel you specify with the UniqueId.
If you use ALL instead of a channel number then this is applied to all channels.
GET MUTE
UniqueId
GET MUTE 25
Get the mute status of channel 25.
Get the muted status of the channel specified by UniqueId.
Returns either True or False.
SET VOLUME
UniqueId/ALL
Volume%
SET VOLUME 25 50
Set the volume of channel 25 to 50 percent.
Instantly set the volume, in percent, of the channel specified by UniqueId.
If you use ALL instead of a channel number then this is applied to all channels.
GET VOLUME
UniqueId
GET VOLUME 25
Get the volume of channel 25.
Get the volume, in percent, of the channel specified by UniqueId.
Returns either True or False.
GET SLIDING
UniqueId
GET SLIDING 25
Get the sliding status of channel 25.
Return if the channel specified by UniqueId is currently sliding.
GET DUCKING
UniqueId
GET DUCKING 25
Get the ducking status of channel 25.
Return if the channel specified by UniqueId is currently ducking.
Returns either True or False.
SLIDE UniqueId/ALL
Volume%
S
SLIDE 25 20 1.5
Slide channel 25 to 20% volume over 1.5 seconds.
Slides the UniqueId channel to the Volume, in percent, over a period of S.
If you use ALL instead of a channel number then this is applied to all channels.
SLIDEMS UniqueId/ALL
Volume%
MS
SLIDEMS 25 20 1500
Slide channel 25 to 20% volume over 1500 milliseconds.
Slides the UniqueId channel to the Volume, in percent, over a period of MS.
If you use ALL instead of a channel number then this is applied to all channels.
DUCK UniqueId/ALL
Volume%
HoldS
*S
DUCK 25 20 5 0.25
Duck channel 25 to 20% volume and hold it for 5 seconds before returning the channel to its original volume. The speed the fade happens is 0.25 seconds.
Duck the UniqueId channel to the desired Volume, in percent, and hold it at that volume for the time set by HoldS. To change the default travel speed from 250 milliseconds set *S to the required period.
If you use ALL instead of a channel number then this is applied to all channels.
DUCKMS UniqueId/ALL
Volume%
HoldMS
*MS
DUCK 25 20 5000 500
Duck channel 25 to 20% volume and hold it for 5 seconds before returning the channel to its original volume. The speed the fade happens is 500 milliseconds.
Duck the UniqueId channel to the desired Volume, in percent, and hold it at that volume for the time set by HoldMS. To change the default travel speed from 250 milliseconds set *MS to the required period.
If you use ALL instead of a channel number then this is applied to all channels.
PLAY STREAM
UniqueId
URL
PLAY STREAM 25 "https://mystream.com/mount"
Load and play the stream https://mystream.com/mount as soon as it has buffered enough data.
Play a stream directly on the UniqueId channel from the URL specified. The stream will begin playing as soon as there is enough data buffered to play.
When playing the stream, if there is insufficient data to continue playing, the stream will be stalled. However, playback will automatically be resumed when sufficient data has been downloaded.
STOP STREAM
UniqueId
STOP STREAM 25
Stops the stream playing, if any, on channel 25.
Stop any stream playing on the UniqueId channel. If no stream is playing then nothing happens.
GET PLAYING
UniqueId
GET PLAYING 25
Return if channel 25 is playing a stream.
Return if the channel specifed by UniqueId is currently playing a stream previously loaded by the PLAY STREAM command.
Returns either True or False. If the stream has stalled due to insufficient data then False will be returned.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article