Navigation
API > API/Plugins > API/Plugins/AudioWidgets
| Name | FWaveformAudioSamplesDataProvider |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/WaveformAudioSamplesDataProvider.h |
| Include Path | #include "WaveformAudioSamplesDataProvider.h" |
Syntax
class FWaveformAudioSamplesDataProvider :
public IFixedSampledSequenceViewProvider ,
public TSharedFromThis< FWaveformAudioSamplesDataProvider >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FWaveformAudioSamplesDataProvider
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWaveformAudioSamplesDataProvider
(
const Audio::FDeviceId InAudioDeviceId, |
WaveformAudioSamplesDataProvider.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FWaveformAudioSamplesDataProvider() |
WaveformAudioSamplesDataProvider.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnDataViewGenerated | FOnDataViewGenerated | WaveformAudioSamplesDataProvider.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnalysisPeriodSamples | uint32 | WaveformAudioSamplesDataProvider.h | ||
| AudioBus | UAudioBus * | WaveformAudioSamplesDataProvider.h | ||
| AudioSamplesCircularBuffer | Audio::TCircularAudioBuffer< float > | WaveformAudioSamplesDataProvider.h | ||
| AudioSamplesForView | TArray< float > | WaveformAudioSamplesDataProvider.h | ||
| bHasTriggered | bool | WaveformAudioSamplesDataProvider.h | ||
| bIsProcessing | bool | WaveformAudioSamplesDataProvider.h | ||
| ChannelIndexToAnalyze | int32 | WaveformAudioSamplesDataProvider.h | ||
| DataView | FFixedSampledSequenceView | WaveformAudioSamplesDataProvider.h | ||
| MaxTimeWindowMs | float | WaveformAudioSamplesDataProvider.h | ||
| MixerDevice | const Audio::FMixerDevice * | WaveformAudioSamplesDataProvider.h | ||
| NumChannels | uint32 | WaveformAudioSamplesDataProvider.h | ||
| NumChannelsToProvide | uint32 | WaveformAudioSamplesDataProvider.h | ||
| NumSamplesPushedToCircularBuffer | uint32 | WaveformAudioSamplesDataProvider.h | ||
| PatchOutput | Audio::FPatchOutputStrongPtr | WaveformAudioSamplesDataProvider.h | ||
| SampleRate | uint32 | WaveformAudioSamplesDataProvider.h | ||
| TempAudioBuffer | TArray< float > | WaveformAudioSamplesDataProvider.h | ||
| TickerHandle | FTSTicker::FDelegateHandle | WaveformAudioSamplesDataProvider.h | ||
| TimeWindowSamples | uint32 | WaveformAudioSamplesDataProvider.h | ||
| TriggerMode | EAudioOscilloscopeTriggerMode | WaveformAudioSamplesDataProvider.h | ||
| TriggerThreshold | float | WaveformAudioSamplesDataProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UAudioBus * GetAudioBus() |
WaveformAudioSamplesDataProvider.h | ||
FFixedSampledSequenceView GetDataView() |
WaveformAudioSamplesDataProvider.h | ||
float GetMaxTimeWindowMs() |
WaveformAudioSamplesDataProvider.h | ||
uint32 GetNumChannels() |
WaveformAudioSamplesDataProvider.h | ||
void ResetAudioBuffers() |
WaveformAudioSamplesDataProvider.h | ||
void SetAnalysisPeriod
(
const float InAnalysisPeriodMs |
WaveformAudioSamplesDataProvider.h | ||
void SetChannelToAnalyze
(
const int32 InChannel |
WaveformAudioSamplesDataProvider.h | ||
void SetMaxTimeWindowMs
(
const float InMaxTimeWindowMs |
WaveformAudioSamplesDataProvider.h | ||
void SetTimeWindow
(
const float InTimeWindowMs |
WaveformAudioSamplesDataProvider.h | ||
void SetTriggerMode
(
const EAudioOscilloscopeTriggerMode InTriggerMode |
WaveformAudioSamplesDataProvider.h | ||
void SetTriggerThreshold
(
const float InTriggerThreshold |
WaveformAudioSamplesDataProvider.h | ||
void StartProcessing() |
WaveformAudioSamplesDataProvider.h | ||
void StopProcessing() |
WaveformAudioSamplesDataProvider.h |
Overridden from IFixedSampledSequenceViewProvider
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFixedSampledSequenceView RequestSequenceView
(
const TRange< double > DataRatioRange |
WaveformAudioSamplesDataProvider.h |