ClockStone Audio Toolkit for Unity - Documentation
AudioSubItem Class |
An AudioSubItem represents a specific Unity audio clip.
Inheritance HierarchyNamespace: (Default Namespace)
Assembly: AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)
SyntaxC#
[SerializableAttribute] public class AudioSubItem
The AudioSubItem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AudioSubItem | Initializes a new instance of the AudioSubItem class |
| AudioSubItem(AudioSubItem, AudioItem) |
Copy constructor
|
Properties
Methods| Name | Description | |
|---|---|---|
| ToString |
Returns the name of the audio clip for debugging.
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | Clip |
Specifies the AudioClip to be played in case of the Item mode.
|
| ClipStartTime |
Offsets the the audio clip start time (in seconds).
|
| ClipStopTime |
Ends playing the audio at this time (in seconds).
|
| Delay |
Defers the playback of the audio sub-item for Delay seconds.
|
| DisableOtherSubitems |
If enabled all other subitmes which do not have this option enabled will not be played. Useful for testing specific subitmes within a large list of subitems.
|
| FadeIn |
Automatic fade-in in seconds
|
| FadeOut |
Automatic fade-out in seconds
|
| individualSettings |
List of attribute names that have individual setings, ie. that are not inherited by the parent AudioItem
|
| ItemModeAudioID |
Specifies the audioID to be played in case of the Item mode
|
| Pan2D |
Alters the pan: -1..left, +1..right
|
| PitchShift |
Alters the pitch in units of semitones ( thus 12 = twice the speed)
|
| Probability |
If multiple sub-items are defined within an audio item, the specific audio clip is chosen with a probability in proportion to the Probability value.
|
| RandomDelay |
Randomly adds a delay between 0 and RandomDelay
|
| RandomPitch |
Randomly shifts the pitch in units of semitones ( thus 12 = twice the speed)
|
| RandomStartPosition |
Starts playing at a random position.
|
| RandomVolume |
Randomly shifts the volume +/- this value
|
| SubItemType |
Specifies the type of this AudioSubItem |
| Volume |
The volume applied to the audio sub-item.
|
Remarks
Add your AudioSubItem to an AudioItem using the Unity inspector.
See Also