unreal.LiveLinkOBSDevice

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

Bases: BaseIngestLiveLinkDevice

Live Link Hub device that controls OBS Studio recording via the OBS WebSocket v5 protocol.

Supports:

• Start / Stop recording (driven by the Live Link Hub recording session)

• Setting the recording filename (driven by the Hub slate name)

• Ingest of recorded video files as mono takes into Capture Manager

C++ Source:

• Plugin: LiveLinkOBSDevice

• Module: LiveLinkOBSDevice

• File: LiveLinkOBSDevice.h

can_set_hardware_id() → bool

Returns whether it’s valid to call SetHardwareId() on this device at this time.

Return type:

bool

connect() → bool

Attempt to establish a connection.

Return type:

bool

disconnect() → bool

Attempt to terminate an existing connection.

Return type:

bool

get_connection_delegate() → ConnectionDelegate

Get Connection Delegate

Return type:

ConnectionDelegate

get_connection_status() → LiveLinkDeviceConnectionStatus

Get the current connection state.

Return type:

LiveLinkDeviceConnectionStatus

get_hardware_id() → str

Retrieve hardware identifier (serial number, network endpoint, etc).

Return type:

str

is_recording() → bool

Is Recording

Return type:

bool

set_hardware_id(hardware_id) → bool

Set hardware identifier (serial number, network endpoint, etc).

Parameters:

hardware_id (str)

Return type:

bool

start_recording() → bool

Start Recording

Return type:

bool

stop_recording() → bool

Stop Recording

Return type:

bool