unreal.VirtualCameraController

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

Bases: unreal.Interface

Virtual Camera Controller

C++ Source:

  • Plugin: VirtualCamera

  • Module: VirtualCamera

  • File: IVirtualCameraController.h

add_blendable_to_camera(blendable_to_add, weight) → None

Add Blendable to Camera

Parameters

  • blendable_to_add (BlendableInterface) –

  • weight (float) –

add_on_virtual_camera_updated_delegate(delegate) → None

Adds a delegate that will be executed every tick while streaming.

Parameters

delegate (VirtualCameraTickDelegate) –

Get Live Link Representation

Return type

LiveLinkSubjectRepresentation

get_options() → VirtualCameraOptions

Get Options

Return type

VirtualCameraOptions

get_preset_container() → VirtualCameraPresetContainer

Get Preset Container

Return type

VirtualCameraPresetContainer

get_relative_transform() → Transform

Get Relative Transform

Return type

Transform

get_scene_capture_component() → SceneCaptureComponent2D

Get Scene Capture Component

Return type

SceneCaptureComponent2D

get_sequence_controller() → LevelSequencePlaybackController

Returns the VirtualCamera’s Sequence Controller.

Return type

LevelSequencePlaybackController

get_streamed_camera_component() → CineCameraComponent

Returns the target camera that is used to create the streamed view.

Return type

CineCameraComponent

is_streaming() → bool

Is Streaming

Return type

bool

remove_on_virtual_camera_updated_delegate(delegate) → None

Remove delegate that is executed every tick while streaming.

Parameters

delegate (VirtualCameraTickDelegate) –

set_before_set_virtual_camera_transform_delegate(delegate) → None

Delegate will be executed before transform is set onto VirtualCamera.

Parameters

delegate (PreSetVirtualCameraTransform) –

set_focus_visualization(show_focus_visualization) → None

Set Focus Visualization

Parameters

show_focus_visualization (bool) –

Set Live Link Representation

Parameters

live_link_represenation (LiveLinkSubjectRepresentation) –

set_on_actor_clicked_delegate(delegate) → None

Delegate will be executed when an actor in the scene was clicked/touched.

Parameters

delegate (OnActorClickedDelegate) –

set_save_settings_on_stop_streaming(should_settings_save) → None

Sets whether settings should be saved when stream is stopped.

Parameters

should_settings_save (bool) –

set_tracked_actor_for_focus(actor_to_track, tracking_point_offset) → None

Set Tracked Actor for Focus

Parameters

  • actor_to_track (Actor) –

  • tracking_point_offset (Vector) –

should_save_settings_on_stop_streaming() → bool

Check whether settings should save when stream is stopped.

Return type

bool