The Audio Middleware Interface. This interface should be implemented by the ATL middleware to communicate with the audio system. More...

#include <AudioMiddleware.h>

Inheritance diagram for plAudioMiddleware:

[legend]

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

virtual plResult	Startup ()=0
	Initializes the audio middleware.

virtual void	Update (plTime delta)=0
	Updates the audio middleware.

virtual plResult	Shutdown ()=0
	Deinitializes and stop the audio middleware.

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

virtual plResult	StopAllSounds ()=0
	Stops all the sounds actually played by the audio middleware.

virtual plResult	AddEntity (plAudioSystemEntityData pEntityData, const char szEntityName)=0
	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.

virtual plResult	ResetEntity (plAudioSystemEntityData *pEntityData)=0
	Resets an entity state.

virtual plResult	UpdateEntity (plAudioSystemEntityData *pEntityData)=0
	Updates an entity state.

virtual plResult	RemoveEntity (plAudioSystemEntityData *pEntityData)=0
	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.

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

virtual plResult	LoadTrigger (plAudioSystemEntityData pEntityData, const plAudioSystemTriggerData pTriggerData, plAudioSystemEventData *pEventData)=0
	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.

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

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

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

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

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

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

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

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

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

virtual plResult	AddListener (plAudioSystemListenerData pListenerData, const char szListenerName)=0
	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).

virtual plResult	ResetListener (plAudioSystemListenerData *pListenerData)=0
	Resets a listener state.

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

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

virtual plResult	LoadBank (plAudioSystemBankData *pBankData)=0
	Loads a bank file.

virtual plResult	UnloadBank (plAudioSystemBankData *pBankData)=0
	Unloads a bank file.

virtual plAudioSystemEntityData *	CreateWorldEntity (plAudioSystemDataID uiEntityId)=0
	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.

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

virtual plResult	DestroyEntityData (plAudioSystemEntityData *pEntityData)=0
	Destroys an audio entity and release memory.

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

virtual plResult	DestroyListenerData (plAudioSystemListenerData *pListenerData)=0
	Destroys an audio listener and release memory.

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

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

virtual plResult	DestroyEventData (plAudioSystemEventData *pEventData)=0
	Destroys an audio event and release memory.

virtual plResult	DestroyBank (plAudioSystemBankData *pBankData)=0
	Destroys an audio bank and release memory.

virtual plResult	DestroyTriggerData (plAudioSystemTriggerData *pTriggerData)=0
	Destroys an audio trigger and release memory.

virtual plResult	DestroyRtpcData (plAudioSystemRtpcData *pRtpcData)=0
	Destroys an audio rtpc and release memory.

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

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

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

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

virtual float	GetMasterGain () const =0
	Gets the audio middleware's master gain.

virtual bool	GetMute () const =0
	Gets the audio middleware's muted state.

virtual void	OnMasterGainChange (float fGain)=0
	Called each time the master gain value change.

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

virtual void	OnLoseFocus ()=0
	Called each time the game application window loses focus.

virtual void	OnGainFocus ()=0
	Called each time the game application window gains focus.

Detailed Description

The Audio Middleware Interface. This interface should be implemented by the ATL middleware to communicate with the audio system.

Member Function Documentation

◆ ActivateTrigger()

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

pure virtual

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.

Implemented in plAmplitude.

◆ AddEntity()

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

pure virtual

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.

Implemented in plAmplitude.

◆ AddListener()

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

pure virtual

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.

Implemented in plAmplitude.

◆ CreateEntityData()

virtual plAudioSystemEntityData * plAudioMiddleware::CreateEntityData ( plAudioSystemDataID uiEntityId )

pure virtual

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.

Implemented in plAmplitude.

◆ CreateEventData()

virtual plAudioSystemEventData * plAudioMiddleware::CreateEventData ( plAudioSystemDataID uiEventId )

pure virtual

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.

Implemented in plAmplitude.

◆ CreateListenerData()

virtual plAudioSystemListenerData * plAudioMiddleware::CreateListenerData ( plAudioSystemDataID uiListenerId )

pure virtual

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.

Implemented in plAmplitude.

◆ CreateWorldEntity()

virtual plAudioSystemEntityData * plAudioMiddleware::CreateWorldEntity ( plAudioSystemDataID uiEntityId )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyBank()

virtual plResult plAudioMiddleware::DestroyBank ( plAudioSystemBankData * pBankData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyEntityData()

virtual plResult plAudioMiddleware::DestroyEntityData ( plAudioSystemEntityData * pEntityData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyEnvironmentData()

virtual plResult plAudioMiddleware::DestroyEnvironmentData ( plAudioSystemEnvironmentData * pEnvironmentData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyEventData()

virtual plResult plAudioMiddleware::DestroyEventData ( plAudioSystemEventData * pEventData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyListenerData()

virtual plResult plAudioMiddleware::DestroyListenerData ( plAudioSystemListenerData * pListenerData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyRtpcData()

virtual plResult plAudioMiddleware::DestroyRtpcData ( plAudioSystemRtpcData * pRtpcData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroySwitchStateData()

virtual plResult plAudioMiddleware::DestroySwitchStateData ( plAudioSystemSwitchStateData * pSwitchStateData )

pure virtual

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.

Implemented in plAmplitude.

◆ DestroyTriggerData()

virtual plResult plAudioMiddleware::DestroyTriggerData ( plAudioSystemTriggerData * pTriggerData )

pure virtual

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.

Implemented in plAmplitude.

◆ GetMasterGain()

virtual float plAudioMiddleware::GetMasterGain ( ) const

nodiscardpure virtual

Gets the audio middleware's master gain.

Returns: The master gain.

Implemented in plAmplitude.

◆ GetMiddlewareName()

virtual const char * plAudioMiddleware::GetMiddlewareName ( ) const

nodiscardpure virtual

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

Returns: The name of the audio middleware.

Implemented in plAmplitude.

◆ GetMute()

virtual bool plAudioMiddleware::GetMute ( ) const

nodiscardpure virtual

Gets the audio middleware's muted state.

Returns: The muted state.

Implemented in plAmplitude.

◆ LoadBank()

virtual plResult plAudioMiddleware::LoadBank ( plAudioSystemBankData * pBankData )

pure virtual

Loads a bank file.

Parameters

pBankData The bank data used for loading.

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

Implemented in plAmplitude.

◆ LoadConfiguration()

virtual plResult plAudioMiddleware::LoadConfiguration ( const plOpenDdlReaderElement & reader )

pure virtual

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

Parameters

reader The DDL file reader.

Implemented in plAmplitude.

◆ LoadTrigger()

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

pure virtual

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.

Implemented in plAmplitude.

◆ OnGainFocus()

virtual void plAudioMiddleware::OnGainFocus ( )

pure virtual

Called each time the game application window gains focus.

Implemented in plAmplitude.

◆ OnLoseFocus()

virtual void plAudioMiddleware::OnLoseFocus ( )

pure virtual

Called each time the game application window loses focus.

Implemented in plAmplitude.

◆ OnMasterGainChange()

virtual void plAudioMiddleware::OnMasterGainChange ( float fGain )

pure virtual

Called each time the master gain value change.

Parameters

fGain The master gain value.

Implemented in plAmplitude.

◆ OnMuteChange()

virtual void plAudioMiddleware::OnMuteChange ( bool bMute )

pure virtual

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

Implemented in plAmplitude.

◆ Release()

virtual plResult plAudioMiddleware::Release ( )

pure virtual

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.

Implemented in plAmplitude.

◆ RemoveEntity()

virtual plResult plAudioMiddleware::RemoveEntity ( plAudioSystemEntityData * pEntityData )

pure virtual

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.

Implemented in plAmplitude.

◆ RemoveListener()

virtual plResult plAudioMiddleware::RemoveListener ( plAudioSystemListenerData * pListenerData )

pure virtual

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.

Implemented in plAmplitude.

◆ ResetEntity()

virtual plResult plAudioMiddleware::ResetEntity ( plAudioSystemEntityData * pEntityData )

pure virtual

Resets an entity state.

Parameters

pEntityData The entity that should be reset.

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

Implemented in plAmplitude.

◆ ResetEventData()

virtual plResult plAudioMiddleware::ResetEventData ( plAudioSystemEventData * pEventData )

pure virtual

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.

Implemented in plAmplitude.

◆ ResetListener()

virtual plResult plAudioMiddleware::ResetListener ( plAudioSystemListenerData * pListenerData )

pure virtual

Resets a listener state.

Parameters

pListenerData The listener that should be reset.

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

Implemented in plAmplitude.

◆ ResetRtpc()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetEntityTransform()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetEnvironmentAmount()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetLanguage()

virtual plResult plAudioMiddleware::SetLanguage ( const char * szLanguage )

pure virtual

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.

Implemented in plAmplitude.

◆ SetListenerTransform()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetObstructionAndOcclusion()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetRtpc()

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

pure virtual

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.

Implemented in plAmplitude.

◆ SetSwitchState()

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

pure virtual

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.

Implemented in plAmplitude.

◆ Shutdown()

virtual plResult plAudioMiddleware::Shutdown ( )

pure virtual

Deinitializes and stop the audio middleware.

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

Implemented in plAmplitude.

◆ Startup()

virtual plResult plAudioMiddleware::Startup ( )

pure virtual

Initializes the audio middleware.

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

Implemented in plAmplitude.

◆ StopAllEvents()

virtual plResult plAudioMiddleware::StopAllEvents ( plAudioSystemEntityData * pEntityData )

pure virtual

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.

Implemented in plAmplitude.

◆ StopAllSounds()

virtual plResult plAudioMiddleware::StopAllSounds ( )

pure virtual

Stops all the sounds actually played by the audio middleware.

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

Implemented in plAmplitude.

◆ StopEvent()

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

pure virtual

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.

Implemented in plAmplitude.

◆ UnloadBank()

virtual plResult plAudioMiddleware::UnloadBank ( plAudioSystemBankData * pBankData )

pure virtual

Unloads a bank file.

Parameters

pBankData The bank data used for unloading.

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

Implemented in plAmplitude.

◆ UnloadTrigger()

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

pure virtual

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.

Implemented in plAmplitude.

◆ Update()

virtual void plAudioMiddleware::Update ( plTime delta )

pure virtual

Updates the audio middleware.

Parameters

delta The elapsed time since the last update.

Implemented in plAmplitude.

◆ UpdateEntity()

virtual plResult plAudioMiddleware::UpdateEntity ( plAudioSystemEntityData * pEntityData )

pure virtual

Updates an entity state.

Parameters

pEntityData The entity that should be updated.

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

Implemented in plAmplitude.

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

Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Core/AudioMiddleware.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateTrigger()

◆ AddEntity()

◆ AddListener()

◆ CreateEntityData()

◆ CreateEventData()

◆ CreateListenerData()

◆ CreateWorldEntity()

◆ 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()