HoloToolkit.Unity.AudioOccluder Class Reference

Class that implements IAudioInfluencer to provide an occlusion effect. More...

Inheritance diagram for HoloToolkit.Unity.AudioOccluder:

Public Member Functions
void	ApplyEffect (GameObject soundEmittingObject, AudioSource audioSource)
	Applies the audio effect. More...
void	ApplyEffect (GameObject soundEmittingObject)
	Applies the audio effect. More...
void	RemoveEffect (GameObject soundEmittingObject, AudioSource audioSource)
	Removes the previously applied audio effect. More...
void	RemoveEffect (GameObject soundEmittingObject)
	Removes the previously applied audio effect. More...

Properties
float	CutoffFrequency [get, set]
float	VolumePassThrough [get, set]

Detailed Description

Class that implements IAudioInfluencer to provide an occlusion effect.

Ensure that all sound emitting objects have an attached AudioEmitter. Failing to do so will result in the desired effect not being applied to the sound.

Definition at line 16 of file AudioOccluder.cs.

Member Function Documentation

ApplyEffect() [1/2]

void HoloToolkit.Unity.AudioOccluder.ApplyEffect	(	GameObject	soundEmittingObject,
		AudioSource	audioSource
	)

Applies the audio effect.

Parameters

soundEmittingObject	The GameObject on which the effect is to be applied.
audioSource	The AudioSource that is emitting the sound.

This method has been deprecated and should be removed in the next major release of the Mixed Reality Toolkit.

Implements HoloToolkit.Unity.IAudioInfluencer.

Definition at line 98 of file AudioOccluder.cs.

ApplyEffect() [2/2]

void HoloToolkit.Unity.AudioOccluder.ApplyEffect

(

GameObject

soundEmittingObject

)

Applies the audio effect.

Parameters

soundEmittingObject

The GameObject on which the effect is to be applied.

Implements HoloToolkit.Unity.IAudioInfluencer.

Definition at line 110 of file AudioOccluder.cs.

RemoveEffect() [1/2]

void HoloToolkit.Unity.AudioOccluder.RemoveEffect	(	GameObject	soundEmittingObject,
		AudioSource	audioSource
	)

Removes the previously applied audio effect.

Parameters

soundEmittingObject	The GameObject from which the effect is to be removed.
audioSource	The AudioSource that is emitting the sound.

This method has been deprecated and should be removed in the next major release of the Mixed Reality Toolkit.

Implements HoloToolkit.Unity.IAudioInfluencer.

Definition at line 147 of file AudioOccluder.cs.

RemoveEffect() [2/2]

void HoloToolkit.Unity.AudioOccluder.RemoveEffect

(

GameObject

soundEmittingObject

)

Removes the previously applied audio effect.

Parameters

soundEmittingObject

The GameObject from which the effect is to be removed.

Implements HoloToolkit.Unity.IAudioInfluencer.

Definition at line 158 of file AudioOccluder.cs.

Property Documentation

CutoffFrequency

float HoloToolkit.Unity.AudioOccluder.CutoffFrequency

getset

Definition at line 32 of file AudioOccluder.cs.

VolumePassThrough

float HoloToolkit.Unity.AudioOccluder.VolumePassThrough

getset

Definition at line 66 of file AudioOccluder.cs.

---

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

• Assets/HoloToolkit/SpatialSound/Scripts/AudioOccluder.cs