Audio::FParameterTransmitterBase Class Reference

#include <IAudioParameterTransmitter.h>

Inheritance diagram for Audio::FParameterTransmitterBase:

Public Member Functions
AUDIOEXTENSIONS_API	FParameterTransmitterBase (TArray< FAudioParameter > InDefaultParams)
virtual AUDIOEXTENSIONS_API	~FParameterTransmitterBase ()
virtual AUDIOEXTENSIONS_API bool	GetParameter (FName InName, FAudioParameter &OutParam) const override
virtual AUDIOEXTENSIONS_API void	ResetParameters () override
virtual AUDIOEXTENSIONS_API const TArray< FAudioParameter > &	GetParameters () const override
virtual AUDIOEXTENSIONS_API void	CopyParameters (TArray< FAudioParameter > &OutParameters) const override
virtual AUDIOEXTENSIONS_API bool	SetParameters (TArray< FAudioParameter > &&InParameters) override
virtual AUDIOEXTENSIONS_API void	AddReferencedObjects (FReferenceCollector &InCollector) override
virtual AUDIOEXTENSIONS_API void	OnVirtualizeActiveSound () override
virtual AUDIOEXTENSIONS_API void	OnRealizeVirtualizedActiveSound (TArray< FAudioParameter > &&InParameters)
AUDIOEXTENSIONS_API bool	IsVirtualized () const
Public Member Functions inherited from Audio::IParameterTransmitter
virtual	~IParameterTransmitter ()=default
virtual void	OnDeleteActiveSound ()
Public Member Functions inherited from Audio::ILegacyParameterTransmitter
virtual	~ILegacyParameterTransmitter ()=default
virtual AUDIOEXTENSIONS_API TArray< const TObjectPtr< UObject > * >	GetReferencedObjects () const

Protected Member Functions
AUDIOEXTENSIONS_API void	AddReferencedObjectsFromParameters (FReferenceCollector &InCollector, TArrayView< FAudioParameter > InParameters) const

Protected Attributes
TArray< FAudioParameter >	AudioParameters
bool	bIsVirtualized

Additional Inherited Members
Static Public Attributes inherited from Audio::IParameterTransmitter
static AUDIOEXTENSIONS_API const FName	RouterName = "ParameterTransmitter"

Detailed Description

Base implementation for the parameter transmitter, which caches parameters and provides implementer to add additional logic to route parameter data accordingly.

Constructor & Destructor Documentation

FParameterTransmitterBase()

PRAGMA_DISABLE_DEPRECATION_WARNINGS Audio::FParameterTransmitterBase::FParameterTransmitterBase

(

TArray< FAudioParameter >

InDefaultParams

)

~FParameterTransmitterBase()

Audio::FParameterTransmitterBase::~FParameterTransmitterBase ( )

virtualdefault

Member Function Documentation

AddReferencedObjects()

void Audio::FParameterTransmitterBase::AddReferencedObjects ( FReferenceCollector &  InCollector )

overridevirtual

Reimplemented from Audio::ILegacyParameterTransmitter.

Reimplemented in FSoundCueParameterTransmitter.

AddReferencedObjectsFromParameters()

void Audio::FParameterTransmitterBase::AddReferencedObjectsFromParameters ( FReferenceCollector &  InCollector, TArrayView< FAudioParameter >  InParameters  ) const

protected

CopyParameters()

void Audio::FParameterTransmitterBase::CopyParameters ( TArray< FAudioParameter > &  OutParameters ) const

overridevirtual

Implements Audio::IParameterTransmitter.

GetParameter()

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool Audio::FParameterTransmitterBase::GetParameter ( FName  InName, FAudioParameter &  OutParam  ) const

overridevirtual

Implements Audio::IParameterTransmitter.

GetParameters()

const TArray< FAudioParameter > & Audio::FParameterTransmitterBase::GetParameters ( ) const

overridevirtual

Implements Audio::IParameterTransmitter.

IsVirtualized()

bool Audio::FParameterTransmitterBase::IsVirtualized

(

)

const

OnRealizeVirtualizedActiveSound()

void Audio::FParameterTransmitterBase::OnRealizeVirtualizedActiveSound ( TArray< FAudioParameter > &&  InParameters )

virtual

Reimplemented from Audio::IParameterTransmitter.

OnVirtualizeActiveSound()

void Audio::FParameterTransmitterBase::OnVirtualizeActiveSound ( )

overridevirtual

Reimplemented from Audio::IParameterTransmitter.

ResetParameters()

void Audio::FParameterTransmitterBase::ResetParameters ( )

overridevirtual

Reimplemented from Audio::IParameterTransmitter.

SetParameters()

bool Audio::FParameterTransmitterBase::SetParameters ( TArray< FAudioParameter > &&  InParameters )

overridevirtual

Implements Audio::IParameterTransmitter.

Reimplemented in FSoundCueParameterTransmitter.

Member Data Documentation

AudioParameters

TArray<FAudioParameter> Audio::FParameterTransmitterBase::AudioParameters

protected

bIsVirtualized

bool Audio::FParameterTransmitterBase::bIsVirtualized

protected

---

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

• Engine/Source/Runtime/AudioExtensions/Public/IAudioParameterTransmitter.h
• Engine/Source/Runtime/AudioExtensions/Private/IAudioParameterTransmitter.cpp