unreal.TakeRecorderBlueprintLibrary

class unreal.TakeRecorderBlueprintLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Take Recorder Blueprint Library

C++ Source:

• Plugin: Takes

• Module: TakeRecorder

• File: TakeRecorderBlueprintLibrary.h

classmethod cancel_recording() → None

Cancel recording if there is a recorder currently active

classmethod get_active_recorder() → TakeRecorder

Retrieve the currently active recorder, or None if there none are active

Return type:

TakeRecorder

classmethod get_default_parameters() → TakeRecorderParameters

Get the default recorder parameters according to the project and user settings

Return type:

TakeRecorderParameters

classmethod get_take_recorder_panel() → TakeRecorderPanel

Get the currently open take recorder panel, if one is open

Return type:

TakeRecorderPanel

classmethod is_recording() → bool

Check whether a recording is currently active

Return type:

bool

classmethod is_take_recorder_enabled() → bool

Is the Take Recorder enabled in the build

Return type:

bool

classmethod open_take_recorder_panel() → TakeRecorderPanel

Get the currently open take recorder panel, if one is open, opening a new one if not

Return type:

TakeRecorderPanel

classmethod set_default_parameters(default_parameters) → None

Set the default recorder parameters

Parameters:

default_parameters (TakeRecorderParameters) –

classmethod set_on_take_recorder_cancelled(on_take_recorder_cancelled) → None

Set on Take Recorder Cancelled deprecated: Please use TakeRecorderSubsystem::TakeRecorderCancelled

Parameters:

on_take_recorder_cancelled (OnTakeRecorderCancelled) –

classmethod set_on_take_recorder_finished(on_take_recorder_finished) → None

Set on Take Recorder Finished deprecated: Please use TakeRecorderSubsystem::TakeRecorderFinished

Parameters:

on_take_recorder_finished (OnTakeRecorderFinished) –

classmethod set_on_take_recorder_marked_frame_added(on_take_recorder_marked_frame_added) → None

Set on Take Recorder Marked Frame Added deprecated: Please use TakeRecorderSubsystem::TakeRecorderMarkedFrameAdded

Parameters:

on_take_recorder_marked_frame_added (OnTakeRecorderMarkedFrameAdded) –

classmethod set_on_take_recorder_panel_changed(on_take_recorder_panel_changed) → None

Called when a Take Panel is constructed or destroyed.

Parameters:

on_take_recorder_panel_changed (OnTakeRecorderPanelChanged) –

classmethod set_on_take_recorder_pre_initialize(on_take_recorder_pre_initialize) → None

Set on Take Recorder Pre Initialize deprecated: Please use TakeRecorderSubsystem::TakeRecorderPreInitialize

Parameters:

on_take_recorder_pre_initialize (OnTakeRecorderPreInitialize) –

classmethod set_on_take_recorder_started(on_take_recorder_started) → None

Set on Take Recorder Started deprecated: Please use TakeRecorderSubsystem::TakeRecorderStarted

Parameters:

on_take_recorder_started (OnTakeRecorderStarted) –

classmethod set_on_take_recorder_stopped(on_take_recorder_stopped) → None

Set on Take Recorder Stopped deprecated: Please use TakeRecorderSubsystem::TakeRecorderStopped

Parameters:

on_take_recorder_stopped (OnTakeRecorderStopped) –

classmethod start_recording(level_sequence, sources, meta_data, parameters) → TakeRecorder

Start a new recording using the specified parameters. Will fail if a recording is currently in progress

Parameters:

• level_sequence (LevelSequence) – The base level sequence to use for the recording. Will be played back during the recording and duplicated to create the starting point for the resulting asset.

• sources (TakeRecorderSources) – The sources to use for the recording

• meta_data (TakeMetaData) – Meta-data pertaining to this recording, duplicated into the resulting recorded sequence

• parameters (TakeRecorderParameters) – Configurable parameters for this recorder instance

Returns:

The recorder responsible for the recording, or None if a a recording could not be started

Return type:

TakeRecorder

classmethod stop_recording() → None

Stop recording if there is a recorder currently active