AudioController.PlayMusic Method (String, Transform, Single, Single, Single)

ClockStone Audio Toolkit

previous page next page

AudioControllerPlayMusic Method (String, Transform, Single, Single, Single)
Plays an audio item with the name audioID as music at the specified position.

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

Parameters

audioID
Type: SystemString
The audio ID.
parentObj
Type: Transform
The parent transform or null.
volume (Optional)
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
PlayMusic makes sure that only one music track is played at a time. If music cross fading is enabled in the AudioController fading is performed automatically.
See Also
previous page start next page