FWaveformEditorSequenceDataProvider | Unreal Engine 5.0 Documentation

API > API/Plugins > API/Plugins/WaveformEditorWidgets

Inheritance Hierarchy

IFixedSampledSequenceViewProvider
TSharedFromThis
FWaveformEditorSequenceDataProvider

References


Module	WaveformEditorWidgets
Header	/Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditorWidgets/Public/WaveformEditorSequenceDataProvider.h
Include	#include "WaveformEditorSequenceDataProvider.h"

Syntax

class FWaveformEditorSequenceDataProvider :  
    public IFixedSampledSequenceViewProvider,  
    public TSharedFromThis< FWaveformEditorSequenceDataProvider >

Remarks

FWaveformEditorSequenceDataProvider

The Waveform Editor Sequence data provider can produce UI to display a chain of waveform transformations.

The main UI elements created are: TransformedPCMData : a float array containing the transformed samples of the waveform, that can be requested through the Transform Layers : an array of UI renderers for each transformation in the chain. Renderers should be contained in dummy widgets.

These are created so that the entire stack of transformation is displayable. E.g: if a 10s long file is trimmed from second 2, seconds 0 to 1 will still be present in the render data. UI widgets are passed a struct with information about the transformation to display property (e.g. StartFrameOffset, SampleDuration, etc.).

UIs for different transformations are registered with and spawned by FWaveformTransformationRenderLayerFactory. Transformations don't necessarily have a widget UI. In that case, they are only reflected in the render data.

Variables

Type	Name	Description
FOnDataViewGenerated	OnDataViewGenerated	Called when new data view is generated
FOnLayersChainGenerated	OnLayersChainGenerated	Called when a new layer chain of transformations UI is created
FOnRenderElementsUpdated	OnRenderElementsUpdated	Called when the different render elements are updated

Constructors

	Type	Name	Description
		FWaveformEditorSequenceDataProvider ( TObjectPtr< USoundWave > InSoundWave, FOnTransformationsPropertiesRequired InTransformationChainPropertiesHandler )

Functions

Type	Name	Description
void	GenerateLayersChain ()	Used to generate the stack of transformations UI Should be called when the waveform transformation chain is changed
const TRange< double >	GetTransformedWaveformBounds ()
TArrayView< const FTransformationRenderLayerInfo >	GetTransformLayers ()
void	UpdateRenderElements ()	Used to generate updated sequence data and pass transformation info to the widgets Should be called when the transformations parameters are changed