AudioEmitterSettings Class Reference

Class that stores the settings to play an audio. More...

Collaboration diagram for AudioEmitterSettings:

Public Types
enum	PlayConditions { PlayAlways , PlayIfNotPlaying , InterruptAndPlay }
	Helper enum to set conditions on playback. More...
enum	StopStyle { HardStop , FadeStop }
	Helper enum to set up how the sound should be stopped. More...

Data Fields
EventReference	eventReference
EmitterGameEvent	eventPlayTrigger = EmitterGameEvent.None
EmitterGameEvent	eventStopTrigger = EmitterGameEvent.None
PlayConditions	playConditions = PlayConditions.PlayAlways
float	playCooldown = 0f

Detailed Description

Class that stores the settings to play an audio.

Member Enumeration Documentation

PlayConditions

enum AudioEmitterSettings.PlayConditions

Helper enum to set conditions on playback.

Enumerator
PlayAlways
PlayIfNotPlaying
InterruptAndPlay

StopStyle

enum AudioEmitterSettings.StopStyle

Helper enum to set up how the sound should be stopped.

Enumerator
HardStop
FadeStop

Field Documentation

eventPlayTrigger

EmitterGameEvent AudioEmitterSettings.eventPlayTrigger = EmitterGameEvent.None

eventReference

EventReference AudioEmitterSettings.eventReference

eventStopTrigger

EmitterGameEvent AudioEmitterSettings.eventStopTrigger = EmitterGameEvent.None

playConditions

PlayConditions AudioEmitterSettings.playConditions = PlayConditions.PlayAlways

playCooldown

float AudioEmitterSettings.playCooldown = 0f

---

The documentation for this class was generated from the following file:

• AudioEmitterSettings.cs