Navigation
API > API/Runtime > API/Runtime/AudioMixer
| Name | FSoundSourceDecoder |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixer/Public/SoundWaveDecoder.h |
| Include Path | #include "SoundWaveDecoder.h" |
Syntax
class FSoundSourceDecoder : public FGCObject
Inheritance Hierarchy
- FGCObject → FSoundSourceDecoder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSoundSourceDecoder() |
SoundWaveDecoder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSoundSourceDecoder() |
SoundWaveDecoder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioDevice | FAudioDevice * | SoundWaveDecoder.h | ||
| AudioThreadId | int32 | SoundWaveDecoder.h | ||
| CommandQueue | TQueue< TFunction< void()> > | SoundWaveDecoder.h | ||
| DecodingSources | TMap< int32, FDecodingSoundSourcePtr > | SoundWaveDecoder.h | ||
| DecodingSourcesCritSec | FCriticalSection | SoundWaveDecoder.h | ||
| InitializingDecodingSources | TMap< int32, FDecodingSoundSourcePtr > | SoundWaveDecoder.h | ||
| PrecachingSources | TMap< int32, FSourceDecodeInit > | SoundWaveDecoder.h | ||
| SampleRate | int32 | SoundWaveDecoder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDecodingSoundSourceHandle CreateSourceHandle
(
USoundWave* InSoundWave |
Creates a new decoding sound source handle. | SoundWaveDecoder.h | |
bool GetSourceBuffer
(
const FDecodingSoundSourceHandle& InHandle, |
Get a decoded buffer for the given decoding sound wave handle. Call only from audio render thread or audio render thread task. | SoundWaveDecoder.h | |
void Init
(
FAudioDevice* InAudioDevice, |
Initialize the source decoder at the given output sample rate Sources will automatically sample rate convert to match this output | SoundWaveDecoder.h | |
bool InitDecodingSource
(
const FSourceDecodeInit& InitData |
Initialize a decoding instance of this sound wave object. Call only from game thread. | SoundWaveDecoder.h | |
bool IsFinished
(
const FDecodingSoundSourceHandle& InHandle |
Queries if the decoding source is finished. | SoundWaveDecoder.h | |
bool IsInitialized
(
const FDecodingSoundSourceHandle& InHandle |
SoundWaveDecoder.h | ||
void RemoveDecodingSource
(
const FDecodingSoundSourceHandle& Handle |
Removes the decoding source from the decoder. | SoundWaveDecoder.h | |
void Reset() |
Resets internal state of decoder. | SoundWaveDecoder.h | |
void SetSourcePitchScale
(
const FDecodingSoundSourceHandle& Handle, |
Sets the source pitch scale. | SoundWaveDecoder.h | |
void SetSourceVolumeScale
(
const FDecodingSoundSourceHandle& Handle, |
Sets the source volume scale. | SoundWaveDecoder.h | |
void Update() |
Called from the audio thread. | SoundWaveDecoder.h | |
void UpdateRenderThread() |
Called from the audio render thread. | SoundWaveDecoder.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
SoundWaveDecoder.h | ||
virtual FString GetReferencerName() |
SoundWaveDecoder.h |