Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Sound/SoundWaveProxyReader.h |
| Include | #include "Sound/SoundWaveProxyReader.h" |
Syntax
class FSoundWaveProxyReader
Remarks
FSoundWaveProxyReader reads a FWaveProxy and outputs 32 bit interleaved audio.
FSoundWaveProxyReader provides controls for looping and relevant frame index values.
Constructors
No constructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Returns TRUE if the reader can produce audio (eg. has a valid decoder, it can still decode, etc.) | |
  |
uint32 | ConformDecodeSize
(
uint32 InMaxDesiredDecodeSizeInFrames |
|
  |
TUniquePtr< FSoundWaveProxyReader > | Create
(
FSoundWaveProxyRef InWaveProxy, |
Create a wave proxy reader. |
  |
int32 | Returns the index of the playhead within the complete wave. | |
  |
int32 | ||
  |
int32 | ||
  |
int32 | ||
  |
int32 | ||
  |
int32 | ||
  |
float | ||
  |
bool | HasFailed () |
Returns TRUE if the reader has encountered a decoder failure. |
  |
bool | IsLooping () |
Returns true if the audio will be looped, false otherwise. |
 |
int32 | PopAudio
(
Audio::FAlignedFloatBuffer& OutBuffer |
Pops audio from reader and copies audio into OutBuffer. |
 |
bool | SeekToFrame
(
uint32 InFrameNum |
Seeks to position in wave at a specific frame. |
 |
bool | SeekToTime
(
float InSeconds |
Seeks to position in wave. |
 |
void | SetIsLooping
(
bool bInIsLooping |
Set whether the reader should loop the audio or not. |
 |
void | SetLoopDuration
(
float InLoopDurationInSeconds |
Sets the duration of the loop in seconds. |
 |
void | SetLoopStartTime
(
float InLoopStartTimeInSeconds |
Sets the beginning position of the loop. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FSettings | Settings for a FSoundWaveProxyReader. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
EDecodeResult |
Typedefs
| Name | Description |
|---|---|
| FSoundWaveProxyRef |
Constants
| Name | Description |
|---|---|
| DecodeSizeQuantizationInFrames | Some codecs have strict requirements on decode size. |
| DefaultMinDecodeSizeInFrames | Minimum number of frames to decode per a call to the decoder. |
| MaxLoopDurationInSeconds | Maximum duration of a loop. |
| MinLoopDurationInSeconds | Minimum duration of a loop. |
| MinNumFramesPerDecode |