Capture Studio Docs
View packages

Capture

Readiness and state

Prepare, wait for stable-ready conditions, and restore editor state after every outcome.

Capture Studio 26.8.5Unity 6000.0+Built-in · URP · HDRPEditor onlyOffline first

Capture Studio snapshots open scenes, active scene, play and pause state, selected Game View size, quality level, locale when Localization is present, time and capture settings, Recorder objects, targeted camera state, activated GameObjects, and package-owned temporary resources.

The snapshot and run journal are written before mutation. Restoration runs after success, cancellation, preflight-safe failure, exception, domain reload, or recoverable editor restart. The Review workspace lists interrupted runs and provides an explicit restore action.

Extension checks

Implement ICaptureReadinessProbe when a project needs a stable condition such as simulation convergence, content streaming completion, or application-specific state. A check returns:

  • Succeeded=false for a failed check;
  • Succeeded=true, Ready=false while waiting;
  • Succeeded=true, Ready=true when the condition is satisfied.

Use CaptureRunContext.State only for data owned by the active run. Put durable customer configuration in project assets. Preparation and cleanup code must honor the provided cancellation token and avoid unbounded work on the editor thread.

Recovery data is local. Cache cleanup preserves recovery journals by design. Uninstall also preserves recovery and evidence unless the user deletes them explicitly.

Still stuck?

Bring the run receipt with you.

Include the Capture Studio version, Unity version, operating system, render pipeline, Recorder version, output profile, receipt, restoration status, and a minimal reproduction.

Email supportJoin Discord

Capture Studio 26.8.5

Search documentation