FSoundWaveProxyPlayer

API > API/Runtime > API/Runtime/Engine

   
Name FSoundWaveProxyPlayer
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundWaveProxyPlayer.h
Include Path #include "Sound/SoundWaveProxyPlayer.h"

Syntax

class FSoundWaveProxyPlayer

Constructors

Name Remarks Include Path Unreal Specifiers

FSoundWaveProxyPlayer ( const FSettings& InSettings
)

 Intentionally Private constructor. Sound/SoundWaveProxyPlayer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSoundWaveProxyPlayer()

   Sound/SoundWaveProxyPlayer.h  

Structs

Name Remarks
FSettings  
FSourceEvent  

Typedefs

Name Type Remarks Include Path
FSoundWaveProxyRef TSharedRef< FSoundWaveProxy, ESPMode::ThreadSafe >   Sound/SoundWaveProxyPlayer.h

Constants

Name Type Remarks Include Path
MaxSpeed float   Sound/SoundWaveProxyPlayer.h
MinLoopDurationSeconds float   Sound/SoundWaveProxyPlayer.h
MinSpeed float   Sound/SoundWaveProxyPlayer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioSyncFrameIndex int32   Sound/SoundWaveProxyPlayer.h  
bFallbackSeekMethodWarningLogged bool   Sound/SoundWaveProxyPlayer.h  
bHasNearlyFinished bool   Sound/SoundWaveProxyPlayer.h  
bIsLooping bool   Sound/SoundWaveProxyPlayer.h  
bRequiresResampling bool   Sound/SoundWaveProxyPlayer.h  
Chan0SamplesSinceQueuedSubtitles int64 Track how many samples played before queueing another subtitle chunk. Sound/SoundWaveProxyPlayer.h  
CompressedAudioInfo TUniquePtr< ICompressedAudioInfo >   Sound/SoundWaveProxyPlayer.h  
ConvertDeinterleave TUniquePtr< Audio::IConvertDeinterleave >   Sound/SoundWaveProxyPlayer.h  
CurrentLoopDuration float   Sound/SoundWaveProxyPlayer.h  
CurrentLoopStartTime float   Sound/SoundWaveProxyPlayer.h  
DecodeBuffer TArray< int16, Audio::FAudioBufferAlignedAllocator > Working "decode buffer" to write decoded audio to before converting it to floats Sound/SoundWaveProxyPlayer.h  
DurationSeconds float Source wave data Sound/SoundWaveProxyPlayer.h  
LoopEndFrameIndex int32   Sound/SoundWaveProxyPlayer.h  
LoopStartFrameIndex int32   Sound/SoundWaveProxyPlayer.h  
NumChannels int32   Sound/SoundWaveProxyPlayer.h  
NumFramesInWave int32   Sound/SoundWaveProxyPlayer.h  
ResampledAudio Audio::FAlignedFloatBuffer "resampled audio" buffer to render "Resampled" audio to before de-interleaving Sound/SoundWaveProxyPlayer.h  
RuntimeResampler Audio::FRuntimeResampler   Sound/SoundWaveProxyPlayer.h  
SampleRate float   Sound/SoundWaveProxyPlayer.h  
Settings FSettings   Sound/SoundWaveProxyPlayer.h  
SortedCuePoints TArray< FSoundWaveCuePoint >   Sound/SoundWaveProxyPlayer.h  
SoundWaveDataPtr TSharedPtr< const FSoundWaveData >   Sound/SoundWaveProxyPlayer.h  
SourceAudio Audio::FAlignedFloatBuffer "source audio" buffer to write "interleaved" audio to before de-interleaving Sound/SoundWaveProxyPlayer.h  
SourceFrameIndex int32 Playback Sound/SoundWaveProxyPlayer.h  
Speed float   Sound/SoundWaveProxyPlayer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GenerateSourceAudio ( TArrayView< float > OutAudio
)

 Directly generate audio from the Wave Source into an interleaved buffer Sound/SoundWaveProxyPlayer.h  

const TArray< FSoundWaveCuePoint > & GetCuePoints()

 Get the Current Cue Points as a sorted array If the Sound Wave is not valid, cue points will be empty Sound/SoundWaveProxyPlayer.h  

int32 GetCurrentPlaybackFrame()

 The Current playback position into the Source Sound/SoundWaveProxyPlayer.h  

float GetCurrentPlaybackTimeSeconds()

 Returns the current playback position into the Source Sound/SoundWaveProxyPlayer.h  

float GetLoopProgress()

 Returns the current loop progress between the current loop region based on the playback time in the source file Sound/SoundWaveProxyPlayer.h  

int32 GetOutputNumChannels()

   Sound/SoundWaveProxyPlayer.h  

float GetOutputSampleRate()

   Sound/SoundWaveProxyPlayer.h  

float GetPlaybackProgress()

 Returns the current playback progress based on the playback time into the source file Sound/SoundWaveProxyPlayer.h  

float GetSourceDuration()

   Sound/SoundWaveProxyPlayer.h  

int32 GetSourceNumChannels()

   Sound/SoundWaveProxyPlayer.h  

int32 GetSourceNumFrames()

   Sound/SoundWaveProxyPlayer.h  

float GetSourceSampleRate()

   Sound/SoundWaveProxyPlayer.h  

float GetSpeed()

   Sound/SoundWaveProxyPlayer.h  

bool IsFinished()

   Sound/SoundWaveProxyPlayer.h  

bool IsLooping()

   Sound/SoundWaveProxyPlayer.h  

bool IsPlayerValid()

   Sound/SoundWaveProxyPlayer.h  

void RenderMultiChannelAudio ( int32 BlockFrameIndex,
Audio::FMultichannelBufferView& OutMultiChannelAudio,
TArray< FSourceEvent >& OutEvents
)

 Render audio from the Wave Source based on the current Speed, Loop Settings, and Desired output Sample Rate Expects the number of channels in the output buffer be the same as the initial settings Sound/SoundWaveProxyPlayer.h  

void RenderMultiChannelAudio ( const Audio::FMultichannelBufferView& OutMultiChannelAudio
)

 Render audio from the Wave Source based on the current Speed, Loop Settings, and Desired output Sample Rate Expects the number of channels in the output buffer be the same as the initial settings Sound/SoundWaveProxyPlayer.h  

void Reset ( const FSettings& NewSettings
)

 Reset the Wave Player with a new Wave Proxy and new settings Helpful to avoid creating a whole new Wave Player with new buffers etc. Sound/SoundWaveProxyPlayer.h  

bool SeekToFrame ( int32 InFrame
)

 Seek this wave player to a specified frame. Sound/SoundWaveProxyPlayer.h  

bool SeekToTime ( float TimeSeconds
)

 Seek this Wave Player to the specified time Can fail if the wave player is not initialized or the wave asset does not properly support seeking Sound/SoundWaveProxyPlayer.h  

void SetLoop ( bool InIsLooping,
float InLoopStartTimeSeconds,
float InLoopDurationSeconds
)

 Set whether this wave player should loop with optional loop parameters Sound/SoundWaveProxyPlayer.h  

bool SetSoundWave ( const TSharedRef< const FSoundWaveData >& InWaveData
)

 Set the SoundWave Data to play Sound/SoundWaveProxyPlayer.h  

bool SetSoundWave ( FSoundWaveProxyPtr InWaveProxy
)

   Sound/SoundWaveProxyPlayer.h  

void SetSpeed ( float InSpeed
)

 Set the speed of the wave player clamped to MinSpeed & MaxSpeed Sound/SoundWaveProxyPlayer.h  

Static

Name Remarks Include Path Unreal Specifiers

static TUniquePtr< FSoundWaveProxyPlayer > Create ( const FSettings& InSettings
)

 Create a SoundWaveProxyPlayer initialized with the given output settings (Note: Settings can be changed after creation, so no need to create a new one if you need to change the settings) Sound/SoundWaveProxyPlayer.h  

static bool IsValidSoundWaveData ( const FSoundWaveData& InWaveData
)

 Check whether the Wave Proxy has valid data (valid Sample Rate, Num Channels, Num Frames) Sound/SoundWaveProxyPlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page