unreal.VCamPixelStreamingSession

class unreal.VCamPixelStreamingSession(outer: Object | None = None, name: Name | str = 'None')

Bases: DecoupledOutputProvider

VCam Pixel Streaming Session

C++ Source:

  • Plugin: VirtualCameraCore

  • Module: DecoupledOutputProvider

  • File: VCamPixelStreamingSession.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_set_live_link_subject (bool): [Read-Write] If true then the Live Link Subject of the owning VCam Component will be set to the subject created by this Output Provider when the Provider is enabled

  • enable_ar_kit_tracking (bool): [Read-Write] Check this if you wish to control the corresponding CineCamera with transform data received from the LiveLink app

  • from_composure_output_provider_index (int32): [Read-Write] If using the output from a Composure Output Provider, specify it here

  • gameplay_view_target_policy (GameplayViewTargetPolicy): [Read-Write] In game worlds, such as PIE or shipped games, determines which a player controller whose view target should be set to the owning cine camera.

    Note that multiple output providers may have a policy set and policies might choose the same player controllers to set the view target for. This conflict is resolved as follows: if a player controller already has the cine camera as view target, the policy is not used. Hence, you can order your output providers array in the VCamComponent. The first policies will get automatically get higher priority.

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

  • match_remote_resolution (bool): [Read-Write] If true the streamed UE viewport will match the resolution of the remote device.

  • on_activated_delegate_blueprint (ActivationDelegate_Blueprint): [Read-Write] Called when the activation state of this output provider changes.

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

  • prevent_editor_idle (bool): [Read-Write] If not selected, when the editor is not the foreground application, input through the vcam session may seem sluggish or unresponsive.

  • streamer_id (str): [Read-Write] Set the name of this stream to be reported to the signalling server. If none is supplied a default will be used. If ids are not unique issues can occur.

  • target_viewport (VCamTargetViewportID): [Read-Write] Which viewport to use for this VCam

  • 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

[Read-Write] If true then the Live Link Subject of the owning VCam Component will be set to the subject created by this Output Provider when the Provider is enabled

Type:

(bool)

property enable_ar_kit_tracking: bool

[Read-Write] Check this if you wish to control the corresponding CineCamera with transform data received from the LiveLink app

Type:

(bool)

property from_composure_output_provider_index: int

[Read-Write] If using the output from a Composure Output Provider, specify it here

Type:

(int32)

property match_remote_resolution: bool

[Read-Write] If true the streamed UE viewport will match the resolution of the remote device.

Type:

(bool)

property prevent_editor_idle: bool

[Read-Write] If not selected, when the editor is not the foreground application, input through the vcam session may seem sluggish or unresponsive.

Type:

(bool)

property streamer_id: str

[Read-Write] Set the name of this stream to be reported to the signalling server. If none is supplied a default will be used. If ids are not unique issues can occur.

Type:

(str)