unreal.VCamBlueprintFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

VCam Blueprint Function Library

C++ Source:

• Plugin: VirtualCamera

• Module: VirtualCamera

• File: VCamBlueprintFunctionLibrary.h

classmethod calculate_auto_focus_distance(reticle_position, cine_camera) → float

Calculates auto focus

Parameters

• reticle_position (Vector2D) –

• cine_camera (CineCameraComponent) –

Returns

Return type

float

classmethod call_function_by_name(obj_ptr, function_name) → bool

Returns true if the function was found & executed correctly.

Parameters

• obj_ptr (Object) –

• function_name (Name) –

Returns

Return type

bool

classmethod convert_string_to_frame_rate(frame_rate_string) → FrameRate

Converts a double framerate to a FFrameRate

Parameters

frame_rate_string (str) –

Returns

Return type

FrameRate

classmethod editor_load_asset(asset_path) → Object

Load an asset through path.

Parameters

asset_path (str) –

Returns

Return type

Object

classmethod editor_save_asset(asset_path) → bool

Save an asset through path. Returns true on success.

Parameters

asset_path (str) –

Returns

Return type

bool

classmethod editor_set_game_view(is_toggled) → None

Sets the current game view

Parameters

is_toggled (bool) –

classmethod enable_debug_focus_plane(cine_camera, enabled) → None

Enable/Disable debug focus plane

Parameters

• cine_camera (CineCameraComponent) –

• enabled (bool) –

classmethod get_bound_objects(camera_binding_id)

Get UObject from Camera Object Bindings

Parameters

camera_binding_id (MovieSceneObjectBindingID) –

Returns

Return type

Array(Object)

classmethod get_current_level_sequence() → LevelSequence

Get the currently opened level sequence asset

Returns

Return type

LevelSequence

classmethod get_current_level_sequence_current_frame() → int32

Get the current playback position in frames

Returns

Return type

int32

classmethod get_display_rate(level_sequence) → FrameRate

Grab the display rate from a LevelSequences’ MovieScene

Parameters

level_sequence (LevelSequence) –

Returns

Return type

FrameRate

classmethod get_level_sequence_frame_as_timecode(level_sequence, frame) → Timecode

Convert a frame from a level sequence to timecode

Parameters

• level_sequence (LevelSequence) –

• frame (int32) –

Returns

Return type

Timecode

classmethod get_level_sequence_frame_as_timecode_without_object(display_rate, frame) → Timecode

Convert a frame from a level sequence to timecode using only a provided display rate

Parameters

• display_rate (FrameRate) –

• frame (int32) –

Returns

Return type

Timecode

classmethod get_level_sequence_length_in_frames(level_sequence) → int32

Get length in frames of a level sequence

Parameters

level_sequence (LevelSequence) –

Returns

Return type

int32

classmethod get_next_undo_description() → str

Returns the description of the undo action that will be performed next.

Returns

Return type

str

classmethod get_object_metadata_tags(object)

Retrieves UObject’s metadata tags

Parameters

object (Object) –

Returns

Return type

Map(Name, str)

classmethod get_user_settings() → VirtualCameraUserSettings

Get User Settings

Returns

Return type

VirtualCameraUserSettings

classmethod import_snapshot_texture(file_name, sub_folder_name, absolute_path_package) → Texture

Imports image as a uasset

Parameters

• file_name (str) –

• sub_folder_name (str) –

• absolute_path_package (str) –

Returns

Return type

Texture

classmethod is_current_level_sequence_playing() → bool

Check whether the sequence is actively playing.

Returns

Return type

bool

classmethod is_game_running() → bool

Returns true if not in editor or if running the game in PIE or Simulate

Returns

Return type

bool

classmethod modify_level_sequence_metadata(level_sequence_meta_data) → bool

Marks a LevelSequence as dirty and saves it, persisting metadata changes

Parameters

level_sequence_meta_data (VirtualCameraClipsMetaData) –

Returns

Return type

bool

classmethod modify_level_sequence_metadata_for_selects(level_sequence_meta_data, is_selected) → bool

Saves UVirtualCameraClipsMetaData with updated selects information.

Parameters

• level_sequence_meta_data (VirtualCameraClipsMetaData) –

• is_selected (bool) –

Returns

Return type

bool

classmethod modify_object_metadata_tags(object, tag, value) → None

Modifies a UObject’s metadata tags, adding a tag if the tag does not exist.

Parameters

• object (Object) –

• tag (Name) –

• value (str) –

classmethod pause_current_level_sequence() → None

Pause the current level sequence

classmethod pilot_actor(selected_actor) → None

Pilot the provided actor using editor scripting

Parameters

selected_actor (Actor) –

classmethod play_current_level_sequence() → None

Play the current level sequence

classmethod set_current_level_sequence_current_frame(new_frame) → None

Set playback position for the current level sequence in frames

Parameters

new_frame (int32) –

classmethod sort_assets_by_timecode_asset_data(level_sequence_assets)

Sort array of FAssetData by metadata timecode *

Parameters

level_sequence_assets (Array(AssetData)) –

Returns

Return type

Array(AssetData)

classmethod timecode_to_frame_amount(timecode, frame_rate) → int32

Convert timecode to amount of frames at a given framerate

Parameters

• timecode (Timecode) –

• frame_rate (FrameRate) –

Returns

Return type

int32

classmethod update_post_process_settings_for_capture(capture_component, depth_of_field, f_stop_value) → bool

Updates the provided USceneCaptureComponent2D’s PostProcessingSettings. Returns true on success.

Parameters

• capture_component (SceneCaptureComponent2D) –

• depth_of_field (float) –

• f_stop_value (float) –

Returns

Return type

bool