@norskvideo/moq-watch 0.2.0 → 0.2.2

package/video/renderer.d.ts

@@ -1,25 +1,34 @@
 import { Time } from "@norskvideo/moq-net";
 import { type Getter, type Inputs, type Readonlys, Signal } from "@norskvideo/moq-signals";
 import type { Decoder } from "./decoder";
+import { type VisibilitySource } from "./tab-visible";
 /**
  * Controls when video is downloaded relative to the canvas position.
  *
  * - `"never"`: never download video.
  * - `"always"`: always download video, regardless of the canvas position or tab visibility.
+ * - `"tab"`: download wherever the canvas is, while the tab is visible (an off-screen tile keeps
+ *   playing; a background tab stops).
  * - a CSS length (`"0px"`, `"200px"`, `"100%"`, ...): download while the canvas is within
  *   that distance of the viewport (used as the {@link IntersectionObserver} `rootMargin`) and
  *   the tab is visible. `"0px"` means strictly on screen; larger values pre-warm the video
  *   before it scrolls in.
+ *
+ * Whatever the policy, other than `"always"`, a hidden tab only stops video once it has been
+ * hidden for `hiddenGrace`, so a quick flip to another tab and back does not interrupt it.
  */
-export type Visible = "never" | "always" | (string & {});
+export type Visible = "never" | "always" | "tab" | (string & {});
 export type RendererInput = {
     canvas: Getter<HTMLCanvasElement | undefined>;
     visible: Getter<Visible>;
+    hiddenGrace: Getter<number>;
 };
 /** Constructor properties for {@link Renderer}. */
 export type RendererProps = Inputs<RendererInput> & {
     /** Decoder supplying video frames. */
     decoder: Decoder;
+    /** The document whose visibility counts. Defaults to the global `document`. */
+    document?: VisibilitySource;
 };
 type RendererOutput = {
     frame: Signal<VideoFrame | undefined>;

package/video/renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/video/renderer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAU,KAAK,MAAM,EAAU,KAAK,MAAM,EAAE,KAAK,SAAS,EAAa,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3G,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMzC;;;;;;;;;GASG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAG9C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;CACzB,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG;IACnD,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,KAAK,cAAc,GAAG;IAErB,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAGtC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IAI1C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;CACzB,CAAC;AAGF,qBAAa,QAAQ;;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAOtC,QAAQ,CAAC,GAAG,4BAAwB;IAKpC,YAAY,KAAK,EAAE,aAAa,EAe/B;IAmID,KAAK,SAOJ;CACD"}
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/video/renderer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAU,KAAK,MAAM,EAAU,KAAK,MAAM,EAAE,KAAK,SAAS,EAAa,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3G,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAc,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAKlE;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEjE,MAAM,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAG9C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAGzB,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;CAC5B,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG;IACnD,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAEF,KAAK,cAAc,GAAG;IAErB,KAAK,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAGtC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IAI1C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;CACzB,CAAC;AAGF,qBAAa,QAAQ;;IACpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAOtC,QAAQ,CAAC,GAAG,4BAAwB;IAMpC,YAAY,KAAK,EAAE,aAAa,EAiB/B;IA0ID,KAAK,SAQJ;CACD"}

package/video/tab-visible.d.ts

@@ -0,0 +1,28 @@
+import { type Getter, Signal } from "@norskvideo/moq-signals";
+/** What TabVisible watches: `document`, or a stand-in with the same event and flag. */
+export type VisibilitySource = EventTarget & {
+    readonly hidden: boolean;
+};
+/** Constructor properties for {@link TabVisible}. */
+export type TabVisibleProps = {
+    /** The document to watch. Defaults to the global `document`. */
+    doc?: VisibilitySource;
+    /** How long, in milliseconds, the tab must stay hidden before it counts as invisible. Defaults to 5000. */
+    grace?: Getter<number> | number;
+};
+/**
+ * Whether the tab counts as visible: true while it is shown, and false only once it has been
+ * hidden for the grace period.
+ *
+ * A background tab is throttled, so video that keeps downloading cannot be rendered in time,
+ * and on return the player fast-forwards through the backlog. Turning video off once the tab
+ * has been away for a while means it comes back at the live edge, while the grace keeps a
+ * quick flip to another tab and back from interrupting it.
+ */
+export declare class TabVisible {
+    #private;
+    readonly visible: Signal<boolean>;
+    constructor(props?: TabVisibleProps);
+    close(): void;
+}
+//# sourceMappingURL=tab-visible.d.ts.map

package/video/tab-visible.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tab-visible.d.ts","sourceRoot":"","sources":["../../src/video/tab-visible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,MAAM,EAAU,MAAM,EAAE,MAAM,cAAc,CAAC;AAEnE,uFAAuF;AACvF,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAE1E,qDAAqD;AACrD,MAAM,MAAM,eAAe,GAAG;IAC7B,gEAAgE;IAChE,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,2GAA2G;IAC3G,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAChC,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,UAAU;;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAMlC,YAAY,KAAK,GAAE,eAAoB,EAmBtC;IAED,KAAK,IAAI,IAAI,CAEZ;CACD"}