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::CAudioProxy Class Reference

Inherits Audio::IAudioProxy.

Public Member Functions

void Initialize (const char *sObjectName, void *ownerOverride=nullptr, const bool bInitAsync=true) override
 
void Release () override
 
void ExecuteTrigger (TAudioControlID nTriggerID) override
 
void ExecuteSourceTrigger (TAudioControlID nTriggerID, const SAudioSourceInfo &rSourceInfo) override
 
void StopAllTriggers () override
 
void StopTrigger (TAudioControlID nTriggerID) override
 
void SetSwitchState (TAudioControlID nSwitchID, TAudioSwitchStateID nStateID) override
 
void SetRtpcValue (TAudioControlID nRtpcID, float fValue) override
 
void SetObstructionCalcType (ObstructionType eObstructionType) override
 
void SetPosition (const SATLWorldPosition &refPosition) override
 
void SetPosition (const AZ::Vector3 &refPosition) override
 
void SetMultiplePositions (const MultiPositionParams &params) override
 
void SetEnvironmentAmount (TAudioEnvironmentID nEnvironmentID, float fValue) 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::CAudioProxy::ExecuteSourceTrigger ( TAudioControlID  nTriggerID,
const SAudioSourceInfo &  rSourceInfo 
)
overridevirtual

Implements Audio::IAudioProxy.

◆ ExecuteTrigger()

void Audio::CAudioProxy::ExecuteTrigger ( TAudioControlID  nTriggerID)
overridevirtual

Implements Audio::IAudioProxy.

◆ GetAudioObjectID()

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

Implements Audio::IAudioProxy.

◆ Initialize()

void Audio::CAudioProxy::Initialize ( const char *  sObjectName,
void *  ownerOverride = nullptr,
const bool  bInitAsync = true 
)
overridevirtual

Implements Audio::IAudioProxy.

◆ Release()

void Audio::CAudioProxy::Release ( )
overridevirtual

Implements Audio::IAudioProxy.

◆ ResetEnvironments()

void Audio::CAudioProxy::ResetEnvironments ( )
overridevirtual

Implements Audio::IAudioProxy.

◆ ResetParameters()

void Audio::CAudioProxy::ResetParameters ( )
overridevirtual

Implements Audio::IAudioProxy.

◆ SetEnvironmentAmount()

void Audio::CAudioProxy::SetEnvironmentAmount ( TAudioEnvironmentID  nEnvironmentID,
float  fValue 
)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetMultiplePositions()

void Audio::CAudioProxy::SetMultiplePositions ( const MultiPositionParams &  params)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetObstructionCalcType()

void Audio::CAudioProxy::SetObstructionCalcType ( ObstructionType  eObstructionType)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetPosition() [1/2]

void Audio::CAudioProxy::SetPosition ( const AZ::Vector3 &  refPosition)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetPosition() [2/2]

void Audio::CAudioProxy::SetPosition ( const SATLWorldPosition &  refPosition)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetRtpcValue()

void Audio::CAudioProxy::SetRtpcValue ( TAudioControlID  nRtpcID,
float  fValue 
)
overridevirtual

Implements Audio::IAudioProxy.

◆ SetSwitchState()

void Audio::CAudioProxy::SetSwitchState ( TAudioControlID  nSwitchID,
TAudioSwitchStateID  nStateID 
)
overridevirtual

Implements Audio::IAudioProxy.

◆ StopAllTriggers()

void Audio::CAudioProxy::StopAllTriggers ( )
overridevirtual

Implements Audio::IAudioProxy.

◆ StopTrigger()

void Audio::CAudioProxy::StopTrigger ( TAudioControlID  nTriggerID)
overridevirtual

Implements Audio::IAudioProxy.

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