With the Soundboard action you can trigger specific sounds to be played, which is great for sound effects, such as explosions, clashing swords, or for creating sonic ambiences.
Module Configuration
You need to set up the soundboard in Foundry. This is done in the Foundry module settings. At the top you will find the 'Soundboard Configuration' button. Clicking it opens the configuration screen, as shown below.
The screen is divided into a number of boxes, each labeled 'Sound #', where each represents a single sound and its settings. The number of sounds you can see depends on what Stream Deck model you've set up in the module configuration.
For each sound there are multiple options:
Name
The name of the sound, this is the name that will be displayed on the SD button if 'Display Name' is selected in the property inspector. This name doesn't have to correspond with the file name of the sound, or the name that can be seen in the Foundry playlist.
Playlist
Sets the playlist from which you want to select a sound. If you select 'File Picker', a file picker will appear instead of the sound selection drop-down menu.
Sound Selection
This is either a drop-down menu where you can select a sound from the selected playlist, or a file picker.
When using the file picker, it is possible to use wildcard names, this means that you can randomly play a sound from a selection. To do this, navigate to the folder that contains the sounds, in the textbox append the folder name with the common part of the name of the sounds you want to play, followed by an asterisk.
For example, if you have the sounds 'Thunder.wav', 'Thunder2.wav' and 'Thunder3.wav' in the folder 'Assets', you could fill in the following: 'Assets/Thunder*', which will play one of the three sounds randomly when you press the button on the SD.
Icon
Here you can select an icon that will be displayed on the SD button if 'Display Icon' is selected in the property inspector.
Please read these notes on rules regarding icon selection.
On Color
Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is playing.
Off Color
Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is not playing.
Playback
This sets the playback mode, you can select from:
- Once - Play the sound once
- Repeat - Play the sound on repeat
- Hold - Play the sound as long as the button is held down
Volume
The playback volume of the sound. The final playback volume is also determined by the Ambient Volume slider in Foundry's 'Audio Playlists' tab.
Stream Deck Configuration
Mode
Select the mode of the button
- Play Sound - Play (or stop) the selected sound
- Offset - Pressing this button offsets the sound number for easy switching between visible sounds
- Stop All Sounds - Stops all currently playing sounds
Mode: Play Sound
Play or stop the selected sound
Sound Number
The sound to play. The number corresponds with the number in the 'Soundboard Configuration'.
Display Name
Toggles whether or not the button should display the sound's name, as set in the 'Soundboard Configuration'.
Display Icon
Toggles whether or not the button should display the sound's icon, as set in the 'Soundboard Configuration'.
Background
Sets the background color of the button. The icon needs to have transparent parts (so no jpeg).
Mode: Offset
With offset you can give the sound number an offset allowing easy switching between displaying different sounds.
Offset
Sets the amount the sound number needs to be offset when the button is pressed.
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. The icon needs to have transparent parts (so no jpeg).
Mode: Stop All Sounds
Pressing this will stop all currently playing sounds
Background
Sets the background color of the button. The icon needs to have transparent parts (so no jpeg).