The Amplitude Audio Middleware. More...

#include <AmplitudeAudioSingleton.h>

Inheritance diagram for plAmplitude:

Public Member Functions
plResult	LoadConfiguration (const plOpenDdlReaderElement &reader) override
	Loads the middleware-specif configuration from the ATL config file.

plResult	Startup () override
	Initializes the audio middleware.

void	Update (plTime delta) override
	Updates the audio middleware.

plResult	Shutdown () override
	Deinitializes and stop the audio middleware.

plResult	Release () override
	Destroys all the resources allocated by the audio middleware. This is usually called after Shutdown.

plResult	StopAllSounds () override
	Stops all the sounds actually played by the audio middleware.

plResult	AddEntity (plAudioSystemEntityData pEntityData, const char szEntityName) override
	Add/register an entity in the audio middleware. This is needed in order to provide transformation values (position and orientation), execute triggers (play sounds), and set real-time parameters or switches.

plResult	ResetEntity (plAudioSystemEntityData *pEntityData) override
	Resets an entity state.

plResult	UpdateEntity (plAudioSystemEntityData *pEntityData) override
	Updates an entity state.

plResult	RemoveEntity (plAudioSystemEntityData *pEntityData) override
	Remove/unregister an entity from the audio middleware. This action disable the possibility to execute triggers, set real-time parameters or switches, and update the position of the entity.

plResult	SetEntityTransform (plAudioSystemEntityData *pEntityData, const plAudioSystemTransform &Transform) override
	Sets the global position (world position) of an entity.

plResult	LoadTrigger (plAudioSystemEntityData pEntityData, const plAudioSystemTriggerData pTriggerData, plAudioSystemEventData *pEventData) override
	Loads a trigger for a further activation. All the data and media needed by the trigger will be loaded. Once done, the trigger status will change to Ready.

plResult	ActivateTrigger (plAudioSystemEntityData pEntityData, const plAudioSystemTriggerData pTriggerData, plAudioSystemEventData *pEventData) override
	Triggers an event on an entity. A trigger is everything which can affect the state of an event.

plResult	UnloadTrigger (plAudioSystemEntityData pEntityData, const plAudioSystemTriggerData pTriggerData) override
	Unload the trigger. This is called when the trigger and all data loaded during LoadTrigger need to be disposed.

plResult	StopEvent (plAudioSystemEntityData pEntityData, const plAudioSystemEventData pEventData) override
	Stops an event on the given entity.

plResult	StopAllEvents (plAudioSystemEntityData *pEntityData) override
	Stops all events active on the given entity.

plResult	SetRtpc (plAudioSystemEntityData pEntityData, const plAudioSystemRtpcData pRtpcData, float fValue) override
	Sets an audio RTPC to the specified value on an entity.

plResult	ResetRtpc (plAudioSystemEntityData pEntityData, const plAudioSystemRtpcData pRtpcData) override
	Resets an audio RTPC to the default value on an entity.

plResult	SetSwitchState (plAudioSystemEntityData pEntityData, const plAudioSystemSwitchStateData pSwitchStateData) override
	Sets an audio switch to the specified state on an entity.

plResult	SetObstructionAndOcclusion (plAudioSystemEntityData *pEntityData, float fObstruction, float fOcclusion) override
	Sets the obstruction and occlusion values on an entity.

plResult	SetEnvironmentAmount (plAudioSystemEntityData pEntityData, const plAudioSystemEnvironmentData pEnvironmentData, float fAmount) override
	Sets the amount of an audio environment effect associated on an entity.

plResult	AddListener (plAudioSystemListenerData pListenerData, const char szListenerName) override
	Add/register a listener in the audio middleware. This is needed to let the middleware know where to render audio, and to provide transformation values (position and orientation).

plResult	ResetListener (plAudioSystemListenerData *pListenerData) override
	Resets a listener state.

plResult	RemoveListener (plAudioSystemListenerData *pListenerData) override
	Remove/unregister a listener from the audio middleware. This action disable the possibility to update the position of the listener.

plResult	SetListenerTransform (plAudioSystemListenerData *pListenerData, const plAudioSystemTransform &Transform) override
	Sets the global transform (wold position and orientation) of a listener.

plResult	LoadBank (plAudioSystemBankData *pBankData) override
	Loads a bank file.

plResult	UnloadBank (plAudioSystemBankData *pBankData) override
	Unloads a bank file.

plAudioSystemEntityData *	CreateWorldEntity (plAudioSystemDataID uiEntityId) override
	Creates a world entity. This is a special entity used by non-spatial sounds. The engine will take care to create a game object at position (0,0,0) and orientation (0,0,0,1), and pass the game object ID as parameter to this function. The game object is ensured to never move nor rotate.

plAudioSystemEntityData *	CreateEntityData (plAudioSystemDataID uiEntityId) override
	Creates an audio entity that is attached to a game object.

plResult	DestroyEntityData (plAudioSystemEntityData *pEntityData) override
	Destroys an audio entity and release memory.

plAudioSystemListenerData *	CreateListenerData (plAudioSystemDataID uiListenerId) override
	Creates an audio listener that is attached to a game object.

plResult	DestroyListenerData (plAudioSystemListenerData *pListenerData) override
	Destroys an audio listener and release memory.

plAudioSystemEventData *	CreateEventData (plAudioSystemDataID uiEventId) override
	Creates an audio event that is attached to a game object.

plResult	ResetEventData (plAudioSystemEventData *pEventData) override
	Resets the audio event state, so it can safely recycled in the pool.

plResult	DestroyEventData (plAudioSystemEventData *pEventData) override
	Destroys an audio event and release memory.

plResult	DestroyBank (plAudioSystemBankData *pBankData) override
	Destroys an audio bank and release memory.

plResult	DestroyTriggerData (plAudioSystemTriggerData *pTriggerData) override
	Destroys an audio trigger and release memory.

plResult	DestroyRtpcData (plAudioSystemRtpcData *pRtpcData) override
	Destroys an audio rtpc and release memory.

plResult	DestroySwitchStateData (plAudioSystemSwitchStateData *pSwitchStateData) override
	Destroys an audio switch state and release memory.

plResult	DestroyEnvironmentData (plAudioSystemEnvironmentData *pEnvironmentData) override
	Destroys an audio environment effect and release memory.

plResult	SetLanguage (const char *szLanguage) override
	Sets the language used by the audio middleware.

const char *	GetMiddlewareName () const override
	Gets the audio middleware implementation name. e.g. "FMOD", "Wwise", "Amplitude", etc.

float	GetMasterGain () const override
	Gets the audio middleware's master gain.

bool	GetMute () const override
	Gets the audio middleware's muted state.

void	OnMasterGainChange (float fGain) override
	Called each time the master gain value change.

void	OnMuteChange (bool bMute) override
	Called when the audio middleware should toggle the muted state. \paarm bMute The muted state.

void	OnLoseFocus () override
	Called each time the game application window loses focus.

void	OnGainFocus () override
	Called each time the game application window gains focus.

SparkyStudios::Audio::Amplitude::Engine *	GetEngine () const

plAudioSystemBankData *	DeserializeBankEntry (plStreamReader *pBankEntry)
	Parses the entry in the controls collection that represent a bank.

plAudioSystemTriggerData *	DeserializeTriggerEntry (plStreamReader *pTriggerEntry) const
	Parses the entry in the controls collection that represent a trigger.

plAudioSystemRtpcData *	DeserializeRtpcEntry (plStreamReader *pRtpcEntry) const
	Parses the entry in the controls collection that represent a rtpc.

plAudioSystemSwitchStateData *	DeserializeSwitchStateEntry (plStreamReader *pSwitchStateEntry) const
	Parses the entry in the controls collection that represent a switch state.

plAudioSystemEnvironmentData *	DeserializeEnvironmentEntry (plStreamReader *pEnvironmentEntry) const
	Parses the entry in the controls collection that represent a environment effect.

Static Public Member Functions
static void	GameApplicationEventHandler (const plGameApplicationExecutionEvent &e)

Detailed Description

The Amplitude Audio Middleware.

This class implements the plAudioMiddleware interface of the Audio System and allows the audio system to execute audio requests through Amplitude Audio.

Member Function Documentation

◆ ActivateTrigger()

plResult plAmplitude::ActivateTrigger	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemTriggerData *	pTriggerData,
		plAudioSystemEventData *	pEventData )

overridevirtual

Triggers an event on an entity. A trigger is everything which can affect the state of an event.

Parameters

pEntityData	The entity on which trigger the event.
pTriggerData	The event trigger. Can't be modified here.
pEventData	The triggered event.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ AddEntity()

plResult plAmplitude::AddEntity	(	plAudioSystemEntityData *	pEntityData,
		const char *	szEntityName )

overridevirtual

Add/register an entity in the audio middleware. This is needed in order to provide transformation values (position and orientation), execute triggers (play sounds), and set real-time parameters or switches.

Parameters

pEntityData	The entity that should be added in the audio middleware.
szEntityName	The name of the game object representing that entity. (Can be used for debug purposes)

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ AddListener()

plResult plAmplitude::AddListener	(	plAudioSystemListenerData *	pListenerData,
		const char *	szListenerName )

overridevirtual

Add/register a listener in the audio middleware. This is needed to let the middleware know where to render audio, and to provide transformation values (position and orientation).

Parameters

pListenerData	The listener that should be added in the audio middleware.
szListenerName	The name of the game object representing that listener. (Can be used for debug purposes)

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ CreateEntityData()

plAudioSystemEntityData * plAmplitude::CreateEntityData ( plAudioSystemDataID uiEntityId )

overridevirtual

Creates an audio entity that is attached to a game object.

Parameters

uiEntityId The game object ID referencing the new audio entity.

Returns: The created entity data, or nullptr if it was not created.

Implements plAudioMiddleware.

◆ CreateEventData()

plAudioSystemEventData * plAmplitude::CreateEventData ( plAudioSystemDataID uiEventId )

overridevirtual

Creates an audio event that is attached to a game object.

Parameters

uiEventId The game object ID referencing the new audio event.

Returns: The created event data, or nullptr if it was not created.

Implements plAudioMiddleware.

◆ CreateListenerData()

plAudioSystemListenerData * plAmplitude::CreateListenerData ( plAudioSystemDataID uiListenerId )

overridevirtual

Creates an audio listener that is attached to a game object.

Parameters

uiListenerId The game object ID referencing the new audio listener.

Returns: The created listener data, or nullptr if it was not created.

Implements plAudioMiddleware.

◆ CreateWorldEntity()

plAudioSystemEntityData * plAmplitude::CreateWorldEntity ( plAudioSystemDataID uiEntityId )

overridevirtual

Creates a world entity. This is a special entity used by non-spatial sounds. The engine will take care to create a game object at position (0,0,0) and orientation (0,0,0,1), and pass the game object ID as parameter to this function. The game object is ensured to never move nor rotate.

Parameters

uiEntityId The game object ID referencing the new audio entity.

Returns: The created entity data, or nullptr if it was not created.

Implements plAudioMiddleware.

◆ DeserializeBankEntry()

plAudioSystemBankData * plAmplitude::DeserializeBankEntry ( plStreamReader * pBankEntry )

Parses the entry in the controls collection that represent a bank.

Parameters

pBankEntry The stream storing the bank entry.

Returns: The created bank data, or nullptr if no bank was created.

◆ DeserializeEnvironmentEntry()

plAudioSystemEnvironmentData * plAmplitude::DeserializeEnvironmentEntry ( plStreamReader * pEnvironmentEntry ) const

Parses the entry in the controls collection that represent a environment effect.

Parameters

pEnvironmentEntry The stream storing the environment effect entry.

Returns: The created environment effect data, or nullptr if no environment effect was created.

◆ DeserializeRtpcEntry()

plAudioSystemRtpcData * plAmplitude::DeserializeRtpcEntry ( plStreamReader * pRtpcEntry ) const

Parses the entry in the controls collection that represent a rtpc.

Parameters

pRtpcEntry The stream storing the rtpc entry.

Returns: The created rtpc data, or nullptr if no rtpc was created.

◆ DeserializeSwitchStateEntry()

plAudioSystemSwitchStateData * plAmplitude::DeserializeSwitchStateEntry ( plStreamReader * pSwitchStateEntry ) const

Parses the entry in the controls collection that represent a switch state.

Parameters

pSwitchStateEntry The stream storing the switch state entry.

Returns: The created switch state data, or nullptr if no switch state was created.

◆ DeserializeTriggerEntry()

plAudioSystemTriggerData * plAmplitude::DeserializeTriggerEntry ( plStreamReader * pTriggerEntry ) const

Parses the entry in the controls collection that represent a trigger.

Parameters

pTriggerEntry The stream storing the event entry.

Returns: The created trigger data, or nullptr if no trigger was created.

◆ DestroyBank()

plResult plAmplitude::DestroyBank ( plAudioSystemBankData * pBankData )

overridevirtual

Destroys an audio bank and release memory.

Parameters

pBankData The bank data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyEntityData()

plResult plAmplitude::DestroyEntityData ( plAudioSystemEntityData * pEntityData )

overridevirtual

Destroys an audio entity and release memory.

Parameters

pEntityData The entity data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyEnvironmentData()

plResult plAmplitude::DestroyEnvironmentData ( plAudioSystemEnvironmentData * pEnvironmentData )

overridevirtual

Destroys an audio environment effect and release memory.

Parameters

pEnvironmentData The environment effect data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyEventData()

plResult plAmplitude::DestroyEventData ( plAudioSystemEventData * pEventData )

overridevirtual

Destroys an audio event and release memory.

Parameters

pEventData The event data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyListenerData()

plResult plAmplitude::DestroyListenerData ( plAudioSystemListenerData * pListenerData )

overridevirtual

Destroys an audio listener and release memory.

Parameters

pListenerData The listener data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyRtpcData()

plResult plAmplitude::DestroyRtpcData ( plAudioSystemRtpcData * pRtpcData )

overridevirtual

Destroys an audio rtpc and release memory.

Parameters

pRtpcData The rtpc data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroySwitchStateData()

plResult plAmplitude::DestroySwitchStateData ( plAudioSystemSwitchStateData * pSwitchStateData )

overridevirtual

Destroys an audio switch state and release memory.

Parameters

pSwitchStateData The switch state data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ DestroyTriggerData()

plResult plAmplitude::DestroyTriggerData ( plAudioSystemTriggerData * pTriggerData )

overridevirtual

Destroys an audio trigger and release memory.

Parameters

pTriggerData The trigger data to destroy.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ GetMasterGain()

float plAmplitude::GetMasterGain ( ) const

nodiscardoverridevirtual

Gets the audio middleware's master gain.

Returns: The master gain.

Implements plAudioMiddleware.

◆ GetMiddlewareName()

const char * plAmplitude::GetMiddlewareName ( ) const

nodiscardoverridevirtual

Gets the audio middleware implementation name. e.g. "FMOD", "Wwise", "Amplitude", etc.

Returns: The name of the audio middleware.

Implements plAudioMiddleware.

◆ GetMute()

bool plAmplitude::GetMute ( ) const

nodiscardoverridevirtual

Gets the audio middleware's muted state.

Returns: The muted state.

Implements plAudioMiddleware.

◆ LoadBank()

plResult plAmplitude::LoadBank ( plAudioSystemBankData * pBankData )

overridevirtual

Loads a bank file.

Parameters

pBankData The bank data used for loading.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ LoadConfiguration()

plResult plAmplitude::LoadConfiguration ( const plOpenDdlReaderElement & reader )

overridevirtual

Loads the middleware-specif configuration from the ATL config file.

Parameters

reader The DDL file reader.

Implements plAudioMiddleware.

◆ LoadTrigger()

plResult plAmplitude::LoadTrigger	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemTriggerData *	pTriggerData,
		plAudioSystemEventData *	pEventData )

overridevirtual

Loads a trigger for a further activation. All the data and media needed by the trigger will be loaded. Once done, the trigger status will change to Ready.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ OnGainFocus()

void plAmplitude::OnGainFocus ( )

overridevirtual

Called each time the game application window gains focus.

Implements plAudioMiddleware.

◆ OnLoseFocus()

void plAmplitude::OnLoseFocus ( )

overridevirtual

Called each time the game application window loses focus.

Implements plAudioMiddleware.

◆ OnMasterGainChange()

void plAmplitude::OnMasterGainChange ( float fGain )

overridevirtual

Called each time the master gain value change.

Parameters

fGain The master gain value.

Implements plAudioMiddleware.

◆ OnMuteChange()

void plAmplitude::OnMuteChange ( bool bMute )

overridevirtual

Called when the audio middleware should toggle the muted state. \paarm bMute The muted state.

Implements plAudioMiddleware.

◆ Release()

plResult plAmplitude::Release ( )

overridevirtual

Destroys all the resources allocated by the audio middleware. This is usually called after Shutdown.

Returns: PL_SUCCESS when audio middleware resources was successfully released, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ RemoveEntity()

plResult plAmplitude::RemoveEntity ( plAudioSystemEntityData * pEntityData )

overridevirtual

Remove/unregister an entity from the audio middleware. This action disable the possibility to execute triggers, set real-time parameters or switches, and update the position of the entity.

Parameters

pEntityData The entity that should be removed from the audio middleware.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ RemoveListener()

plResult plAmplitude::RemoveListener ( plAudioSystemListenerData * pListenerData )

overridevirtual

Remove/unregister a listener from the audio middleware. This action disable the possibility to update the position of the listener.

Parameters

pListenerData The listener that should be removed from the audio middleware.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ ResetEntity()

plResult plAmplitude::ResetEntity ( plAudioSystemEntityData * pEntityData )

overridevirtual

Resets an entity state.

Parameters

pEntityData The entity that should be reset.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ ResetEventData()

plResult plAmplitude::ResetEventData ( plAudioSystemEventData * pEventData )

overridevirtual

Resets the audio event state, so it can safely recycled in the pool.

Parameters

pEventData The event data to reset.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ ResetListener()

plResult plAmplitude::ResetListener ( plAudioSystemListenerData * pListenerData )

overridevirtual

Resets a listener state.

Parameters

pListenerData The listener that should be reset.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ ResetRtpc()

plResult plAmplitude::ResetRtpc	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemRtpcData *	pRtpcData )

overridevirtual

Resets an audio RTPC to the default value on an entity.

Parameters

pEntityData	The entity on which reset the rtpc value.
pRtpcData	The rtpc data.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetEntityTransform()

plResult plAmplitude::SetEntityTransform	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemTransform &	Transform )

overridevirtual

Sets the global position (world position) of an entity.

Parameters

pEntityData	The entity on which set the global position.
Transform	The global transform of the entity.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetEnvironmentAmount()

plResult plAmplitude::SetEnvironmentAmount	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemEnvironmentData *	pEnvironmentData,
		float	fAmount )

overridevirtual

Sets the amount of an audio environment effect associated on an entity.

Parameters

pEntityData	The entity on which set the environment effect value.
pEnvironmentData	The environment effect data.
fAmount	The environment effect value.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetLanguage()

plResult plAmplitude::SetLanguage ( const char * szLanguage )

overridevirtual

Sets the language used by the audio middleware.

Parameters

szLanguage The language to use.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetListenerTransform()

plResult plAmplitude::SetListenerTransform	(	plAudioSystemListenerData *	pListenerData,
		const plAudioSystemTransform &	Transform )

overridevirtual

Sets the global transform (wold position and orientation) of a listener.

Parameters

pListenerData	The listener data.
Transform	The global transformation of the listener.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetObstructionAndOcclusion()

plResult plAmplitude::SetObstructionAndOcclusion	(	plAudioSystemEntityData *	pEntityData,
		float	fObstruction,
		float	fOcclusion )

overridevirtual

Sets the obstruction and occlusion values on an entity.

Parameters

pEntityData	The entity on which set the obstruction and occlusion values.
fObstruction	The obstruction value.
fOcclusion	The occlusion value.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetRtpc()

plResult plAmplitude::SetRtpc	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemRtpcData *	pRtpcData,
		float	fValue )

overridevirtual

Sets an audio RTPC to the specified value on an entity.

Parameters

pEntityData	The entity on which set the rtpc value.
pRtpcData	The rtpc data.
fValue	The rtpc value.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ SetSwitchState()

plResult plAmplitude::SetSwitchState	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemSwitchStateData *	pSwitchStateData )

overridevirtual

Sets an audio switch to the specified state on an entity.

Parameters

pEntityData	The entity on which set the switch value.
pSwitchStateData	The switch state data.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ Shutdown()

plResult plAmplitude::Shutdown ( )

overridevirtual

Deinitializes and stop the audio middleware.

Returns: PL_SUCCESS when the audio middleware was successfully stopped, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ Startup()

plResult plAmplitude::Startup ( )

overridevirtual

Initializes the audio middleware.

Returns: PL_SUCCESS when the audio middleware was successfully initialized, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ StopAllEvents()

plResult plAmplitude::StopAllEvents ( plAudioSystemEntityData * pEntityData )

overridevirtual

Stops all events active on the given entity.

Parameters

pEntityData The entity on which stop all events.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ StopAllSounds()

plResult plAmplitude::StopAllSounds ( )

overridevirtual

Stops all the sounds actually played by the audio middleware.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ StopEvent()

plResult plAmplitude::StopEvent	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemEventData *	pEventData )

overridevirtual

Stops an event on the given entity.

Parameters

pEntityData	The entity on which stop the event.
pEventData	The event to stop.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ UnloadBank()

plResult plAmplitude::UnloadBank ( plAudioSystemBankData * pBankData )

overridevirtual

Unloads a bank file.

Parameters

pBankData The bank data used for unloading.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ UnloadTrigger()

plResult plAmplitude::UnloadTrigger	(	plAudioSystemEntityData *	pEntityData,
		const plAudioSystemTriggerData *	pTriggerData )

overridevirtual

Unload the trigger. This is called when the trigger and all data loaded during LoadTrigger need to be disposed.

Parameters

pEntityData	The entity on which trigger the event.
pTriggerData	The event trigger. Can't be modified here.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

◆ Update()

void plAmplitude::Update ( plTime delta )

overridevirtual

Updates the audio middleware.

Parameters

delta The elapsed time since the last update.

Implements plAudioMiddleware.

◆ UpdateEntity()

plResult plAmplitude::UpdateEntity ( plAudioSystemEntityData * pEntityData )

overridevirtual

Updates an entity state.

Parameters

pEntityData The entity that should be updated.

Returns: PL_SUCCESS when the operation is successful, PL_FAILURE otherwise.

Implements plAudioMiddleware.

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

Code/EnginePlugins/AudioSystem/AmplitudeAudioPlugin/AmplitudeAudioSingleton.h
Code/EnginePlugins/AudioSystem/AmplitudeAudioPlugin/AmplitudeAudioSingleton.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateTrigger()

◆ AddEntity()

◆ AddListener()

◆ CreateEntityData()

◆ CreateEventData()

◆ CreateListenerData()

◆ CreateWorldEntity()

◆ DeserializeBankEntry()

◆ DeserializeEnvironmentEntry()

◆ DeserializeRtpcEntry()

◆ DeserializeSwitchStateEntry()

◆ DeserializeTriggerEntry()

◆ DestroyBank()

◆ DestroyEntityData()

◆ DestroyEnvironmentData()

◆ DestroyEventData()

◆ DestroyListenerData()

◆ DestroyRtpcData()

◆ DestroySwitchStateData()

◆ DestroyTriggerData()

◆ GetMasterGain()

◆ GetMiddlewareName()

◆ GetMute()

◆ LoadBank()

◆ LoadConfiguration()

◆ LoadTrigger()

◆ OnGainFocus()

◆ OnLoseFocus()

◆ OnMasterGainChange()

◆ OnMuteChange()

◆ Release()

◆ RemoveEntity()

◆ RemoveListener()

◆ ResetEntity()

◆ ResetEventData()

◆ ResetListener()

◆ ResetRtpc()

◆ SetEntityTransform()

◆ SetEnvironmentAmount()

◆ SetLanguage()

◆ SetListenerTransform()

◆ SetObstructionAndOcclusion()

◆ SetRtpc()

◆ SetSwitchState()

◆ Shutdown()

◆ Startup()

◆ StopAllEvents()

◆ StopAllSounds()

◆ StopEvent()

◆ UnloadBank()

◆ UnloadTrigger()

◆ Update()

◆ UpdateEntity()