unreal.CaptureManagerIngestBlueprintLibrary

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

Bases: BlueprintFunctionLibrary

Capture Manager Ingest Blueprint Library

C++ Source:

  • Plugin: CaptureManagerEditor

  • Module: CaptureManagerIngestBlueprint

  • File: CaptureManagerIngestBlueprintLibrary.h

classmethod cancel_ingest(ingest_id) → bool

Cancel a queued or running ingest by its ID.

Queued ingests are removed immediately and their OnFailure delegate fires with a cancellation message. Running ingests are signaled to stop - conversion nodes bail at their next cancellation check and the partial working directory is cleaned up.

Parameters:

ingest_id (int32) – The ID returned by an async ingest function.

Returns:

True if the IngestId was found and cancellation was initiated. False if it was already completed, already canceled, or invalid.

Return type:

bool

classmethod find_take_directories(search_directory, recursive=True) → Array[CaptureManagerTakeDirectoryInfo]

Scans a directory for capture-related content and returns an inventory of what was found.

Returns one entry per directory that contains at least one recognized capture artifact (video, image sequence, audio, calibration, or .cptake archive).

File arrays are populated by filesystem scan only, not by parsing .cptake metadata. When bIsTakeArchive is true, the file arrays are empty - the .cptake manifest is the authoritative inventory. Pass the directory path to IngestTakeArchive directly.

Parameters:

  • search_directory (str) – Root directory to search.

  • recursive (bool) – If true, recurse into subdirectories. Recursion stops at directories that contain capture artifacts.

Return type:

Array[CaptureManagerTakeDirectoryInfo]

classmethod ingest_calibration(calibration_file_path, calibration_name, on_success, on_failure) → int32

Import a standalone calibration file (.json) asynchronously. Format (OpenCV or Unreal) is auto-detected.

Parameters:

  • calibration_file_path (str) – Path to a calibration JSON file.

  • calibration_name (str) – Name for the calibration asset. Must be unique per import - determines the output asset path. If multiple calibration files share the same filename (e.g. calib.json), consider using the parent folder name to distinguish them.

  • on_success (CaptureManagerIngestSuccess) – Called on the game thread when the import completes successfully.

  • on_failure (CaptureManagerIngestFailed) – Called on the game thread if the import fails.

Return type:

int32

classmethod ingest_calibration_sync(calibration_file_path, calibration_name) -> (FootageCaptureData, out_error_message=Text)

Import a standalone calibration file (.json). Format (OpenCV or Unreal) is auto-detected. Creates a FootageCaptureData asset with no footage and one CameraCalibration entry. Access the calibration via FootageCaptureData->CameraCalibrations[0].

Parameters:

  • calibration_file_path (str) – Path to a calibration JSON file.

  • calibration_name (str) – Name for the calibration asset. Must be unique per import - determines the output asset path. If multiple calibration files share the same filename (e.g. calib.json), consider using the parent folder name to distinguish them.

Returns:

out_error_message (Text): Set on failure; describes what went wrong.

Return type:

Text

Import a LiveLink Face capture asynchronously. Supports both the current .cptake format and the pre-5.6 LiveLink Face format.

Parameters:
Return type:

int32

Import a LiveLink Face capture. Supports both the current .cptake format and the pre-5.6 LiveLink Face format.

Parameters:

  • take_directory_path (str) – Path to the take directory containing the LiveLink Face capture data.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

Returns:

out_error_message (Text): Set on failure; describes what went wrong.

Return type:

Text

classmethod ingest_mono_video(video_file_path, audio_file_path, slate, take_number, params, on_success, on_failure) → int32

Import a single-camera video file (.mp4 or .mov) asynchronously.

Parameters:

  • video_file_path (str) – Path to the video file.

  • audio_file_path (str) – Optional. Path to a separate audio file. Leave empty to use embedded audio if present.

  • slate (str) – Optional. Slate name for the imported take. Derived from the video filename if empty.

  • take_number (int32) – Optional. Take number. Defaults to 1 if less than 1.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

  • on_success (CaptureManagerIngestSuccess) – Called on the game thread when the import completes successfully.

  • on_failure (CaptureManagerIngestFailed) – Called on the game thread if the import fails.

Return type:

int32

classmethod ingest_mono_video_sync(video_file_path, audio_file_path, slate, take_number, params) -> (FootageCaptureData, out_error_message=Text)

Import a single-camera video file (.mp4 or .mov).

Parameters:

  • video_file_path (str) – Path to the video file.

  • audio_file_path (str) – Optional. Path to a separate audio file. Leave empty to use embedded audio if present.

  • slate (str) – Optional. Slate name for the imported take. Derived from the video filename if empty.

  • take_number (int32) – Optional. Take number. Defaults to 1 if less than 1.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

Returns:

out_error_message (Text): Set on failure; describes what went wrong.

Return type:

Text

classmethod ingest_stereo_video(video_path_a, video_path_b, audio_file_path, calibration_file_path, slate, take_number, params, on_success, on_failure) → int32

Import a dual-camera stereo video asynchronously. Pass two video files (.mp4/.mov) or two image-sequence folders.

Parameters:

  • video_path_a (str) – Path to the first video file or image-sequence folder. Becomes the default primary camera for MHA processing.

  • video_path_b (str) – Path to the second video file or image-sequence folder. Must be the same type as the first video (both files, or both folders). Becomes the secondary view, resolved automatically.

  • audio_file_path (str) – Optional. Path to a dedicated audio file. Leave empty if there is no separate audio.

  • calibration_file_path (str) – Optional. Path to a calibration file (.json). Format (OpenCV or Unreal) is auto-detected from JSON structure. Leave empty if not available.

  • slate (str) – Optional. Slate name for the imported take. Derived from the first video’s filename if empty.

  • take_number (int32) – Optional. Take number. Defaults to 1 if less than 1.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

  • on_success (CaptureManagerIngestSuccess) – Called on the game thread when the import completes successfully.

  • on_failure (CaptureManagerIngestFailed) – Called on the game thread if the import fails.

Return type:

int32

classmethod ingest_stereo_video_sync(video_path_a, video_path_b, audio_file_path, calibration_file_path, slate, take_number, params) -> (FootageCaptureData, out_error_message=Text)

Import a dual-camera stereo video. Pass two video files (.mp4/.mov) or two image-sequence folders.

Parameters:

  • video_path_a (str) – Path to the first video file or image-sequence folder. Becomes the default primary camera for MHA processing.

  • video_path_b (str) – Path to the second video file or image-sequence folder. Must be the same type as the first video (both files, or both folders). Becomes the secondary view, resolved automatically.

  • audio_file_path (str) – Optional. Path to a dedicated audio file. Leave empty if there is no separate audio.

  • calibration_file_path (str) – Optional. Path to a calibration file (.json). Format (OpenCV or Unreal) is auto-detected from JSON structure. Leave empty if not available.

  • slate (str) – Optional. Slate name for the imported take. Derived from the first video’s filename if empty.

  • take_number (int32) – Optional. Take number. Defaults to 1 if less than 1.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

Returns:

out_error_message (Text): Set on failure; describes what went wrong.

Return type:

Text

classmethod ingest_take_archive(take_archive_path, params, on_success, on_failure) → int32

Import a take archive (.cptake) asynchronously. Accepts a directory path or a direct path to the .cptake file. Slate, take number, and device info are read from the archive metadata.

Parameters:

  • take_archive_path (str) – Path to the take directory or .cptake file. If a directory is given, searches for a .cptake file automatically.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

  • on_success (CaptureManagerIngestSuccess) – Called on the game thread when the import completes successfully.

  • on_failure (CaptureManagerIngestFailed) – Called on the game thread if the import fails.

Return type:

int32

classmethod ingest_take_archive_sync(take_archive_path, params) -> (FootageCaptureData, out_error_message=Text)

Import a take archive (.cptake). Accepts a directory path or a direct path to the .cptake file. Slate, take number, and device info are read from the archive metadata.

Parameters:

  • take_archive_path (str) – Path to the take directory or .cptake file. If a directory is given, searches for a .cptake file automatically.

  • params (CaptureManagerConversionParams) – Conversion settings (pixel format, rotation, output formats).

Returns:

out_error_message (Text): Set on failure; describes what went wrong.

Return type:

Text