unreal.MovieSceneCaptureProtocolBase

class unreal.MovieSceneCaptureProtocolBase(outer=None, name='None')

Bases: unreal.Object

A capture protocol responsible for dealing with captured frames using some custom method (writing out to disk, streaming, etc)

A typical process for capture consits of the following process:
Setup -> [ Warm up -> [ Capture Frame ] ] -> Begin Finalize -> [ HasFinishedProcessing ] -> Finalize

C++ Source:

  • Module: MovieSceneCapture
  • File: MovieSceneCaptureProtocolBase.h
get_state() → MovieSceneCaptureProtocolState

Get the current state of this capture protocol

Returns:
Return type:MovieSceneCaptureProtocolState
is_capturing() → bool

Check whether we can capture a frame from this protocol

Returns:
Return type:bool