OVR.SoundEmitter Class Reference

Inheritance diagram for OVR.SoundEmitter:

Public Types
enum	FadeState { FadeState.Null, FadeState.FadingIn, FadeState.FadingOut, FadeState.Ducking }

Public Member Functions
void	SetPlayingSoundGroup (SoundGroup soundGroup)
void	SetOnFinished (System.Action onFinished)
void	SetOnFinished (System.Action< object > onFinished, object obj)
void	SetChannel (int _channel)
void	SetDefaultParent (Transform parent)
void	SetAudioMixer (AudioMixerGroup _mixer)
bool	IsPlaying ()
void	Play ()
void	Pause ()
void	Stop ()
void	ParentTo (Transform parent)
void	DetachFromParent ()
void	ResetParent (Transform parent)
void	SyncTo (SoundEmitter other, float fadeTime, float toVolume)
void	FadeTo (float fadeTime, float toVolume)
void	FadeIn (float fadeTime, float defaultVolume)
void	FadeIn (float fadeTime)
void	FadeOut (float fadeTime)
void	FadeOutDelayed (float delayedSecs, float fadeTime)

Public Attributes
EmitterChannel	channel = EmitterChannel.Reserved
bool	disableSpatialization = false
AudioSource	audioSource = null
SoundPriority	priority = SoundPriority.Default
ONSPAudioSource	osp = null
float	endPlayTime = 0.0f
float	defaultVolume = 1.0f
Transform	defaultParent = null
int	originalIdx = -1
System.Action	onFinished = null
System.Action< object >	onFinishedObject = null
object	onFinishedParam
SoundGroup	playingSoundGroup = null

Properties
float	volume [get, set]
float	pitch [get, set]
AudioClip	clip [get, set]
float	time [get, set]
float	length [get]
bool	loop [get, set]
bool	mute [get, set]
AudioVelocityUpdateMode	velocityUpdateMode [get, set]
bool	isPlaying [get]

Member Enumeration Documentation

FadeState

enum OVR.SoundEmitter.FadeState

strong

Enumerator
Null
FadingIn
FadingOut
Ducking

Member Function Documentation

DetachFromParent()

void OVR.SoundEmitter.DetachFromParent

(

)

FadeIn() [1/2]

void OVR.SoundEmitter.FadeIn	(	float	fadeTime,
		float	defaultVolume
	)

FadeIn() [2/2]

void OVR.SoundEmitter.FadeIn

(

float

fadeTime

)

FadeOut()

void OVR.SoundEmitter.FadeOut

(

float

fadeTime

)

FadeOutDelayed()

void OVR.SoundEmitter.FadeOutDelayed	(	float	delayedSecs,
		float	fadeTime
	)

FadeTo()

void OVR.SoundEmitter.FadeTo	(	float	fadeTime,
		float	toVolume
	)

IsPlaying()

bool OVR.SoundEmitter.IsPlaying

(

)

ParentTo()

void OVR.SoundEmitter.ParentTo

(

Transform

parent

)

Pause()

void OVR.SoundEmitter.Pause

(

)

Play()

void OVR.SoundEmitter.Play

(

)

ResetParent()

void OVR.SoundEmitter.ResetParent

(

Transform

parent

)

SetAudioMixer()

void OVR.SoundEmitter.SetAudioMixer

(

AudioMixerGroup

_mixer

)

SetChannel()

void OVR.SoundEmitter.SetChannel

(

int

_channel

)

SetDefaultParent()

void OVR.SoundEmitter.SetDefaultParent

(

Transform

parent

)

SetOnFinished() [1/2]

void OVR.SoundEmitter.SetOnFinished

(

System.Action

onFinished

)

SetOnFinished() [2/2]

void OVR.SoundEmitter.SetOnFinished	(	System.Action< object >	onFinished,
		object	obj
	)

SetPlayingSoundGroup()

void OVR.SoundEmitter.SetPlayingSoundGroup

(

SoundGroup

soundGroup

)

Stop()

void OVR.SoundEmitter.Stop

(

)

SyncTo()

void OVR.SoundEmitter.SyncTo	(	SoundEmitter	other,
		float	fadeTime,
		float	toVolume
	)

Member Data Documentation

audioSource

AudioSource OVR.SoundEmitter.audioSource = null

channel

EmitterChannel OVR.SoundEmitter.channel = EmitterChannel.Reserved

defaultParent

Transform OVR.SoundEmitter.defaultParent = null

defaultVolume

float OVR.SoundEmitter.defaultVolume = 1.0f

disableSpatialization

bool OVR.SoundEmitter.disableSpatialization = false

endPlayTime

float OVR.SoundEmitter.endPlayTime = 0.0f

onFinished

System.Action OVR.SoundEmitter.onFinished = null

onFinishedObject

System.Action<object> OVR.SoundEmitter.onFinishedObject = null

onFinishedParam

object OVR.SoundEmitter.onFinishedParam

originalIdx

int OVR.SoundEmitter.originalIdx = -1

osp

ONSPAudioSource OVR.SoundEmitter.osp = null

playingSoundGroup

SoundGroup OVR.SoundEmitter.playingSoundGroup = null

priority

SoundPriority OVR.SoundEmitter.priority = SoundPriority.Default

Property Documentation

clip

AudioClip OVR.SoundEmitter.clip

getset

isPlaying

bool OVR.SoundEmitter.isPlaying

get

length

float OVR.SoundEmitter.length

get

loop

bool OVR.SoundEmitter.loop

getset

mute

bool OVR.SoundEmitter.mute

getset

pitch

float OVR.SoundEmitter.pitch

getset

time

float OVR.SoundEmitter.time

getset

velocityUpdateMode

AudioVelocityUpdateMode OVR.SoundEmitter.velocityUpdateMode

getset

volume

float OVR.SoundEmitter.volume

getset

---

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

• Oculus/AudioManager/Scripts/Audio/SoundEmitter.cs