unreal.TakeRecorderProjectParameters

class unreal.TakeRecorderProjectParameters(root_take_save_dir: DirectoryPath = Ellipsis, take_save_dir: str = '', default_slate: str = '', recording_clock_source: UpdateClockSource = Ellipsis, start_at_current_timecode: bool = False, record_timecode: bool = False, record_sources_into_sub_sequences: bool = False, record_to_possessable: bool = False, show_notifications: bool = False)

Bases: StructBase

Take Recorder Project Parameters

C++ Source:

  • Plugin: Takes

  • Module: TakeRecorder

  • File: TakeRecorderParameters.h

Editor Properties: (see get_editor_property/set_editor_property)

  • default_slate (str): [Read-Write] Default Slate: The default name to use for the Slate information

  • default_tracks (Array[TakeRecorderTrackSettings]): [Read-Write] Default Tracks: List of property names for which movie scene tracks will always record.

  • record_sources_into_sub_sequences (bool): [Read-Write] Record Sources Into Sub Sequences: If enabled, each Source will be recorded into a separate Sequence and embedded in the Master Sequence will link to them via Subscenes track. If disabled, all Sources will be recorded into the Master Sequence, and you will not be able to swap between various takes of specific source using the Sequencer Take ui. This can still be done via copying and pasting between sequences if needed.

  • record_timecode (bool): [Read-Write] Record Timecode: If enabled, timecode will be recorded into each actor track

  • record_to_possessable (bool): [Read-Write] Record to Possessable: * If enabled, all recorded actors will be recorded to possessable object bindings in Sequencer. If disabled, all recorded actors will be * recorded to spawnable object bindings in Sequencer. This can be overridden per actor source.

  • recording_clock_source (UpdateClockSource): [Read-Write] Recording Clock Source: The clock source to use when recording

  • root_take_save_dir (DirectoryPath): [Read-Write] Root Take Save Dir: The root of the directory in which to save recorded takes.

  • show_notifications (bool): [Read-Write] Show Notifications: Whether to show notification windows or not when recording

  • start_at_current_timecode (bool): [Read-Write] Start at Current Timecode: If enabled, track sections will start at the current timecode. Otherwise, 0.

  • take_save_dir (str): [Read-Write] Take Save Dir: The name of the directory in which to save recorded takes. Supports any of the following format specifiers that will be substituted when a take is recorded: {day} - The day of the timestamp for the start of the recording. {month} - The month of the timestamp for the start of the recording. {year} - The year of the timestamp for the start of the recording. {hour} - The hour of the timestamp for the start of the recording. {minute} - The minute of the timestamp for the start of the recording. {second} - The second of the timestamp for the start of the recording. {take} - The take number. {slate} - The slate string.

property default_slate: str

[Read-Write] Default Slate: The default name to use for the Slate information

Type:

(str)

property record_sources_into_sub_sequences: bool

[Read-Write] Record Sources Into Sub Sequences: If enabled, each Source will be recorded into a separate Sequence and embedded in the Master Sequence will link to them via Subscenes track. If disabled, all Sources will be recorded into the Master Sequence, and you will not be able to swap between various takes of specific source using the Sequencer Take ui. This can still be done via copying and pasting between sequences if needed.

Type:

(bool)

property record_timecode: bool

[Read-Write] Record Timecode: If enabled, timecode will be recorded into each actor track

Type:

(bool)

property record_to_possessable: bool

[Read-Write] Record to Possessable: * If enabled, all recorded actors will be recorded to possessable object bindings in Sequencer. If disabled, all recorded actors will be * recorded to spawnable object bindings in Sequencer. This can be overridden per actor source.

Type:

(bool)

property recording_clock_source: UpdateClockSource

[Read-Write] Recording Clock Source: The clock source to use when recording

Type:

(UpdateClockSource)

property root_take_save_dir: DirectoryPath

[Read-Write] Root Take Save Dir: The root of the directory in which to save recorded takes.

Type:

(DirectoryPath)

property show_notifications: bool

[Read-Write] Show Notifications: Whether to show notification windows or not when recording

Type:

(bool)

property start_at_current_timecode: bool

[Read-Write] Start at Current Timecode: If enabled, track sections will start at the current timecode. Otherwise, 0.

Type:

(bool)

property take_save_dir: str

[Read-Write] Take Save Dir: The name of the directory in which to save recorded takes. Supports any of the following format specifiers that will be substituted when a take is recorded: {day} - The day of the timestamp for the start of the recording. {month} - The month of the timestamp for the start of the recording. {year} - The year of the timestamp for the start of the recording. {hour} - The hour of the timestamp for the start of the recording. {minute} - The minute of the timestamp for the start of the recording. {second} - The second of the timestamp for the start of the recording. {take} - The take number. {slate} - The slate string.

Type:

(str)