Vision - 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. The sound clip needs to be a *.wav file. The clip becomes embedded within the window that the sound player is on. Clients do not need access to a shared *.wav file.
Properties​
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Loop Count | If Loop Mode is Loop N Times, this value represents 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 | Determines when the sound is played:
| int | .playMode | Behavior |
| Quality | The data quality code for any Tag bindings on this component. | QualityCode | .quality | Data |
| 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​
See the Vision - Sound Player Scripting Functions page for the associated Component and Extension Functions available for this component.
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.