FSoundCueParameterTransmitter Class Reference

#include <SoundCue.h>

Inheritance diagram for FSoundCueParameterTransmitter:

Public Member Functions
ENGINE_API	FSoundCueParameterTransmitter (Audio::FParameterTransmitterInitParams &&InParams)
virtual ENGINE_API	~FSoundCueParameterTransmitter ()
ENGINE_API TArray< const TObjectPtr< UObject > * >	GetReferencedObjects () const override
virtual ENGINE_API void	AddReferencedObjects (FReferenceCollector &InCollector) override
virtual ENGINE_API bool	SetParameters (TArray< FAudioParameter > &&InParameters) override
ENGINE_API void	CreateChildTransmitter (UPTRINT InWaveInstanceHash, USoundBase &InSound, Audio::FParameterTransmitterInitParams InTransmitterInitParams)
ENGINE_API void	RemoveChildTransmitter (UPTRINT InWaveInstanceHash)
ENGINE_API TArray< FAudioParameter >	ReleaseAccumulatedParameterUpdates ()
Public Member Functions inherited from Audio::FParameterTransmitterBase
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 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

Public Attributes
TArray< FAudioParameter >	ParamsToSet
TMap< UPTRINT, TSharedPtr< Audio::IParameterTransmitter > >	Transmitters

Additional Inherited Members
Static Public Attributes inherited from Audio::IParameterTransmitter
static AUDIOEXTENSIONS_API const FName	RouterName = "ParameterTransmitter"
Protected Member Functions inherited from Audio::FParameterTransmitterBase
AUDIOEXTENSIONS_API void	AddReferencedObjectsFromParameters (FReferenceCollector &InCollector, TArrayView< FAudioParameter > InParameters) const
Protected Attributes inherited from Audio::FParameterTransmitterBase
TArray< FAudioParameter >	AudioParameters
bool	bIsVirtualized

Constructor & Destructor Documentation

FSoundCueParameterTransmitter()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FSoundCueParameterTransmitter::FSoundCueParameterTransmitter

(

Audio::FParameterTransmitterInitParams &&

InParams

)

~FSoundCueParameterTransmitter()

PRAGMA_ENABLE_DEPRECATION_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS FSoundCueParameterTransmitter::~FSoundCueParameterTransmitter ( )

virtual

Member Function Documentation

AddReferencedObjects()

void FSoundCueParameterTransmitter::AddReferencedObjects ( FReferenceCollector &  InCollector )

overridevirtual

Reimplemented from Audio::FParameterTransmitterBase.

CreateChildTransmitter()

void FSoundCueParameterTransmitter::CreateChildTransmitter	(	UPTRINT	InWaveInstanceHash,
		USoundBase &	InSound,
		Audio::FParameterTransmitterInitParams	InTransmitterInitParams
	)

GetReferencedObjects()

PRAGMA_ENABLE_DEPRECATION_WARNINGS TArray< const TObjectPtr< UObject > * > FSoundCueParameterTransmitter::GetReferencedObjects ( ) const

overridevirtual

Reimplemented from Audio::ILegacyParameterTransmitter.

ReleaseAccumulatedParameterUpdates()

TArray< FAudioParameter > FSoundCueParameterTransmitter::ReleaseAccumulatedParameterUpdates

(

)

The SoundCueParameter keeps a running track of parameter changes from SetParameters(...). When this method is called, the accumulated parameters are returned and the internal tracking of accumulated parameters is reset.

RemoveChildTransmitter()

void FSoundCueParameterTransmitter::RemoveChildTransmitter

(

UPTRINT

InWaveInstanceHash

)

SetParameters()

bool FSoundCueParameterTransmitter::SetParameters ( TArray< FAudioParameter > &&  InParameters )

overridevirtual

Reimplemented from Audio::FParameterTransmitterBase.

Member Data Documentation

ParamsToSet

TArray<FAudioParameter> FSoundCueParameterTransmitter::ParamsToSet

Transmitters

TMap<UPTRINT, TSharedPtr<Audio::IParameterTransmitter> > FSoundCueParameterTransmitter::Transmitters

---

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

• Engine/Source/Runtime/Engine/Classes/Sound/SoundCue.h
• Engine/Source/Runtime/Engine/Private/SoundCue.cpp