With the Playlist action you can control the built-in Foundry playlist function. It allows you to play or stop playlists or tracks, and shows which playlists or tracks are currently playing (from a set of playlists you've selected).
See the image below for an example on how to set up a playlist control screen. It has been taken from the provided example XL profile.
Button functions in the image: Top row, from left to right:
- 1 Back - Exits this folder to go back to the home page of the profile
- 2 Mode: Stop All - Stops all tracks and playlists
- 3-5 Mode: Playlist, Type: Offset - Offsets the playlist number, allowing easy switching between different playlists
- 6-8 Mode: Track, Type: Offset - Offsets the track number, allowing easy switching between different tracks
Other rows show 3 different playlists (1 per row):
- 1 Mode: Playlist, Type: Play/Stop - Play or stop the selected playlist
- 2-8 Mode: Track, Type: Play/Stop - Play or stop the selected track
Module Configuration
You need to configure the playlist control in the Foundry module settings. At the top you will find the 'Playlist Configuration' button. Clicking it opens the configuration screen, as shown below.
There are 2 sections: 'Settings', and 'Playlists'.
Settings
Default Play Mode
The play mode determines what to do when a track is playing, while another track is requested. By setting it to 'Unrestricted', you can play as many tracks at the same time as you want. Setting it to 'One track per playlist' will automatically stop all playing tracks in the playlist, ensuring that only one track is playing at a time. Setting 'Play Method' to 'One track in total' will limit playback to only one track in total.
This setting sets the default play mode, which can be overridden for each separate playlist, which will be discussed below.
Options:
- Unrestricted - Play as many tracks at the same time as you want
- One track per playlist - Play only one track per playlist. Trying to start a second track will stop the other tracks in the playlist
- One track in total - Play only one track in total. Trying to start a second track will stop all other tracks that are playing
Note: This play method only applies if tracks are started using the Stream Deck, you can still play more tracks using Foundry's internal audio player.
Number of playlists
This sets the number of playlists that will be displayed. You can make this number as high or low as you want. This only changes the amount of playlists that are displayed, not the amount of playlists that can be controlled (there is no upper limit, as long as Foundry doesn't crash).
Playlists
Here you can select which playlists can be controlled with the module. You can manage as many playlists as you've set at 'Number of playlists', where the playlist number corresponds with the number you have to fill in in the property inspector (see below).
For each playlist you can set the play mode, which overrides the default play mode for that specific playlist.
Note: While you can assign the same playlist to multiple playlists in this configuration screen, only the play method of the first instance will be applied.
Stream Deck Configuration
Mode
Select the mode of the button
- Playlist - Control playlists
- Track - Control tracks
- Stop All - Stop all playlists and tracks
Mode: Playlist/Track
The playlist and track mode are very similar, the only difference is that one controls playlists, while the other controls tracks. Setup is the same for both.
Type: Play/Stop
Play or stop a playlist/track.
Playlist/Track Nr
Sets the playlist or track number to control with this button. The playlist number corresponds with the number in the 'Playlist Configuration' in the module settings, the track number corresponds with the order of the track in the playlist (as seen in Foundry's playlist).
Type: Increase Decrease Track Volume/Set Volume
With these functions you can set the volume of the selected track.
Volume
The desired volume (if set to 'Set Volume') or change in volume (if set to 'Increase/Decrease Volume').
Display Volume
('Mode' set to 'Track' only) Toggles whether or not the button should display the track's volume.
Display Name
Toggles whether or not the button should display the playlist/track name.
On Color
Sets the color of the ring that's shown on the button when the playlist/track is playing.
Off Color
Sets the color of the ring that's shown on the button when the playlist/track is not playing.
Background
Sets the background color of the button.
Type: Relative/Absolute Offset
With offset you can give the playlist or track number an offset allowing easy switching between displaying different playlists/tracks. For example, in the (topmost) image above, the playlist absolute offset is set to 0, 3, and 6 for the 3 offset buttons respectively (left to right). In the case of absolute offset, the offset will be set to the value you enter into the 'offset' box. In the case of relative offset the offset is incremented or decremented by the amount you enter into the 'offset' box.
Offset
Sets the amount the playlist/track needs to be offset when the button is pressed.
Display Offset Target Name
Only for relative playlist offsets, it will display the name of the playlist that the offset will take you to (only really works well if you only have a single playlist displayed).
On Color
Sets the color of the ring that's shown on the button when the offset is set to the value set in the offset box.
Off Color
Sets the color of the ring that's shown on the button when the offset is set to the value set in the offset box.
Background
Sets the background color of the button.
Mode: Stop All
Stops all tracks and playlists.
Display Current Playlist
Displays the name of the playlist that is at the current offset.
Background
Sets the background color of the button.