unreal.LiveLinkOBSDeviceSettings

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

Bases: LiveLinkDeviceSettings

Persisted settings for an OBS device instance.

C++ Source:

  • Plugin: LiveLinkOBSDevice

  • Module: LiveLinkOBSDevice

  • File: LiveLinkOBSDevice.h

Editor Properties: (see get_editor_property/set_editor_property)

  • display_name (str): [Read-Write] Unique display name for this device

  • filename_format (str): [Read-Write] Format string for the OBS recording filename. Uses NamingTokens syntax; wrap token names in curly braces.

    LLH tokens (namespace “llh”): {slate}, {take}, {session}, {config} Global tokens: {project}, {user}, {yyyy}, {mm}, {Ddd}, etc.

    This format is also used to identify and parse takes when browsing the OBS recording directory. For example, {slate}-{take} will correctly extract the slate name and take number from “MySlate-01.mp4”. Recordings that don’t match the current format are still discovered, using the full filename as the slate name.

  • host (str): [Read-Write] Host running OBS WebSocket server (e.g. 127.0.0.1 or a remote IP).

  • password (str): [Read-Write] Password set in OBS WebSocket Server Settings. Leave empty if authentication is disabled.

  • port (int32): [Read-Write] Port configured in OBS Tools > WebSocket Server Settings (default 4455).