C# Class AudioSubItem, swip3

Show file Open project: unit9/swip3 Class Usage Examples

Public Properties

Property Type Description
Clip UnityEngine.AudioClip
ClipStartTime float
ClipStopTime float
Delay float
FadeIn float
FadeOut float
ItemModeAudioID string
Pan2D float
PitchShift float
Probability float
RandomDelay float
RandomPitch float
RandomStartPosition bool
RandomVolume float
SubItemType AudioSubItemType
Volume float

Private Properties

Property Type Description

Public Methods

Method Description
ToString ( ) : string

Returns the name of the audio clip for debugging.

Method Details

ToString() public method

Returns the name of the audio clip for debugging.
public ToString ( ) : string
return string

Property Details

Clip public property

Specifies the UnityEngine.AudioClip to be played in case of the AudioSubItemType.Item mode.
public AudioClip,UnityEngine Clip
return UnityEngine.AudioClip

ClipStartTime public property

Offsets the the audio clip start time (in seconds).
Does not work with looping.
public float ClipStartTime
return float

ClipStopTime public property

Ends playing the audio at this time (in seconds).
Can be used as a workaround for an unknown clip length (e.g. for tracker files)
public float ClipStopTime
return float

Delay public property

Defers the playback of the audio sub-item for Delay seconds.
public float Delay
return float

FadeIn public property

Automatic fade-in in seconds
public float FadeIn
return float

FadeOut public property

Automatic fade-out in seconds
public float FadeOut
return float

ItemModeAudioID public property

Specifies the audioID to be played in case of the AudioSubItemType.Item mode
public string ItemModeAudioID
return string

Pan2D public property

Alters the pan: -1..left, +1..right
public float Pan2D
return float

PitchShift public property

Alters the pitch in units of semitones ( thus 12 = twice the speed)
public float PitchShift
return float

Probability public property

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 float Probability
return float

RandomDelay public property

Randomly adds a delay between 0 and RandomDelay
public float RandomDelay
return float

RandomPitch public property

Randomly shifts the pitch in units of semitones ( thus 12 = twice the speed)
public float RandomPitch
return float

RandomStartPosition public property

Starts playing at a random position.
Useful for audio loops.
public bool RandomStartPosition
return bool

RandomVolume public property

Randomly shifts the volume +/- this value
public float RandomVolume
return float

SubItemType public property

Specifies the type of this AudioSubItem
public AudioSubItemType SubItemType
return AudioSubItemType

Volume public property

The volume applied to the audio sub-item.
public float Volume
return float