unreal.TakeMetaData

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

Bases: unreal.Object

Take meta-data that is stored on ULevelSequence assets that are recorded through the Take Recorder. Meta-data is retrieved through ULevelSequence::FindMetaData<UTakeMetaData>()

C++ Source:

• Plugin: Takes

• Module: TakesCore

• File: TakeMetaData.h

generate_asset_path(path_format_string) → str

Generate the desired asset path for this take meta-data

Parameters

path_format_string (str) –

Returns

Return type

str

get_description() → str

Returns

The user-provided description for this take

Return type

str

get_duration() → FrameTime

Returns

The duration for this take

Return type

FrameTime

get_frame_rate() → FrameRate

Returns

The frame-rate for this take

Return type

FrameRate

get_frame_rate_from_timecode() → bool

Returns

Get if we get frame rate from time code

Return type

bool

get_level_origin() → Level

Returns

The Map used to create this recording

Return type

Level

get_level_path() → str

Returns

The AssetPath of the Level used to create a Recorded Level Sequence

Return type

str

get_preset_origin() → TakePreset

Returns

The preset on which the take was originally based

Return type

TakePreset

get_slate() → str

Returns

The slate for this take

Return type

str

get_take_number() → int32

Returns

The take number for this take

Return type

int32

get_timecode_in() → Timecode

Returns

The timecode in for this take

Return type

Timecode

get_timecode_out() → Timecode

Returns

The timecode out for this take

Return type

Timecode

get_timestamp() → DateTime

Returns

The timestamp for this take

Return type

DateTime

is_locked() → bool

Check whether this take is locked

Returns

Return type

bool

lock() → None

Lock this take, causing it to become read-only

recorded() → bool

Check if this take was recorded (as opposed to being setup for recording)

Returns

Return type

bool

set_description(description) → None

Set this take’s user-provided description note:: Only valid for takes that have not been locked

Parameters

description (str) –

set_duration(duration) → None

Set this take’s duration note:: Only valid for takes that have not been locked

Parameters

duration (FrameTime) –

set_frame_rate(frame_rate) → None

Set this take’s frame-rate note:: Only valid for takes that have not been locked

Parameters

frame_rate (FrameRate) –

set_frame_rate_from_timecode(from_timecode) → None

Set if we get frame rate from time code

Parameters

from_timecode (bool) –

set_level_origin(level_origin) → None

Set the map used to create this recording

Parameters

level_origin (Level) –

set_preset_origin(preset_origin) → None

Set the preset on which the take is based note:: Only valid for takes that have not been locked

Parameters

preset_origin (TakePreset) –

set_slate(slate, emit_changed=True) → None

Set the slate for this take and reset its take number to 1 note:: Only valid for takes that have not been locked

Parameters

• slate (str) –

• emit_changed (bool) – Whether or not to send a slate changed event

set_take_number(take_number, emit_changed=True) → None

Set this take’s take number. Take numbers are always clamped to be >= 1. note:: Only valid for takes that have not been locked

Parameters

• take_number (int32) –

• emit_changed (bool) – Whether or not to send a take number changed event

set_timecode_in(timecode_in) → None

Set this take’s timecode in note:: Only valid for takes that have not been locked

Parameters

timecode_in (Timecode) –

set_timecode_out(timecode_out) → None

Set this take’s timecode out note:: Only valid for takes that have not been locked

Parameters

timecode_out (Timecode) –

set_timestamp(timestamp) → None

Set this take’s timestamp note:: Only valid for takes that have not been locked

Parameters

timestamp (DateTime) –

unlock() → None

Unlock this take if it is read-only, allowing it to be modified once again