Open 3D Engine LmbrCentral Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
LmbrCentral::AudioSystemComponent Class Reference

#include <AudioSystemComponent.h>

Inherits AZ::Component, AudioSystemComponentRequestBus::Handler, and AzFramework::LevelSystemLifecycleNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (AudioSystemComponent, "{666E28D2-FC99-4D41-861D-3758C5070653}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Protected Member Functions

void Init () override
 
void Activate () override
 
void Deactivate () override
 
bool IsAudioSystemInitialized () override
 
void GlobalStopAllSounds () override
 
void GlobalMuteAudio () override
 
void GlobalUnmuteAudio () override
 
void GlobalRefreshAudio (AZStd::string_view levelName) override
 
void GlobalExecuteAudioTrigger (const char *triggerName, AZ::EntityId callbackOwnerEntityId) override
 
void GlobalKillAudioTrigger (const char *triggerName, AZ::EntityId callbackOwnerEntityId) override
 
void GlobalSetAudioRtpc (const char *rtpcName, float value) override
 
void GlobalResetAudioRtpcs () override
 
void GlobalSetAudioSwitchState (const char *switchName, const char *stateName) override
 
void LevelLoadAudio (AZStd::string_view levelName) override
 
void LevelUnloadAudio () override
 
void OnLoadingStart (const char *levelName) override
 
void OnUnloadComplete (const char *levelName) override
 

Detailed Description

AudioSystemComponent Handles requests of a global context for the audio system. The requests are not tied to an AZ::Entity.

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