CaptureResult ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Interface · import type { CaptureResult } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 16. Capture, export, AR

What a capture returns.

Members ​

Member Kind Summary
image property The encoded image (format).
completed property False: readiness expired or a late swap (a detail map) had not landed; stand-ins may show.
snapshot property What the image shows, for repeatability and audit.
problems property Non-fatal problems of this capture (e.g. 'ready-timeout', or 'asset-failed' for a slot drawn with the stand-in of a detail map that failed).

Declaration ​

ts
export interface CaptureResult {
  readonly image: Blob;
  readonly completed: boolean;
  readonly snapshot: {
    readonly source: 'render' | 'displayed' | 'other';
    readonly revision: number;
    readonly seq: number;
    readonly frame: number;
    readonly settled: boolean;
    readonly sceneHash: string;
    readonly camera: Pick<CameraState, 'position' | 'target' | 'fovDeg' | 'aspect'>;
    readonly size: {
      readonly width: number;
      readonly height: number;
      readonly pixelRatio: number;
    };
    readonly runtime: string;
  };
  readonly problems: readonly Problem[];
}

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: CaptureResult names no product
2. A precedent pass: a correctness rule (rows G21)
3. Two apps, or labs pass: 24 apps (ledger: app-c1384707fc; fleet cross-check: app-04c2774145, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508, app-822bb9d6aa, app-8675b3225c, app-b362a81c85 and 16 more)
4. The cheaper fix first decided per need in Appendix B: rows G21 at tier stable (a member only where no rule, data, asset or app code serves the need)