The AudioEvent class is the main component of UAudioManager and contains settings and a container for playing audio clips. More...

Inheritance diagram for HoloToolkit.Unity.AudioEvent:

Public Member Functions
bool	IsContinuous ()
	Is this AudioEvent's container a continuous container? More...

int	CompareTo (object obj)
	Compares this AudioEvent with another object. More...

int	CompareTo (AudioEvent other)
	Compares this AudioEvent with another AudioEvent. More...

Public Attributes
string	Name = "_NewAudioEvent"

SpatialPositioningType	Spatialization = SpatialPositioningType.TwoD

SpatialSoundRoomSizes	RoomSize = SpatialSoundSettings.DefaultSpatialSoundRoom

AnimationCurve	AttenuationCurve = AnimationCurve.EaseInOut(0f, 1f, 1f, 0f)

AnimationCurve	SpatialCurve = AnimationCurve.EaseInOut(0f, 1f, 1f, 1f)

AnimationCurve	SpreadCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f)

AnimationCurve	ReverbCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f)

float	MaxDistanceAttenuation3D = 100f

AudioMixerGroup	AudioBus

float	PitchCenter = 1.0f

float	PitchRandomization
	The amount in either direction from Pitch Center that the pitch can randomly vary upon playing the event. More...

float	VolumeCenter = 1.0f

float	VolumeRandomization
	The amount in either direction from Volume Center that the volume can randomly vary upon playing the event. More...

float	PanCenter

float	PanRandomization
	The amount in either direction from Pan Center that panning can randomly vary upon playing the event. More...

float	FadeInTime

float	FadeOutTime

int	InstanceLimit

float	InstanceTimeBuffer

AudioEventInstanceBehavior	AudioEventInstanceBehavior = AudioEventInstanceBehavior.KillOldest

AudioContainer	Container = new AudioContainer()
	Contains the sounds associated with this AudioEvent. More...

Detailed Description

The AudioEvent class is the main component of UAudioManager and contains settings and a container for playing audio clips.

Definition at line 54 of file AudioEvent.cs.

Member Function Documentation

§ CompareTo() [1/2]

int HoloToolkit.Unity.AudioEvent.CompareTo ( object obj )

Compares this AudioEvent with another object.

Parameters

obj	The object to compare against.

Returns: An integer that indicates whether this AudioEvent precedes (-1), follows (1), or appears in the same position (0) in the sort order as the AudioEvent being compared.

If the specified object is not an AudioEvent, the return value is 1.

Definition at line 157 of file AudioEvent.cs.

§ CompareTo() [2/2]

int HoloToolkit.Unity.AudioEvent.CompareTo ( AudioEvent other )

Compares this AudioEvent with another AudioEvent.

Parameters

other The AudioEvent to compare against.

Returns: An integer that indicates whether this AudioEvent precedes (-1), follows (1), or appears in the same position (0) in the sort order as the AudioEvent being compared.

Definition at line 177 of file AudioEvent.cs.

§ IsContinuous()

bool HoloToolkit.Unity.AudioEvent.IsContinuous ( )

Is this AudioEvent's container a continuous container?

Returns: True if this AudioEvent's container is one of the continuous types (random or sequential), otherwise false.

Definition at line 144 of file AudioEvent.cs.

Member Data Documentation

§ AttenuationCurve

AnimationCurve HoloToolkit.Unity.AudioEvent.AttenuationCurve = AnimationCurve.EaseInOut(0f, 1f, 1f, 0f)

Definition at line 66 of file AudioEvent.cs.

§ AudioBus

AudioMixerGroup HoloToolkit.Unity.AudioEvent.AudioBus

Definition at line 82 of file AudioEvent.cs.

§ AudioEventInstanceBehavior

AudioEventInstanceBehavior HoloToolkit.Unity.AudioEvent.AudioEventInstanceBehavior = AudioEventInstanceBehavior.KillOldest

Definition at line 133 of file AudioEvent.cs.

§ Container

AudioContainer HoloToolkit.Unity.AudioEvent.Container = new AudioContainer()

Contains the sounds associated with this AudioEvent.

Definition at line 138 of file AudioEvent.cs.

§ FadeInTime

float HoloToolkit.Unity.AudioEvent.FadeInTime

Definition at line 120 of file AudioEvent.cs.

§ FadeOutTime

float HoloToolkit.Unity.AudioEvent.FadeOutTime

Definition at line 124 of file AudioEvent.cs.

§ InstanceLimit

int HoloToolkit.Unity.AudioEvent.InstanceLimit

Definition at line 127 of file AudioEvent.cs.

§ InstanceTimeBuffer

float HoloToolkit.Unity.AudioEvent.InstanceTimeBuffer

Definition at line 130 of file AudioEvent.cs.

§ MaxDistanceAttenuation3D

float HoloToolkit.Unity.AudioEvent.MaxDistanceAttenuation3D = 100f

Definition at line 79 of file AudioEvent.cs.

§ Name

string HoloToolkit.Unity.AudioEvent.Name = "_NewAudioEvent"

Definition at line 57 of file AudioEvent.cs.

§ PanCenter

float HoloToolkit.Unity.AudioEvent.PanCenter

Definition at line 108 of file AudioEvent.cs.

§ PanRandomization

float HoloToolkit.Unity.AudioEvent.PanRandomization

The amount in either direction from Pan Center that panning can randomly vary upon playing the event.

The supported range is 0.0f - 0.5f.

Definition at line 115 of file AudioEvent.cs.

§ PitchCenter

float HoloToolkit.Unity.AudioEvent.PitchCenter = 1.0f

Definition at line 86 of file AudioEvent.cs.

§ PitchRandomization

float HoloToolkit.Unity.AudioEvent.PitchRandomization

The amount in either direction from Pitch Center that the pitch can randomly vary upon playing the event.

The supported range is 0.0f - 2.0f.

Definition at line 93 of file AudioEvent.cs.

§ ReverbCurve

AnimationCurve HoloToolkit.Unity.AudioEvent.ReverbCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f)

Definition at line 75 of file AudioEvent.cs.

§ RoomSize

SpatialSoundRoomSizes HoloToolkit.Unity.AudioEvent.RoomSize = SpatialSoundSettings.DefaultSpatialSoundRoom

Definition at line 63 of file AudioEvent.cs.

§ SpatialCurve

AnimationCurve HoloToolkit.Unity.AudioEvent.SpatialCurve = AnimationCurve.EaseInOut(0f, 1f, 1f, 1f)

Definition at line 69 of file AudioEvent.cs.

§ Spatialization

SpatialPositioningType HoloToolkit.Unity.AudioEvent.Spatialization = SpatialPositioningType.TwoD

Definition at line 60 of file AudioEvent.cs.

§ SpreadCurve

AnimationCurve HoloToolkit.Unity.AudioEvent.SpreadCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f)

Definition at line 72 of file AudioEvent.cs.

§ VolumeCenter

float HoloToolkit.Unity.AudioEvent.VolumeCenter = 1.0f

Definition at line 97 of file AudioEvent.cs.

§ VolumeRandomization

float HoloToolkit.Unity.AudioEvent.VolumeRandomization

The amount in either direction from Volume Center that the volume can randomly vary upon playing the event.