ogplayer 1.2.1 → 1.2.2

package/dist/ui/keymap.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Keyboard shortcuts for `<og-player>` — the map from `KeyboardEvent.key` to
+ * a player action, kept DOM-free so the resolution is unit-testable.
+ * Desktop keyboards only; TV remotes are a separate concern and are not
+ * wired through here.
+ *
+ * The default map is the one viewers already know from the big video sites:
+ * Space/K play-pause, ←/→ and J/L seek by the player's seek increment,
+ * ↑/↓ volume, M mute, F fullscreen, C subtitles, 0–9 jump to 0–90 % (VOD),
+ * Home/End start/end (live edge on live), Esc leaves fullscreen.
+ */
+export type OGKeyAction = "playPause" | "seekBackward" | "seekForward" | "volumeUp" | "volumeDown" | "toggleMute" | "toggleFullscreen" | "exitFullscreen" | "toggleSubtitles" | "seekToStart" | "seekToEnd" | "seekToPercent";
+/** Per-key overrides merged over {@link DEFAULT_KEYMAP}: `null` removes a
+ *  key, an action adds or remaps one. Keys are `KeyboardEvent.key` values;
+ *  single characters are matched case-insensitively. */
+export type OGKeymap = Partial<Record<string, OGKeyAction | null>>;
+export declare const DEFAULT_KEYMAP: Readonly<Record<string, OGKeyAction>>;
+/** Single characters compare case-insensitively ("M" and "m" are one key);
+ *  named keys ("ArrowLeft", "Home") are used as they come. */
+export declare function normalizeKey(key: string): string;
+/** The effective map: defaults, then the host's overrides on top. Never
+ *  mutates {@link DEFAULT_KEYMAP}. */
+export declare function mergeKeymap(overrides?: OGKeymap): Record<string, OGKeyAction>;
+export interface KeyLike {
+    key: string;
+    ctrlKey?: boolean;
+    metaKey?: boolean;
+    altKey?: boolean;
+}
+export interface ResolvedKey {
+    action: OGKeyAction;
+    /** 0–9 for `seekToPercent` (the digit key that was pressed). */
+    digit?: number;
+}
+/**
+ * Which action, if any, a key press means under `keymap`. Returns `null` for
+ * keys that are not ours — including every modifier chord (Ctrl/Cmd/Alt),
+ * which stays with the browser and the page. `seekToPercent` only resolves
+ * from a digit key, because the digit is the target.
+ */
+export declare function resolveKeyAction(e: KeyLike, keymap: Record<string, OGKeyAction>): ResolvedKey | null;

package/dist/ui/og-player.d.ts

@@ -1,6 +1,7 @@
 import type { OGPlayer } from "../core/player.js";
 import type { OGPlayerError } from "../core/types.js";
 import { type OGControlColors, type OGControlDimens } from "./tokens.js";
+import { type OGKeymap } from "./keymap.js";
 /** A host-supplied icon button rendered left of the (future) cast position —
  * icon-only, max 8, part of the chrome (mirrors Android/iOS `CustomAction`). */
 export interface CustomAction {
@@ -101,6 +102,18 @@ export interface OGUIConfig {
     /** Extra inline CSS for the card (same contract as `titleStyle`), e.g.
      *  "background:#F6C445E6;color:#131313;font-family:Georgia,serif". */
     upNextStyle?: string;
+    /** Keyboard shortcuts while the player has focus (default true): Space/K
+     *  play-pause, ←/→ and J/L seek by the seek increment, ↑/↓ volume, M mute,
+     *  F fullscreen, C subtitles on/off, 0–9 jump to 0–90 % (VOD), Home/End
+     *  start/end (live edge on live), Esc leaves fullscreen. Seek keys obey
+     *  the live rules and stay inert during ads. `false` = the element handles
+     *  no keys at all (not even Space) — the host owns the keyboard. */
+    keyboardShortcuts: boolean;
+    /** Per-key overrides merged over the default map: `{ m: null }` removes
+     *  mute, `{ p: "playPause" }` adds a key, `{ ArrowUp: "seekForward" }`
+     *  remaps one. Keys are KeyboardEvent.key values; letters are
+     *  case-insensitive. Unmapped keys pass through to the page. */
+    keymap?: OGKeymap;
 }
 export declare const defaultUIConfig: OGUIConfig;
 /** Every control flag off — headless chrome in one call (mobile parity:
@@ -143,6 +156,8 @@ export declare class OGPlayerElement extends HTMLElement {
     constructor();
     get player(): OGPlayer | null;
     set player(p: OGPlayer | null);
+    /** Subtitle track the C key switched off, restored on the next press. */
+    private lastTextTrackId;
     get config(): OGUIConfig;
     set config(c: Partial<OGUIConfig>);
     connectedCallback(): void;
@@ -202,6 +217,11 @@ export declare class OGPlayerElement extends HTMLElement {
      * a "starts in fullscreen" flow calls this from its start button. */
     enterFullscreen(): Promise<void>;
     exitFullscreen(): void;
+    /** One keyboard shortcut → one player action. Seek keys follow the live
+     *  rules (nothing on edge-locked LIVE, window-bound on LIVE_DVR, End = the
+     *  live edge) and stay inert during ads; volume, mute and fullscreen work
+     *  everywhere. Actions that change what the viewer sees raise the chrome. */
+    private runKeyAction;
     private toggleFullscreen;
     private detach;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ogplayer",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "OGPlayer video player for the browser — an <og-player> web component with HLS, DRM (Widevine, PlayReady, FairPlay), Google IMA ads, playlists and themeable controls.",
   "type": "module",
   "main": "./dist/ogplayer.js",