unreal.TakeRecorderBlueprintLibrary¶
-
class
unreal.TakeRecorderBlueprintLibrary(outer=None, name='None')¶ Bases:
unreal.BlueprintFunctionLibraryTake Recorder Blueprint Library
C++ Source:
Plugin: Takes
Module: TakeRecorder
File: TakeRecorderBlueprintLibrary.h
-
classmethod
get_active_recorder() → TakeRecorder¶ Retrieve the currently active recorder, or None if there none are active
- Returns
- Return type
-
classmethod
get_default_parameters() → TakeRecorderParameters¶ Get the default recorder parameters according to the project and user settings
- Returns
- Return type
-
classmethod
get_take_recorder_panel() → TakeRecorderPanel¶ Get the currently open take recorder panel, if one is open
- Returns
- Return type
-
classmethod
is_recording() → bool¶ Check whether a recording is currently active
- Returns
- Return type
-
classmethod
is_take_recorder_enabled() → bool¶ Is the Take Recorder enabled in the build
- Returns
- Return type
-
classmethod
open_take_recorder_panel() → TakeRecorderPanel¶ Get the currently open take recorder panel, if one is open, opening a new one if not
- Returns
- Return type
-
classmethod
set_on_take_recorder_cancelled(on_take_recorder_cancelled) → None¶ Called when take recording is cancelled.
- Parameters
on_take_recorder_cancelled (OnTakeRecorderCancelled) –
-
classmethod
set_on_take_recorder_finished(on_take_recorder_finished) → None¶ Called when take recording finishes.
- Parameters
on_take_recorder_finished (OnTakeRecorderFinished) –
-
classmethod
set_on_take_recorder_marked_frame_added(on_take_recorder_marked_frame_added) → None¶ Called when a marked frame is added.
- 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¶ Called before initialization occurs (ie. when the recording button is pressed and before the countdown starts)
- Parameters
on_take_recorder_pre_initialize (OnTakeRecorderPreInitialize) –
-
classmethod
set_on_take_recorder_started(on_take_recorder_started) → None¶ Called when take recording starts.
- Parameters
on_take_recorder_started (OnTakeRecorderStarted) –
-
classmethod
set_on_take_recorder_stopped(on_take_recorder_stopped) → None¶ Called when take recording is stopped.
- 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