Skip to main content
Version: 7.9

Sound Player

Component Palette Icon:


The Sound Player component is an invisible component that facilitates audio playback in the client. Each Sound Player component has one sound clip associated with it, and will play that clip on demand. There is a built in triggering system, as well as facilities to loop the sound while the trigger is set. Note that the sound clip needs to be a *.wav file, and that the clip becomes embedded within the window that the sound player is on - clients do not need access to a share *.wav file.


Due to how the Mobile Module functions, the sound player component does not work with projects launched using the Mobile Module.


NameDescriptionProperty TypeScriptingCategory
Data QualityThe data quality code for any tag bindings on this
Loop CountIf Loop Mode is "Loop N Times", this is the "N".int.loopCountBehavior
Loop ModeThe Loop Mode determines how many times the sound is played when
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
MuteIf true, the clip will be muted during playback.boolean.muteBehavior
NameThe name of this component.String.nameCommon
Play ModeThe Play Mode determines whether the sound is played automatically on trigger or
Sound DataThe clip that this component will play.byte[].soundDataData
TriggerThe clip will be played when the trigger is true, if Play Mode is "ON_TRIGGER"boolean.triggerData
VolumeThe volume to use for playback (from 0.0 to 1.0).double.volumeBehavior


Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page