playSound
Browser Only
This can only be used in code which runs in Dashboards and Graphics.
playSound(cueName, *opts)
→ {Object|undefined} (SoundJS AbstractAudioInstance)
Plays the sound cue of the provided cueName
in the current bundle. Does nothing if the cue doesn't exist or if the cue has no assigned file to play.
Parameters
Name | Type | Attributes | Description |
---|---|---|---|
cueName | String | Sound cue's name | |
opts | Object | <optional> | Options for the sound cue |
Opts
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
updateVolume | boolean | <optional> | true | Whether or not to let NodeCG automatically update this instance's volume when the user changes it on the dashboard. |