1. Epic GamesDeveloper
  3. FAudioOscilloscope

FAudioOscilloscope

API > API/Plugins > API/Plugins/AudioWidgets

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

Syntax

class FAudioOscilloscope : public AudioWidgets::IAudioAnalyzerRackUnit

Constructors

Name Remarks Include Path Unreal Specifiers

FAudioOscilloscope ( Audio::FDeviceId InAudioDeviceId,
const uint32 InNumChannels,
const float InTimeWindowMs,
const float InMaxTimeWindowMs,
const float InAnalysisPeriodMs,
const EAudioPanelLayoutType InPanelLayoutType,
const FAudioOscilloscopePanelStyle* InOscilloscopePanelStyle,
TObjectPtr< UAudioBus > InExternalAudioBus
)

   AudioOscilloscope.h  

Constants

Name Type Remarks Include Path
RackUnitAnalysisPeriodMs float   AudioOscilloscope.h
RackUnitMaxTimeWindowMs float   AudioOscilloscope.h
RackUnitPanelLayoutType EAudioPanelLayoutType   AudioOscilloscope.h
RackUnitTimeWindowMs float   AudioOscilloscope.h
RackUnitTypeInfo const FAudioAnalyzerRackUnitTypeInfo   AudioOscilloscope.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioBus TStrongObjectPtr< UAudioBus >   AudioOscilloscope.h  
AudioSamplesDataProvider TSharedPtr< FWaveformAudioSamplesDataProvider >   AudioOscilloscope.h  
OscilloscopePanelStyle FAudioOscilloscopePanelStyle   AudioOscilloscope.h  
OscilloscopePanelWidget TSharedPtr< SAudioOscilloscopePanelWidget >   AudioOscilloscope.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CreateAudioBus ( const uint32 InNumChannels
)

   AudioOscilloscope.h  

void CreateDataProvider ( Audio::FDeviceId InAudioDeviceId,
const float InTimeWindowMs,
const float InMaxTimeWindowMs,
const float InAnalysisPeriodMs,
const EAudioPanelLayoutType InPanelLayoutType
)

   AudioOscilloscope.h  

void CreateOscilloscopeWidget ( const uint32 InNumChannels,
const EAudioPanelLayoutType InPanelLayoutType,
const FAudioOscilloscopePanelStyle* InOscilloscopePanelStyle
)

   AudioOscilloscope.h  

UAudioBus * GetAudioBus()

   AudioOscilloscope.h  

TSharedRef< SWidget > GetPanelWidget()

   AudioOscilloscope.h  

Overridden from IAudioAnalyzerRackUnit

Name Remarks Include Path Unreal Specifiers

virtual void SetAudioBusInfo ( const FAudioBusInfo& AudioBusInfo
)

 If the Audio Bus to analyze changes (due to channel count change), handle this here. AudioOscilloscope.h  

virtual TSharedRef< SDockTab > SpawnTab ( const FSpawnTabArgs& Args
) const

 Spawn the actual analyzer Widget in a DockTab. AudioOscilloscope.h  

virtual void StartProcessing()

 Be notified of request to start processing. AudioOscilloscope.h  

virtual void StopProcessing()

 Be notified of request to stop processing. AudioOscilloscope.h  

Static

Name Remarks Include Path Unreal Specifiers
  AudioOscilloscope.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page