Open 3D Engine AudioSystem Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Audio::CAudioSystem Class Reference

Inherits AZ::Interface::Registrar, and AzFramework::DebugDisplayEventBus::Handler.

Public Member Functions

 AZ_RTTI (CAudioSystem, "{96254647-000D-4896-93C4-92E0F258F21D}", IAudioSystem)
 
 AZ_CLASS_ALLOCATOR (CAudioSystem, AZ::SystemAllocator)
 
 CAudioSystem (const CAudioSystem &)=delete
 
CAudioSystemoperator= (const CAudioSystem &)=delete
 
bool Initialize () override
 
void Release () override
 
void ExternalUpdate () override
 
void PushRequest (AudioRequestVariant &&request) override
 
void PushRequests (AudioRequestsQueue &requests) override
 
void PushRequestBlocking (AudioRequestVariant &&request) override
 
void PushCallback (AudioRequestVariant &&callback) override
 
TAudioControlID GetAudioTriggerID (const char *const sAudioTriggerName) const override
 
TAudioControlID GetAudioRtpcID (const char *const sAudioRtpcName) const override
 
TAudioControlID GetAudioSwitchID (const char *const sAudioSwitchName) const override
 
TAudioSwitchStateID GetAudioSwitchStateID (const TAudioControlID nSwitchID, const char *const sAudioSwitchStateName) const override
 
TAudioPreloadRequestID GetAudioPreloadRequestID (const char *const sAudioPreloadRequestName) const override
 
TAudioEnvironmentID GetAudioEnvironmentID (const char *const sAudioEnvironmentName) const override
 
bool ReserveAudioListenerID (TAudioObjectID &rAudioObjectID) override
 
bool ReleaseAudioListenerID (const TAudioObjectID nAudioObjectID) override
 
bool SetAudioListenerOverrideID (const TAudioObjectID nAudioObjectID) override
 
const char * GetControlsPath () const override
 
void UpdateControlsPath () override
 
void RefreshAudioSystem (const char *const levelName) override
 
IAudioProxyGetAudioProxy () override
 
void RecycleAudioProxy (IAudioProxy *const pIAudioProxy) override
 
TAudioSourceId CreateAudioSource (const SAudioInputConfig &sourceConfig) override
 
void DestroyAudioSource (TAudioSourceId sourceId) override
 

Friends

class CAudioThread
 

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