FSoundSourceDecoder | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	AudioMixer
Header	/Engine/Source/Runtime/AudioMixer/Public/SoundWaveDecoder.h
Include	#include "SoundWaveDecoder.h"

class FSoundSourceDecoder : public FGCObject

	Type	Name	Description
		FSoundSourceDecoder ()

	Type	Name	Description
		~FSoundSourceDecoder ()

Type	Name	Description
FDecodingSoundSourceHandle	CreateSourceHandle ( USoundWave* InSoundWave )	Creates a new decoding sound source handle.
bool	GetSourceBuffer ( const FDecodingSoundSourceHandle& InHandle, const int32 NumOutFrames, const int32 NumOutChannels, FAlignedFloatBuffer& OutAudioBuffer )	Get a decoded buffer for the given decoding sound wave handle. Call only from audio render thread or audio render thread task.
void	Init ( FAudioDevice* InAudioDevice, int32 SampleRate )	Initialize the source decoder at the given output sample rate Sources will automatically sample rate convert to match this output
bool	InitDecodingSource ( const FSourceDecodeInit& InitData )	Initialize a decoding instance of this sound wave object. Call only from game thread.
bool	IsFinished ( const FDecodingSoundSourceHandle& InHandle )	Queries if the decoding source is finished.
bool	IsInitialized ( const FDecodingSoundSourceHandle& InHandle )
void	RemoveDecodingSource ( const FDecodingSoundSourceHandle& Handle )	Removes the decoding source from the decoder.
void	Reset ()	Resets internal state of decoder.
void	SetSourcePitchScale ( const FDecodingSoundSourceHandle& Handle, float InPitchScale )	Sets the source pitch scale.
void	SetSourceVolumeScale ( const FDecodingSoundSourceHandle& Handle, float InVolumeScale )	Sets the source volume scale.
void	Update ()	Called from the audio thread.
void	UpdateRenderThread ()	Called from the audio render thread.

	Type	Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.
	FString	GetReferencerName ()	Overload this method to report a name for your referencer