Click or drag to resize

AudioControllerPlay Method (String, Single, Single, Single)

Plays an audio item with the name audioID.

Namespace:  (Default Namespace)
Assembly:  AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
Syntax
C#
public static AudioObject Play(
	string audioID,
	float volume,
	float delay = 0f,
	float startTime = 0f
)

Parameters

audioID
Type: SystemString
The audio ID.
volume
Type: SystemSingle
The volume between 0 and 1 [default=1].
delay (Optional)
Type: SystemSingle
The delay [default=0].
startTime (Optional)
Type: SystemSingle
The start time [default=0]

Return Value

Type: AudioObject
Returns the reference of the AudioObject that is used to play the audio item, or null if the audioID does not exist. Warning: Use PoolableReferenceT to store an AudioObject reference if you have pooling enabled.
Remarks
If "3D sound" is enabled in the audio import settings of the audio clip the object will be placed right in front of the current audio listener which is usually on the main camera. Note that the audio object will not be parented - so you will hear when the audio listener moves.
See Also