ClockStone Audio Toolkit for Unity - Documentation
AudioItem Class |
The AudioItem class represents a uniquely named audio entity that can be played by scripts.
Inheritance HierarchyNamespace: (Default Namespace)
Assembly: AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
SyntaxC#
[SerializableAttribute] public class AudioItem
The AudioItem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AudioItem | Initializes a new instance of the AudioItem class |
| AudioItem(AudioItem) |
Copy constructor
|
Properties
Methods| Name | Description | |
|---|---|---|
| ResetSequence |
Resets the sub-item sequence. (So if you are using a sequence mode the first sub-item will be played next)
|
| UnloadAudioClip |
Unloads the AudioClip from memory.
|
Fields| Name | Description | |
|---|---|---|
 | audioSource_MaxDistance |
Overrides the AudioSource MaxDistance value if overrideAudioSourceSettings is enabled.
|
| audioSource_MinDistance |
Overrides the AudioSource MinDistance value if overrideAudioSourceSettings is enabled.
|
| Delay |
Defers the playback of the audio item for Delay seconds.
|
| DestroyOnLoad |
If disabled, the audio will keep on playing if a new scene is loaded.
|
| Loop |
If enabled the audio item will get looped when played.
|
| loopSequenceCount |
The number of sub-items to be played in the loop modes LoopSequence.
|
| loopSequenceOverlap |
Specifies a time overlap for the LoopSequence |
| loopSequenceRandomDelay |
Specifies a random delay for the LoopSequence |
| loopSequenceRandomPitch |
Specifies a random pitch for the LoopSequence |
| loopSequenceRandomVolume |
Specifies a random volume for the LoopSequence |
| MaxInstanceCount |
Assures that the same audio item will not be played more than MaxInstanceCount times simultaneously.
|
| 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.
|
| Name |
The unique name of the audio item ( = audioID )
|
| overrideAudioSourceSettings |
If enabled you can specify specific AudioSource settings
|
| RandomDelay |
This is the general random delay variation for the sub items in this audio item
|
| RandomPitch |
This is the general random pitch variation for the sub items in this audio item
|
| RandomVolume |
This is the general random volume variation for the sub items in this audio item
|
| spatialBlend |
Overrides the AudioSource spatialBlend value (0=2D 1=3D)
|
| SubItemPickMode |
Determines which AudioSubItem is chosen when playing an AudioItem |
| subItems |
Define your audio sub-items using the Unity inspector.
|
| Volume |
The volume applied to all audio sub-items of this audio item.
|
Remarks
AudioItem objects are defined in an AudioCategory using the Unity inspector.
See Also