@hypit/html-document
Build a browser-playable document from a Composition:
<import as="page" from="@hypit/html-document@1"/>
<page:Document id="preview" composition={main.composition}/>
The package-owned declaration consumes the completed Composition and uses its Timeline for
frame rate and duration. Markup contributes the Document spelling; direct APIs and other
Frontends use the same declaration compiler.
Select the document as an Invocation target:
<?svml using="@hypit/markup/invocation@1"?>
<svrun version="1">
<author source="./main.svml"/>
<target output="preview.document"/>
</svrun>
The HtmlDocument result contains a compiled HtmlProgram and its AudioProgram.
The Programme gives every visual dependency a document-local identity separate from
its Result-store Blob identity, so recursive Blob rebinding never requires a reverse
resource table. The Author Source owns durable material selection; the Invocation selects only the
document Target and any transient authored Record override.
Hosts turn the result into HTML by supplying material URLs:
import { materializeHtmlDocument } from "@hypit/html-document";
const html = materializeHtmlDocument(document, artifact => materialUrl(artifact), {
autoplay: true,
loop: true,
muted: true,
responsive: true,
});
The URL resolver can return relative paths, HTTP URLs or data URLs. It must
provide every resource referenced by the document. Autoplay, looping, muting
and responsive canvas sizing default to true.
Video sources carry the measured frame timestamps supplied by Prepare.
Browser playback selects a source frame from these timestamps and locates the
native decoder inside that frame's presentation interval, including for reverse
playback and variable frame rates.
The generated page displays the composition inside the iframe's viewport:
<iframe title="Preview" src="./preview.html"></iframe>
Hosts can also assign the generated HTML to iframe.srcdoc. The host page
provides any playback controls and uses the document's JavaScript API.
The page exposes window.__hypitDocument with ready, play(), pause(),
seekFrame(frame), setMuted(value), and read-only frame and playing values.
ready resolves when the initial frame and its materials are prepared.
Frame indices are integers in [0, document.program.frameCount).
Audible playback follows the browser's user-activation policy.
An embedding parent can send playback commands through postMessage:
iframe.contentWindow.postMessage({
type: "hypit.html-document.command@1",
action: "seek",
frame: 90,
}, "*");
Actions are play, pause, seek with frame, mute with muted, and state.
The document accepts commands from its embedding parent and serializes them.
It sends hypit.html-document.state@1 messages containing frame, frameCount,
frameRate and playing, at up to ten updates per second during playback and
immediately after state changes. Command errors use hypit.html-document.error@1.
The parent checks that event.source === iframe.contentWindow before using a message.