|
|
| ClockStone Audio Toolkit for Unity - Documentation |
| AudioObject Properties |
| AudioObject Class See Also Send Feedback |
|
The AudioObject type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
audioID |
Gets the audio ID.
|
|
|
audioItem |
Gets the corresponding AudioSubItem
|
|
|
audioObjectTime |
Returns the high precision local time of this audio object
|
|
|
audioTime |
Sets or gets the current audio time relative to ClipStartTime
|
|
|
category |
Gets the category.
|
|
|
clipLength |
Gets the length of the clip.
|
|
|
completelyPlayedDelegate |
Gets or sets the delegate to be called once an audio clip was completely played.
|
|
|
isFadeOutComplete |
return true if the audio has completely faded out
|
|
|
isFadingIn |
return true if the audio is currently fading in
|
|
|
isFadingOut |
return true if the audio is currently fading out
|
|
|
isFadingOutOrScheduled |
return true if the audio is currently fading out or is scheduled to fade out
|
|
|
isPlayedAsMusicOrAmbienceSound |
Returns true if the audio object is treated as music
|
|
|
pan |
Sets or gets the audio pan.
|
|
|
pitch |
Sets or gets the audio pitch.
|
|
|
playCalledAtTime |
Gets the systemTime at which the audio Play() function was called.
|
|
|
primaryAudioSource |
returns the primary AudioSource
|
|
|
scheduledPlayingAtDspTime |
Gets or sets the DSP time at which the audio is scheduled to play.
|
|
|
secondaryAudioSource |
returns the secondary AudioSource
|
|
|
startedPlayingAtTime |
Gets the systemTime at which the audio started playing.
|
|
|
stopAfterFadeOut |
If enabled, the audio will stop plaing if a fadeout is finished.
|
|
|
subItem |
Gets the corresponding AudioSubItem
|
|
|
timeUntilEnd |
Gets the time until the clip will stop.
|
|
|
volume |
Gets or sets the volume.
|
|
|
volumeItem |
Gets or sets the volume of the audio item.
|
|
|
volumeTotal |
Gets the total volume.
|
|
|
volumeTotalWithoutFade |
Gets the total volume.
|
See Also
Send comments on this topic to ClockStone Support Email
Copyright (c) 2012 by ClockStone Software GmbH