1. Epic GamesDeveloper
  3. FDecodingSoundSource

FDecodingSoundSource

API > API/Runtime > API/Runtime/AudioMixer

   
Name FDecodingSoundSource
Type class
Header File /Engine/Source/Runtime/AudioMixer/Public/SoundWaveDecoder.h
Include Path #include "SoundWaveDecoder.h"

Syntax

class FDecodingSoundSource

Constructors

Name Remarks Include Path Unreal Specifiers

FDecodingSoundSource ( FAudioDevice* AudioDevice,
const FSourceDecodeInit& InitData
)

   SoundWaveDecoder.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FDecodingSoundSource()

   SoundWaveDecoder.h  

Structs

Name Remarks
FSourceInfo Object used for source generation from decoded buffers.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioDeviceID FDeviceId   SoundWaveDecoder.h  
bForceSyncDecode bool Force the decoding of this sound to be synchronous SoundWaveDecoder.h  
bInitialized FThreadSafeBool If we've initialized SoundWaveDecoder.h  
Handle FDecodingSoundSourceHandle Handle to the decoding source. SoundWaveDecoder.h  
MixerBuffer FMixerBuffer * Mixer buffer object which is a convenience wrapper around some buffer initialization and management. SoundWaveDecoder.h  
MixerSourceBuffer TSharedPtr< FMixerSourceBuffer, ESPMode::ThreadSafe > Object which handles bulk of decoding operations. SoundWaveDecoder.h  
MixerSourceBufferCritSec FCriticalSection Critical Section around mixer source buffer access. SoundWaveDecoder.h  
SampleRate int32 Sample rate of the source. SoundWaveDecoder.h  
ScratchBuffer FAlignedFloatBuffer Scratch buffer used for upmixing and downmixing the audio. SoundWaveDecoder.h  
SeekTime float Current seek time. SoundWaveDecoder.h  
SoundWave TObjectPtr< USoundWave > The sound wave object with which this sound is generating. SoundWaveDecoder.h  
SourceInfo FSourceInfo   SoundWaveDecoder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetAudioBuffer ( const int32 InNumFrames,
const int32 InNumChannels,
FAlignedFloatBuffer& OutAudioBuffer
)

 Get audio buffer. SoundWaveDecoder.h  

USoundWave * GetSoundWave()

 Return the underlying sound wave. SoundWaveDecoder.h  

TObjectPtr< USoundWave > & GetSoundWavePtr()

   SoundWaveDecoder.h  

void Init()

 Initializes the decoding source. SoundWaveDecoder.h  

bool IsFinished()

 If the sound source finished playing all its source. Will only return true for non-looping sources. SoundWaveDecoder.h  

bool IsInitialized()

 Returns if we've been initialized. SoundWaveDecoder.h  

bool IsReadyToInit()

 Queries if we're ready to initialize. SoundWaveDecoder.h  

bool PreInit ( int32 OutputSampleRate
)

 Called before we initialize. SoundWaveDecoder.h  

void SetForceSyncDecode ( bool bShouldForceSyncDecode
)

 Sets the ForceSyncDecode flag. (Decodes for this soundwave will not happen in an async task if true) SoundWaveDecoder.h  

void SetPitchScale ( float InPitchScale,
uint32 NumFrames
)

 Sets the pitch scale. SoundWaveDecoder.h  

void SetVolumeScale ( float InVolumeScale,
uint32 NumFrames
)

 Sets the volume scale. SoundWaveDecoder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page