FAudioDebugger

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Audio/AudioDebug.h

Include

#include "Audio/AudioDebug.h"

Syntax

class FAudioDebugger

Constructors

Name Description

Public function

FAudioDebugger()

Audio Debugger Implementation

Functions

Name Description

Public function

void

 

ClearMutesAndSolos()

Public function Static

void

 

ClearStats

(
    const uint32 StatsToToggle,
    UWorld* InWorld
)

Public function Static

void

 

DrawDebugInfo

(
    const FActiveSound& ActiveSound,
    const TArray< FWaveInstance* >...,
    const float DeltaTime
)

Public function Static

void

 

DrawDebugInfo

(
    const FAudioVirtualLoop& VirtualLo...
)

Public function Static

void

 

DrawDebugInfo

(
    const FSoundSource& SoundSource
)

Public function Static

void

 

DrawDebugInfo

(
    UWorld& World,
    const TArray< FListener >& Listene...
)

Public function Static

int32

 

DrawDebugStats

(
    UWorld& World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 Y
)

Public function Static

bool

 

DrawDebugStatsEnabled()

Public function Const

void

 

DumpActiveSounds()

Public function

bool

 

GetAudioDebugSound

(
    FString& OutDebugSound
)

Public function Const

const FStrin...

 

GetAudioMixerDebugSoundName()

Public function Const

bool

 

IsMuteSoundClass

(
    FName InName
)

Public function Const

bool

 

IsMuteSoundCue

(
    FName InName
)

Public function Const

bool

 

IsMuteSoundWave

(
    FName InName
)

Public function Const

bool

 

IsSoloSoundClass

(
    FName InName
)

Is Mute/Solos. (only audio thread).

Public function Const

bool

 

IsSoloSoundCue

(
    FName InName
)

Public function Const

bool

 

IsSoloSoundWave

(
    FName InName
)

Public function Const

bool

 

IsVisualizeDebug3dEnabled()

Public function Static

void

 

LogSubtitle

(
    const TCHAR* InCmd,
    USoundWave& InSoundWave
)

Public function Static

void

 

OnBeginPIE()

Public function Static

void

 

OnEndPIE()

Public function Static

bool

 

PostStatModulatorHelp

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function Const

void

 

QuerySoloMuteSoundClass

(
    const FString& Name,
    bool& bOutIsSoloed,
    bool& bOutIsMuted,
    FString& OutReason
)

Evaluate Mute/Solos.

Public function Const

void

 

QuerySoloMuteSoundCue

(
    const FString& Name,
    bool& bOutIsSoloed,
    bool& bOutIsMuted,
    FString& OutReason
)

Public function Const

void

 

QuerySoloMuteSoundWave

(
    const FString& Name,
    bool& bOutIsSoloed,
    bool& bOutIsMuted,
    FString& OutReason
)

Public function Static

void

 

RemoveDevice

(
    const FAudioDevice& AudioDevice
)

Public function Static

int32

 

RenderStatCues

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y
)

Public function Static

int32

 

RenderStatMixes

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y
)

Public function Static

int32

 

RenderStatModulators

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y,
    const FVector* ViewLocation,
    const FRotator* ViewRotation
)

Public function Static

int32

 

RenderStatReverb

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y
)

Public function Static

int32

 

RenderStatSounds

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y
)

Public function Static

int32

 

RenderStatWaves

(
    UWorld* World,
    FViewport* Viewport,
    FCanvas* Canvas,
    int32 X,
    int32 Y
)

Public function Static

void

 

ResolveDesiredStats

(
    FViewportClient* ViewportClien...
)

Public function Static

void

 

SendUpdateResultsToGameThread

(
    const FAudioDevice& AudioDevice,
    const int32 FirstActiveIndex
)

Public function

void

 

SetAudioDebugSound

(
    const TCHAR* SoundName
)

Public function

void

 

SetAudioMixerDebugSound

(
    const TCHAR* SoundName
)

Public function

void

 

SetMuteSoundCue

(
    FName InName,
    bool bInOnOff
)

Set Mute/Solo. (any thread).

Public function

void

 

SetMuteSoundWave

(
    FName InName,
    bool bInOnOff
)

Public function

void

 

SetSoloSoundCue

(
    FName InName,
    bool bInOnOff
)

Public function

void

 

SetSoloSoundWave

(
    FName InName,
    bool bInOnOff
)

Public function Static

void

 

SetStats

(
    const uint32 StatsToToggle,
    UWorld* InWorld
)

Public function

void

 

ToggleMuteSoundClass

(
    FName InName,
    bool bExclusive
)

Public function

void

 

ToggleMuteSoundCue

(
    FName InName,
    bool bExclusive
)

Public function

void

 

ToggleMuteSoundWave

(
    FName InName,
    bool bExclusive
)

Public function

void

 

ToggleSoloSoundClass

(
    FName InName,
    bool bExclusive
)

Mute/Solos toggles. (any thread). (If exclusive, toggle-on will clear everything first, and toggle-off will clear all).

Public function

void

 

ToggleSoloSoundCue

(
    FName InName,
    bool bExclusive
)

Public function

void

 

ToggleSoloSoundWave

(
    FName InName,
    bool bExclusive
)

Public function Static

bool

 

ToggleStatCues

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function Static

bool

 

ToggleStatMixes

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function Static

bool

 

ToggleStatModulators

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function Static

bool

 

ToggleStatSounds

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function Static

bool

 

ToggleStatWaves

(
    UWorld* World,
    FCommonViewportClient* Viewpor...,
    const TCHAR* Stream
)

Public function

void

 

ToggleVisualizeDebug3dEnabled()

Public function Static

void

 

UpdateAudibleInactiveSounds

(
    const uint32 FirstIndex,
    const TArray< FWaveInstance* >...
)

Classes

Name

Description

Public struct

FDebugNames

Struct which contains debug names for run-time debugging of sounds.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss