`unreal.TakeRecorderSubsystem`¶

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

Bases: EngineSubsystem

UTakeRecorderSubsystem Subsystem for Take Recorder. SetTargetSequence() needs to be called at least once prior to use. This will perform additional initialization and register the subsystem as tickable currently required to cache level metadata.

C++ Source:

Plugin: Takes
Module: TakeRecorder
File: TakeRecorderSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

take_recorder_cancelled (TakeRecorderCancelled): [Read-Write] Called when take recorder is cancelled
take_recorder_finished (TakeRecorderFinished): [Read-Write] Called when take recorder has finished
take_recorder_initialized (TakeRecorderInitialized): [Read-Write] called when take recorder is initializing.
take_recorder_marked_frame_added (TakeRecorderMarkedFrameAdded): [Read-Write] Called when a marked frame is added to take recorder
take_recorder_pre_initialize (TakeRecorderPreInitialize): [Read-Write] Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts)
take_recorder_slate_changed (TakeRecorderSlateChanged): [Read-Write] Called when a take recorder slate changes.
take_recorder_source_added (OnTakeRecorderSourceAddedDynamic): [Read-Write] Multicast delegate when any source has been added.
take_recorder_source_removed (OnTakeRecorderSourceRemovedDynamic): [Read-Write] Multicast delegate when any source has been removed.
take_recorder_started (TakeRecorderStarted): [Read-Write] Called when take recorder is started
take_recorder_stopped (TakeRecorderStopped): [Read-Write] Called when take recorder is stopped
take_recorder_take_number_changed (TakeRecorderTakeNumberChanged): [Read-Write] Called when a take recorder take number changes.

add_source(source_class) → TakeRecorderSource¶

Add a source by a source class.

Parameters:: source_class (type(Class))
Return type:: TakeRecorderSource

add_source_for_actor(actor, reduce_keys=True, show_progress=True) → None¶

Add an actor as a source.

Parameters:

actor (Actor) – The actor that should be added to Sources. Note that this can include ALevelSequenceActors. *
reduce_keys (bool) – Enable/disable key reduction on all the sources registered *
show_progress (bool) – Enable/disable the dialog box showing progress for the potentially slow parts of finalizing the take

can_review_last_recording() → bool¶

Can we review the last recording?

Return type:: bool

cancel_recording(show_confirm_message=True) → None¶

Cancel an in-progress recording.

Parameters:: show_confirm_message (bool)

clear_pending_take() → None¶: Clear the pending take.

clear_sources() → None¶: Remove all sources from the current sequence.

get_all_sources_copy() → Array[TakeRecorderSource]¶

Retrieves a copy of the list of sources that are being recorded. This is intended for Blueprint usages which cannot use TArrayView. DO NOT MODIFY THIS ARRAY, modifications will be lost.

Return type:: Array[TakeRecorderSource]

get_frame_rate() → FrameRate¶

Access the frame rate for this take

Return type:: FrameRate

get_global_record_settings() → TakeRecorderParameters¶

Retrieve the global take recorder settings.

Return type:: TakeRecorderParameters

get_last_recorded_level_sequence() → LevelSequence¶

Retrieve the Last Recorded Level Sequence if it exists.

Return type:: LevelSequence

get_level_sequence() → LevelSequence¶

Return the level sequence we are using.

Return type:: LevelSequence

get_next_take_number(slate) → int32¶

Compute the next take number given a slate.

Parameters:: slate (str)
Return type:: int32

get_number_of_takes(slate) -> (out_max_take=int32, out_num_takes=int32)¶

Find both the current maximum take value and the total number of takes for a given slate.

Parameters:

slate (str)

Returns:

out_max_take (int32):

out_num_takes (int32):

Return type:

tuple

get_pending_take() → TakePreset¶

Retrieve the pending take. This may be null.

Return type:: TakePreset

get_slates(package_path='None') → Array[AssetData]¶

Retrieve all slates.

Parameters:: package_path (Name) – [Optional] Scope the search to a specific folder, recursively.
Return type:: Array[AssetData]

get_source_actor(source) → Actor¶

Retrieve the actor from a source, if applicable.

Parameters:: source (TakeRecorderSource)
Return type:: Actor

get_source_by_class(source_class) → TakeRecorderSource¶

Retrieve the first source of the given class.

Parameters:: source_class (type(Class))
Return type:: TakeRecorderSource

get_source_record_settings(source) → Array[Object]¶

Retrieve additional settings objects from a source.

Parameters:: source (TakeRecorderSource)
Return type:: Array[Object]

get_sources() → TakeRecorderSources¶

Retrieve the sources.

Return type:: TakeRecorderSources

get_state() → TakeRecorderState¶

Retrieve the current take recorder state.

Return type:: TakeRecorderState

get_take_meta_data() → TakeMetaData¶

Retrieve the current meta data.

Return type:: TakeMetaData

get_take_recorder_mode() → TakeRecorderMode¶

The current take recorder mode.

Return type:: TakeRecorderMode

is_recording() → bool¶

If Take Recorder is currently recording.

Return type:: bool

is_reviewing() → bool¶

If Take Recorder is currently reviewing.

Return type:: bool

mark_frame() → bool¶

Mark the current frame.

Return type:: bool

remove_actor_from_sources(actor) → None¶

Remove an actor from available sources.

Parameters:: actor (Actor)

remove_source(source) → None¶

Remove a given source.

Parameters:: source (TakeRecorderSource)

reset_to_pending_take() → None¶: Reset to the pending take.

revert_changes() → None¶: Revert any changes restoring the preset origin.

review_last_recording() → bool¶

Supply the last recording if it exists.

Returns:: true if it can be reviewed, false if it there isn’t a recording to review.
Return type:: bool

set_frame_rate(frame_rate) → None¶

Set the frame rate for this take

Parameters:: frame_rate (FrameRate)

set_frame_rate_from_timecode() → None¶: Set if the frame rate is set from the Timecode frame rate

set_global_record_settings(parameters) → None¶

Set the global take recorder settings.

Parameters:: parameters (TakeRecorderParameters)

set_sequence_countdown(seconds) → None¶

Sets the current sequence’s countdown.

Parameters:: seconds (float) – Time in seconds.

set_slate_name(slate_name, emit_changed=True) → None¶

Directly set the slate name.

Parameters:

slate_name (str) – The new slate name to set.
emit_changed (bool) – Whether to broadcast events signaling the slate name has changed.

set_take_number(new_take_number, emit_changed=True) → None¶

Directly set the take number.

Parameters:

new_take_number (int32) – The new take number to set.
emit_changed (bool) – Whether to broadcast events signaling the take number has changed.

set_target_sequence(data=[None, None, None, None]) → None¶

Provide sequence data for this take recorder. This will also perform initialization of the subsystem. This must be called prior to any usage.

Parameters:: data (TakeRecorderSequenceParameters) – The sequence parameters, which are mutually exclusive. They can all be null.

start_recording(open_sequencer=True, show_error_message=True) → bool¶

Begin a new recording.

Parameters:

open_sequencer (bool) – If sequencer should open when starting the recording.
show_error_message (bool) – If an error message should be displayed on failure.

Returns: