Audio::IParameterTransmitter Class Reference

#include <IAudioParameterTransmitter.h>

Inheritance diagram for Audio::IParameterTransmitter:

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

Static Public Attributes
static AUDIOEXTENSIONS_API const FName	RouterName = "ParameterTransmitter"

Detailed Description

Interface for a audio instance transmitter.

An audio instance transmitter ushers control parameters to a single audio object instance.

Constructor & Destructor Documentation

~IParameterTransmitter()

virtual Audio::IParameterTransmitter::~IParameterTransmitter ( )

virtualdefault

Member Function Documentation

CopyParameters()

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

pure virtual

Implemented in Audio::FParameterTransmitterBase.

GetParameter()

virtual bool Audio::IParameterTransmitter::GetParameter ( FName  InName, FAudioParameter &  OutParam  ) const

pure virtual

Implemented in Audio::FParameterTransmitterBase.

GetParameters()

virtual const TArray< FAudioParameter > & Audio::IParameterTransmitter::GetParameters ( ) const

pure virtual

Implemented in Audio::FParameterTransmitterBase.

OnDeleteActiveSound()

virtual void Audio::IParameterTransmitter::OnDeleteActiveSound ( )

inlinevirtual

OnRealizeVirtualizedActiveSound()

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

inlinevirtual

Reimplemented in Audio::FParameterTransmitterBase.

OnVirtualizeActiveSound()

virtual void Audio::IParameterTransmitter::OnVirtualizeActiveSound ( )

inlinevirtual

Reimplemented in Audio::FParameterTransmitterBase.

ResetParameters()

virtual void Audio::IParameterTransmitter::ResetParameters ( )

inlinevirtual

Reimplemented in Audio::FParameterTransmitterBase.

SetParameters()

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

pure virtual

Implemented in Audio::FParameterTransmitterBase, and FSoundCueParameterTransmitter.

Member Data Documentation

RouterName

const FName Audio::IParameterTransmitter::RouterName = "ParameterTransmitter"

static

---

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