Media & Video
captureProductClip
Capture Product Clip
Record a real browser session of a Cloud page (or a Studio app route like "/a/<slug>") on one of your MachineSync machines, at device scale 2 with a single high-bitrate H.264 encode, and land the…
Arguments
appIdstringoptionalThe Studio video project (app) ID whose media pool the clip lands in. Required to start a capture.durationMsnumberoptionalLength of the clip in milliseconds, 1000 to 60000. Default 10000.interactionsobject[]optionalOptional script, run in order while recording: waits, clicks and scrolls. At most 40 steps.jobIdstringoptionalRead an earlier capture instead of starting one: the jobId captureProductClip returned.machineIdstringoptionalWhich machine records (from listMachines). Omit to let the least busy healthy one take it.urlstringoptionalThe page: a full URL ("https://www.thecloud.so/home") or a Cloud route ("/a/<slug>/menu"). Required to start a capture.viewportobjectoptionalThe page size in CSS pixels. The clip is twice this in real pixels. Default 1280x800.
Returns
Returns { jobId, status, expected pixel size } at once; call again with just the jobId for the landed clip (file URL, pixel size, pool item).
Ask for it
The Cloud routes these requests to this verb.
- record the dashboard for the video
- capture a clip of this page
- screen-record The Cloud at retina
- get a 10-second clip of the Studio page into my project
Pair it with
The verbs that finish the job.