@vestra-player/sdk 1.5.31 → 1.5.33

package/dist/plugin/values.d.ts

@@ -50,6 +50,8 @@ import type { Json } from "../wire.ts";
  * ```
  *
  * @since 1.5.10
+ *
+ * @category Testing
  */
 export declare const UI_VALUE_LIMITS: {
     /** Nesting depth; the value itself is depth 0 (8). */
@@ -74,6 +76,9 @@ export declare const UI_VALUE_LIMITS: {
  * The player's runtime image limits (`src/host/src/ui/ui_image.rs`): a file's
  * bytes and sides, the decoded pixels each plugin caches, and (SDK 1.5.19,
  * player 0.5.1) the decoded pixels the nested images of one view may show.
+ *
+ * @since 1.5.19
+ * @category Testing
  */
 export declare const IMAGE_LIMITS: Readonly<{
     /** The largest image file the player reads, in bytes. */

package/dist/plugin/values.js

@@ -48,6 +48,8 @@
  * ```
  *
  * @since 1.5.10
+ *
+ * @category Testing
  */
 export const UI_VALUE_LIMITS = {
     /** Nesting depth; the value itself is depth 0 (8). */
@@ -82,6 +84,9 @@ function documentText(value) {
  * The player's runtime image limits (`src/host/src/ui/ui_image.rs`): a file's
  * bytes and sides, the decoded pixels each plugin caches, and (SDK 1.5.19,
  * player 0.5.1) the decoded pixels the nested images of one view may show.
+ *
+ * @since 1.5.19
+ * @category Testing
  */
 export const IMAGE_LIMITS = Object.freeze({
     /** The largest image file the player reads, in bytes. */

package/dist/processing.d.ts

@@ -29,6 +29,9 @@ import type { Transport } from "./wire.ts";
  * ];
  * plugin.video.filter("picture").set(chain);
  * ```
+ *
+ * @since 1.0.0
+ * @category Processing
  */
 export type VideoNode = 
 /** FFmpeg `eq`; every field is live. */
@@ -181,6 +184,9 @@ export type VideoNode =
  *   ],
  * });
  * ```
+ *
+ * @since 1.0.0
+ * @category Processing
  */
 export type AudioNode = 
 /** FFmpeg `volume`. */

package/dist/source-resolvers.d.ts

@@ -46,6 +46,9 @@ export type ResolvedResource = {
  *   },
  * });
  * ```
+ *
+ * @since 1.0.0
+ * @category Sources
  */
 export type ResolvedMedia = {
     /** Always `"media"`. */

package/dist/subtitles.d.ts

@@ -43,6 +43,9 @@ export type SubtitleStamp = {
  * };
  * await plugin.subtitles.setStyle(style);
  * ```
+ *
+ * @since 1.0.0
+ * @category Subtitles
  */
 export type SubtitleStyle = {
     /** A font id from {@link SubtitlesState.fonts}. */

package/dist/wire.d.ts

@@ -6,6 +6,9 @@ export declare const API_VERSION: "vestra/1";
 /**
  * A JSON value: what crosses the wire to the player. Slint property values,
  * callback arguments and protocol parameters are all `Json`.
+ *
+ * @since 1.0.0
+ * @category Plugin
  */
 export type Json = null | boolean | number | string | Json[] | {
     [key: string]: Json;
@@ -92,11 +95,21 @@ export interface UiCallback {
  * host.reset("clipboard.writeText"); // writes succeed again
  * await stop();
  * ```
+ *
+ * @remarks
+ * A definite refusal, as opposed to a lost reply: the SDK does not retry
+ * it, and the plugin sees an `Error` with `code`.
+ *
+ * @capability None.
+ * @since 1.0.0
+ * @category Testing
  */
 export declare class HostError extends Error {
     /** The stable error code, e.g. `"invalid"`, `"stale"`, `"unavailable"`. */
     code: string;
     /**
+     * A refusal with this code, as the player would send it.
+     *
      * @param code - The stable error code the caller will see as `error.code`.
      * @param message - Human-readable detail (not for branching on).
      */

package/dist/wire.js

@@ -52,11 +52,21 @@ export const API_VERSION = "vestra/1";
  * host.reset("clipboard.writeText"); // writes succeed again
  * await stop();
  * ```
+ *
+ * @remarks
+ * A definite refusal, as opposed to a lost reply: the SDK does not retry
+ * it, and the plugin sees an `Error` with `code`.
+ *
+ * @capability None.
+ * @since 1.0.0
+ * @category Testing
  */
 export class HostError extends Error {
     /** The stable error code, e.g. `"invalid"`, `"stale"`, `"unavailable"`. */
     code;
     /**
+     * A refusal with this code, as the player would send it.
+     *
      * @param code - The stable error code the caller will see as `error.code`.
      * @param message - Human-readable detail (not for branching on).
      */