Sound Player
Component Palette Icon:
Description
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.
Properties
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Data Quality | The data quality code for any tag bindings on this component. | int | .dataQuality | Data |
| Loop Count | If Loop Mode is "Loop N Times", this is the "N". | int | .loopCount | Behavior |
| Loop Mode | The Loop Mode determines how many times the sound is played when triggered. | int | .loopMode | Behavior |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String | .toolTipText | Common |
| Mute | If true, the clip will be muted during playback. | boolean | .mute | Behavior |
| Name | The name of this component. | String | .name | Common |
| Play Mode | The Play Mode determines whether the sound is played automatically on trigger or manually. | int | .playMode | Behavior |
| Sound Data | The clip that this component will play. | byte[] | .soundData | Data |
| Trigger | The clip will be played when the trigger is true, if Play Mode is "ON_TRIGGER" | boolean | .trigger | Data |
| Volume | The volume to use for playback (from 0.0 to 1.0). | double | .volume | Behavior |
Scripting
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