Navigation
API > API/Plugins > API/Plugins/WaveTable
Serialized WaveTable data, that supports multiple bit depth formats.
| Name | FWaveTableData |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/WaveTable/Source/WaveTable/Public/WaveTable.h |
| Include Path | #include "WaveTable.h" |
Syntax
USTRUCT (BlueprintType )
struct FWaveTableData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWaveTableData
(
TArrayView< const int16 > InSamples, |
WaveTable.h | ||
FWaveTableData
(
TArrayView< const float > InSamples, |
WaveTable.h | ||
FWaveTableData
(
EWaveTableBitDepth InBitDepth |
WaveTable.h | ||
| WaveTable.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BitDepth | EWaveTableBitDepth | WaveTable.h |
|
|
| Data | TArray< uint8 > | WaveTable.h | ||
| FinalValue | float | WaveTable.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ArrayMixIn
(
TArrayView< float > OutputWaveSamples, |
Adds this WaveTableData's internal contents to the given float buffer view, initially performing bit depth conversion to values to IEEE_FLOAT if required. | WaveTable.h | |
void Empty() |
Empties the underlying data container, deallocating memory and invalidating the FinalValue. | WaveTable.h | |
EWaveTableBitDepth GetBitDepth() |
WaveTable.h | ||
bool GetDataView
(
TArrayView< float >& OutData |
WaveTable.h | ||
bool GetDataView
(
TArrayView< const float >& OutData |
Returns true if ArrayView of underlying Data in the proper sample format, setting OutData to a view of the Table's data. | WaveTable.h | |
bool GetDataView
(
TArrayView< const int16 >& OutData |
WaveTable.h | ||
bool GetDataView
(
TArrayView< int16 >& OutData |
WaveTable.h | ||
float GetFinalValue () |
Returns the value to interpolate to beyond the last value of the DataView. | WaveTable.h | |
float GetLastValue() |
Returns the last data value value as a float. If DataView is empty, returns 0. | WaveTable.h | |
int32 GetNumSamples () |
Returns number of samples within the underlying DataView, not including a FinalValue if set. | WaveTable.h | |
const TArray< uint8 > & GetRawData() |
Returns read-only view of byte array that stores sample data. | WaveTable.h | |
bool IsEmpty() |
Whether or not the underlying data is empty. | WaveTable.h | |
bool Resample
(
int32 InCurrentSampleRate, |
Resamples the underlying data to a provided new sample rate. | WaveTable.h | |
void Reset
(
int32 NumSamples |
Resets the underlying data to the given number of samples. | WaveTable.h | |
bool SetBitDepth
(
EWaveTableBitDepth InBitDepth |
Converts bit depth and sets internal data to the requested bit depth. | WaveTable.h | |
void SetData
(
TArrayView< const float > InData, |
WaveTable.h | ||
void SetData
(
TArrayView< const int16 > InData, |
WaveTable.h | ||
void SetFinalValue
(
float InFinalValue |
WaveTable.h | ||
void SetRawData
(
EWaveTableBitDepth InBitDepth, |
WaveTable.h | ||
void SetRawData
(
EWaveTableBitDepth InBitDepth, |
WaveTable.h | ||
void Zero
(
int32 InNumSamples |
Zeros the underlying data. | WaveTable.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetBitDepthPropertyName() |
WaveTable.h |