@vestra-player/sdk 1.5.31 → 1.5.34

package/llms.txt

@@ -1,6 +1,6 @@
 # Vestra Player SDK
 
-> @vestra-player/sdk 1.5.31: write plugins for Vestra Player in TypeScript (plugin API `vestra/1`). A plugin is a folder with `manifest.json` and an entry module whose default export `activate(plugin)` the player calls; it runs in its own Node.js process. Everything a plugin creates (commands, windows, panels, filters, listeners…) is a handle that is released automatically when the plugin stops. L<n>: a line of llms-full.txt (next to this file), which has every page, declaration and example.
+> @vestra-player/sdk 1.5.34: write plugins for Vestra Player in TypeScript (plugin API `vestra/1`). A plugin is a folder with `manifest.json` and an entry module whose default export `activate(plugin)` the player calls; it runs in its own Node.js process. Everything a plugin creates (commands, windows, panels, filters, listeners…) is a handle that is released automatically when the plugin stops. L<n>: a line of llms-full.txt (next to this file), which has every page, declaration and example.
 
 **Rules**
 
@@ -33,7 +33,7 @@ my-plugin/
 }
 ```
 
-Fields: `id`, `version`, `apiVersion`, `entry`, `capabilities`, `name`, `author`, `punchline`, `description`, `tags`, `icon`, `readme`, `changelog`, `sourceUrl`, `license`, `minPlayerVersion`; unknown fields and capabilities are rejected. Rules and limits: L2428–2495.
+Fields: `id`, `version`, `apiVersion`, `entry`, `capabilities`, `name`, `author`, `punchline`, `description`, `tags`, `icon`, `readme`, `changelog`, `sourceUrl`, `license`, `minPlayerVersion`; unknown fields and capabilities are rejected. Rules and limits: L2507–2575.
 
 **main.ts**
 
@@ -76,9 +76,9 @@ export default async function activate(plugin: Plugin) {
 - `ui.settings`: Settings.page/show
 - `ui.theme`: Appearance.set/setLanguage
 - `secrets`: Secrets.get/set/delete
-- No capability: `tools`, `storage`, `system`, `app`, `ui` (images and Markdown), `i18n`, reading window.state, appearance.theme and packages.list. Details: L2496–2554.
+- No capability: `tools`, `storage`, `system`, `app`, `ui` (images and Markdown), `i18n`, reading window.state, appearance.theme and packages.list. Details: L2576–2634.
 
-**Test**: `tests/*.test.ts` with `node:test`, run by `vestra-plugin test`. `startPlugin(activate, { directory: new URL("..", import.meta.url) })` from `@vestra-player/sdk/testing` returns `{ host, stop }`, `host` an in-memory player (TestHost): act (`host.command(id).run()`, `host.press(key)`), `await host.settle()`, assert on `host.osd`, `host.window(id).props`… Guide: L1869–2057; TestHost: L10902.
+**Test**: `tests/*.test.ts` with `node:test`, run by `vestra-plugin test`. `startPlugin(activate, { directory: new URL("..", import.meta.url) })` from `@vestra-player/sdk/testing` returns `{ host, stop }`, `host` an in-memory player (TestHost): act (`host.command(id).run()`, `host.press(key)`), `await host.settle()`, assert on `host.osd`, `host.window(id).props`… Guide: L1948–2136; TestHost: L12044.
 
 **Command line**
 
@@ -105,40 +105,40 @@ export default async function activate(plugin: Plugin) {
 - `timeout`: A time limit ran out
 - `limit`: A player-wide limit was reached, a property value is over the limits of PropValue
 - `reserved`: The id is `vestra` or starts with `vestra.`
-- `versionMismatch`: The package needs a newer player or another `apiVersion`
-- Others: PluginError, llms-full.txt L3516.
+- `versionMismatch`: The package needs a newer player
+- Others: PluginError, llms-full.txt L3634.
 
 ## Reference
 
 - [llms-full.txt](https://vestrasys.github.io/vestra-player-sdk/llms-full.txt), also node_modules/@vestra-player/sdk/llms-full.txt; pages: [site](https://vestrasys.github.io/vestra-player-sdk/).
 - Tutorials: Getting started L9–237
 - Concepts: How a plugin runs L238–408; Commands, menus and key bindings L409–520; Playback state, controls and sources L521–666; Video and audio processing L667–745; Windows, panels, settings pages, dialogs and the OSD L746–1034
-- How-to: Control playback L1035–1163; Store a plugin's data L1164–1231; Keep a slider responsive while dragging L1232–1406; Remember a window's state between runs L1407–1536; Translate a plugin L1537–1720; Migrate a plugin to English source text L1721–1868; Test a plugin L1869–2057; Publish a plugin L2058–2146; Migrating off package rollback (1.5.16, removed in 1.5.17) L2147–2222
-- Guidelines: Interface guidelines L2223–2330; Menu guidelines L2331–2427
-- Reference: Manifest L2428–2495; Capabilities L2496–2554; Limits L2555–2669; Commands, menus and bindings L2670–3152; Platforms L3153–3181; Theme L3182–3403; Command line L3404–3461
-- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L3462–10678
-- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html): L10679–12888
+- How-to: Control playback L1035–1163; Store a plugin's data L1164–1231; Load subtitles from a plugin L1232–1310; Keep a slider responsive while dragging L1311–1485; Remember a window's state between runs L1486–1615; Translate a plugin L1616–1799; Migrate a plugin to English source text L1800–1947; Test a plugin L1948–2136; Publish a plugin L2137–2225; Migrating off package rollback (1.5.16, removed in 1.5.17) L2226–2301
+- Guidelines: Interface guidelines L2302–2409; Menu guidelines L2410–2506
+- Reference: Manifest L2507–2575; Capabilities L2576–2634; Limits L2635–2764; Commands, menus and bindings L2765–3247; Platforms L3248–3276; Theme L3277–3498; Command line L3499–3556
+- [API: @vestra-player/sdk](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk.html): L3557–11728
+- [API: @vestra-player/sdk/testing](https://vestrasys.github.io/vestra-player-sdk/modules/_vestra-player_sdk_testing.html): L11729–14320
 
 ## API
 
 Where each `plugin.<module>` is declared:
 
-- Plugin L3765, Scope L3592, PluginError L3516, Disposable L3477
-- Commands L4156; Windows L5093; Panels L6512; Dialogs L6973; Player L7714; video: VideoFilter L8594, VideoView L8680, RenderOptions L8734; audio: AudioFilter L8631; Subtitles L8847; media: MediaCapture L9033; Resolvers L9204; Packages L9487; Osd L8459; Host L8301; Clipboard L9646; Power L9733; Tools L9792; Storage L9944; System L10143; Secrets L10223; window: MainWindow L6767; App L6879; Bindings L9604; Ui L4445; Timeline L6724; Drops L5786; Appearance L5840; I18n L6073; Settings L6356.
+- Plugin L3954, Scope L3709, PluginError L3634, Disposable L3572
+- Commands L4351; Windows L5288; Panels L6734; Dialogs L7381; Player L8122; video: VideoFilter L9002, VideoView L9102, RenderOptions L9189; audio: AudioFilter L9047; Subtitles L9336; media: MediaCapture L9740; Resolvers L9970; Packages L10368; Osd L8867; Host L8709; Clipboard L10696; Power L10783; Tools L10842; Storage L10994; System L11193; Secrets L11273; window: MainWindow L7051; App L7231; Bindings L10596; Ui L4640; Timeline L6963; Drops L5981; Appearance L6062; I18n L6295; Settings L6578.
 
 ## Examples
 
 Tested plugins in [examples/](https://github.com/vestrasys/vestra-player-sdk/tree/main/examples):
 
-- hello: The README Quick start: one menu command and an on-screen message. L13319–13408
-- blur: A tool window with one slider that blurs the playing video. L13409–13670
-- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L13671–14003
-- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L14004–14190
-- panel-menu: A sidebar panel with its own right-click menu. L14191–14399
-- menus: Radio menu items, separator groups and a menu item whose title changes. L14400–14559
-- theme-widgets: A tool window drawn with the player's theme and widgets. L14560–14723
-- markdown: A window that shows a Markdown document. L14724–14920
-- i18n: A plugin in the player's language: English source text, a Chinese translation. L14921–15088
+- hello: The README Quick start: one menu command and an on-screen message. L14753–14842
+- blur: A tool window with one slider that blurs the playing video. L14843–15104
+- signal-generator: Generates its own video and audio: colour bars and a 1 kHz tone. L15105–15437
+- bookmark: A tool window bound to the playback state: remember the position and jump back to it. L15438–15624
+- panel-menu: A sidebar panel with its own right-click menu. L15625–15833
+- menus: Radio menu items, separator groups and a menu item whose title changes. L15834–15993
+- theme-widgets: A tool window drawn with the player's theme and widgets. L15994–16157
+- markdown: A window that shows a Markdown document. L16158–16354
+- i18n: A plugin in the player's language: English source text, a Chinese translation. L16355–16522
 
 ## Optional
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vestra-player/sdk",
-  "version": "1.5.31",
+  "version": "1.5.34",
   "description": "Plugin API types, test host and plugin CLI for Vestra Player (apiVersion vestra/1)",
   "license": "Apache-2.0",
   "repository": {