Navigation
| Name | AudioInsights |
| Type | Plugin |
| Part of Plugins | Audio Insights |
| Location | /Engine/Plugins/AudioInsights/Source/AudioInsights/ |
| Module Build Rules | AudioInsights.Build.cs |
Classes
Structs
Interfaces
| Name | Remarks |
|---|---|
| IAudioCachedMessage | |
| IAudioInsightsModule | |
| IAudioInsightsModuleInterface | |
| IAudioInsightsTraceModule | |
| IDashboardDataTreeViewEntry | |
| IDashboardDataViewEntry | |
| IDashboardFactory | |
| IDashboardViewFactory | |
| IObjectDashboardEntry | |
| IObjectTreeDashboardEntry | Tree view entries can inherit from this class to implement extra UObject functionality (ex: open, browse, edit, etc.) |
| ISignalFlowNode | ISignalFlowNode : Class that holds data on a node's position, order, inputs, outputs etc. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDataPoint | TPair< double, float > | Dashboard entry. | AudioInsightsDataSource.h |
| FEventLogFilterID | int32 | Views/AudioEventLogDashboardViewFactory.h | |
| FIsEntryFilteredOutByText | TBaseDelegate_OneParam< bool, const FSignalFlowDashboardEntry & > | Views/SSignalFlowGraph.h | |
| FIsInHighlightedPath | TBaseDelegate_OneParam< bool, const FSignalFlowEntryKey & > | Views/SSignalFlowGraph.h | |
| FOnSignalFlowNodeContextMenuOpened | TBaseDelegate_TwoParams< void, const FPointerEvent &, const TSharedPtr< FSignalFlowDashboardEntry > > | Views/SSignalFlowGraphNode.h | |
| FOnSignalFlowNodeSelected | TBaseDelegate_OneParam< void, TSharedPtr< FSignalFlowDashboardEntry > > | Views/SSignalFlowGraphNode.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAudioAmplitudeDisplayMode | EAudioAmplitudeDisplayModeThe units that audio amplitude and volume values are displayed in |
| ESignalFlowJustification | ESignalFlowJustificationWhere the nodes in the signal flow graph are aligned |
| ESoundDashboardAutoExpandOptions | ESoundDashboardAutoExpandOptions |
| ESoundDashboardTreeViewingOptions | ESoundDashboardTreeViewingOptions |
| EStopCacheWhenPausedBehaviour | EStopCacheWhenPausedBehaviourControls whether the cache stops collecting new data when paused. |
| UE::Audio::Insights::EAudioBusType | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::EAudioEventCacheState | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::EAudioEventLogSoundCategory | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ECacheAndProcess | How the cache manage handles new incoming messages Cache - will save the incoming message inside the cache to be retrievable later Process - sends the message to the AudioInsights providers to be processed and displayed in the UI |
| UE::Audio::Insights::EDefaultDashboardTabStack | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::EMuteSoloMode | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ESignalFlowEntryType | Which render stage does this node belong to. |
| UE::Audio::Insights::ESignalFlowNodeDetailParam | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ESoundDashboardEntryType | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ESoundDashboardFilterFlags | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ESystemControllingTimeMarker | Copyright Epic Games, Inc. All Rights Reserved. |
| UE::Audio::Insights::ETraceMode | Copyright Epic Games, Inc. All Rights Reserved. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| UE::Audio::Insights::INVALID_TIMEOUT | double | Messages/SoundTraceMessages.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioLoggerName | const ANSICHAR * | AudioInsightsConstants.h | ||
| MetaSoundSource | const FString | Messages/SoundTraceMessages.h | ||
| SoundCue | const FString | Messages/SoundTraceMessages.h | ||
| SoundCueTemplate | const FString | Messages/SoundTraceMessages.h | ||
| SoundWave | const FString | Messages/SoundTraceMessages.h | ||
| SoundWaveProcedural | const FString | Messages/SoundTraceMessages.h | ||
| TimestampFieldName | const ANSICHAR * | AudioInsightsConstants.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const T & UE::Audio::Insights::CastEntry
(
const IDashboardDataViewEntry& InData |
AudioInsightsDataSource.h | ||
bool UE::Audio::Insights::operator!
(
ESoundDashboardFilterFlags E |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags UE::Audio::Insights::operator&
(
ESoundDashboardFilterFlags Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags & UE::Audio::Insights::operator&=
(
ESoundDashboardFilterFlags& Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags UE::Audio::Insights::operator^
(
ESoundDashboardFilterFlags Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags & UE::Audio::Insights::operator^=
(
ESoundDashboardFilterFlags& Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags UE::Audio::Insights::operator|
(
ESoundDashboardFilterFlags Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags & UE::Audio::Insights::operator|=
(
ESoundDashboardFilterFlags& Lhs, |
Views/SoundDashboardViewFactory.h | ||
ESoundDashboardFilterFlags UE::Audio::Insights::operator~
(
ESoundDashboardFilterFlags E |
Views/SoundDashboardViewFactory.h |