unreal.VCamOutputProviderBase

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

Bases: unreal.Object

VCam Output Provider Base

C++ Source:

• Plugin: VirtualCamera

• Module: VCamCore

• File: VCamOutputProviderBase.h

Editor Properties: (see get_editor_property/set_editor_property)

• is_active (bool): [Read-Write] If set, this output provider will execute every frame

• override_resolution (IntPoint): [Read-Write] When bUseOverrideResolution is set, use this custom resolution

• umg_class (type(Class)): [Read-Write] The UMG class to be rendered in this output provider

• use_override_resolution (bool): [Read-Write] Override the default output resolution with a custom value - NOTE you must toggle bIsActive off then back on for this to take effect

is_active() → bool

Returns if this output provider is currently active or not

Returns

Return type

bool

is_initialized() → bool

Returns if this output provider has been initialized or not

Returns

Return type

bool

property override_resolution

[Read-Write] When bUseOverrideResolution is set, use this custom resolution

Type

(IntPoint)

set_active(active) → None

Called to turn on or off this output provider

Parameters

active (bool) –

set_target_camera(target_camera) → None

Sets the TargetCamera parameter

Parameters

target_camera (CineCameraComponent) –

set_umg_class(umg_class) → None

Sets the UMG class to be rendered in this output provider

Parameters

umg_class (type(Class)) –

property umg_class

[Read-Write] The UMG class to be rendered in this output provider

Type

(type(Class))

property use_override_resolution

[Read-Write] Override the default output resolution with a custom value - NOTE you must toggle bIsActive off then back on for this to take effect

Type

(bool)