CryAudio::Impl::ITrigger

CryAudio::Impl::ITriggerabstract

#include

Public Member Functions

virtual ERequestStatus Load () const =0
virtual ERequestStatus Unload () const =0
virtual ERequestStatus LoadAsync (IEvent *const pIEvent) const =0
virtual ERequestStatus UnloadAsync (IEvent *const pIEvent) const =0

Detailed Description

An implementation may use this interface to define a class for storing implementation-specific data needed for identifying and using the corresponding ITrigger (e.g. a middleware-specific event ID or name, a sound-file name to be passed to an API function)

Member Function Documentation

◆ Load()

virtual ERequestStatus CryAudio::Impl::ITrigger::Load ( ) const
pure virtual

Load the metadata and media needed by the audio middleware to execute this trigger Loading Triggers manually is only necessary if their data have not been loaded via PreloadRequests

Returns
ERequestStatus::Success if the the data was successfully loaded, ERequestStatus::Failure otherwise
See also
Unload, LoadAsync, UnloadAsync

◆ LoadAsync()

virtual ERequestStatus CryAudio::Impl::ITrigger::LoadAsync ( IEvent *const pIEvent) const
pure virtual

Load the metadata and media needed by the audio middleware to execute this trigger asynchronously. Loading Triggers manually is only necessary if their data have not been loaded via PreloadRequests.

Parameters
pIEvent- The callback called once the loading is done must report that this event is finished.
Returns
ERequestStatus::Success if the the request was successfully sent to the audio middleware, ERequestStatus::Failure otherwise
See also
Load, Unload, UnloadAsync

◆ Unload()

virtual ERequestStatus CryAudio::Impl::ITrigger::Unload ( ) const
pure virtual

Release the metadata and media needed by the audio middleware to execute this trigger Unloading Triggers manually is only necessary if their data are not managed via PreloadRequests.

Returns
ERequestStatus::Success if the the data was successfully unloaded, ERequestStatus::Failure otherwise
See also
Load, LoadAsync, UnloadAsync

◆ UnloadAsync()

virtual ERequestStatus CryAudio::Impl::ITrigger::UnloadAsync ( IEvent *const pIEvent) const
pure virtual

Release the metadata and media needed by the audio middleware to execute this trigger asynchronously. Unloading Triggers manually is only necessary if their data have not been loaded via PreloadRequests.

Parameters
pIEvent- The callback called once the loading is done must report that this event is finished.
Returns
ERequestStatus::Success if the the request was successfully sent to the audio middleware, ERequestStatus::Failure otherwise
See also
Load, Unload, LoadAsync