1. Epic GamesDeveloper
  3. SAudioSpectrumPlot

SAudioSpectrumPlot

Slate Widget for plotting an audio power spectrum, with linear or log frequency scale, and decibels sound levels.

API > API/Plugins > API/Plugins/AudioWidgets

Slate Widget for plotting an audio power spectrum, with linear or log frequency scale, and decibels sound levels.

   
Name SAudioSpectrumPlot
Type class
Header File /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/SAudioSpectrumPlot.h
Include Path #include "SAudioSpectrumPlot.h"

Syntax

class SAudioSpectrumPlot : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Constants

Name Type Remarks Include Path
ClampMinSoundLevel const float   SAudioSpectrumPlot.h
ContextMenuExtensionHook FName   SAudioSpectrumPlot.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AxisLabelColor TAttribute< FSlateColor >   SAudioSpectrumPlot.h  
BackgroundColor TAttribute< FSlateColor >   SAudioSpectrumPlot.h  
bAllowContextMenu TAttribute< bool >   SAudioSpectrumPlot.h  
bDisplayCrosshair TAttribute< bool >   SAudioSpectrumPlot.h  
bDisplayFrequencyAxisLabels TAttribute< bool >   SAudioSpectrumPlot.h  
bDisplayFrequencyGridLines TAttribute< bool >   SAudioSpectrumPlot.h  
bDisplaySoundLevelAxisLabels TAttribute< bool >   SAudioSpectrumPlot.h  
bDisplaySoundLevelGridLines TAttribute< bool >   SAudioSpectrumPlot.h  
ContextMenuExtender TSharedPtr< FExtender >   SAudioSpectrumPlot.h  
CrosshairColor TAttribute< FSlateColor >   SAudioSpectrumPlot.h  
FrequencyAxisPixelBucketMode TAttribute< EAudioSpectrumPlotFrequencyAxisPixelBucketMode >   SAudioSpectrumPlot.h  
FrequencyAxisScale TAttribute< EAudioSpectrumPlotFrequencyAxisScale >   SAudioSpectrumPlot.h  
GridColor TAttribute< FSlateColor >   SAudioSpectrumPlot.h  
OnContextMenuOpening FOnContextMenuOpening   SAudioSpectrumPlot.h  
OnDisplayFrequencyAxisLabelsButtonToggled FOnDisplayAxisLabelsButtonToggled   SAudioSpectrumPlot.h  
OnDisplaySoundLevelAxisLabelsButtonToggled FOnDisplayAxisLabelsButtonToggled   SAudioSpectrumPlot.h  
OnFrequencyAxisPixelBucketModeMenuEntryClicked FOnFrequencyAxisPixelBucketModeMenuEntryClicked   SAudioSpectrumPlot.h  
OnFrequencyAxisScaleMenuEntryClicked FOnFrequencyAxisScaleMenuEntryClicked   SAudioSpectrumPlot.h  
OnGetAudioSpectrumData FGetAudioSpectrumData   SAudioSpectrumPlot.h  
OnTiltSpectrumMenuEntryClicked FOnTiltSpectrumMenuEntryClicked   SAudioSpectrumPlot.h  
SelectedFrequency TAttribute< TOptional< float > >   SAudioSpectrumPlot.h  
SpectrumColor TAttribute< FSlateColor >   SAudioSpectrumPlot.h  
Style const FAudioSpectrumPlotStyle *   SAudioSpectrumPlot.h  
TiltExponent TAttribute< float >   SAudioSpectrumPlot.h  
TiltPivotFrequency TAttribute< float >   SAudioSpectrumPlot.h  
ViewMaxFrequency TAttribute< float >   SAudioSpectrumPlot.h  
ViewMaxSoundLevel TAttribute< float >   SAudioSpectrumPlot.h  
ViewMinFrequency TAttribute< float >   SAudioSpectrumPlot.h  
ViewMinSoundLevel TAttribute< float >   SAudioSpectrumPlot.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< const FExtensionBase > AddContextMenuExtension ( EExtensionHook::Position HookPosition,
const TSharedPtr< FUICommandList >& CommandList,
const FMenuExtensionDelegate& MenuExtensionDelegate
)

   SAudioSpectrumPlot.h  

void Construct ( const FArguments& InArgs
)

 Constructs this widget with InArgs SAudioSpectrumPlot.h  
  SAudioSpectrumPlot.h  

void RemoveContextMenuExtension ( const TSharedRef< const FExtensionBase >& Extension
)

   SAudioSpectrumPlot.h  

void SetAllowContextMenu ( bool bInAllowContextMenu
)

   SAudioSpectrumPlot.h  

void SetDisplayCrosshair ( bool bInDisplayCrosshair
)

   SAudioSpectrumPlot.h  

void SetDisplayFrequencyAxisLabels ( bool bInDisplayFrequencyAxisLabels
)

   SAudioSpectrumPlot.h  

void SetDisplayFrequencyGridLines ( bool bInDisplayFrequencyGridLines
)

   SAudioSpectrumPlot.h  

void SetDisplaySoundLevelAxisLabels ( bool bInDisplaySoundLevelAxisLabels
)

   SAudioSpectrumPlot.h  

void SetDisplaySoundLevelGridLines ( bool bInDisplaySoundLevelGridLines
)

   SAudioSpectrumPlot.h  

void SetFrequencyAxisPixelBucketMode ( EAudioSpectrumPlotFrequencyAxisPixelBucketMode InFrequencyAxisPixelBucketMode
)

   SAudioSpectrumPlot.h  

void SetFrequencyAxisScale ( EAudioSpectrumPlotFrequencyAxisScale InFrequencyAxisScale
)

   SAudioSpectrumPlot.h  

void SetSelectedFrequency ( TOptional< float > InSelectedFrequency
)

   SAudioSpectrumPlot.h  

void SetTiltExponent ( float InTiltExponent
)

   SAudioSpectrumPlot.h  

void SetTiltPivotFrequency ( float InTiltPivotFrequency
)

   SAudioSpectrumPlot.h  

void SetViewMaxFrequency ( float InViewMaxFrequency
)

   SAudioSpectrumPlot.h  

void SetViewMaxSoundLevel ( float InViewMaxSoundLevel
)

   SAudioSpectrumPlot.h  

void SetViewMinFrequency ( float InViewMinFrequency
)

   SAudioSpectrumPlot.h  

void SetViewMinSoundLevel ( float InViewMinSoundLevel
)

   SAudioSpectrumPlot.h  

void UnbindOnGetAudioSpectrumData()

   SAudioSpectrumPlot.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnMouseButtonDown ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

   SAudioSpectrumPlot.h  

virtual FReply OnMouseButtonUp ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

   SAudioSpectrumPlot.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   SAudioSpectrumPlot.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SAudioSpectrumPlot.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GetSpectrumLinePoints ( TArray< FVector2f >& OutLinePoints,
TConstArrayView< FVector2f > DataPoints,
const FAudioSpectrumPlotScaleInfo& ScaleInfo,
TFunctionRef< float(const FVector2f&DataPoint)> CostFunction
)

 This is a function to reduce the given array of data points to a possibly shorter array of points that will form the line to be plotted. SAudioSpectrumPlot.h  

static float GetTiltExponentValue ( const EAudioSpectrumPlotTilt InTilt
)

   SAudioSpectrumPlot.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page