Class which supports IAudioInfluencers being used with audio sources. More...

Inheritance diagram for HoloToolkit.Unity.AudioEmitter:

Public Member Functions
float	GetNativeLowPassCutoffFrequency ()
	Gets the native cutoff frequency of the attached low pass filter. More...

void	SetNativeLowPassCutoffFrequency (float frequency)
	Sets the cached native cutoff frequency of the attached low pass filter. More...

float	GetNativeHighPassCutoffFrequency ()
	Gets the native cutoff frequency of the attached high pass filter. More...

void	SetNativeHighPassCutoffFrequency (float frequency)
	Sets the cached native cutoff frequency of the attached high pass filter. More...

Static Public Attributes
static readonly float	NeutralLowFrequency = 10.0f
	Frequency below the nominal range of human hearing. More...

static readonly float	NeutralHighFrequency = 22000.0f
	Frequency above the nominal range of human hearing. More...

Properties
float	UpdateInterval `[get, set]`

float	MaxDistance `[get, set]`

Detailed Description

Class which supports IAudioInfluencers being used with audio sources.

AudioEmitter requires an AudioSource component. If one is not attached, it will be added automatically. Each sound playing game object needs to have an AudioEmitter attached in order to have it's audio influenced.

Definition at line 19 of file AudioEmitter.cs.

Member Function Documentation

§ GetNativeHighPassCutoffFrequency()

float HoloToolkit.Unity.AudioEmitter.GetNativeHighPassCutoffFrequency ( )

Gets the native cutoff frequency of the attached high pass filter.

Returns: The native cutoff frequency, or a neutral frequency if there is no high pass filter attached.

Definition at line 280 of file AudioEmitter.cs.

§ GetNativeLowPassCutoffFrequency()

float HoloToolkit.Unity.AudioEmitter.GetNativeLowPassCutoffFrequency ( )

Gets the native cutoff frequency of the attached low pass filter.

Returns: The native cutoff frequency, or a neutral frequency if there is no low pass filter attached.

Definition at line 258 of file AudioEmitter.cs.

§ SetNativeHighPassCutoffFrequency()

void HoloToolkit.Unity.AudioEmitter.SetNativeHighPassCutoffFrequency ( float frequency )

Sets the cached native cutoff frequency of the attached high pass filter.

Parameters

frequency The new high pass filter cutoff frequency.

This method may be called by an attached effect to change the native behavior of the high pass filter for scenarios such as simulating a dynamic sound source quality change.

Definition at line 291 of file AudioEmitter.cs.

§ SetNativeLowPassCutoffFrequency()

void HoloToolkit.Unity.AudioEmitter.SetNativeLowPassCutoffFrequency ( float frequency )

Sets the cached native cutoff frequency of the attached low pass filter.

Parameters

frequency The new low pass filter cutoff frequency.

This method may be called by an attached effect to change the native behavior of the low pass filter for scenarios such as simulating a dynamic sound source quality change.

Definition at line 269 of file AudioEmitter.cs.

Member Data Documentation

§ NeutralHighFrequency

readonly float HoloToolkit.Unity.AudioEmitter.NeutralHighFrequency = 22000.0f

static

Frequency above the nominal range of human hearing.

This frequency can be used to set a low pass filter to allow all audible frequencies through the filter.

Definition at line 37 of file AudioEmitter.cs.

§ NeutralLowFrequency

readonly float HoloToolkit.Unity.AudioEmitter.NeutralLowFrequency = 10.0f

static

Frequency below the nominal range of human hearing.

This frequency can be used to set a high pass filter to allow all audible frequencies through the filter.

Definition at line 28 of file AudioEmitter.cs.

Property Documentation

§ MaxDistance

float HoloToolkit.Unity.AudioEmitter.MaxDistance

getset

Definition at line 84 of file AudioEmitter.cs.

§ UpdateInterval

float HoloToolkit.Unity.AudioEmitter.UpdateInterval