unreal.TakeRecorderPanel

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

Bases: Object

Take recorder UI panel interop object

C++ Source:

• Plugin: Takes

• Module: TakeRecorder

• File: TakeRecorderPanel.h

can_start_recording() → Text or None

Whether the panel is ready to start recording

Returns:

out_error_text (Text):

Return type:

Text or None

clear_pending_take() → None

• Clear the pending take level sequence

get_frame_rate() → FrameRate

Access the frame rate for this take

Return type:

FrameRate

get_last_recorded_level_sequence() → LevelSequence

Access the last level sequence that was recorded

Return type:

LevelSequence

get_level_sequence() → LevelSequence

Access the level sequence for this take

Return type:

LevelSequence

get_mode() → TakeRecorderPanelMode

Get the mode that the panel is currently in

Return type:

TakeRecorderPanelMode

get_sources() → TakeRecorderSources

Access the sources that are to be (or were) used for recording this take

Return type:

TakeRecorderSources

get_take_meta_data() → TakeMetaData

Access take meta data for this take

Return type:

TakeMetaData

new_take() → None

New Take deprecated: Please use ClearPendingTake instead

set_frame_rate(frame_rate) → None

Set the frame rate for this take

Parameters:

frame_rate (FrameRate) –

set_frame_rate_from_timecode(from_timecode) → None

Set if the frame rate is set from the Timecode frame rate

Parameters:

from_timecode (bool) –

setup_for_editing(take_preset) → None

Setup this panel as an editor for the specified take preset asset.

Parameters:

take_preset (TakePreset) –

setup_for_recording_into_level_sequence(level_sequence_asset) → None

Setup this panel such that it is ready to start recording using the specified level sequence asset to record into.

Parameters:

level_sequence_asset (LevelSequence) –

setup_for_recording_level_sequence(level_sequence_asset) → None

Setup this panel such that it is ready to start recording using the specified level sequence asset as a template for the recording.

Parameters:

level_sequence_asset (LevelSequence) –

setup_for_recording_take_preset(take_preset_asset) → None

Setup this panel such that it is ready to start recording using the specified take preset as a template for the recording.

Parameters:

take_preset_asset (TakePreset) –

setup_for_viewing(level_sequence_asset) → None

Setup this panel as a viewer for a previously recorded take.

Parameters:

level_sequence_asset (LevelSequence) –

start_recording() → None

Start recording with the current take

stop_recording() → None

Stop recording with the current take