SoundToolKit.Unity.SoundToolKitManager Class Reference

Singleton class which governs the resources and lifetime of SoundToolKit engine. Allows controlling several output volume levels of STK engine and synchronizing the commands issued to it. More...

Inheritance diagram for SoundToolKit.Unity.SoundToolKitManager:

Public Member Functions
void	Play ()
	This will start SoundToolKit processing. More...
void	Pause ()
	This will disable SoundToolKit processing. More...
void	UpdateAudio ()
	This method will synchronize each command send to SoundToolKit. More...
void	Finish ()
	This method will force execution of each command send to SoundToolKit prior to it's call. Note: Calling this while in game may cause freezes as it enforces waiting for all commands to execute. More...

Properties
bool	Initialized [get]
ResourcesContainer	ResourceContainer [get]
	A container that holds reference to resurces used by SoundToolKit. More...
SoundToolKitSettings	Settings [get, set]
	SoundToolKitSettings that determine the low-level processing details of SoundToolKit. Can be swapped at runtime. More...
float	MasterVolume [get, set]
	The output volume of SoundToolKit More...
float	SpatialVolume [get, set]
	The output volume of SoundToolKit's spatial processing of Sound Paths. More...
float	AmbientVolume [get, set]
	The output volume of SoundToolKit's Ambient Sound Sources. More...
float	ReverbVolume [get, set]
	The output volume of SoundToolKit's late reverberation processor. More...

Events
Action	OnInitialized
	This event will be fired on Initialization. More...
Action< SeverityLevel, string >	OnLogAdded

Detailed Description

Singleton class which governs the resources and lifetime of SoundToolKit engine. Allows controlling several output volume levels of STK engine and synchronizing the commands issued to it.

Member Function Documentation

Finish()

void SoundToolKit.Unity.SoundToolKitManager.Finish

(

)

This method will force execution of each command send to SoundToolKit prior to it's call. Note: Calling this while in game may cause freezes as it enforces waiting for all commands to execute.

Pause()

void SoundToolKit.Unity.SoundToolKitManager.Pause

(

)

This will disable SoundToolKit processing.

Play()

void SoundToolKit.Unity.SoundToolKitManager.Play

(

)

This will start SoundToolKit processing.

UpdateAudio()

void SoundToolKit.Unity.SoundToolKitManager.UpdateAudio

(

)

This method will synchronize each command send to SoundToolKit.

Property Documentation

AmbientVolume

float SoundToolKit.Unity.SoundToolKitManager.AmbientVolume

getset

The output volume of SoundToolKit's Ambient Sound Sources.

Initialized

bool SoundToolKit.Unity.SoundToolKitManager.Initialized

get

MasterVolume

float SoundToolKit.Unity.SoundToolKitManager.MasterVolume

getset

The output volume of SoundToolKit

ResourceContainer

ResourcesContainer SoundToolKit.Unity.SoundToolKitManager.ResourceContainer

get

A container that holds reference to resurces used by SoundToolKit.

ReverbVolume

float SoundToolKit.Unity.SoundToolKitManager.ReverbVolume

getset

The output volume of SoundToolKit's late reverberation processor.

Settings

SoundToolKitSettings SoundToolKit.Unity.SoundToolKitManager.Settings

getset

SoundToolKitSettings that determine the low-level processing details of SoundToolKit. Can be swapped at runtime.

SpatialVolume

float SoundToolKit.Unity.SoundToolKitManager.SpatialVolume

getset

The output volume of SoundToolKit's spatial processing of Sound Paths.

Event Documentation

OnInitialized

Action SoundToolKit.Unity.SoundToolKitManager.OnInitialized

This event will be fired on Initialization.

OnLogAdded

Action<SeverityLevel, string> SoundToolKit.Unity.SoundToolKitManager.OnLogAdded