AudioSubItem Members

Audio Toolkit

Collapse image Expand Image Copy image CopyHover image

The AudioSubItem type exposes the following members.

Constructors

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

Methods

  Name Description
Public method ToString
Returns the name of the audio clip for debugging.
(Overrides Object..::..ToString()()()().)

Fields

  Name Description
Public field Clip
Specifies the AudioClip to be played in case of the Item mode.
Public field ClipStartTime
Offsets the the audio clip start time (in seconds).
Public field ClipStopTime
Ends playing the audio at this time (in seconds).
Public field Delay
Defers the playback of the audio sub-item for Delay seconds.
Public field 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.
Public field FadeIn
Automatic fade-in in seconds
Public field FadeOut
Automatic fade-out in seconds
Public field individualSettings
List of attribute names that have individual setings, ie. that are not inherited by the parent AudioItem
Public field ItemModeAudioID
Specifies the audioID to be played in case of the Item mode
Public field Pan2D
Alters the pan: -1..left, +1..right
Public field PitchShift
Alters the pitch in units of semitones ( thus 12 = twice the speed)
Public field 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.
Public field RandomDelay
Randomly adds a delay between 0 and RandomDelay
Public field RandomPitch
Randomly shifts the pitch in units of semitones ( thus 12 = twice the speed)
Public field RandomStartPosition
Starts playing at a random position.
Public field RandomVolume
Randomly shifts the volume +/- this value
Public field SubItemType
Specifies the type of this AudioSubItem
Public field Volume
The volume applied to the audio sub-item.

Properties

  Name Description
Public property item
the AudioItem the sub-item belongs to.

See Also