Class SoundVariation

The persistent storage for sound effect audio data.

Inheritance

System.Object

SoundVariation

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Stem

Assembly: Stem.dll

Syntax

[Serializable]
public class SoundVariation

Properties

Clip

The audio clip with audio data. Please refer to Unity Scripting Reference for details.

Declaration

public AudioClip Clip { get; set; }

Property Value

Type	Description
AudioClip	A reference to an audio clip.

Delay

The delay of the sound variation.

Declaration

public float Delay { get; }

Property Value

Type	Description
System.Single	FixedDelay value if RandomizeDelay is false. Otherwise random delay value from RandomDelay range.

FixedDelay

The fixed delay of the sound variation.

Declaration

public float FixedDelay { get; set; }

Property Value

Type	Description
System.Single	Fixed delay in seconds of the sound variation. Value must be greater or equal to zero.

FixedPitch

The fixed pitch of the sound variation.

Declaration

public float FixedPitch { get; set; }

Property Value

Type	Description
System.Single	Fixed pitch of the souhnd variation. Value must be in [-3;3] range.

FixedVolume

The fixed volume of the sound variation.

Declaration

public float FixedVolume { get; set; }

Property Value

Type	Description
System.Single	Fixed volume of the sound variation. Value must be in [0;1] range.

Name

The name of the sound variation.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	Name of the current audio clip being used. Null reference otherwise.

Pitch

The pitch of the sound variation.

Declaration

public float Pitch { get; }

Property Value

Type	Description
System.Single	FixedPitch value if RandomizePitch is false. Otherwise random pitch value from RandomPitch range.

RandomDelay

The random delay range of the sound variation.

Declaration

public Vector2 RandomDelay { get; set; }

Property Value

Type	Description
Vector2	Random delay range of the sound variation. Vector components store range boundaries (x - min, y - max).

RandomizeDelay

The flag indicating which property is used for Delay.

Declaration

public bool RandomizeDelay { get; set; }

Property Value

Type	Description
System.Boolean	True, if RandomDelay is used. Otherwise FixedDelay is used.

RandomizePitch

The flag indicating which property is used for Pitch.

Declaration

public bool RandomizePitch { get; set; }

Property Value

Type	Description
System.Boolean	True, if RandomPitch is used. Otherwise FixedPitch is used.

RandomizeVolume

The flag indicating which property is used for Volume.

Declaration

public bool RandomizeVolume { get; set; }

Property Value

Type	Description
System.Boolean	True, if RandomVolume is used. Otherwise FixedVolume is used.

RandomPitch

The random pitch range of the sound variation.

Declaration

public Vector2 RandomPitch { get; set; }

Property Value

Type	Description
Vector2	Random pitch range of the sound variation. Vector components store range boundaries (x - min, y - max).

RandomVolume

The random volume range of the sound variation.

Declaration

public Vector2 RandomVolume { get; set; }

Property Value

Type	Description
Vector2	Random volume range of the sound variation. Vector components store range boundaries (x - min, y - max).

Volume

The volume of the sound variation.

Declaration

public float Volume { get; }

Property Value

Type	Description
System.Single	FixedVolume value if RandomizeVolume is false. Otherwise random volume value from RandomVolume range.