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

  • final_output_render_target (TextureRenderTarget2D): [Read-Write] TextureRenderTarget2D asset that contains the final output.

    If specified, this render target will be output by the provider. This allows you to do custom compositing before outputting happens. The details depend on the output provider subclass implementation. For example, the pixel streaming output provider outputs the viewport by default. If FinalOutputRenderTarget is specified, the specified render target is streamed instead of the viewport.

  • 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

  • override_streamer_name (bool): [Read-Write] Whether to override StreamerId with a user provided name.

  • 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] The name of this streamer to be reported to the signalling server. Defaults to the actor label if unique, and uses the soft object path if not. 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 match_remote_resolution: bool

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

Type:

(bool)

property override_streamer_name: bool

[Read-Write] Whether to override StreamerId with a user provided name.

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] The name of this streamer to be reported to the signalling server. Defaults to the actor label if unique, and uses the soft object path if not. If ids are not unique issues can occur.

Type:

(str)