Parse the implementation-specific XML node that represents an ATLEnvironmentImpl, return a pointer to the data needed for identifying and using this ATLEnvironmentImpl instance inside the AudioImplementation

Parameters

pRootNode

- an XML node corresponding to the new ATLEnvironmentImpl to be created

Returns

IEnvironment pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding ATLEnvironmentImpl; nullptr if the new IEnvironment instance was not created

See also

DestructEnvironment

Create an object implementing IEvent that stores all of the data needed by the AudioImplementation to identify and use an AudioEvent. Return a pointer to that object.

Parameters

event

- ATL Audio-Event associated with the newly created AudioEvent

Returns

IEvent pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding AudioEvent; nullptr if the new IEvent instance was not created

See also

DestructEvent

Parse the implementation-specific XML node that represents an audio file, fill the fields of the struct referenced by pFileInfo with the data necessary to correctly access and store the file's contents in memory. Create an object implementing IFile to hold implementation-specific data about the file and store a pointer to it in a member of pFileInfo

Parameters

pRootNode	- an XML node containing the necessary information about the file
pFileInfo	- a pointer to the struct containing the data used by the ATL to load the file into memory

Returns

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

See also

DestructFile

Create an object implementing IObject that stores all of the data needed by the AudioImplementation to identify and use the GlobalAudioObject.

Returns

IObject pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding GlobalAudioObject; nullptr if the new IObject instance was not created

See also

DestructObject

Construct an object implementing IListener that stores all of the data needed by the AudioImplementation to identify and use an AudioListener. Return a pointer to that object.

Parameters

szName

- optional name of the listener to construct (not used in release builds)

Returns

CryAudio::Impl::IListener pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding AudioListener; nullptr if the new CryAudio::Impl::IListener instance was not created.

See also

DestructListener

Create an object implementing IObject that stores all of the data needed by the AudioImplementation to identify and use the AudioObject. Return a pointer to that object.

Parameters

szName

- optional name of the object to construct (not used in release builds)

Returns

IObject pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding GlobalAudioObject; nullptr if the new IObject instance was not created

See also

DestructObject

Parse the implementation-specific XML node that represents an ATLRtpcImpl, return a pointer to the data needed for identifying and using this ATLRtpcImpl instance inside the AudioImplementation

Parameters

pRootNode

- an XML node corresponding to the new ATLRtpcImpl to be created

Returns

IParameter pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding ATLRtpcImpl; nullptr if the new AudioTrigger instance was not created

See also

DestructParameter

Create an object implementing ConstructStandaloneFile that stores all of the data needed by the AudioImplementation to identify and use an audio standalone file. Return a pointer to that object.

Parameters

standaloneFile	- reference to the CATLStandaloneFile associated with the IStandaloneFile object we want to construct. It's used as an ID to link the two objects.
szFile	- full path to the file that wants to be played
bLocalized	- is the file specified in szFile localized or not
pITrigger	- if set, routes the playing of the audio file through the specified implementation trigger

Returns

IStandaloneFile pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding audio standalone file.

nullptr if the new IStandaloneFile instance was not created.

See also

DestructStandaloneFile

Parse the implementation-specific XML node that represents an ATLSwitchStateImpl, return a pointer to the data needed for identifying and using this ATLSwitchStateImpl instance inside the AudioImplementation

Parameters

pRootNode

- an XML node corresponding to the new ATLSwitchStateImpl to be created

Returns

ISwitchState pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding ATLSwitchStateImpl; nullptr if the new AudioTriggerImplData instance was not created

See also

DestructSwitchState

Parse the implementation-specific XML node that represents an ATLTriggerImpl, return a pointer to the data needed for identifying and using this ATLTriggerImpl instance inside the AudioImplementation

Parameters

pRootNode

- an XML node corresponding to the new ATLTriggerImpl to be created

Returns

ITrigger pointer to the audio implementation-specific data needed by the audio middleware and the

AudioImplementation code to use the corresponding ATLTriggerImpl; nullptr if the new AudioTriggerImplData instance was not created

See also

DestructTrigger

Free the memory and potentially other resources used by the supplied IEnvironment instance

Parameters

pIEnvironment

- pointer to the object implementing IEnvironment to be discarded

Returns

void

See also

ConstructEnvironment

Free the memory and potentially other resources used by the supplied IEvent instance

Parameters

pIEvent

- pointer to the object implementing IEvent to be discarded

Returns

void

See also

ConstructEvent

Free the memory and potentially other resources used by the supplied IFile instance. Normally, an IFile instance is created by ConstructFile() and a pointer is stored in a member of SFileInfo.

Parameters

pIFile

- pointer to the object implementing IFile to be discarded

Returns

void

See also

ConstructFile

Destruct the supplied CryAudio::Impl::IListener instance.

Parameters

pIListener

- pointer to the object implementing CryAudio::Impl::IListener to be discarded

Returns

void

See also

ConstructListener

Free the memory and potentially other resources used by the supplied IObject instance

Parameters

pIObject

- pointer to the object implementing IObject to be discarded

Returns

void

See also

ConstructObject, ConstructGlobalObject

Free the memory and potentially other resources used by the supplied IAudioParameter instance

Parameters

pIParameter

- pointer to the object implementing IAudioParameter to be discarded

Returns

void

See also

ConstructParameter

Free the memory and potentially other resources used by the supplied IStandaloneFile instance

Parameters

pIStandaloneFile

- pointer to the object implementing IStandaloneFile to be discarded

Returns

void

See also

ConstructStandaloneFile

Free the memory and potentially other resources used by the supplied ISwitchState instance

Parameters

pISwitchState

- pointer to the object implementing ISwitchState to be discarded

Returns

void

See also

ConstructSwitchState

Free the memory and potentially other resources used by the supplied ITrigger instance

Parameters

pITrigger

- pointer to the object implementing ITrigger to be discarded

Returns

void

See also

ConstructTrigger

Called whenever a Gamepad gets connected. This is used by audio middleware that supports controller effects such as rumble.

Parameters

deviceUniqueID

- unique device identifier

Returns

void

See also

GamepadDisconnected

Called whenever a Gamepad gets disconnected. This is used by audio middleware that supports controller effects such as rumble.

Parameters

deviceUniqueID

- unique device identifier

Returns

void

See also

GamepadConnected

Asks the audio implementation to fill the fileData structure with data (e.g. duration of track) relating to the standalone file referenced in szName.

Parameters

[in]	szName	- filepath to the standalone file
[out]	fileData	- a reference to an instance of SAudioFileData

Returns

void

Get the full path to the folder containing the file described by the pFileInfo

Parameters

pFileInfo

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

Returns

A C-string containing the path to the folder where the file corresponding to the pFileInfo is stored

Return a string of the audio middeware folder name plus a separator. This string is used for building the path to audio files and audio controls editor data.

Parameters

[out]

implInfo

- a reference to an instance of SImplInfo

Returns

void

Fill in the memoryInfo describing the current memory usage of this AudioImplementation. This data gets displayed in the AudioDebug header shown on the screen whenever s_DrawAudioDebug is not 0

Parameters

[out]

memoryInfo

- a reference to an instance of SMemoryInfo

Returns

void

Initialize all internal components and the audio middleware.

Parameters

objectPoolSize	- Number of objects to preallocate storage for.
eventPoolSize	- Number of events to preallocate storage for.

Returns

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

See also

ShutDown

Mute all sounds, after this call there should be no audio coming from the audio middleware.

Returns

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

See also

UnmuteAll, StopAllSounds

Called before the middleware is shutdown to give it time to clean up. After this call all the ATL audio objects and events will be released.

Returns

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

See also

ShutDown, Release, Init

This method is called every time the main Game (or Editor) window gets focus.

Returns

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

See also

OnLoseFocus

This method is called every time the main Game (or Editor) window loses focus.

Returns

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

See also

OnGetFocus

Perform a "hot restart" of the audio middleware. Reset all of the internal data.

See also

Release, Init

Returns

void

Pauses playback of all audio events.

Returns

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

See also

ResumeAll

Inform the audio middleware about the memory location of a preloaded audio-data file

Parameters

pFileInfo

- ATL-specific information describing the resources used by the preloaded file being reported

Returns

ERequestStatus::Success if the audio middleware is able to use the preloaded file, ERequestStatus::Failure otherwise

See also

UnregisterInMemoryFile

Frees all of the resources used by the class and destroys the instance. This action is not reversible.

Returns

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

See also

ShutDown, Init

Resumes playback of all audio events.

Returns

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

See also

PauseAll

Informs the audio middleware that the localized sound banks and streamed files need to use a different language. NOTE: this function DOES NOT unload or reload the currently loaded audio files

Parameters

szLanguage

- a C-string representing the CryEngine language

Returns

void

See also

GetFileLocation

Shuts down all of the internal components and the audio middleware. Note: After a call to ShutDown(), the system can still be reinitialized by calling Init().

Returns

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

See also

Release, Init

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

Returns

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

See also

MuteAll

Restore the audio output of the audio middleware after a call to MuteAll().

Returns

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

See also

MuteAll

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

Parameters

pFileInfo

- ATL-specific information describing the resources used by the preloaded file being invalidated

Returns

ERequestStatus::Success if the audio middleware was able to unregister the preloaded file supplied, ERequestStatus::Failure otherwise

See also

RegisterInMemoryFile

Is called at roughly the same rate as the external thread and a minimum rate if the external thread falls below a given threshold.

Returns

void