FGenericVideoRecordingSystem Class Reference

#include <VideoRecordingSystem.h>

Inheritance diagram for FGenericVideoRecordingSystem:

Public Member Functions
virtual void	EnableRecording (const bool bEnableRecording) override
virtual bool	IsEnabled () const override
virtual bool	NewRecording (const TCHAR *DestinationFileName, FVideoRecordingParameters Parameters=FVideoRecordingParameters()) override
virtual void	StartRecording () override
virtual void	PauseRecording () override
virtual uint64	GetMinimumRecordingSeconds () const override
virtual uint64	GetMaximumRecordingSeconds () const override
virtual float	GetCurrentRecordingSeconds () const override
virtual void	FinalizeRecording (const bool bSaveRecording, const FText &Title, const FText &Comment, const bool bStopAutoContinue) override
virtual EVideoRecordingState	GetRecordingState () const override
Public Member Functions inherited from IVideoRecordingSystem
virtual	~IVideoRecordingSystem ()
FVideoRecordingFinalized &	GetOnVideoRecordingFinalizedDelegate ()

Additional Inherited Members
Protected Attributes inherited from IVideoRecordingSystem
FVideoRecordingFinalized	OnVideoRecordingFinalized

Detailed Description

A generic implementation of the video recording system, that doesn't support recording

Member Function Documentation

EnableRecording()

virtual void FGenericVideoRecordingSystem::EnableRecording ( const bool  bEnableRecording )

inlineoverridevirtual

Enables or disables recording if the platform supports it. Useful to prevent users from sharing spoilers.\

Parameters

bEnableRecording

If true, video recording will be allowed. If false, videos will not be recorded.

Implements IVideoRecordingSystem.

FinalizeRecording()

virtual void FGenericVideoRecordingSystem::FinalizeRecording ( const bool  bSaveRecording, const FText &  Title, const FText &  Comment, const bool  bStopAutoContinue  )

inlineoverridevirtual

Stops recording and prepares the final video file for use.

Parameters

bSaveRecording	If true, the recording will be saved. If false, the recording will be discarded.
bStopAutoContinue	If true, a auto-continue recording will be stopped.
Title	The title to use for the final video
Comment	A comment to store with the final video

Implements IVideoRecordingSystem.

GetCurrentRecordingSeconds()

virtual float FGenericVideoRecordingSystem::GetCurrentRecordingSeconds ( ) const

inlineoverridevirtual

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

Implements IVideoRecordingSystem.

GetMaximumRecordingSeconds()

virtual uint64 FGenericVideoRecordingSystem::GetMaximumRecordingSeconds ( ) const

inlineoverridevirtual

Implements IVideoRecordingSystem.

GetMinimumRecordingSeconds()

virtual uint64 FGenericVideoRecordingSystem::GetMinimumRecordingSeconds ( ) const

inlineoverridevirtual

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

Implements IVideoRecordingSystem.

GetRecordingState()

virtual EVideoRecordingState FGenericVideoRecordingSystem::GetRecordingState ( ) const

inlineoverridevirtual

Returns the current state of video recording.

Implements IVideoRecordingSystem.

IsEnabled()

virtual bool FGenericVideoRecordingSystem::IsEnabled ( ) const

inlineoverridevirtual

Returns whether recording is currently enabled.

Implements IVideoRecordingSystem.

NewRecording()

virtual bool FGenericVideoRecordingSystem::NewRecording ( const TCHAR *  DestinationFileName, FVideoRecordingParameters  Parameters = FVideoRecordingParameters()  )

inlineoverridevirtual

Initializes a new video recording.

By default does not start capturing, will not start again after saving and will export to the library. Use GetOnVideoRecordingFinalizedDelegate to retrieve the final filepath.

Parameters

DestinationFileName	The base name of the resulting video, without a path or extension.
Parameters	the parameters for this recording

Returns

True if opening the recording succeeded, false otherwise.

Implements IVideoRecordingSystem.

PauseRecording()

virtual void FGenericVideoRecordingSystem::PauseRecording ( )

inlineoverridevirtual

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

Implements IVideoRecordingSystem.

StartRecording()

virtual void FGenericVideoRecordingSystem::StartRecording ( )

inlineoverridevirtual

Begins capturing video after a call to NewRecording or PauseRecording.

Implements IVideoRecordingSystem.

---

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

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