AutoMovie API
    Preparing search index...

    Type Alias IAutoMovieDesignAnalysisOutcome

    IAutoMovieDesignAnalysisOutcome:
        | { candidates: string[]; status: "observed" }
        | { reason: string; status: "unsupported" }
        | { reason: string; status: "not-run" }

    What one attempted reading of a frame actually produced.

    observed is the only outcome that carries readings. An analysis this host cannot perform is unsupported, and one that was simply never executed is not-run; both carry a reason and no candidates, so an absent reading is never mistaken for a clean sheet.

    Type Declaration

    • { candidates: string[]; status: "observed" }
      • candidates: string[]

        Candidate ids this analysis produced; at least one, each resolving in the document and named once.

        An analysis reads one frame, so every candidate here is built from marks on that same frame. Correlating two sheets is the authored building's job through IAutoMovieDesignEvidence, which may cite candidates from any frame of any document.

      • status: "observed"

        The reading ran and produced candidates.

    • { reason: string; status: "unsupported" }
      • reason: string

        Non-blank statement of what is missing.

      • status: "unsupported"

        This host cannot perform the reading at all.

    • { reason: string; status: "not-run" }
      • reason: string

        Non-blank statement of why it was skipped.

      • status: "not-run"

        The reading is possible but was not executed.