UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FHighlightRecorder Class Referencefinal

#include <HighlightRecorder.h>

+ Inheritance diagram for FHighlightRecorder:

Public Types

enum class  EState { Stopped , Recording , Paused }
 
using FDoneCallback = TFunction< void(bool, const FString &)>
 

Public Member Functions

 FHighlightRecorder ()
 
 ~FHighlightRecorder ()
 
EState GetState () const
 
bool Start (double RingBufferDurationSecs)
 
bool Pause (bool bPause)
 
void Stop ()
 
bool IsSaving () const
 
bool SaveHighlight (const TCHAR *Filename, FDoneCallback DoneCallback, double MaxDurationSecs=1.0 *60 *60)
 

Static Public Member Functions

static void Start (const TArray< FString > &Args, UWorld *, FOutputDevice &Output)
 
static void StopCmd ()
 
static void PauseCmd ()
 
static void ResumeCmd ()
 
static void SaveCmd (const TArray< FString > &Args, UWorld *, FOutputDevice &Output)
 

Member Typedef Documentation

◆ FDoneCallback

Member Enumeration Documentation

◆ EState

Enumerator
Stopped 
Recording 
Paused 

Constructor & Destructor Documentation

◆ FHighlightRecorder()

FHighlightRecorder::FHighlightRecorder ( )

◆ ~FHighlightRecorder()

FHighlightRecorder::~FHighlightRecorder ( )

Member Function Documentation

◆ GetState()

EState FHighlightRecorder::GetState ( ) const
inline

◆ IsSaving()

bool FHighlightRecorder::IsSaving ( ) const
inline

◆ Pause()

bool FHighlightRecorder::Pause ( bool  bPause)

◆ PauseCmd()

static void FHighlightRecorder::PauseCmd ( )
inlinestatic

◆ ResumeCmd()

static void FHighlightRecorder::ResumeCmd ( )
inlinestatic

◆ SaveCmd()

static void FHighlightRecorder::SaveCmd ( const TArray< FString > &  Args,
UWorld ,
FOutputDevice Output 
)
inlinestatic

◆ SaveHighlight()

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool FHighlightRecorder::SaveHighlight ( const TCHAR Filename,
FDoneCallback  DoneCallback,
double  MaxDurationSecs = 1.0 * 60 * 60 
)

◆ Start() [1/2]

static void FHighlightRecorder::Start ( const TArray< FString > &  Args,
UWorld ,
FOutputDevice Output 
)
inlinestatic

◆ Start() [2/2]

bool FHighlightRecorder::Start ( double  RingBufferDurationSecs)

◆ Stop()

void FHighlightRecorder::Stop ( )

◆ StopCmd()

static void FHighlightRecorder::StopCmd ( )
inlinestatic

The documentation for this class was generated from the following files: