Sound Player

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 shared *.wav file.

Behavior

Play Mode

The Play Mode determines whether the sound is played automatically on trigger or manually

Scripting name

playMode

Data type

int

Values

0	Manual
1	On Trigger

Loop Mode

The Loop Mode determines how many times the sound is played when triggered.

Scripting name

loopMode

Data type

int

Values

0	Play Once
1	Loop Forever
2	Loop N Times

Loop Count

If Loop Mode is "Loop N Times", this is the "N".

Scripting name	loopCount
Data type	int

Volume

The volume to use for playback (from 0.0 to 1.0).

Scripting name	volume
Data type	double

Mute

If true, the clip will be muted during playback.

Scripting name	mute
Data type	boolean

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name	toolTipText
Data type	String

Data

Trigger

The clip will be played when the trigger is true, if Play Mode is "ON_TRIGGER"

Scripting name	trigger
Data type	boolean
Flags	bindable

Sound Data

The clip that this component will play.

Scripting name	soundData
Data type	byte[]

Data Quality

The data quality code for any tag bindings on this component.

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

The following event sets are fired by this component. See Component Event Handlers to learn more.