HoloToolkit.Unity.SpatialSoundSettings Class Reference

The SpatialSoundSettings class provides a set of methods that simplify making modifications to Microsoft Spatial Sound Spatializer parameters. More...

Static Public Member Functions
static void	SetRoomSize (AudioSource audioSource, SpatialSoundRoomSizes room)
	Sets the Spatial Sound room size. More...
static void	SetMinGain (AudioSource audioSource, float gain)
	Sets the Spatial Sound minimum gain. More...
static void	SetMaxGain (AudioSource audioSource, float gain)
	Sets the Spatial Sound maximum gain. More...
static void	SetUnityGainDistance (AudioSource audioSource, float distance)
	Sets the Spatial Sound unity gain distance. More...

Public Attributes
const SpatialSoundRoomSizes	DefaultSpatialSoundRoom = SpatialSoundRoomSizes.Small
const float	MinimumGainDecibels = -96.0f
const float	MaximumGainDecibels = 12.0f
const float	MinimumUnityGainDistanceMeters = 0.05f
const float	MaximumUnityGainDistanceMeters = float.MaxValue
const float	DefaultMinGain = MinimumGainDecibels
const float	DefaultMaxGain = MaximumGainDecibels
const float	DefaultUnityGainDistance = 1.0f

Detailed Description

The SpatialSoundSettings class provides a set of methods that simplify making modifications to Microsoft Spatial Sound Spatializer parameters.

Definition at line 24 of file SpatialSoundSettings.cs.

Member Function Documentation

SetMaxGain()

static void HoloToolkit.Unity.SpatialSoundSettings.SetMaxGain ( AudioSource  audioSource, float  gain  )

static

Sets the Spatial Sound maximum gain.

Parameters

audioSource	The AudioSource on which the maximum gain will be set.
room	The desired maximum gain, in decibels.

Definition at line 73 of file SpatialSoundSettings.cs.

SetMinGain()

static void HoloToolkit.Unity.SpatialSoundSettings.SetMinGain ( AudioSource  audioSource, float  gain  )

static

Sets the Spatial Sound minimum gain.

Parameters

audioSource	The AudioSource on which the minimum gain will be set.
room	The desired minimum gain, in decibels.

Definition at line 63 of file SpatialSoundSettings.cs.

SetRoomSize()

static void HoloToolkit.Unity.SpatialSoundSettings.SetRoomSize ( AudioSource  audioSource, SpatialSoundRoomSizes  room  )

static

Sets the Spatial Sound room size.

Parameters

audioSource	The AudioSource on which the room size will be set.
room	The desired room size.

Definition at line 52 of file SpatialSoundSettings.cs.

SetUnityGainDistance()

static void HoloToolkit.Unity.SpatialSoundSettings.SetUnityGainDistance ( AudioSource  audioSource, float  distance  )

static

Sets the Spatial Sound unity gain distance.

Parameters

audioSource	The AudioSource on which the unity gain distance will be set.
room	The distance, in meters, at which the AudioSource gain will be 0 decibels.

Definition at line 83 of file SpatialSoundSettings.cs.

Member Data Documentation

DefaultMaxGain

const float HoloToolkit.Unity.SpatialSoundSettings.DefaultMaxGain = MaximumGainDecibels

Definition at line 36 of file SpatialSoundSettings.cs.

DefaultMinGain

const float HoloToolkit.Unity.SpatialSoundSettings.DefaultMinGain = MinimumGainDecibels

Definition at line 35 of file SpatialSoundSettings.cs.

DefaultSpatialSoundRoom

const SpatialSoundRoomSizes HoloToolkit.Unity.SpatialSoundSettings.DefaultSpatialSoundRoom = SpatialSoundRoomSizes.Small

Definition at line 26 of file SpatialSoundSettings.cs.

DefaultUnityGainDistance

const float HoloToolkit.Unity.SpatialSoundSettings.DefaultUnityGainDistance = 1.0f

Definition at line 37 of file SpatialSoundSettings.cs.

MaximumGainDecibels

const float HoloToolkit.Unity.SpatialSoundSettings.MaximumGainDecibels = 12.0f

Definition at line 32 of file SpatialSoundSettings.cs.

MaximumUnityGainDistanceMeters

const float HoloToolkit.Unity.SpatialSoundSettings.MaximumUnityGainDistanceMeters = float.MaxValue

Definition at line 34 of file SpatialSoundSettings.cs.

MinimumGainDecibels

const float HoloToolkit.Unity.SpatialSoundSettings.MinimumGainDecibels = -96.0f

Definition at line 31 of file SpatialSoundSettings.cs.

MinimumUnityGainDistanceMeters

const float HoloToolkit.Unity.SpatialSoundSettings.MinimumUnityGainDistanceMeters = 0.05f

Definition at line 33 of file SpatialSoundSettings.cs.

---

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

• Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/SpatialSoundSettings.cs