AutoMovie API
    Preparing search index...

    Function parseAutoMovieCapturePlanRequest

    • Read a capture plan request from named text values, the one reader every host maps its source onto: the page passes its address's URLSearchParams, the command passes the map of readAutoMovieCaptureArguments, and a component passes its props as text.

      A key given without a value reads as the empty string, which turns a switch on. AUTO_MOVIE_CAPTURE_PLAN_KEYS lists every key and formatAutoMovieCapturePlanRequest writes a request back. The inspection keys are read by parseAutoMovieInspectionRequest.

      Key Text Absent
      subject The name of the subject to load The host's only subject
      from, to Subject seconds of an even sampling, 0 <= from < to 0 and the subject's end
      rate Stills per second of an even sampling, positive 5
      at Exact seconds separated by commas, instead of from, to and rate Even sampling
      events Seconds separated by commas whose surrounding frames are drawn None
      window Frames drawn on each side of an event or cut, a whole number 3
      threshold The scdet score from 0 to 100 at which a video file's frame starts a new scene 10
      views View texts of the inspection view grammar separated by ; film
      passes Shades separated by commas, instead of shade The inspection's shade
      sweep A path pattern of the units drawn alone and with their neighbours No sweep
      margin Metres between two units' boxes that still make them neighbours, with sweep 0
      longest The reader's longest edge in pixels 1568
      smallest The smallest legible cell edge in pixels, at most longest 200
      reduction area or nearest area
      round A round name: letters, digits, ., _, - The unnamed capture
      compare An earlier round's name, not round No comparison
      tolerance Bytes 0 to 255 of channel difference counted as unchanged, with compare 0

      It throws an Error naming the key for a key it does not know, a key given twice, at beside from, to or rate, passes beside shade, margin without sweep, tolerance without compare, and a round compared against itself; and naming the key, the text and what is accepted for a value it cannot read. A view text is checked by parseAutoMovieInspectionView; whether the subject offers that view, and whether times lie within it, is planAutoMovieCapture's check.

      const request = parseAutoMovieCapturePlanRequest(new URL(location.href).searchParams);
      

      Parameters

      Returns IAutoMovieCapturePlanRequest