Audio presets allows you to save the active settings and current properties of soundsources, soundgroups and audioeffects. You can then use theses snapshots to restore the conditions of the soundsources and audioeffects using a single function call or tune up or down all the gain of the resources contained in a snapshot all at once. Optionally an edge can also created and used by the audiopreset to smoothly transition from one setup to another.

Using audiopresets you can easily transition and interpolate gain and settings between effects. Simple logic and mechanics can be implements so ie. when the camera is moving from one small room to a corridor to a large room the echo conditions changes. Further actions can be taken if ie. a door open or close; allowing you to transition the gain of the soundsources located inside the room (the one with the door) or by using audioeffects, modulate the level of low frequencies etc...

Take note that similar effect can be created directly using an AudioFilter.

Static Variables

Name	Description
`scene`	The owner of the AudioPreset.
Declaration Scene *scene
`type`	The type of the current AudioPreset.
Declaration AudioPresetType type
`interpolate`	Indicates wether or not the AudioPreset can be interpolated.
Declaration bool interpolate
`uid`	Global unique id that identify the AudioPreset so it can be retrieved.
Declaration unsigned int uid

Variables

Name	Description
`name`	The name of the current AudioPreset.
Declaration char *name
`gain`	Master gain that will be modulated with all other gain values contained in the AudioPreset snapshot.
Declaration float gain Range 0.0 to 1.0
`transition`	Controls the interpolation between the snapshot base and its edge.
Declaration float transition; Range 0.0 to 1.0 \note Transition is only possible if the current preset contain an edge. </td>

Functions

Name	Description
`ClearSnapshot`	Clear the snapshot data.
Declaration void ClearSnapshot( bool edge ) Parameters `edge`: Specify if the edge or base snapshot should be cleared.
`SaveSnapshot`	Create a new snapshot using the current AudioPreset.
Declaration void SaveSnapshot( bool edge ) Parameters `edge`: Specify to snapshot either the base or the edge.
`RestoreSnapshot`	Restore an existing snapshot previously saved.
Declaration void RestoreSnapshot( void )
`ClearInterpolation`	Force to clear the interpolation data.
Declaration void ClearInterpolation( void )
`Cleanup`	Remove all resources that are now inexistent but that are still part of the current snapshot (base and edge).
Declaration void Cleanup( void )

AudioPresetType

The types of AudioPreset.

kSounds: Snapshot only the SoundSource data.
kEffects: Snapshot only the AudioEffect data.
kSoundsAndEffects: Snapshot both SoundSource and AudioEffect data.