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.
Public Member Functions | List of all members
Audio::NullAudioProxy Class Reference

Inherits Audio::IAudioProxy.

Public Member Functions

void Initialize (const char *, void *, const bool=true) override
 
void Release () override
 
void ExecuteTrigger (TAudioControlID) override
 
void ExecuteSourceTrigger (TAudioControlID, const SAudioSourceInfo &) override
 
void StopAllTriggers () override
 
void StopTrigger (TAudioControlID) override
 
void SetSwitchState (TAudioControlID, TAudioSwitchStateID) override
 
void SetRtpcValue (TAudioControlID, float) override
 
void SetObstructionCalcType (ObstructionType) override
 
void SetPosition (const SATLWorldPosition &) override
 
void SetPosition (const AZ::Vector3 &) override
 
void SetMultiplePositions (const MultiPositionParams &) override
 
void SetEnvironmentAmount (TAudioEnvironmentID, float) override
 
void ResetEnvironments () override
 
void ResetParameters () override
 
TAudioObjectID GetAudioObjectID () const override
 
virtual void Initialize (const char *sObjectName, void *ownerOverride=nullptr, bool bInitAsync=true)=0
 
virtual void Release ()=0
 
virtual void ExecuteTrigger (TAudioControlID nTriggerID)=0
 
virtual void ExecuteSourceTrigger (TAudioControlID nTriggerID, const SAudioSourceInfo &rSourceInfo)=0
 
virtual void StopAllTriggers ()=0
 
virtual void StopTrigger (TAudioControlID nTriggerID)=0
 
virtual void SetSwitchState (TAudioControlID nSwitchID, TAudioSwitchStateID nStateID)=0
 
virtual void SetRtpcValue (TAudioControlID nRtpcID, float fValue)=0
 
virtual void SetObstructionCalcType (ObstructionType eObstructionType)=0
 
virtual void SetPosition (const SATLWorldPosition &rPosition)=0
 
virtual void SetPosition (const AZ::Vector3 &rPosition)=0
 
virtual void SetMultiplePositions (const MultiPositionParams &params)=0
 
virtual void SetEnvironmentAmount (TAudioEnvironmentID nEnvironmentID, float fAmount)=0
 
virtual void ResetEnvironments ()=0
 
virtual void ResetParameters ()=0
 
virtual TAudioObjectID GetAudioObjectID () const =0
 

Member Function Documentation

◆ ExecuteSourceTrigger()

void Audio::NullAudioProxy::ExecuteSourceTrigger ( TAudioControlID  ,
const SAudioSourceInfo &   
)
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ ExecuteTrigger()

void Audio::NullAudioProxy::ExecuteTrigger ( TAudioControlID  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ GetAudioObjectID()

TAudioObjectID Audio::NullAudioProxy::GetAudioObjectID ( ) const
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ Initialize()

void Audio::NullAudioProxy::Initialize ( const char *  ,
void *  ,
const bool  = true 
)
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ Release()

void Audio::NullAudioProxy::Release ( )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ ResetEnvironments()

void Audio::NullAudioProxy::ResetEnvironments ( )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ ResetParameters()

void Audio::NullAudioProxy::ResetParameters ( )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetEnvironmentAmount()

void Audio::NullAudioProxy::SetEnvironmentAmount ( TAudioEnvironmentID  ,
float   
)
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetMultiplePositions()

void Audio::NullAudioProxy::SetMultiplePositions ( const MultiPositionParams &  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetObstructionCalcType()

void Audio::NullAudioProxy::SetObstructionCalcType ( ObstructionType  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetPosition() [1/2]

void Audio::NullAudioProxy::SetPosition ( const AZ::Vector3 &  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetPosition() [2/2]

void Audio::NullAudioProxy::SetPosition ( const SATLWorldPosition &  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetRtpcValue()

void Audio::NullAudioProxy::SetRtpcValue ( TAudioControlID  ,
float   
)
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ SetSwitchState()

void Audio::NullAudioProxy::SetSwitchState ( TAudioControlID  ,
TAudioSwitchStateID   
)
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ StopAllTriggers()

void Audio::NullAudioProxy::StopAllTriggers ( )
inlineoverridevirtual

Implements Audio::IAudioProxy.

◆ StopTrigger()

void Audio::NullAudioProxy::StopTrigger ( TAudioControlID  )
inlineoverridevirtual

Implements Audio::IAudioProxy.

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