screenshot

Capture a screenshot from a video asset at a specific timecode.

screenshot

Capture a screenshot from a video asset at a specific timecode.

Capture a still from a video at a SMPTE timecode; stored on the asset.

Safety class: A · API type: admin · Min version:

📘

Confinement

asset_id must be within your run-root anchor; the screenshot is stored on that asset, so it stays confined.

Signatures

def screenshot(sdk, asset_id, time_code):
    """Capture a screenshot of asset_id at the given SMPTE timecode."""
    return sdk.create_screenshot_at_timecode(asset_id, time_code)
export async function screenshot(sdk, assetId, timeCode) {
    // Capture a still from a video at a SMPTE timecode; stored on the asset.
    return await sdk.createScreenshotAtTimecode(assetId, timeCode);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
asset_idassetIdstryese.g. <video-asset-uuid>
time_codetimeCodestryese.g. 00:00:00;05

Returns

dict | None — the screenshot job/record; the image is stored alongside the asset's screenshots.

Errors

  • 401 unauthenticated
  • 404 asset not found
  • source must be a processed video

See also: Python ↔ JS naming map · Return shapes.