AudioController.PlayScheduled Method

Audio Toolkit

previous page next page
Collapse image Expand Image Copy image CopyHover image
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.0.0.0 (8.0.0.0)

Syntax

C#
public static AudioObject PlayScheduled(
	string audioID,
	double dspTime,
	Vector3 worldPosition,
	Transform parentObj = null,
	float volume = 1f,
	float startTime = 0f
)

Parameters

audioID
Type: System..::..String
The audio ID.
dspTime
Type: System..::..Double
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: System..::..Single
The volume between 0 and 1 [default=1].
startTime (Optional)
Type: System..::..Single
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