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::AudioSystemImplementationNotifications Class Referenceabstract

#include <IAudioSystemImplementation.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnAudioSystemLoseFocus ()=0
 This method is called every time the main Game (or Editor) application loses focus.
 
virtual void OnAudioSystemGetFocus ()=0
 This method is called every time the main Game (or Editor) application receives focus.
 
virtual void OnAudioSystemMuteAll ()=0
 
virtual void OnAudioSystemUnmuteAll ()=0
 This method is called when the audio output has been unmuted.
 
virtual void OnAudioSystemRefresh ()=0
 This method is called when user initiates a reload/refresh of all the audio data.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 

Detailed Description

Notifications about the audio system for it and others to respond to. These notifications are sent from various places in the code for global events like gaining and losing application focus, mute and unmute, etc.

Member Function Documentation

◆ OnAudioSystemMuteAll()

virtual void Audio::AudioSystemImplementationNotifications::OnAudioSystemMuteAll ( )
pure virtual

This method is called when the audio output has been muted. After this call there should be no audio coming from the audio middleware.


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