IVideoRecordingSystem

Interface for platform video recording functionality

Windows
MacOS
Linux

Inheritance Hierarchy

IVideoRecordingSystem

FGenericVideoRecordingSystem

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/VideoRecordingSystem.h

Include

#include "VideoRecordingSystem.h"

Syntax

class IVideoRecordingSystem

Remarks

Interface for platform video recording functionality

Variables

Destructors

Name Description

Public function Virtual

~IVideoRecordingSystem()

Functions

Name Description

Public function

void

 

EnableRecording

(
    const bool bEnableRecording
)

Enables or disables recording if the platform supports it.

Public function

void

 

FinalizeRecording

(
    const bool bSaveRecording,
    const FText& Title,
    const FText& Comment,
    const bool bStopAutoContinue
)

Stops recording and prepares the final video file for use.

Public function Const

float

 

GetCurrentRecordingSeconds()

Returns the current length of time the of the recording, up to RecordingLengthSeconds.

Public function Const

uint64

 

GetMaximumRecordingSeconds()

Public function Const

uint64

 

GetMinimumRecordingSeconds()

The minimum and maximum time available for recording on this platform.

Public function

FVideoRecord...

 

GetOnVideoRecordingFinalizedDelegate()

Public function Const

EVideoRecord...

 

GetRecordingState()

Returns the current state of video recording.

Public function Const

bool

 

IsEnabled()

Returns whether recording is currently enabled.

Public function

bool

 

NewRecording

(
    const TCHAR* DestinationFileNa...,
    FVideoRecordingParameters Parameter...
)

Initializes a new video recording.

Public function

void

 

PauseRecording()

Pauses video recording after a call to StartRecording. Call StartRecording again to resume.

Public function

void

 

StartRecording()

Begins capturing video after a call to NewRecording or PauseRecording.

Deprecated Functions

Name Description

Public function Virtual

FDelegateHan...

 

RegisterVideoRecordingFinalizedDelegate

(
    const FVideoRecordingFinalized::FDe...
)

Use GetOnVideoRecordingFinalizedDelegate

Public function Virtual

void

 

UnregisterVideoRecordingFinalizedDelegate

(
    FDelegateHandle Handle
)

Use GetOnVideoRecordingFinalizedDelegate

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback