IVideoRecordingSystem Class Reference

#include <VideoRecordingSystem.h>

Inheritance diagram for IVideoRecordingSystem:

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

Protected Attributes
FVideoRecordingFinalized	OnVideoRecordingFinalized

Detailed Description

Interface for platform video recording functionality

Constructor & Destructor Documentation

~IVideoRecordingSystem()

virtual IVideoRecordingSystem::~IVideoRecordingSystem ( )

inlinevirtual

Member Function Documentation

EnableRecording()

virtual void IVideoRecordingSystem::EnableRecording ( const bool  bEnableRecording )

pure virtual

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.

Implemented in FGenericVideoRecordingSystem.

FinalizeRecording()

virtual void IVideoRecordingSystem::FinalizeRecording ( const bool  bSaveRecording, const FText &  Title, const FText &  Comment, const bool  bStopAutoContinue = true  )

pure virtual

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

Implemented in FGenericVideoRecordingSystem.

GetCurrentRecordingSeconds()

virtual float IVideoRecordingSystem::GetCurrentRecordingSeconds ( ) const

pure virtual

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

Implemented in FGenericVideoRecordingSystem.

GetMaximumRecordingSeconds()

virtual uint64 IVideoRecordingSystem::GetMaximumRecordingSeconds ( ) const

pure virtual

Implemented in FGenericVideoRecordingSystem.

GetMinimumRecordingSeconds()

virtual uint64 IVideoRecordingSystem::GetMinimumRecordingSeconds ( ) const

pure virtual

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

Implemented in FGenericVideoRecordingSystem.

GetOnVideoRecordingFinalizedDelegate()

FVideoRecordingFinalized & IVideoRecordingSystem::GetOnVideoRecordingFinalizedDelegate ( )

inline

GetRecordingState()

virtual EVideoRecordingState IVideoRecordingSystem::GetRecordingState ( ) const

pure virtual

Returns the current state of video recording.

Implemented in FGenericVideoRecordingSystem.

IsEnabled()

virtual bool IVideoRecordingSystem::IsEnabled ( ) const

pure virtual

Returns whether recording is currently enabled.

Implemented in FGenericVideoRecordingSystem.

NewRecording()

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

pure virtual

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.

Implemented in FGenericVideoRecordingSystem.

PauseRecording()

virtual void IVideoRecordingSystem::PauseRecording ( )

pure virtual

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

Implemented in FGenericVideoRecordingSystem.

StartRecording()

virtual void IVideoRecordingSystem::StartRecording ( )

pure virtual

Begins capturing video after a call to NewRecording or PauseRecording.

Implemented in FGenericVideoRecordingSystem.

Member Data Documentation

OnVideoRecordingFinalized

FVideoRecordingFinalized IVideoRecordingSystem::OnVideoRecordingFinalized

protected

---

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

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