UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMediaRecorder Class Reference

#include <MediaRecorder.h>

Classes

struct  FMediaRecorderData
 

Public Types

enum class  EMediaRecorderNumerationStyle { AppendFrameNumber , AppendSampleTime }
 

Public Member Functions

MEDIAUTILS_API FMediaRecorder ()
 
MEDIAUTILS_API void StartRecording (const FMediaRecorderData &InRecoderData)
 
MEDIAUTILS_API void StopRecording ()
 
bool IsRecording () const
 
MEDIAUTILS_API bool WaitPendingTasks (const FTimespan &InDuration)
 

Protected Member Functions

MEDIAUTILS_API void TickRecording ()
 

Friends

class FMediaRecorderClockSink
 

Detailed Description

Records samples from a media player. Loop, seek or reverse and not supported. Currently only records texture samples and that support sample format 8bit BGRA, half float RBGA

Member Enumeration Documentation

◆ EMediaRecorderNumerationStyle

Enumerator
AppendFrameNumber 
AppendSampleTime 

Constructor & Destructor Documentation

◆ FMediaRecorder()

FMediaRecorder::FMediaRecorder ( )

Default constructor.

Member Function Documentation

◆ IsRecording()

bool FMediaRecorder::IsRecording ( ) const
inline

Is currently recording media samples.

◆ StartRecording()

void FMediaRecorder::StartRecording ( const FMediaRecorderData InRecoderData)

Start recording samples from a given media player.

◆ StopRecording()

void FMediaRecorder::StopRecording ( )

Stop recording media samples.

◆ TickRecording()

void FMediaRecorder::TickRecording ( )
protected

Tick the recorder.

Parameters
TimecodeThe current timecode.

◆ WaitPendingTasks()

bool FMediaRecorder::WaitPendingTasks ( const FTimespan InDuration)

Blocking call that will wait for all frames to be recorded before returning.

Friends And Related Symbol Documentation

◆ FMediaRecorderClockSink


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