AudioObject Properties

Audio Toolkit

Collapse image Expand Image Copy image CopyHover image

The AudioObject type exposes the following members.

Properties

  Name Description
Public property audioID
Gets the audio ID.
Public property audioItem
Gets the corresponding AudioSubItem
Public property audioObjectTime
Returns the high precision local time of this audio object
Public property audioTime
Sets or gets the current audio time relative to ClipStartTime
Public property category
Gets the category.
Public property clipLength
Gets the length of the clip.
Public property completelyPlayedDelegate
Gets or sets the delegate to be called once an audio clip was completely played.
Public property isFadeOutComplete
return true if the audio has completely faded out
Public property isFadingIn
return true if the audio is currently fading in
Public property isFadingOut
return true if the audio is currently fading out
Public property isFadingOutOrScheduled
return true if the audio is currently fading out or is scheduled to fade out
Public property isPlayedAsMusicOrAmbienceSound
Returns true if the audio object is treated as music
Public property pan
Sets or gets the audio pan.
Public property pitch
Sets or gets the audio pitch.
Public property playCalledAtTime
Gets the systemTime at which the audio Play() function was called.
Public property primaryAudioSource
returns the primary AudioSource
Public property scheduledPlayingAtDspTime
Gets or sets the DSP time at which the audio is scheduled to play.
Public property secondaryAudioSource
returns the secondary AudioSource
Public property startedPlayingAtTime
Gets the systemTime at which the audio started playing.
Public property stopAfterFadeOut
If enabled, the audio will stop plaing if a fadeout is finished.
Public property subItem
Gets the corresponding AudioSubItem
Public property timeUntilEnd
Gets the time until the clip will stop.
Public property volume
Gets or sets the volume.
Public property volumeItem
Gets or sets the volume of the audio item.
Public property volumeTotal
Gets the total volume.
Public property volumeTotalWithoutFade
Gets the total volume.

See Also