Click or drag to resize

AudioControllerPlay Method (String, Transform, Single, Single, Single)

Plays an audio item with the name audioID parented to a specified transform.

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,
	Transform parentObj,
	float volume,
	float delay = 0f,
	float startTime = 0f
)

Parameters

audioID
Type: SystemString
The audio ID.
parentObj
Type: Transform
The parent transform.
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.
Remarks
If the audio clip is marked as 3D the audio clip will be played at the position of the parent transform. As the audio object will get attached to the transform, it is important to destroy the parent object using the Destroy(GameObject) function, even if the parent object is not poolable itself
See Also