unreal.CaptureManagerDeviceBlueprintLibrary

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

Bases: BlueprintFunctionLibrary

Capture Manager Device Blueprint Library

C++ Source:

  • Plugin: CaptureManagerEditor

  • Module: CaptureManagerDeviceBlueprint

  • File: CaptureManagerDeviceBlueprintLibrary.h

classmethod cancel_device_download(session, take_name) → Text or None

Cancel an in-flight download by take name. The download’s OnFailure callback will fire with a cancellation error.

Parameters:
Returns:

True if a download for this take was found and cancellation was initiated. False if no active download exists for this take.

error_message (Text): Populated on failure with a description of why cancellation failed.

Return type:

Text or None

classmethod connect_to_device(device_name, ip_address, port=14785, timeout_seconds=30, on_success, on_failure) → None

Connect to a device (e.g. LiveLink Face on iPhone/iPad) by IP address. Returns a session handle via OnSuccess, used by all subsequent device operations.

Note: The device uses a second port for file transfers, reported during connection. If downloads fail while the connection succeeds, check that this port is also accessible through any firewalls.

Parameters:

  • device_name (str) – Optional display name for the device. Stored on the session for use in logging and error messages. Defaults to “IP:Port” if empty.

  • ip_address (str) – IP address of the device.

  • port (int32) – Default is 14785.

  • timeout_seconds (int32) – Maximum time to wait for connection.

  • on_success (CaptureManagerDeviceConnected) – Called on the game thread when connected.

  • on_failure (CaptureManagerDeviceConnectFailed) – Called on the game thread if the connection fails or times out.

classmethod connect_to_device_sync(device_name, ip_address, port=14785, timeout_seconds=30) -> (CaptureManagerDeviceSession, error_code=CaptureManagerDeviceError, error_message=Text)

Connect to a device and block until connected or timed out. Intended for Python scripts and other contexts where blocking is acceptable.

Parameters:

  • device_name (str) – Optional display name for the device. Defaults to “IP:Port” if empty.

  • ip_address (str) – IP address of the device.

  • port (int32) – Default is 14785.

  • timeout_seconds (int32) – Maximum time to wait for connection.

Returns:

Session handle on success, nullptr on failure.

error_code (CaptureManagerDeviceError): Error code on failure.

error_message (Text): Error description on failure.

Return type:

tuple

classmethod disconnect_device(session, on_complete) → None

Disconnect from a device and release the session. Cancels any in-flight downloads. Safe to call with a null session.

Parameters:
classmethod disconnect_device_sync(session) → None

Disconnect from a device, blocking until teardown is complete. Cancels any in-flight downloads. Safe to call with a null session.

Parameters:

session (CaptureManagerDeviceSession) – Session handle to disconnect.

classmethod download_device_take(session, take_name, download_root_directory, on_success, on_failure, on_progress) → None

Download a take from a connected device to a local directory. The downloaded directory can be passed directly to Ingest Live Link Face.

Parameters:
classmethod download_device_take_sync(session, take_name, download_root_directory) -> (str, error_code=CaptureManagerDeviceError, error_message=Text)

Download a take from a connected device, blocking until complete. The returned directory can be passed directly to Ingest Live Link Face.

Parameters:

  • session (CaptureManagerDeviceSession) – Session handle from ConnectToDevice.

  • take_name (str) – Name of the take to download (from GetDeviceTakes).

  • download_root_directory (str) – Local directory to download into. A subdirectory named after the take is created automatically. If the subdirectory already exists it is deleted first.

Returns:

Full path to the downloaded take directory. Empty on failure.

error_code (CaptureManagerDeviceError): Error code on failure.

error_message (Text): Error description on failure.

Return type:

tuple

classmethod get_device_takes(session, on_success, on_failure) → None

Retrieve the list of takes available on a connected device.

Parameters:
classmethod get_device_takes_sync(session) -> (Array[CaptureManagerDeviceTakeInfo], error_code=CaptureManagerDeviceError, error_message=Text)

Retrieve the list of takes available on a connected device, blocking until complete.

Parameters:

session (CaptureManagerDeviceSession) – Session handle from ConnectToDevice.

Returns:

Array of take info. Empty on failure or if no takes exist.

error_code (CaptureManagerDeviceError): Error code on failure.

error_message (Text): Error description on failure.

Return type:

tuple