AudioController.PlayScheduled Method

ClockStone Audio Toolkit

previous page next page

AudioControllerPlayScheduled Method

Plays an audio item with the name audioID parented to a specified transform with a world offset scheduled at a specified high precision DSP time (see the Unity AudioSettings.dspTime documentation)

Namespace:  (Default Namespace)
Assembly:  AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
Syntax
C#
Copy
public static AudioObject PlayScheduled(
	string audioID,
	double dspTime,
	Vector3 worldPosition,
	Transform parentObj = null,
	float volume = 1f,
	float startTime = 0f
)

Parameters

audioID
Type: SystemString
The audio ID.
dspTime
Type: SystemDouble
The high precision DSP time at which to start playing.
worldPosition
Type: Vector3
The position in world coordinates.
parentObj (Optional)
Type: Transform
The parent transform.
volume (Optional)
Type: SystemSingle
The volume between 0 and 1 [default=1].
startTime (Optional)
Type: SystemSingle
The start time seconds [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.
See Also
previous page start next page