AudioItem Members

Audio Toolkit

Collapse image Expand Image Copy image CopyHover image

The AudioItem type exposes the following members.

Constructors

  Name Description
Public method AudioItem()()()()
Initializes a new instance of the AudioItem class
Public method AudioItem(AudioItem)
Copy constructor

Methods

  Name Description
Public method ResetSequence
Resets the sub-item sequence. (So if you are using a sequence mode the first sub-item will be played next)
Public method UnloadAudioClip
Unloads the AudioClip from memory.

Fields

  Name Description
Public field audioSource_MaxDistance
Overrides the AudioSource MaxDistance value if overrideAudioSourceSettings is enabled.
Public field audioSource_MinDistance
Overrides the AudioSource MinDistance value if overrideAudioSourceSettings is enabled.
Public field Delay
Defers the playback of the audio item for Delay seconds.
Public field DestroyOnLoad
If disabled, the audio will keep on playing if a new scene is loaded.
Public field Loop
If enabled the audio item will get looped when played.
Public field loopSequenceCount
The number of sub-items to be played in the loop modes LoopSequence.
Public field loopSequenceOverlap
Specifies a time overlap for the LoopSequence
Public field loopSequenceRandomDelay
Specifies a random delay for the LoopSequence
Public field loopSequenceRandomPitch
Specifies a random pitch for the LoopSequence
Public field loopSequenceRandomVolume
Specifies a random volume for the LoopSequence
Public field MaxInstanceCount
Assures that the same audio item will not be played more than MaxInstanceCount times simultaneously.
Public field MinTimeBetweenPlayCalls
Assures that the same audio item will not be played multiple times within this time frame. This is useful if several events triggered at almost the same time want to play the same audio item which can cause unwanted noise artifacts.
Public field Name
The unique name of the audio item ( = audioID )
Public field overrideAudioSourceSettings
If enabled you can specify specific AudioSource settings
Public field RandomDelay
This is the general random delay variation for the sub items in this audio item
Public field RandomPitch
This is the general random pitch variation for the sub items in this audio item
Public field RandomVolume
This is the general random volume variation for the sub items in this audio item
Public field spatialBlend
Overrides the AudioSource spatialBlend value (0=2D 1=3D)
Public field SubItemPickMode
Determines which AudioSubItem is chosen when playing an AudioItem
Public field subItems
Define your audio sub-items using the Unity inspector.
Public field Volume
The volume applied to all audio sub-items of this audio item.

Properties

  Name Description
Public property category
the AudioCategroy the audio item belongs to.

See Also