Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
| Name | TAudioBuffer |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/AudioBuffer.h |
| Include Path | #include "HarmonixDsp/AudioBuffer.h" |
Syntax
template<typename DataType>
class TAudioBuffer
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TAudioBuffer
(
int32 InNumChannels, |
HarmonixDsp/AudioBuffer.h | ||
TAudioBuffer () |
HarmonixDsp/AudioBuffer.h | ||
TAudioBuffer
(
const TAudioBuffer& Other |
HarmonixDsp/AudioBuffer.h | ||
TAudioBuffer
(
FAudioBufferConfig InConfig, |
HarmonixDsp/AudioBuffer.h | ||
TAudioBuffer
(
EAudioBufferChannelLayout InChannelLayout, |
HarmonixDsp/AudioBuffer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~TAudioBuffer() |
HarmonixDsp/AudioBuffer.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| kAudioBufferStompDetector | int32 | HarmonixDsp/AudioBuffer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChannelLayout | EAudioBufferChannelLayout | HarmonixDsp/AudioBuffer.h | ||
| ChannelMask | uint16 | HarmonixDsp/AudioBuffer.h | ||
| CleanupMode | EAudioBufferCleanupMode | HarmonixDsp/AudioBuffer.h | ||
| FirstFrame | int32 | The frame position this buffer is associated with | HarmonixDsp/AudioBuffer.h | |
| IsSilent | bool | HarmonixDsp/AudioBuffer.h | ||
| LastFrame | int32 | HarmonixDsp/AudioBuffer.h | ||
| MaxConfig | FAudioBufferConfig | Maximum channel size, initial num valid channels | HarmonixDsp/AudioBuffer.h | |
| MyData | DataType * | HarmonixDsp/AudioBuffer.h | ||
| NumFrames | int32 | HarmonixDsp/AudioBuffer.h | ||
| NumValidChannels | int32 | These should never be larger than what MaxConfig reports | HarmonixDsp/AudioBuffer.h | |
| NumValidFrames | int32 | HarmonixDsp/AudioBuffer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Accumulate
(
DataType** Input, |
HarmonixDsp/AudioBuffer.h | ||
void Accumulate
(
const TAudioBuffer< DataType >& Other |
HarmonixDsp/AudioBuffer.h | ||
void AdvanceAliasedDataPointers
(
int32 InNumFrames |
HarmonixDsp/AudioBuffer.h | ||
void Alias
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void Alias
(
const DataType* RawData, |
HarmonixDsp/AudioBuffer.h | ||
void AliasChannelDataPointers
(
const FAudioBufferConfig& NewValidConfig, |
HarmonixDsp/AudioBuffer.h | ||
void AliasChannelDataPointers
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void AssertEqualWithTolerance
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
bool CheckIntegrity() |
HarmonixDsp/AudioBuffer.h | ||
void ComputeOverview
(
uint32 InFramesPerOverviewSample, |
HarmonixDsp/AudioBuffer.h | ||
void Configure
(
int32 InNumChannels, |
HarmonixDsp/AudioBuffer.h | ||
void Configure
(
EAudioBufferChannelLayout InChannelLayout, |
HarmonixDsp/AudioBuffer.h | ||
void Configure
(
FAudioBufferConfig InConfig, |
HarmonixDsp/AudioBuffer.h | ||
bool ContainsFrame
(
int32 InFrameNumber |
HarmonixDsp/AudioBuffer.h | ||
void Copy
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void Copy
(
const TAudioBuffer< DataType >& Other |
HarmonixDsp/AudioBuffer.h | ||
void Copy
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void DebugLog
(
uint32 InChannel |
HarmonixDsp/AudioBuffer.h | ||
void Deinterleave
(
const TAudioBuffer< DataType >& Other |
Deinterleave the Other data set into this one. this one ends up deinterleaved. | HarmonixDsp/AudioBuffer.h | |
void Deinterleave
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
bool EqualWithTolerance
(
int32 ThisChannelIdx, |
HarmonixDsp/AudioBuffer.h | ||
bool EqualWithTolerance
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void Fill
(
DataType InValue |
HarmonixDsp/AudioBuffer.h | ||
void FillData
(
char InChr |
HarmonixDsp/AudioBuffer.h | ||
void FillValidFrames
(
char InChr |
HarmonixDsp/AudioBuffer.h | ||
void FillWithWhiteNoise
(
float InGain |
Fill the buffer with white noise this function only works for buffers of floats. | HarmonixDsp/AudioBuffer.h | |
bool FindFirstDiff
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
EAudioBufferChannelLayout GetChannelLayout() |
HarmonixDsp/AudioBuffer.h | ||
uint16 GetChannelMask() |
HarmonixDsp/AudioBuffer.h | ||
EAudioBufferCleanupMode GetCleanupMode() |
HarmonixDsp/AudioBuffer.h | ||
DataType ** GetData () |
HarmonixDsp/AudioBuffer.h | ||
DataType *const * GetData () |
HarmonixDsp/AudioBuffer.h | ||
int32 GetFirstFrame() |
Frame position assigns a frame number to the first sample in the buffer | HarmonixDsp/AudioBuffer.h | |
int32 GetFreeableSize() |
HarmonixDsp/AudioBuffer.h | ||
bool GetIsInterleaved() |
HarmonixDsp/AudioBuffer.h | ||
bool GetIsSilent() |
HarmonixDsp/AudioBuffer.h | ||
size_t GetLastFrame() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetLengthInFrames() |
Because this buffer could hold multiple frames in a single channel (aka interleaved data) then the channel size does not necessarily represent the number of frames | HarmonixDsp/AudioBuffer.h | |
const FAudioBufferConfig & GetMaxConfig() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetMaxNumChannels() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetMaxNumFrames() |
HarmonixDsp/AudioBuffer.h | ||
uint32 GetNumTotalValidSamples() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetNumValidBytes() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetNumValidChannels() |
HarmonixDsp/AudioBuffer.h | ||
int32 GetNumValidFrames() |
HarmonixDsp/AudioBuffer.h | ||
DataType GetPeak () |
HarmonixDsp/AudioBuffer.h | ||
DataType GetPeak
(
int32 ChannelIndex |
HarmonixDsp/AudioBuffer.h | ||
DataType * GetRawChannelData
(
int32 ChanneIdx |
HarmonixDsp/AudioBuffer.h | ||
const DataType * GetRawChannelData
(
int32 ChanneIdx |
HarmonixDsp/AudioBuffer.h | ||
TDynamicStridePtr< DataType > GetStridingChannelDataPointer
(
int32 InChannelIdx |
HarmonixDsp/AudioBuffer.h | ||
DataType * GetValidChannelData
(
int32 InChannelIndex |
HarmonixDsp/AudioBuffer.h | ||
const DataType * GetValidChannelData
(
int32 ChanneIdx |
HarmonixDsp/AudioBuffer.h | ||
FAudioBufferConfig GetValidConfig() |
HarmonixDsp/AudioBuffer.h | ||
void IncrementChannelDataPointers
(
int32 InIncrementSize |
HarmonixDsp/AudioBuffer.h | ||
void Initialize() |
HarmonixDsp/AudioBuffer.h | ||
void Interleave
(
const TAudioBuffer< DataType >& Other |
Interleave the Other data set into this one. this one ends up interleaved. | HarmonixDsp/AudioBuffer.h | |
void Interleave
(
const TAudioBuffer< DataType >& Other, |
HarmonixDsp/AudioBuffer.h | ||
void MultiplyAccumulate
(
const TAudioBuffer< DataType >& Other, |
Merge the Other to this buffer, and apply the specified InGain, which will change by the delta each sample. | HarmonixDsp/AudioBuffer.h | |
void Reset() |
Clears the buffer and deletes the data if CleanupMode == EAudioBufferCleanupMode::Delete | HarmonixDsp/AudioBuffer.h | |
bool Saturate
(
DataType MinValue, |
HarmonixDsp/AudioBuffer.h | ||
bool SaturateWithNANCheck
(
DataType MinValue, |
HarmonixDsp/AudioBuffer.h | ||
void Scale
(
float InFactor |
HarmonixDsp/AudioBuffer.h | ||
void SetAliasedChannelData
(
DataType** InData, |
HarmonixDsp/AudioBuffer.h | ||
void SetChannelData
(
int32 InChannelIndex, |
HarmonixDsp/AudioBuffer.h | ||
void SetChannelLayout
(
EAudioBufferChannelLayout InChannelLayout |
HarmonixDsp/AudioBuffer.h | ||
void SetChannelMask
(
uint16 InMask |
HarmonixDsp/AudioBuffer.h | ||
void SetFirstFrame
(
int32 InFirstFrame |
HarmonixDsp/AudioBuffer.h | ||
void SetIsSilent
(
bool InIsSilent |
HarmonixDsp/AudioBuffer.h | ||
void SetLengthInFrames
(
int32 InLength |
HarmonixDsp/AudioBuffer.h | ||
void SetNumValidChannels
(
int32 InNumChannels |
HarmonixDsp/AudioBuffer.h | ||
void SetNumValidFrames
(
int32 InNumFrames |
HarmonixDsp/AudioBuffer.h | ||
void SetSampleRate
(
float InSampleRateHz |
HarmonixDsp/AudioBuffer.h | ||
void SwapEndianness() |
HarmonixDsp/AudioBuffer.h | ||
void ZeroData() |
HarmonixDsp/AudioBuffer.h | ||
void ZeroValidFrames() |
HarmonixDsp/AudioBuffer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool _UseSIMD () |
HarmonixDsp/AudioBuffer.h | ||
static int32 GetBytesPerSample() |
HarmonixDsp/AudioBuffer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const TAudioBuffer< DataType >& Other |
HarmonixDsp/AudioBuffer.h | ||
TAudioBuffer< DataType > & operator*=
(
const TAudioBuffer< DataType >& Other |
HarmonixDsp/AudioBuffer.h | ||
DataType * operator[]
(
int32 Index |
HarmonixDsp/AudioBuffer.h | ||
void operator=
(
const TAudioBuffer& Other |
HarmonixDsp/AudioBuffer.h | ||
bool operator==
(
const TAudioBuffer< DataType >& Other |
HarmonixDsp/AudioBuffer.h |