1. Epic GamesDeveloper
  3. FSampleBufferReader

FSampleBufferReader

API > API/Runtime > API/Runtime/SignalProcessing

   
Name FSampleBufferReader
Type class
Header File /Engine/Source/Runtime/SignalProcessing/Public/DSP/SampleBufferReader.h
Include Path #include "DSP/SampleBufferReader.h"

Syntax

class FSampleBufferReader

Constructors

Name Remarks Include Path Unreal Specifiers

FSampleBufferReader()

   DSP/SampleBufferReader.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSampleBufferReader()

   DSP/SampleBufferReader.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearBuffer()

 Clears current buffer and resets state. DSP/SampleBufferReader.h  

bool Generate ( float* OutAudioBuffer,
const int32 NumFrames,
const int32 OutChannels,
const bool bWrap
)

 Generates the next block of audio. Returns true if it's no longer playing (reached end of the buffer and not set to wrap) DSP/SampleBufferReader.h  

int32 GetNumChannels()

 Returns the number of channels of this buffer. DSP/SampleBufferReader.h  

int32 GetNumFrames()

 Returns the number of frames of the buffer. DSP/SampleBufferReader.h  

float GetPlaybackProgress()

 Returns the current playback position in seconds. DSP/SampleBufferReader.h  

bool HasBuffer()

 Whether or not the buffer reader has a buffer. DSP/SampleBufferReader.h  

void Init ( const int32 InSampleRate
)

   DSP/SampleBufferReader.h  

void SeekTime ( const float InTimeSec,
const ESeekType::Type InSeekType,
const bool bWrap
)

 Seeks the buffer the given time in seconds. Returns true if succeeded. DSP/SampleBufferReader.h  

void SetBuffer ( const int16* InBufferPtr,
const int32 InNumBufferSamples,
const int32 InNumChannels,
const int32 InBufferSampleRate
)

 This must be a completely loaded buffer. This buffer reader doesn't OWN the buffer memory. DSP/SampleBufferReader.h  

void SetPitch ( const float InPitch,
const float InterpolationTimeSec
)

 Sets the pitch of the buffer reader. Can be negative. Will linearly interpolate over the given time value. DSP/SampleBufferReader.h  

void SetScrubMode ( const bool bInIsScrubMode
)

 Puts the wave reader into scrub mode. DSP/SampleBufferReader.h  

void SetScrubTimeWidth ( const float InScrubTimeWidthSec
)

 Sets the scrub width. The sound will loop between the scrub width region and the current frame. DSP/SampleBufferReader.h  

Protected

Name Remarks Include Path Unreal Specifiers

float GetSampleValue ( const int16* InBuffer,
const int32 SampleIndex
)

   DSP/SampleBufferReader.h  

float GetSampleValueForChannel ( const int32 Channel
)

   DSP/SampleBufferReader.h  

void UpdateScrubMinAndMax()

   DSP/SampleBufferReader.h  

void UpdateSeekFrame()

   DSP/SampleBufferReader.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page