unreal.CaptureManagerDeviceBatchDownloadLibrary

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

Bases: BlueprintFunctionLibrary

Capture Manager Device Batch Download Library

C++ Source:

• Plugin: CaptureManagerEditor

• Module: CaptureManagerDeviceBlueprint

• File: CaptureManagerDeviceBatchDownloadLibrary.h

classmethod cancel_batch_download(session) → None

Cancel a batch download. The current take fails with a Canceled error and remaining takes are skipped.

Parameters:

session (CaptureManagerDeviceSession) – Session handle from ConnectToDevice.

classmethod download_device_takes_batch(session, takes, download_root_directory, on_take_success, on_take_failed, on_take_progress, on_all_complete) → None

Download multiple takes sequentially from a connected device.

Parameters:

• session (CaptureManagerDeviceSession) – Session handle from ConnectToDevice.

• takes (Array[CaptureManagerDeviceTakeInfo]) – Takes to download (from GetDeviceTakes, optionally filtered).

• download_root_directory (str) – Local directory to download into. Subdirectories are created per take. If a subdirectory already exists it is deleted first.

• on_take_success (CaptureManagerBatchDownloadTakeResult) – Called on the game thread when each take completes.

• on_take_failed (CaptureManagerBatchDownloadTakeFailed) – Called on the game thread when each take fails.

• on_take_progress (CaptureManagerDeviceDownloadProgress) – Called on the game thread with download progress (0.0 to 1.0) per take.

• on_all_complete (CaptureManagerBatchDownloadComplete) – Called on the game thread when all takes have been processed.

classmethod download_device_takes_batch_sync(session, takes, download_root_directory) → Array[CaptureManagerBatchDownloadResult]

Download multiple takes sequentially from a connected device, blocking until all complete.

Parameters:

• session (CaptureManagerDeviceSession) – Session handle from ConnectToDevice.

• takes (Array[CaptureManagerDeviceTakeInfo]) – Takes to download (from GetDeviceTakes, optionally filtered).

• download_root_directory (str) – Local directory to download into. Subdirectories are created per take. If a subdirectory already exists it is deleted first.

Returns:

Per-take results with success/failure status and paths.

Return type:

Array[CaptureManagerBatchDownloadResult]