#include <IAudioSystemImplementation.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual void	Update (float updateIntervalMS)=0

virtual EAudioRequestStatus	Initialize ()=0

virtual EAudioRequestStatus	ShutDown ()=0

virtual EAudioRequestStatus	Release ()=0

virtual EAudioRequestStatus	StopAllSounds ()=0

virtual EAudioRequestStatus	RegisterAudioObject (IATLAudioObjectData objectData, const char objectName=nullptr)=0

virtual EAudioRequestStatus	UnregisterAudioObject (IATLAudioObjectData *objectData)=0

virtual EAudioRequestStatus	ResetAudioObject (IATLAudioObjectData *objectData)=0

virtual EAudioRequestStatus	UpdateAudioObject (IATLAudioObjectData *objectData)=0

virtual EAudioRequestStatus	PrepareTriggerSync (IATLAudioObjectData audioObjectData, const IATLTriggerImplData triggerData)=0

virtual EAudioRequestStatus	UnprepareTriggerSync (IATLAudioObjectData objectData, const IATLTriggerImplData triggerData)=0

virtual EAudioRequestStatus	PrepareTriggerAsync (IATLAudioObjectData objectData, const IATLTriggerImplData triggerData, IATLEventData *eventData)=0

virtual EAudioRequestStatus	UnprepareTriggerAsync (IATLAudioObjectData pAudioObjectData, const IATLTriggerImplData pTriggerData, IATLEventData *pEventData)=0

virtual EAudioRequestStatus	ActivateTrigger (IATLAudioObjectData objectData, const IATLTriggerImplData triggerData, IATLEventData tventData, const SATLSourceData sourceData)=0

virtual EAudioRequestStatus	StopEvent (IATLAudioObjectData objectData, const IATLEventData eventData)=0

virtual EAudioRequestStatus	StopAllEvents (IATLAudioObjectData *objectData)=0

virtual EAudioRequestStatus	SetPosition (IATLAudioObjectData *objectData, const SATLWorldPosition &worldPosition)=0

virtual EAudioRequestStatus	SetMultiplePositions (IATLAudioObjectData *objectData, const MultiPositionParams &multiPositions)=0

virtual EAudioRequestStatus	SetRtpc (IATLAudioObjectData objectData, const IATLRtpcImplData rtpcData, float value)=0

virtual EAudioRequestStatus	SetSwitchState (IATLAudioObjectData objectData, const IATLSwitchStateImplData switchStateData)=0

virtual EAudioRequestStatus	SetObstructionOcclusion (IATLAudioObjectData *objectData, float obstruction, float occlusion)=0

virtual EAudioRequestStatus	SetEnvironment (IATLAudioObjectData objectData, const IATLEnvironmentImplData environmentData, float amount)=0

virtual EAudioRequestStatus	SetListenerPosition (IATLListenerData *listenerData, const SATLWorldPosition &newPosition)=0

virtual EAudioRequestStatus	ResetRtpc (IATLAudioObjectData objectData, const IATLRtpcImplData rtpcData)=0

virtual EAudioRequestStatus	RegisterInMemoryFile (SATLAudioFileEntryInfo *audioFileEntry)=0

virtual EAudioRequestStatus	UnregisterInMemoryFile (SATLAudioFileEntryInfo *audioFileEntry)=0

virtual EAudioRequestStatus	ParseAudioFileEntry (const AZ::rapidxml::xml_node< char > audioFileEntryNode, SATLAudioFileEntryInfo fileEntryInfo)=0

virtual void	DeleteAudioFileEntryData (IATLAudioFileEntryData *oldAudioFileEntryData)=0

virtual const char *const	GetAudioFileLocation (SATLAudioFileEntryInfo *fileEntryInfo)=0

virtual IATLTriggerImplData *	NewAudioTriggerImplData (const AZ::rapidxml::xml_node< char > *audioTriggerNode)=0

virtual void	DeleteAudioTriggerImplData (IATLTriggerImplData *oldTriggerData)=0

virtual IATLRtpcImplData *	NewAudioRtpcImplData (const AZ::rapidxml::xml_node< char > *audioRtpcNode)=0

virtual void	DeleteAudioRtpcImplData (IATLRtpcImplData *oldRtpcData)=0

virtual IATLSwitchStateImplData *	NewAudioSwitchStateImplData (const AZ::rapidxml::xml_node< char > *audioSwitchStateNode)=0

virtual void	DeleteAudioSwitchStateImplData (IATLSwitchStateImplData *oldAudioSwitchStateData)=0

virtual IATLEnvironmentImplData *	NewAudioEnvironmentImplData (const AZ::rapidxml::xml_node< char > *audioEnvironmentNode)=0

virtual void	DeleteAudioEnvironmentImplData (IATLEnvironmentImplData *oldEnvironmentData)=0

virtual IATLAudioObjectData *	NewGlobalAudioObjectData (TAudioObjectID objectId)=0

virtual IATLAudioObjectData *	NewAudioObjectData (TAudioObjectID objectId)=0

virtual void	DeleteAudioObjectData (IATLAudioObjectData *oldObjectData)=0

virtual IATLListenerData *	NewDefaultAudioListenerObjectData (TATLIDType objectId)=0

virtual IATLListenerData *	NewAudioListenerObjectData (TATLIDType objectId)=0

virtual void	DeleteAudioListenerObjectData (IATLListenerData *oldListenerData)=0

virtual IATLEventData *	NewAudioEventData (TAudioEventID eventID)=0

virtual void	DeleteAudioEventData (IATLEventData *oldEventData)=0

virtual void	ResetAudioEventData (IATLEventData *eventData)=0

virtual void	SetLanguage (const char *language)=0

virtual const char *const	GetImplSubPath () const =0

virtual const char *const	GetImplementationNameString () const =0

virtual void	GetMemoryInfo (SAudioImplMemoryInfo &memoryInfo) const =0

virtual AZStd::vector< AudioImplMemoryPoolInfo >	GetMemoryPoolInfo ()=0

virtual bool	CreateAudioSource (const SAudioInputConfig &sourceConfig)=0

virtual void	DestroyAudioSource (TAudioSourceId sourceId)=0

virtual void	SetPanningMode (PanningMode mode)=0

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Detailed Description

Requests interface for audio middleware implementations. This is the main interface for interacting with an audio middleware implementation, creating and destroying objects, event handling, parameter setting, etc.

Member Function Documentation

◆ ActivateTrigger()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::ActivateTrigger	(	IATLAudioObjectData *	objectData,
		const IATLTriggerImplData *	triggerData,
		IATLEventData *	tventData,
		const SATLSourceData *	sourceData
	)

pure virtual

Activate a trigger on an audio object.

Parameters

objectData	Implementation-specific audio object data.
triggerData	Implementation-specific trigger data.
eventData	Implementation-specific event data.

Returns: Success if the trigger was activated and the event posted to the audio middleware, Failure otherwise.

◆ CreateAudioSource()

virtual bool Audio::AudioSystemImplementationRequests::CreateAudioSource ( const SAudioInputConfig & sourceConfig )

pure virtual

Create an Audio Source as specified by a configuration.

Parameters

sourceConfig Configuration information specifying the format of the source.

◆ DeleteAudioEnvironmentImplData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioEnvironmentImplData ( IATLEnvironmentImplData * oldEnvironmentData )

pure virtual

Free the memory and resources of the supplied audio environment object.

Parameters

oldEnvironmentData Implementation-specific audio environment data.

◆ DeleteAudioEventData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioEventData ( IATLEventData * oldEventData )

pure virtual

Free the memory and resources of the supplied event object.

Parameters

oldEventData Implementation-specific event object.

◆ DeleteAudioFileEntryData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioFileEntryData ( IATLAudioFileEntryData * oldAudioFileEntryData )

pure virtual

Free the memory and resources of the supplied audio file entry data.

Parameters

oldAudioFileEntryData Implementation-specific audio file entry data.

◆ DeleteAudioListenerObjectData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioListenerObjectData ( IATLListenerData * oldListenerData )

pure virtual

Free the memory and resources of the supplied listener object.

Parameters

oldListenerData Implementation-specific listener object.

◆ DeleteAudioObjectData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioObjectData ( IATLAudioObjectData * oldObjectData )

pure virtual

Free the memory and resources of the supplied audio object data.

Parameters

oldObjectData Implementation-specific audio object data.

◆ DeleteAudioRtpcImplData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioRtpcImplData ( IATLRtpcImplData * oldRtpcData )

pure virtual

Free the memory and resources of the supplied audio rtpc object.

Parameters

oldRtpcData Implementation-specific audio rtpc data.

◆ DeleteAudioSwitchStateImplData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioSwitchStateImplData ( IATLSwitchStateImplData * oldAudioSwitchStateData )

pure virtual

Free the memory and resources of the supplied audio switchstate object.

Parameters

oldAudioSwitchStateData Implementation-specific audio switchstate data.

◆ DeleteAudioTriggerImplData()

virtual void Audio::AudioSystemImplementationRequests::DeleteAudioTriggerImplData ( IATLTriggerImplData * oldTriggerData )

pure virtual

Free the memory and resources of the supplied audio trigger object.

Parameters

oldTriggerData Implementation-specific audio trigger data.

◆ DestroyAudioSource()

virtual void Audio::AudioSystemImplementationRequests::DestroyAudioSource ( TAudioSourceId sourceId )

pure virtual

Destroys a managed Audio Source.

Parameters

sourceId ID of the Audio Source.

◆ GetAudioFileLocation()

virtual const char *const Audio::AudioSystemImplementationRequests::GetAudioFileLocation ( SATLAudioFileEntryInfo * fileEntryInfo )

pure virtual

Get the full path to the folder containing the file described by fileEntryInfo.

Parameters

fileEntryInfo ATL-specific information describing the file whose location is being queried.

Returns: A zero-terminated C-string containing the path to the file.

◆ GetImplementationNameString()

virtual const char *const Audio::AudioSystemImplementationRequests::GetImplementationNameString ( ) const

pure virtual

Get the name of the audio middleware implementation. This string can be displayed on screen.

Returns: A zero-terminated C-string with the name of the audio middleware implementation.

◆ GetImplSubPath()

virtual const char *const Audio::AudioSystemImplementationRequests::GetImplSubPath ( ) const

pure virtual

Get the canonical subfolder for this audio middleware implementation. Used for locating audio data in the game assets folder.

Returns: A zero-terminated C-string with the subfolder this implementation uses.

◆ GetMemoryInfo()

virtual void Audio::AudioSystemImplementationRequests::GetMemoryInfo ( SAudioImplMemoryInfo & memoryInfo ) const

pure virtual

Obtain information describing the current memory usage of this audio middleware implementation. This data can be displayed on screen. param memoryInfo A reference to a SAudioImplMemoryInfo struct.

◆ GetMemoryPoolInfo()

virtual AZStd::vector< AudioImplMemoryPoolInfo > Audio::AudioSystemImplementationRequests::GetMemoryPoolInfo ( )

pure virtual

Retrieve information about memory pools active in the audio middleware.

Returns: Vector of AudioImplMemoryPoolInfo.

◆ Initialize()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::Initialize ( )

pure virtual

Initialize all internal components of the audio middleware implementation.

Returns: Success if the initialization was successful, Failure otherwise.

◆ NewAudioEnvironmentImplData()

virtual IATLEnvironmentImplData * Audio::AudioSystemImplementationRequests::NewAudioEnvironmentImplData ( const AZ::rapidxml::xml_node< char > * audioEnvironmentNode )

pure virtual

Parse the implementation-specific XML node that represents an audio environment.

Parameters

audioEnvironmentNode XML node corresponding to the new audio environment object to be created. Assumes that strings are null-terminated (i.e. the xml_document has been parsed without the 'parse_no_string_terminators' flag).

Returns: Pointer to the newly created audio environment object, or nullptr if it was not created.

◆ NewAudioEventData()

virtual IATLEventData * Audio::AudioSystemImplementationRequests::NewAudioEventData ( TAudioEventID eventID )

pure virtual

Create an implementation-specific event object data.

Parameters

eventId Unique ID for the event.

Returns: Pointer to the newly created event object, or nullptr if it was not created.

◆ NewAudioListenerObjectData()

virtual IATLListenerData * Audio::AudioSystemImplementationRequests::NewAudioListenerObjectData ( TATLIDType objectId )

pure virtual

Create an implementation-specific listener object data.

Parameters

objectId Unique ID of the listener.

Returns: Pointer to the newly created listener object, or nullptr if it was not created.

◆ NewAudioObjectData()

virtual IATLAudioObjectData * Audio::AudioSystemImplementationRequests::NewAudioObjectData ( TAudioObjectID objectId )

pure virtual

Create an implementation-specific audio object.

Parameters

objectId Unique ID of the audio object.

Returns: Pointer to the newly created audio object, or nullptr if it was not created.

◆ NewAudioRtpcImplData()

virtual IATLRtpcImplData * Audio::AudioSystemImplementationRequests::NewAudioRtpcImplData ( const AZ::rapidxml::xml_node< char > * audioRtpcNode )

pure virtual

Parse the implementation-specific XML node that represents an audio rtpc.

Parameters

audioRtpcNode XML node corresponding to the new audio rtpc object to be created. Assumes that strings are null-terminated (i.e. the xml_document has been parsed without the 'parse_no_string_terminators' flag).

Returns: Pointer to the newly created audio rtpc object, or nullptr if it was not created.

◆ NewAudioSwitchStateImplData()

virtual IATLSwitchStateImplData * Audio::AudioSystemImplementationRequests::NewAudioSwitchStateImplData ( const AZ::rapidxml::xml_node< char > * audioSwitchStateNode )

pure virtual

Parse the implementation-specific XML node that represents an audio switchstate.

Parameters

audioSwitchStateNode XML node corresponding to the new audio switchstate object to be created. Assumes that strings are null-terminated (i.e. the xml_document has been parsed without the 'parse_no_string_terminators' flag).

Returns: Pointer to the newly created audio switchstate object, or nullptr if it was not created.

◆ NewAudioTriggerImplData()

virtual IATLTriggerImplData * Audio::AudioSystemImplementationRequests::NewAudioTriggerImplData ( const AZ::rapidxml::xml_node< char > * audioTriggerNode )

pure virtual

Parse the implementation-specific XML node that represents an audio trigger.

Parameters

audioTriggerNode XML node corresponding to the new audio trigger object to be created. Assumes that strings are null-terminated (i.e. the xml_document has been parsed without the 'parse_no_string_terminators' flag).

Returns: Pointer to the newly created audio trigger object, or nullptr if it was not created.

◆ NewDefaultAudioListenerObjectData()

virtual IATLListenerData * Audio::AudioSystemImplementationRequests::NewDefaultAudioListenerObjectData ( TATLIDType objectId )

pure virtual

Create an implementation-specific listener object data that will be the default listener.

Parameters

objectId Unique ID of the default listener.

Returns: Pointer to the newly created default listener object, or nullptr if it was not created.

◆ NewGlobalAudioObjectData()

virtual IATLAudioObjectData * Audio::AudioSystemImplementationRequests::NewGlobalAudioObjectData ( TAudioObjectID objectId )

pure virtual

Create an implementation-specific global audio object.

Parameters

objectId Unique ID to assign to the global audio object.

Returns: Pointer to the newly created global audio object, or nullptr if it was not created.

◆ ParseAudioFileEntry()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::ParseAudioFileEntry	(	const AZ::rapidxml::xml_node< char > *	audioFileEntryNode,
		SATLAudioFileEntryInfo *	fileEntryInfo
	)

pure virtual

Parse the implementation-specific XML node that represents an audio file entry. Fill the fields of the struct with the data necessary to locate and store the file's contents in memory.

Parameters

audioFileEntryNode	XML node corresponding to information about the file. Assumes that strings are null-terminated (i.e. the xml_document has been parsed without the 'parse_no_string_terminators' flag).
fileEntryInfo	Pointer to the struct containing the file entry information.

Returns: Success if the XML node was parsed successfully, Failure otherwise.

◆ PrepareTriggerAsync()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::PrepareTriggerAsync	(	IATLAudioObjectData *	objectData,
		const IATLTriggerImplData *	triggerData,
		IATLEventData *	eventData
	)

pure virtual

Prepare a trigger asynchronously for execution. Loads any metadata and media needed by the audio middleware to execute the trigger. An event that references eventData is created on the audio object. The prepare event callback is called once the loading is done and the trigger is now prepared.

Parameters

objectData	Implementation-specific audio object data.
triggerData	Implementation-specific trigger data.
eventData	Implementation-specific event data. Used to manage the prepare event.

Returns: Success if the trigger prepare event was successfully sent to the audio middleware, Failure otherwise.

◆ PrepareTriggerSync()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::PrepareTriggerSync	(	IATLAudioObjectData *	audioObjectData,
		const IATLTriggerImplData *	triggerData
	)

pure virtual

Prepare a trigger synchronously for execution. Loads any metadata and media needed by the audio middleware to execute the trigger.

Parameters

objectData	Implementation-specific audio object data.
triggerData	Implementation-specific trigger data.

Returns: Success if the the trigger was successfully prepared, Failure otherwise.

◆ RegisterAudioObject()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::RegisterAudioObject	(	IATLAudioObjectData *	objectData,
		const char *	objectName = `nullptr`
	)

pure virtual

Register an audio object with the audio middleware. An object needs to be registered in order to set position, execute triggers on it, or set parameters and switches. @prarm objectData Implementation-specific audio object data.

Parameters

objectName The name of the audio object to be shown in debug info.

Returns: Success if the object was registered, Failure otherwise.

◆ RegisterInMemoryFile()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::RegisterInMemoryFile ( SATLAudioFileEntryInfo * audioFileEntry )

pure virtual

Inform the audio middleware about the memory location of loaded audio data file.

Parameters

audioFileEntry ATL-specific information describing the in-memory file being registered.

Returns: Success if the audio middleware successfully registered the file, Failure otherwise.

◆ Release()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::Release ( )

pure virtual

Frees all of the resources used by the audio middleware implementation and destroys it. This action is not reversible.

Returns: Success if the action was successful, Failure otherwise.

◆ ResetAudioEventData()

virtual void Audio::AudioSystemImplementationRequests::ResetAudioEventData ( IATLEventData * eventData )

pure virtual

Reset all the members of an audio event instance without releasing the memory. This is used so the event object can be recycled back to the pool.

Parameters

eventData Implementation-specific event data.

◆ ResetAudioObject()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::ResetAudioObject ( IATLAudioObjectData * objectData )

pure virtual

Clear out the audio object's internal state and reset it. After this action, the object can be recycled back to the pool of available audio objects.

Parameters

objectData Implementation-specific audio object data.

Returns: Success if the object was reset, Failure otherwise.

◆ ResetRtpc()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::ResetRtpc	(	IATLAudioObjectData *	objectData,
		const IATLRtpcImplData *	rtpcData
	)

pure virtual

Resets the audio rtpc data to the default state for the provided audio object.

Parameters

objectData	Implementation-specific audio object data.
rtpcData	Implementation-specific audio rtpc data.

Returns: Success if the provided rtpc has been successfully reset, Failure otherwise.

◆ SetEnvironment()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetEnvironment	(	IATLAudioObjectData *	objectData,
		const IATLEnvironmentImplData *	environmentData,
		float	amount
	)

pure virtual

Set the amount of an audio environment associated with an audio object.

Parameters

objectData	Implementation-specific audio object data.
environmentData	Implementation-specific audio environment data.
amount	The float value to set, in the range [0.0, 1.0].

Returns: Success if the environment amount was set, Failure otherwise.

◆ SetLanguage()

virtual void Audio::AudioSystemImplementationRequests::SetLanguage ( const char * language )

pure virtual

Set the language used by the audio middleware. Informs the audio middleware that the localized sound banks and streamed files need to use a different language. This function does not unload or reload the currently loaded audio files.

Parameters

language A zero-terminated C-string representing the language.

◆ SetListenerPosition()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetListenerPosition	(	IATLListenerData *	listenerData,
		const SATLWorldPosition &	newPosition
	)

pure virtual

Set the world transform of an audio listener.

Parameters

listenerData	Implementation-specific audio listener data.
newPosition	The transform to set the listener to.

Returns: Success if the audio listener's world transform has been successfully set, Failure otherwise.

◆ SetMultiplePositions()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetMultiplePositions	(	IATLAudioObjectData *	objectData,
		const MultiPositionParams &	multiPositions
	)

pure virtual

Sets multiple world positions of an audio object.

Parameters

objectData	Implementation-specific audio object data.
multiPositions	Position parameter object containing world positions.

Returns: Success if the position's were successfully set, Failure otherwise.

◆ SetObstructionOcclusion()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetObstructionOcclusion	(	IATLAudioObjectData *	objectData,
		float	obstruction,
		float	occlusion
	)

pure virtual

Set the Obstruction and Occlusion amounts on a given audio object.

Parameters

objectData	Implementation-specific audio object data.
obstruction	The amount of obstruction associated with the audio object. Obstruction describes direct sound path being blocked but other paths may exist.
occlusion	The amount of occlusion associated with the audio object. Occlusion describes all paths being blocked, direct and environmental reflection paths.

Returns: Success if the values were set, Failure otherwise.

◆ SetPanningMode()

virtual void Audio::AudioSystemImplementationRequests::SetPanningMode ( PanningMode mode )

pure virtual

Set the panning mode for the audio middleware.

Parameters

mode	The PanningMode to use.

◆ SetPosition()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetPosition	(	IATLAudioObjectData *	objectData,
		const SATLWorldPosition &	worldPosition
	)

pure virtual

Set the world position of an audio object.

Parameters

objectData	Implementation-specific audio object data.
worldPosition	The transform to set the audio object to.

Returns: Success if the position was successfully set, Failure otherwise.

◆ SetRtpc()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetRtpc	(	IATLAudioObjectData *	objectData,
		const IATLRtpcImplData *	rtpcData,
		float	value
	)

pure virtual

Set an audio rtpc to the specified value on a given audio object.

Parameters

objectData	Implementation-specific audio object data.
rtpcData	Implementation-specific audio rtpc data.
value	The value to be set, normally in the range [0.0, 1.0].

Returns: Success if the rtpc value was set on the audio object, Failure otherwise.

◆ SetSwitchState()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::SetSwitchState	(	IATLAudioObjectData *	objectData,
		const IATLSwitchStateImplData *	switchStateData
	)

pure virtual

Set the audio switchstate on a given audio object.

Parameters

objectData	Implementation-specific audio object data.
switchStateData	Implementation-specific audio switchstate data.

Returns: Success if the audio switchstate has been successfully set, Failure otherwise.

◆ ShutDown()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::ShutDown ( )

pure virtual

Shuts down all of the internal components of the audio middleware implementation. After calling ShutDown the system can still be brought back up by calling Initialize.

Returns: Success if the shutdown was successful, Failure otherwise.

◆ StopAllEvents()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::StopAllEvents ( IATLAudioObjectData * objectData )

pure virtual

Stop all events currently active on an audio object.

Parameters

objectData Implementation-specific audio object data.

Returns: Success if the events were successfully stopped, Failure otherwise.

◆ StopAllSounds()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::StopAllSounds ( )

pure virtual

Stops all currently playing sounds. Has no effect on anything triggered after this method is called.

Returns: Success if the action was successful, Failure otherwise.

◆ StopEvent()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::StopEvent	(	IATLAudioObjectData *	objectData,
		const IATLEventData *	eventData
	)

pure virtual

Stop an event active on an audio object.

Parameters

objectData	Implementation-specific audio object data.
eventData	Implementation-specific event data.

Returns: Success if the event was successfully stopped, Failure otherwise.

◆ UnprepareTriggerAsync()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::UnprepareTriggerAsync	(	IATLAudioObjectData *	pAudioObjectData,
		const IATLTriggerImplData *	pTriggerData,
		IATLEventData *	pEventData
	)

pure virtual

Unprepare a trigger asynchronously when no longer needed. The metadata and media associated with the trigger are released. An event that references eventData is created on the audio object. The unprepare event callback is called once the unloading is done and the trigger is unprepared.

Parameters

objectData	Implementation-specific audio object data.
triggerData	Implementation-specific trigger data.
eventData	Implementation-specific event data.

Returns: Success if the trigger unprepare event was successfully sent to the audio middleware, Failure otherwise.

◆ UnprepareTriggerSync()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::UnprepareTriggerSync	(	IATLAudioObjectData *	objectData,
		const IATLTriggerImplData *	triggerData
	)

pure virtual

Unprepare a trigger synchronously when no longer needed. The metadata and media associated with the trigger are released.

Parameters

objectData	Implementation-specific audio object data.
triggerData	Implementation-specific trigger data.

Returns: Success if the trigger data was successfully unloaded, Failure otherwise.

◆ UnregisterAudioObject()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::UnregisterAudioObject ( IATLAudioObjectData * objectData )

pure virtual

Unregister an audio object with the audio middleware. After this action, executing triggers, setting position, states, or rtpcs no longer have an effect on the audio object. @prarm objectData Implementation-specific audio object data

Returns: Success if the object was unregistered, Failure otherwise.

◆ UnregisterInMemoryFile()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::UnregisterInMemoryFile ( SATLAudioFileEntryInfo * audioFileEntry )

pure virtual

Inform the audio middleware that the memory containing the audio data file should no longer be used.

Parameters

audioFileEntry ATL-specific information describing the file being invalidated.

Returns: Success if the audio middleware unregistered the file contents, Failure otherwise.

◆ Update()

virtual void Audio::AudioSystemImplementationRequests::Update ( float updateIntervalMS )

pure virtual

Update the audio middleware implementation. Updates all of the internal sub-systems that require regular updates, and pumps the audio middleware api.

Parameters

updateIntervalMS Time since the last call to Update in milliseconds.

◆ UpdateAudioObject()

virtual EAudioRequestStatus Audio::AudioSystemImplementationRequests::UpdateAudioObject ( IATLAudioObjectData * objectData )

pure virtual

Performs actions that need to be executed regularly on an audio object.

Parameters

objectData Implementation-specific audio object data.

Returns: Success if the object was updated, Failure otherwise.

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

Gems/AudioSystem/Code/Include/Engine/IAudioSystemImplementation.h

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ActivateTrigger()

◆ CreateAudioSource()

◆ DeleteAudioEnvironmentImplData()

◆ DeleteAudioEventData()

◆ DeleteAudioFileEntryData()

◆ DeleteAudioListenerObjectData()

◆ DeleteAudioObjectData()

◆ DeleteAudioRtpcImplData()

◆ DeleteAudioSwitchStateImplData()

◆ DeleteAudioTriggerImplData()

◆ DestroyAudioSource()

◆ GetAudioFileLocation()

◆ GetImplementationNameString()

◆ GetImplSubPath()

◆ GetMemoryInfo()

◆ GetMemoryPoolInfo()

◆ Initialize()

◆ NewAudioEnvironmentImplData()

◆ NewAudioEventData()

◆ NewAudioListenerObjectData()

◆ NewAudioObjectData()

◆ NewAudioRtpcImplData()

◆ NewAudioSwitchStateImplData()

◆ NewAudioTriggerImplData()

◆ NewDefaultAudioListenerObjectData()

◆ NewGlobalAudioObjectData()

◆ ParseAudioFileEntry()

◆ PrepareTriggerAsync()

◆ PrepareTriggerSync()

◆ RegisterAudioObject()

◆ RegisterInMemoryFile()

◆ Release()

◆ ResetAudioEventData()

◆ ResetAudioObject()

◆ ResetRtpc()

◆ SetEnvironment()

◆ SetLanguage()

◆ SetListenerPosition()

◆ SetMultiplePositions()

◆ SetObstructionOcclusion()

◆ SetPanningMode()

◆ SetPosition()

◆ SetRtpc()

◆ SetSwitchState()

◆ ShutDown()

◆ StopAllEvents()

◆ StopAllSounds()

◆ StopEvent()

◆ UnprepareTriggerAsync()

◆ UnprepareTriggerSync()

◆ UnregisterAudioObject()

◆ UnregisterInMemoryFile()

◆ Update()

◆ UpdateAudioObject()