Audio::FSoundSourceDecoder Class Reference

#include <SoundWaveDecoder.h>

Inheritance diagram for Audio::FSoundSourceDecoder:

Public Member Functions
AUDIOMIXER_API	FSoundSourceDecoder ()
virtual AUDIOMIXER_API	~FSoundSourceDecoder ()
virtual AUDIOMIXER_API void	AddReferencedObjects (FReferenceCollector &Collector) override
virtual FString	GetReferencerName () const override
AUDIOMIXER_API void	Init (FAudioDevice *InAudioDevice, int32 SampleRate)
AUDIOMIXER_API FDecodingSoundSourceHandle	CreateSourceHandle (USoundWave *InSoundWave)
AUDIOMIXER_API void	Update ()
AUDIOMIXER_API void	UpdateRenderThread ()
AUDIOMIXER_API bool	InitDecodingSource (const FSourceDecodeInit &InitData)
AUDIOMIXER_API void	RemoveDecodingSource (const FDecodingSoundSourceHandle &Handle)
AUDIOMIXER_API void	Reset ()
AUDIOMIXER_API void	SetSourcePitchScale (const FDecodingSoundSourceHandle &Handle, float InPitchScale)
AUDIOMIXER_API void	SetSourceVolumeScale (const FDecodingSoundSourceHandle &Handle, float InVolumeScale)
AUDIOMIXER_API bool	GetSourceBuffer (const FDecodingSoundSourceHandle &InHandle, const int32 NumOutFrames, const int32 NumOutChannels, FAlignedFloatBuffer &OutAudioBuffer)
AUDIOMIXER_API bool	IsFinished (const FDecodingSoundSourceHandle &InHandle) const
AUDIOMIXER_API bool	IsInitialized (const FDecodingSoundSourceHandle &InHandle) const
Public Member Functions inherited from FGCObject
	FGCObject ()
	FGCObject (const FGCObject &Other)
	FGCObject (FGCObject &&Other)
	FGCObject (EFlags Flags)
virtual	~FGCObject ()
FGCObject &	operator= (const FGCObject &)
FGCObject &	operator= (FGCObject &&)
COREUOBJECT_API void	RegisterGCObject ()
COREUOBJECT_API void	UnregisterGCObject ()
virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()
Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

Constructor & Destructor Documentation

FSoundSourceDecoder()

Audio::FSoundSourceDecoder::FSoundSourceDecoder

(

)

~FSoundSourceDecoder()

Audio::FSoundSourceDecoder::~FSoundSourceDecoder ( )

virtual

Member Function Documentation

AddReferencedObjects()

void Audio::FSoundSourceDecoder::AddReferencedObjects ( FReferenceCollector &  Collector )

overridevirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters

Collector

The collector of referenced objects.

Implements FGCObject.

CreateSourceHandle()

FDecodingSoundSourceHandle Audio::FSoundSourceDecoder::CreateSourceHandle

(

USoundWave *

InSoundWave

)

GetReferencerName()

virtual FString Audio::FSoundSourceDecoder::GetReferencerName ( ) const

inlineoverridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

GetSourceBuffer()

bool Audio::FSoundSourceDecoder::GetSourceBuffer	(	const FDecodingSoundSourceHandle &	InHandle,
		const int32	NumOutFrames,
		const int32	NumOutChannels,
		FAlignedFloatBuffer &	OutAudioBuffer
	)

Init()

void Audio::FSoundSourceDecoder::Init	(	FAudioDevice *	InAudioDevice,
		int32	SampleRate
	)

InitDecodingSource()

bool Audio::FSoundSourceDecoder::InitDecodingSource

(

const FSourceDecodeInit &

InitData

)

IsFinished()

bool Audio::FSoundSourceDecoder::IsFinished

(

const FDecodingSoundSourceHandle &

InHandle

)

const

IsInitialized()

bool Audio::FSoundSourceDecoder::IsInitialized

(

const FDecodingSoundSourceHandle &

InHandle

)

const

RemoveDecodingSource()

void Audio::FSoundSourceDecoder::RemoveDecodingSource

(

const FDecodingSoundSourceHandle &

Handle

)

Reset()

void Audio::FSoundSourceDecoder::Reset

(

)

SetSourcePitchScale()

void Audio::FSoundSourceDecoder::SetSourcePitchScale	(	const FDecodingSoundSourceHandle &	Handle,
		float	InPitchScale
	)

SetSourceVolumeScale()

void Audio::FSoundSourceDecoder::SetSourceVolumeScale	(	const FDecodingSoundSourceHandle &	Handle,
		float	InVolumeScale
	)

Update()

void Audio::FSoundSourceDecoder::Update

(

)

UpdateRenderThread()

void Audio::FSoundSourceDecoder::UpdateRenderThread

(

)

---

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

• Engine/Source/Runtime/AudioMixer/Public/SoundWaveDecoder.h
• Engine/Source/Runtime/AudioMixer/Private/SoundWaveDecoder.cpp