Navigation
API > API/Runtime > API/Runtime/Engine
FSoundWaveProxyReader reads a FWaveProxy and outputs 32 bit interleaved audio.
FSoundWaveProxyReader provides controls for looping and relevant frame index values.
| Name | FSoundWaveProxyReader |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/SoundWaveProxyReader.h |
| Include Path | #include "Sound/SoundWaveProxyReader.h" |
Syntax
class FSoundWaveProxyReader
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSoundWaveProxyReader
(
FSoundWaveProxyRef InWaveProxy, |
Construct a wave proxy reader. | Sound/SoundWaveProxyReader.h |
Structs
| Name | Remarks |
|---|---|
| FSettings | Settings for a FSoundWaveProxyReader. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FSoundWaveProxyRef | TSharedRef< FSoundWaveProxy, ESPMode::ThreadSafe > | Sound/SoundWaveProxyReader.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DecodeSizeQuantizationInFrames | uint32 | Some codecs have strict requirements on decode size. | Sound/SoundWaveProxyReader.h |
| DefaultMinDecodeSizeInFrames | uint32 | Minimum number of frames to decode per a call to the decoder. | Sound/SoundWaveProxyReader.h |
| MaxLoopDurationInSeconds | float | Maximum duration of a loop. | Sound/SoundWaveProxyReader.h |
| MinLoopDurationInSeconds | float | Minimum duration of a loop. | Sound/SoundWaveProxyReader.h |
| MinNumFramesPerDecode | uint32 | Sound/SoundWaveProxyReader.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFallbackSeekMethodWarningLogged | bool | Sound/SoundWaveProxyReader.h | ||
| bIsDecoderValid | bool | Sound/SoundWaveProxyReader.h | ||
| bIsFirstDecode | bool | Sound/SoundWaveProxyReader.h | ||
| bPreviousIsStreaming | bool | Sound/SoundWaveProxyReader.h | ||
| CompressedAudioInfo | TUniquePtr< class ICompressedAudioInfo > | Sound/SoundWaveProxyReader.h | ||
| CurrentFrameIndex | int32 | Sound/SoundWaveProxyReader.h | ||
| DecodeResult | EDecodeResult | Sound/SoundWaveProxyReader.h | ||
| DecoderOutput | Audio::TCircularAudioBuffer< float > | Sound/SoundWaveProxyReader.h | ||
| DurationInSeconds | float | Sound/SoundWaveProxyReader.h | ||
| LoopEndFrameIndex | int32 | Sound/SoundWaveProxyReader.h | ||
| LoopStartFrameIndex | int32 | Sound/SoundWaveProxyReader.h | ||
| MaxLoopStartTimeInSeconds | float | Sound/SoundWaveProxyReader.h | ||
| NumChannels | int32 | Sound/SoundWaveProxyReader.h | ||
| NumDecodeSamplesToDiscard | int32 | Sound/SoundWaveProxyReader.h | ||
| NumFramesInWave | int32 | Sound/SoundWaveProxyReader.h | ||
| NumFramesPerDecode | uint32 | Sound/SoundWaveProxyReader.h | ||
| ResidualBuffer | TArray< int16 > | Sound/SoundWaveProxyReader.h | ||
| SampleConversionBuffer | Audio::FAlignedFloatBuffer | Sound/SoundWaveProxyReader.h | ||
| SampleRate | float | Sound/SoundWaveProxyReader.h | ||
| Settings | FSettings | Sound/SoundWaveProxyReader.h | ||
| WaveProxy | FSoundWaveProxyRef | Sound/SoundWaveProxyReader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanProduceMoreAudio() |
Returns TRUE if the reader can produce audio (eg. has a valid decoder, it can still decode, etc.) | Sound/SoundWaveProxyReader.h | |
int32 GetFrameIndex() |
Returns the index of the playhead within the complete wave. | Sound/SoundWaveProxyReader.h | |
int32 GetLoopEndFrameIndex() |
Sound/SoundWaveProxyReader.h | ||
int32 GetLoopStartFrameIndex() |
Sound/SoundWaveProxyReader.h | ||
int32 GetNumChannels() |
Sound/SoundWaveProxyReader.h | ||
int32 GetNumFramesInLoop() |
Sound/SoundWaveProxyReader.h | ||
int32 GetNumFramesInWave() |
Sound/SoundWaveProxyReader.h | ||
float GetSampleRate() |
Sound/SoundWaveProxyReader.h | ||
bool HasFailed() |
Returns TRUE if the reader has encountered a decoder failure. | Sound/SoundWaveProxyReader.h | |
bool IsLooping() |
Returns true if the audio will be looped, false otherwise. | Sound/SoundWaveProxyReader.h | |
int32 PopAudio
(
Audio::FAlignedFloatBuffer& OutBuffer |
Pops audio from reader and copies audio into OutBuffer. | Sound/SoundWaveProxyReader.h | |
bool SeekToFrame
(
uint32 InFrameNum |
Seeks to position in wave at a specific frame. | Sound/SoundWaveProxyReader.h | |
bool SeekToTime
(
float InSeconds |
Seeks to position in wave. | Sound/SoundWaveProxyReader.h | |
void SetIsLooping
(
bool bInIsLooping |
Set whether the reader should loop the audio or not. | Sound/SoundWaveProxyReader.h | |
void SetLoopDuration
(
float InLoopDurationInSeconds |
Sets the duration of the loop in seconds. | Sound/SoundWaveProxyReader.h | |
void SetLoopStartTime
(
float InLoopStartTimeInSeconds |
Sets the beginning position of the loop. | Sound/SoundWaveProxyReader.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 ConformDecodeSize
(
uint32 InMaxDesiredDecodeSizeInFrames |
Sound/SoundWaveProxyReader.h | ||
static TUniquePtr< FSoundWaveProxyReader > Create
(
FSoundWaveProxyRef InWaveProxy, |
Create a wave proxy reader. | Sound/SoundWaveProxyReader.h |