Admin

Preview where a take would record (admins only).

A take records where it fits: a page drawn at 40 fps or more on a plain machine is light and goes to Browser Run (or a CPU runner); a heavier page, or one whose own sound is recorded, needs a runner that can (a GPU, PulseAudio or SleeperAudioTap). Allow-listed connections send their heavy (or unmeasured) pages to a shared-host GPU runner first, and their light pages there only when nothing else may take them. A busy or degraded runner hands the take to the next candidate; a take whose picture still stutters is re-recorded once on a heavier runner. A preview: nothing is recorded or changed. 404 not_found for an unknown connection. Scope: account:read. Free.

post/admin/capture-runners/preview

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/admin/capture-runners/preview
  • Auth: HTTP bearer

Request body

purpose'record' | 'sign-in-test'
connectionIdstring nullable

The app connection the take signs in with; omit for one of Sleeper's own takes.

sound'off' | 'app'
drawFpsnumber nullable

The smoothness preflight's draw rate for the tour's opening page; omit when not measured.

runnerstring nullable

auto, a runner's name, or browser-run: refused (never rerouted) when it breaks a hard rule.

Response

The route: its candidates in order, or why none may take it.

okboolean required
heavyboolean nullable required

Whether the page needs a GPU recorder; null when not measured.

needsstring[] required
code'no_recorder' | 'override_refused'

When not ok.

reasonstring

When not ok: why, in plain words.

reasonsstring[] required

Why each runner was or was not picked.

Changes

No recorded changes to this operation across all 1 revision of this API.