unreal.MonoVideoIngestDeviceSettings

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

Bases: LiveLinkDeviceSettings

Mono Video Ingest Device Settings

C++ Source:

  • Plugin: CaptureManagerDevices

  • Module: MonoVideoIngestDevice

  • File: MonoVideoIngestDevice.h

Editor Properties: (see get_editor_property/set_editor_property)

  • display_name (str): [Read-Write]

  • take_directory (DirectoryPath): [Read-Write] Path to a directory containing the take(s) data

  • video_discovery_expression (TakeDiscoveryExpression): [Read-Write] Format of the file name that the device expects
    Available expressions:
    • <Slate> - slate name

    • <Name> - identifier for the camera

    • <Take> - take number

    • <Any> - any string

    • <Auto> - used alone to automatically figure out takes based on directory structure

    Available delimiters: ‘_’, ‘-’, ‘.’

    Examples: Considering input video MyTakeFolder/MySlate_MyName_SomeString-005.mov

    Video File Name Pattern <Auto> - will set Slate to the video filename “MySlate_MyName_SomeString_005” (dash converted to underline), Name will be set to just “video” and Take will be set to 1 by default.

    Video File Name Pattern <Slate>_<Name>_<Any>-<Take> - will extract Slate as “MySlate”, Name as “MyName” and Take as 5. <Any> ensures that the “SomeString” part of the filename is ignored.

    In both cases, extension ‘.mov’ is stripped out.

    Note: when not using <Auto> expression, then both <Slate> and <Name> must be present in the pattern.

property display_name: str

[Read-Write]

Type:

(str)

property take_directory: DirectoryPath

[Read-Write] Path to a directory containing the take(s) data

Type:

(DirectoryPath)

property video_discovery_expression: TakeDiscoveryExpression
[Read-Write] Format of the file name that the device expects
Available expressions:
  • <Slate> - slate name

  • <Name> - identifier for the camera

  • <Take> - take number

  • <Any> - any string

  • <Auto> - used alone to automatically figure out takes based on directory structure

Available delimiters: ‘_’, ‘-’, ‘.’

Examples: Considering input video MyTakeFolder/MySlate_MyName_SomeString-005.mov

Video File Name Pattern <Auto> - will set Slate to the video filename “MySlate_MyName_SomeString_005” (dash converted to underline), Name will be set to just “video” and Take will be set to 1 by default.

Video File Name Pattern <Slate>_<Name>_<Any>-<Take> - will extract Slate as “MySlate”, Name as “MyName” and Take as 5. <Any> ensures that the “SomeString” part of the filename is ignored.

In both cases, extension ‘.mov’ is stripped out.

Note: when not using <Auto> expression, then both <Slate> and <Name> must be present in the pattern.

Type:

(TakeDiscoveryExpression)