AudioObject Methods |
The AudioObject type exposes the following members.
| Name | Description | |
|---|---|---|
| DestroyAudioObject |
Destroys the audio object (using ObjectPoolController if pooling is enabled)
| |
| DoesBelongToCategory |
Checks if this AudioObject belongs to a specific category
| |
| FadeIn |
Fades-in a playing audio.
| |
| FadeOut(Single) |
Starts a fade-out. If the AudioItem mode is is a sequence, the next sub-item will continue to play
after the this sub-item is completely faded out.
| |
| FadeOut(Single, Single) |
Starts a fade-out at a specified time. If the AudioItem mode is is a sequence, the next sub-item will continue to play
after the this sub-item is completely faded out.
| |
| FinishSequence |
Finishes a playing sequence, depending on the AudioItem's loop mode :
| |
| InverseTransformPitch |
Inverse pitch transformation: TransformPitch(Single) | |
| InverseTransformVolume |
Inverse volume transformation TransformVolume(Single) | |
| IsPaused |
Determines whether the audio clip is paused.
| |
| IsPlaying |
Determines if either the primary or the secondary audio clip is playing.
| |
| IsPrimaryPlaying |
Determines if the primary audio clip is playing.
| |
| IsSecondaryPlaying |
Determines if the secondary audio clip is playing.
| |
| Pause |
Pauses the audio clip.
| |
| Pause(Single) |
Pauses the audio clip with a fade-out.
| |
| Play |
Plays the audio clip with the specified delay.
| |
| PlayAfter |
Plays the specified audio after the current has finished playing
| |
| PlayNow |
Plays the specified audio.
| |
| PlayScheduled |
Plays the audio clip at the specified high precision DSP time (see the Unity AudioSettings.dspTime documentation)
| |
| Stop |
Stops playing this instance.
| |
| Stop(Single) |
Stops a playing audio with fade-out.
| |
| Stop(Single, Single) |
Stops a playing audio with fade-out at a specified time.
| |
| SwitchAudioSources |
Switches the primary and secondary audio source
| |
| TransformPitch |
Transforms the pitch from semitones to a multiplicative factor
| |
| TransformVolume |
Transforms the volume to make it perceptually more intuitive to scale and cross-fade.
| |
| Unpause |
Unpauses the audio clip.
| |
| Unpause(Single) |
Unpauses the audio clip with a fade-in.
|