Navigation
API > API/Plugins > API/Plugins/AudioWidgets
Maintains a history of spectrogram frames, and presents their visualization by implementing ISlateViewport.
| Name | FAudioSpectrogramViewport |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioSpectrogramViewport.h |
| Include Path | #include "AudioSpectrogramViewport.h" |
Syntax
class FAudioSpectrogramViewport :
public ISlateViewport ,
public TSharedFromThis< FAudioSpectrogramViewport >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAudioSpectrogramViewport
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAudioSpectrogramViewport() |
AudioSpectrogramViewport.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAudioSpectrogramViewport() |
AudioSpectrogramViewport.h |
Classes
| Name | Remarks |
|---|---|
| FHistoryFrameData | Stores one frame of spectrogram data. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| History | TRingBuffer< FHistoryFrameData > | AudioSpectrogramViewport.h | ||
| RenderParams | FAudioSpectrogramViewportRenderParams | AudioSpectrogramViewport.h | ||
| UpdatableTexture | FSlateUpdatableTexture * | AudioSpectrogramViewport.h | ||
| UpdatableTexturePixelFormat | EPixelFormat | AudioSpectrogramViewport.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddFrame
(
const FAudioSpectrogramFrameData& SpectrogramFrameData |
Add the given spectrum frame data to the history buffer. | AudioSpectrogramViewport.h | |
void SetRenderParams
(
const FAudioSpectrogramViewportRenderParams& InRenderParams |
The render params must be set before the FAudioSpectrogramViewport will do anything. | AudioSpectrogramViewport.h |
Overridden from ISlateViewport
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AllowScaling() |
AudioSpectrogramViewport.h | ||
virtual FIntPoint GetSize() |
ISlateViewport interface | AudioSpectrogramViewport.h | |
virtual FSlateShaderResource * GetViewportRenderTargetTexture() |
AudioSpectrogramViewport.h | ||
virtual bool RequiresVsync() |
AudioSpectrogramViewport.h |