unreal.MetaHumanCaptureSourceSync

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

Bases: Object

MetaHuman Capture Source Sync

C++ Source:

  • Plugin: MetaHuman

  • Module: MetaHumanCaptureSource

  • File: MetaHumanCaptureSourceSync.h

Editor Properties: (see get_editor_property/set_editor_property)

  • capture_source_type (MetaHumanCaptureSourceType): [Read-Write]

  • copy_images_to_project (bool): [Read-Write]

  • depth_precision (MetaHumanCaptureDepthPrecisionType): [Read-Write] Precision of the calculated depth data. Full precision is more accurate, but requires more disk space to store.

  • depth_resolution (MetaHumanCaptureDepthResolutionType): [Read-Write] Resolution scaling applied to the calculated depth data. Full resolution is more accurate, but requires more disk space to store.

  • device_address (str): [Read-Write] deprecated: This property has changed its type

  • device_control_port (uint16): [Read-Write]

  • device_ip_address (DeviceAddress): [Read-Write]

  • export_listening_port (uint16): [Read-Write] deprecated: This property isn’t used anymore as the port is being provided automatically by the OS

  • max_distance (float): [Read-Write] The maximum cm from the camera expected for valid depth information.

    Depth information beyond this will be ignored to help filter out noise.

  • min_distance (float): [Read-Write] The minimum cm from the camera expected for valid depth information.

    Depth information closer than this will be ignored to help filter out noise.

  • storage_path (DirectoryPath): [Read-Write]

can_cancel() → bool

Can Cancel

Return type:

bool

can_ingest_takes() → bool

Can Ingest Takes

Return type:

bool

can_startup() → bool

Can Startup

Return type:

bool

cancel_processing(take_id_list) → None

Cancel Processing

Parameters:

take_id_list (Array[int32])

property device_address: str

[Read-Write] deprecated: This property has changed its type

Type:

(str)

property export_listening_port: int

[Read-Write] deprecated: This property isn’t used anymore as the port is being provided automatically by the OS

Type:

(uint16)

get_num_takes() → int32

Get Num Takes

Return type:

int32

get_take_ids() → Array[int32]

Get Take Ids

Return type:

Array[int32]

get_take_info(take_id) → MetaHumanTakeInfo or None

Get Take Info

Parameters:

take_id (int32)

Returns:

out_take_info (MetaHumanTakeInfo):

Return type:

MetaHumanTakeInfo or None

get_takes(take_id_list) → Array[MetaHumanTake]

Get Takes

Parameters:

take_id_list (Array[int32])

Return type:

Array[MetaHumanTake]

is_cancelling() → bool

Is Cancelling

Return type:

bool

is_processing() → bool

Is Processing

Return type:

bool

refresh() → Array[MetaHumanTakeInfo]

Refresh

Return type:

Array[MetaHumanTakeInfo]

set_target_path(target_ingest_directory, target_folder_asset_path) → None

Set Target Path

Parameters:

  • target_ingest_directory (str)

  • target_folder_asset_path (str)

shutdown() → None

Shutdown

startup() → None

brief: Startup the MetaHuman|Footage Ingest API. Get information on the available takes based on the type of this Capture Source