User guide: Elgato Stream Deck

1. To get started, you need an Elgato Stream Deck of any model available at major retailers such as Amazon.
2. You also need a Soundtrack API key associated with your Soundtrack account, which you can request on our API page.
3. Set up your Stream Deck using the Quick Start Guide.
4. Download and install the Soundtrack Plugin available on the Elgato Marketplace. Add any Soundtrack button of your choice:
   
5. Enter your Soundtrack API key and select which zone (player) you would like to control. You only need to do this once — all subsequent buttons will inherit this information.
   

Play/Pause – Toggle between playing and pausing.

Next – Skip to the next track.

Block – Block the current track so it is never played again and skip to the next one.

Volume – Up, down, mute, or set to a pre-defined level, e.g. 7.

Happy Birthday

• Requires Unlimited Music Control on the zone.
• Select from several popular Happy Birthday tracks.

Playlist

• You can have any number of Playlist buttons, each assigned to a specific playlist that you select from ‘Your Music’.
• Short press to change after the current track has finished playing.
• Long press for instant change.

Song

• Requires Unlimited Music Control on the zone.
• You can have any number of Song buttons, each assigned to a specific track you can select from our catalog of over 100 million tracks.
• When you press any of your Song buttons, the selected track will play immediately.

Schedule

• You can have any number of Schedule buttons, each assigned to a specific schedule from ‘Your Music’. Note: activating a schedule may result in silence if the schedule is not set to play anything.
• Short press to change after the current track has finished playing.
• Long press for instant change.

Message

• Requires Soundtrack Messaging.
• You can play any of your messages instantly.
• You can have any number of Message buttons, each assigned to a specific message you select from your Message library.

When you click a button on the Stream Deck the connected computer will request our API to control a zone. For this to work the computer, connected to your Stream Deck, needs internet access and be able to reach our APIs.

To verify that you can make requests to our APIs visit our API documentation from the computer connected to the Stream Deck. If this works then making requests to our API should also work.

When an action fails an exclamation mark in a yellow triangle is shown. Starting with plugin version 1.3.3 an error code may show below the triangle. Below you’ll find help for the most common error codes. Due to the limited space on Stream Deck buttons, the error code may be truncated but in the list below the error codes are shown in full.

No internet

It seems that there is a problem with the internet connection. Please check the troubleshooting section above on how to verify that your computer can reach our API.

UNAUTHENTICATED

Authentication failed, please check if you have set the API key and if it was set in its entirety.

FORBIDDEN

Authorization failed, it seems that the API key does not have access to the zone you are trying to control or the zone does not exist anymore.

NOT_FOUND

Could not communicate with the selected zone, does it have an active subscription? Is the player currently online? You can verify that the zone is in the correct state by visiting the zone page. On that page, the zone you want to control should have the status ‘Connected’ and playback controls (pause and next) should be visible. If the zone has status ‘Offline’ you’ll see a Troubleshoot button for determining the problem. If the zone has the status ‘Player not connected’ then you need to connect a device.

UNLIMITED_PLAN_REQUIRED

The zone you are controlling needs Unlimited Music Control for this action to work. This applies to the Happy Birthday and Song buttons.

If further troubleshooting is necessary there are log files where additional information is logged. The log files for the Soundtrack Plugin are created in:

• macOS

  • ~/Library/Application\ Support/com.elgato.StreamDeck/Plugins/com.soundtrackyourbrand.stream-deck-plugin.sdPlugin/logs/

• Windows

  • %appdata%\Elgato\StreamDeck\Plugins\com.soundtrackyourbrand.stream-deck-plugin.sdPlugin\logs/

The log files are named com.soundtrackyourbrand.stream-deck-plugin.X.log where X is a number from 0 and up. com.soundtrackyourbrand.stream-deck-plugin.0.log always contains the most recent logs.