CryEngine.Audio

Public Member Functions | Static Public Member Functions | List of all members

CryEngine.Audio

Maps trigger identifier names to id's of internal audio project. Audio projects can be setup via SDL, WWISE or FMOD. More...

Public Member Functions
delegate void	ManagedAudioStateListenerDelegate (AudioStateType audioState, string triggerName)
	Public listener for audio request listener in C# More...

Static Public Member Functions
static bool	Play (string triggerName)
	Retrieves and executes the specified audio trigger by name More...

static AudioTriggerId	GetTriggerId (string triggerName)
	Returns the trigger id of the specified audio trigger More...

static bool	Play (AudioTriggerId triggerId)
	Plays the audio specified by the trigger id. Returns true if the trigger id is valid More...

static bool	Stop (string triggerName)
	Stops the audio trigger by the specified name. Only audio triggers that have been "played" can be stopped. More...

static bool	Stop (AudioTriggerId triggerId)
	Stops the specified audio trigger. Only audio triggers that have been "played" can be stopped. More...

static void	StopAllTriggers ()
	Stops all active audio triggers. More...

static void	StopAllSounds ()
	Stops all playing audio More...

static void	EnableAllSound (bool enabled)
	Mute or unmute all sounds More...

static string	GetConfigurationPath ()
	Returns the path in which audio configuration data is stored More...

static void	SetParameter (string parameterName, float parameterVal)
	Sets the specified audio parameter with the specified name to the specified value More...

static void	SetSwitchState (string switchName, string switchStateName)
	Sets the Audio switch with the specified name to the specified state name More...

static bool	AddAudioStateListener (string triggerName, ManagedAudioStateListenerDelegate requestListener)

static bool	RemoveAudioStateListener (string triggerName)

Detailed Description

Maps trigger identifier names to id's of internal audio project. Audio projects can be setup via SDL, WWISE or FMOD.

Member Function Documentation

◆ AddAudioStateListener()

static bool CryEngine.Audio.AddAudioStateListener	(	string	triggerName,
		ManagedAudioStateListenerDelegate	requestListener
	)

inline

static

Parameters

triggerName
requestListener

Returns

◆ EnableAllSound()

static void CryEngine.Audio.EnableAllSound

(

bool

enabled

)

inline

static

Mute or unmute all sounds

Parameters

enabled

◆ GetConfigurationPath()

static string CryEngine.Audio.GetConfigurationPath

(

)

inline

static

Returns the path in which audio configuration data is stored

Returns

◆ GetTriggerId()

static AudioTriggerId CryEngine.Audio.GetTriggerId

(

string

triggerName

)

inline

static

Returns the trigger id of the specified audio trigger

Parameters

triggerName

Returns

◆ ManagedAudioStateListenerDelegate()

delegate void CryEngine.Audio.ManagedAudioStateListenerDelegate	(	AudioStateType	audioState,
		string	triggerName
	)

Public listener for audio request listener in C#

Parameters

audioState
triggerName

◆ Play() [1/2]

static bool CryEngine.Audio.Play

(

string

triggerName

)

inline

static

Retrieves and executes the specified audio trigger by name

Parameters

triggerName

Returns: Returns true if the audio trigger is executed. False otherwise

◆ Play() [2/2]

static bool CryEngine.Audio.Play

(

AudioTriggerId

triggerId

)

inline

static

Plays the audio specified by the trigger id. Returns true if the trigger id is valid

Parameters

triggerId

Returns

◆ RemoveAudioStateListener()

static bool CryEngine.Audio.RemoveAudioStateListener

(

string

triggerName

)

inline

static

Parameters

triggerName

Returns

◆ SetParameter()

static void CryEngine.Audio.SetParameter	(	string	parameterName,
		float	parameterVal
	)

inline

static

Sets the specified audio parameter with the specified name to the specified value

Parameters

parameterName
parameterVal

◆ SetSwitchState()

static void CryEngine.Audio.SetSwitchState	(	string	switchName,
		string	switchStateName
	)

inline

static

Sets the Audio switch with the specified name to the specified state name

Parameters

switchName
switchStateName

◆ Stop() [1/2]

static bool CryEngine.Audio.Stop

(

string

triggerName

)

inline

static

Stops the audio trigger by the specified name. Only audio triggers that have been "played" can be stopped.

Parameters

triggerName

Returns: True if the audio trigger is stopped

◆ Stop() [2/2]

static bool CryEngine.Audio.Stop

(

AudioTriggerId

triggerId

)

inline

static

Stops the specified audio trigger. Only audio triggers that have been "played" can be stopped.

Parameters

triggerId

Returns: True if the audio trigger is stopped

◆ StopAllSounds()

static void CryEngine.Audio.StopAllSounds

(

)

inline

static

Stops all playing audio

◆ StopAllTriggers()

static void CryEngine.Audio.StopAllTriggers

(

)

inline

static

Stops all active audio triggers.

Returns