Click or drag to resize

AudioControllerPlayAmbienceSound Method (String, Single, Single, Single)

Plays an audio item with the name audioID as ambience sound.

Namespace:  (Default Namespace)
Assembly:  AudioToolkit (in AudioToolkit.dll) Version: (
public static AudioObject PlayAmbienceSound(
	string audioID,
	float volume = 1f,
	float delay = 0f,
	float startTime = 0f


Type: SystemString
The audio ID.
volume (Optional)
Type: SystemSingle
The volume betweeen 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.
PlayAmbienceSound makes sure that only one ambience track is played at a time. If cross fading is enabled in the AudioController fading is performed automatically.
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