@reactor-models/lingbot-world-2 0.2.5

package/dist/core.d.mts

@@ -0,0 +1,370 @@
+import { Reactor, FileRef } from '@reactor-team/js-sdk';
+export { FileRef } from '@reactor-team/js-sdk';
+
+declare const MODEL_NAME: "reactor/lingbot-world-2";
+declare const MODEL_VERSION: "v0.2.5";
+/**
+ * Preset media tracks for the LingbotWorld2 model.
+ *
+ * Declared in the model's OpenAPI schema and passed to the SDK as
+ * `modelTracks` so the transport can prepare the SDP offer in
+ * parallel with session polling (faster first-frame latency).
+ */
+declare const LingbotWorld2Tracks: readonly [{
+    readonly name: "main_video";
+    readonly kind: "video";
+    readonly direction: "recvonly";
+}];
+/** Track names the client can subscribe to (recvonly, from the client's perspective). */
+type LingbotWorld2RecvTrackName = "main_video";
+/** Set seed */
+interface LingbotWorld2SetSeedParams {
+    /**
+     * Seed for the random generator used to sample the initial noise. Must be a non-negative integer; the model never draws its own random seed — pick one explicitly (or keep the default) for reproducible runs. Read once when `start` fires; later changes take effect only after `reset` followed by a new `start`.
+     * @minimum 0
+     * @default 42
+     */
+    seed?: number;
+}
+/** Provide a reference image that anchors generation (image-to-video). Call before `start`; the image is required for generation to begin. Changes during generation have no effect until `reset` is issued and `start` is called again. Emits `image_accepted`, `conditions_ready`, and `state` on success, or `command_error` if the file is missing, not an image, or cannot be decoded. */
+interface LingbotWorld2SetImageParams {
+    /**
+     * Reference to a file uploaded via the Reactor presigned-URL protocol.
+     * @default null
+     */
+    image?: FileRef;
+}
+/** Set the scene prompt. Valid at any time — call before `start` to arm generation, or hot-swap during generation to steer the next chunk. Emits `prompt_accepted`, `conditions_ready`, and `state` on success. */
+interface LingbotWorld2SetPromptParams {
+    /**
+     * Natural-language description of the scene to generate. Replaces the previously active prompt. Applied on the next chunk when generating; otherwise takes effect when `start` fires.
+     * @default ""
+     */
+    prompt?: string;
+}
+/** Set attn_window */
+interface LingbotWorld2SetAttnWindowParams {
+    /**
+     * Manual override for the DiT self-attention window. `auto` uses the motion-based still-window trigger (unchanged default behavior); `small` forces the still (small) window; `large` forces the moving (large) window. Can be changed at any time; the new value applies to the next chunk.
+     * @default "auto"
+     */
+    attn_window?: "auto" | "small" | "large";
+}
+/** Set camera_pose */
+interface LingbotWorld2SetCameraPoseParams {
+    /**
+     * Native camera-pose layer: a flat list of per-frame motion deltas, length a multiple of 6 — `[rx, ry, rz, tx, ty, tz]` per frame (small Euler-radian rotation + translation, in the camera-local frame). 6 floats = one delta applied to the whole chunk; 6*chunk_size = one delta per latent frame; any other 6*k is resampled to chunk_size. When active, rotation OVERRIDES look_horizontal / look_vertical and translation ADDS to WASD movement. Inputs are sanitized (NaN/Inf→0, rotations clamped to ±pi, translation to ±100), so any payload is safe. Pass an empty list (or omit) to deactivate.
+     * @maxLength 1536
+     * @default null
+     */
+    camera_pose?: unknown[];
+}
+/** Set move_lateral */
+interface LingbotWorld2SetMoveLateralParams {
+    /**
+     * Lateral (strafe left/right) camera translation. `idle` holds position; `strafe_left` / `strafe_right` translate sideways. Independent of `move_longitudinal` — both can be active together for diagonal movement. Can be changed at any time; the new value applies to the next chunk.
+     * @default "idle"
+     */
+    move_lateral?: "idle" | "strafe_left" | "strafe_right";
+}
+/** Set look_vertical */
+interface LingbotWorld2SetLookVerticalParams {
+    /**
+     * Vertical (pitch) camera rotation. `idle` holds pitch steady; `up` / `down` rotate the camera at the rate given by `rotation_speed_deg`. Can be changed at any time; the new value applies to the next chunk.
+     * @default "idle"
+     */
+    look_vertical?: "idle" | "up" | "down";
+}
+/** Set look_horizontal */
+interface LingbotWorld2SetLookHorizontalParams {
+    /**
+     * Horizontal (yaw) camera rotation. `idle` holds yaw steady; `left` / `right` rotate the camera at the rate given by `rotation_speed_deg`. Can be changed at any time; the new value applies to the next chunk.
+     * @default "idle"
+     */
+    look_horizontal?: "idle" | "left" | "right";
+}
+/** Set move_longitudinal */
+interface LingbotWorld2SetMoveLongitudinalParams {
+    /**
+     * Longitudinal (forward/back) camera translation. `idle` holds position; `forward` / `back` translate along the look axis. Independent of `move_lateral` — both can be active together for diagonal movement. Can be changed at any time; the new value applies to the next chunk.
+     * @default "idle"
+     */
+    move_longitudinal?: "idle" | "forward" | "back";
+}
+/** Set rotation_speed_deg */
+interface LingbotWorld2SetRotationSpeedDegParams {
+    /**
+     * Camera rotation speed in degrees per latent frame, applied when `look_horizontal` or `look_vertical` is not `idle`. Range 0.0 – 30.0. Ignored when both look axes are `idle`. Can be changed at any time; the new value applies to the next chunk.
+     * @minimum 0
+     * @maximum 30
+     * @default 5
+     */
+    rotation_speed_deg?: number;
+}
+/**
+ * Snapshot of the session's observable state.
+ *
+ * Emitted on connect, after every command that mutates session state (`set_prompt`, `set_image`, `start`, `pause`, `resume`, `reset`, and the auto-generated `set_<field>` setters), and after each `chunk_complete`. Clients can treat this as the single source of truth for driving UI, without having to track every individual command and message themselves.
+ */
+interface LingbotWorld2StateMessage {
+    type: "state";
+    /** Current value of the `seed` input field. The seed that was actually used by the running generation was captured when `start` fired — later changes to `seed` only take effect after `reset` and a new `start`. */
+    seed: number;
+    /** True while generation is paused via `pause`. */
+    paused: boolean;
+    /** True while the chunk loop is actively producing frames — equivalent to `started and not paused`. `False` both before `start` and while paused; read `started` to disambiguate. */
+    running: boolean;
+    /** True once `start` has been accepted. Remains true while paused; reset to false by `reset` or after `generation_complete` when the session is not auto-restarting. */
+    started: boolean;
+    /** True once a reference image has been set for the session. */
+    has_image: boolean;
+    /** True once a prompt has been set for the session. */
+    has_prompt: boolean;
+    /** Current value of the `move_lateral` input field. */
+    move_lateral: string;
+    /** Zero-based index of the last completed chunk. `0` before the first chunk has completed, and resets to `0` on `reset`. */
+    current_chunk: number;
+    /** Current value of the `look_vertical` input field. */
+    look_vertical: string;
+    /** Composite action string derived from `move_longitudinal`, `move_lateral`, `look_horizontal`, and `look_vertical` — a `+`-joined combination of `w`/`s`/`a`/`d` and `left`/`right`/`up`/`down`, or `still` when idle. */
+    current_action: string;
+    /** The prompt currently driving generation, or `null` if no prompt has been set for the session. */
+    current_prompt: unknown;
+    /** Current value of the `look_horizontal` input field. */
+    look_horizontal: string;
+    /** Current value of the `move_longitudinal` input field. */
+    move_longitudinal: string;
+    /** True when a non-empty `camera_pose` has been set. */
+    camera_pose_active: boolean;
+    /** Current value of the `rotation_speed_deg` input field (0.0 – 30.0). */
+    rotation_speed_deg: number;
+}
+/** Emitted when a command is rejected because preconditions are not met or its arguments could not be processed. */
+interface LingbotWorld2CommandErrorMessage {
+    type: "command_error";
+    /** Human-readable explanation of why the command was rejected. */
+    reason: string;
+    /** Name of the command that was rejected. */
+    command: string;
+}
+/** Emitted once per completed chunk of `main_video`. */
+interface LingbotWorld2ChunkCompleteMessage {
+    type: "chunk_complete";
+    /** Zero-based index of the chunk that just completed. */
+    chunk_index: number;
+    /** The composite action string used to drive this chunk — a `+`-joined combination of translation (`w`/`s`/`a`/`d`) and look directions (`left`/`right`/`up`/`down`), or `still` when the camera is stationary. */
+    active_action: string;
+    /** The prompt that was active while this chunk was generated. */
+    active_prompt: string;
+    /** Number of pixel frames emitted by this chunk. */
+    frames_emitted: number;
+}
+/** Emitted after `set_image` successfully decodes the uploaded file. */
+interface LingbotWorld2ImageAcceptedMessage {
+    type: "image_accepted";
+    /** Width in pixels of the decoded reference image. */
+    width: number;
+    /** Height in pixels of the decoded reference image. */
+    height: number;
+}
+/** Emitted after `set_prompt` is accepted. */
+interface LingbotWorld2PromptAcceptedMessage {
+    type: "prompt_accepted";
+    /** The prompt text that was accepted. */
+    prompt: string;
+}
+/** Emitted after `set_prompt` or `set_image` so the client can tell at a glance whether `start` will succeed. */
+interface LingbotWorld2ConditionsReadyMessage {
+    type: "conditions_ready";
+    /** True once a reference image has been set for the session. */
+    has_image: boolean;
+    /** True once a prompt has been set for the session. */
+    has_prompt: boolean;
+}
+/** Emitted after `reset` clears session state and returns to the waiting state. */
+interface LingbotWorld2GenerationResetMessage {
+    type: "generation_reset";
+    /** Short human-readable reason the reset was issued. */
+    reason: string;
+}
+/** Emitted in response to `pause`, once the current chunk finishes. */
+interface LingbotWorld2GenerationPausedMessage {
+    type: "generation_paused";
+    /** Index of the last completed chunk before pausing. */
+    chunk_index: number;
+}
+/** Emitted in response to `resume` when leaving the paused state. */
+interface LingbotWorld2GenerationResumedMessage {
+    type: "generation_resumed";
+    /** Index of the last completed chunk before resuming. */
+    chunk_index: number;
+}
+/** Emitted once when `start` succeeds and frames begin streaming. */
+interface LingbotWorld2GenerationStartedMessage {
+    type: "generation_started";
+    /** The prompt active at the start of generation. */
+    prompt: string;
+    /** Total number of chunks the run will produce before `generation_complete` fires. */
+    chunk_num: number;
+    /** Total number of pixel frames the run will emit on `main_video` before `generation_complete`. */
+    frame_num: number;
+}
+/** Emitted when all `chunk_num` chunks of a run have streamed. If the session is still `started`, a new run kicks off immediately with the same prompt and image; call `reset` to stop. */
+interface LingbotWorld2GenerationCompleteMessage {
+    type: "generation_complete";
+    /** Total number of chunks produced by the run. */
+    total_chunks: number;
+}
+type LingbotWorld2Message = LingbotWorld2StateMessage | LingbotWorld2CommandErrorMessage | LingbotWorld2ChunkCompleteMessage | LingbotWorld2ImageAcceptedMessage | LingbotWorld2PromptAcceptedMessage | LingbotWorld2ConditionsReadyMessage | LingbotWorld2GenerationResetMessage | LingbotWorld2GenerationPausedMessage | LingbotWorld2GenerationResumedMessage | LingbotWorld2GenerationStartedMessage | LingbotWorld2GenerationCompleteMessage;
+/**
+ * Options for creating a LingbotWorld2Model (model name is set automatically).
+ *
+ * Derived from `Reactor`'s own constructor options with `modelName`
+ * and `modelTracks` removed — those are supplied by this class.
+ * Any new option the SDK adds appears here automatically on the
+ * next `defaultSdkVersion` bump.
+ */
+type LingbotWorld2Options = Omit<ConstructorParameters<typeof Reactor>[0], "modelName" | "modelTracks">;
+/**
+ * Strongly-typed client for the LingbotWorld2 model.
+ *
+ * Extends {@link Reactor} with the model name (and modelTracks) baked into the
+ * constructor, so every public method on Reactor — `connect`, `disconnect`,
+ * `sendCommand`, `on`/`off`, `getStats`, `publishTrack`/`unpublishTrack`,
+ * etc. — is reachable directly on the instance. The schema-derived sugar
+ * below adds typed wrappers for every declared event, message, and track.
+ */
+declare class LingbotWorld2Model extends Reactor {
+    constructor(options?: LingbotWorld2Options);
+    /** @deprecated The model client now extends `Reactor` directly — call methods on `this` instead. This accessor returns `this` for backwards compatibility and will be removed in a future major release. */
+    get reactor(): this;
+    /** Pause generation after the current chunk finishes. Frames stop streaming on `main_video` until `resume` is called. Requires generation to be active. Emits `generation_paused` and `state` on success, or `command_error` if not generating or already paused. */
+    pause(): Promise<void>;
+    /** Abort the current run, clear the active prompt and reference image, and return to the waiting state. Valid at any time. After `reset`, call `set_prompt` and `set_image` again before `start` to begin a new session. Emits `generation_reset` and `state`. */
+    reset(): Promise<void>;
+    /** Begin generating video on `main_video`. Requires both a prompt (via `set_prompt`) and a reference image (via `set_image`). Emits `generation_started` and `state` on success, or `command_error` if a precondition is missing. Has no effect while already generating. */
+    start(): Promise<void>;
+    /** Resume generation from a previous `pause`. Requires the session to be paused. Emits `generation_resumed` and `state` on success, or `command_error` if not paused. */
+    resume(): Promise<void>;
+    /**
+     * Set seed
+     * @param params - Set seed
+     */
+    setSeed(params: LingbotWorld2SetSeedParams): Promise<void>;
+    /**
+     * Provide a reference image that anchors generation (image-to-video). Call before `start`; the image is required for generation to begin. Changes during generation have no effect until `reset` is issued and `start` is called again. Emits `image_accepted`, `conditions_ready`, and `state` on success, or `command_error` if the file is missing, not an image, or cannot be decoded.
+     * @param params - Provide a reference image that anchors generation (image-to-video). Call before `start`; the image is required for generation to begin. Changes during generation have no effect until `reset` is issued and `start` is called again. Emits `image_accepted`, `conditions_ready`, and `state` on success, or `command_error` if the file is missing, not an image, or cannot be decoded.
+     */
+    setImage(params: LingbotWorld2SetImageParams): Promise<void>;
+    /**
+     * Set the scene prompt. Valid at any time — call before `start` to arm generation, or hot-swap during generation to steer the next chunk. Emits `prompt_accepted`, `conditions_ready`, and `state` on success.
+     * @param params - Set the scene prompt. Valid at any time — call before `start` to arm generation, or hot-swap during generation to steer the next chunk. Emits `prompt_accepted`, `conditions_ready`, and `state` on success.
+     */
+    setPrompt(params: LingbotWorld2SetPromptParams): Promise<void>;
+    /**
+     * Set attn_window
+     * @param params - Set attn_window
+     */
+    setAttnWindow(params: LingbotWorld2SetAttnWindowParams): Promise<void>;
+    /**
+     * Set camera_pose
+     * @param params - Set camera_pose
+     */
+    setCameraPose(params: LingbotWorld2SetCameraPoseParams): Promise<void>;
+    /**
+     * Set move_lateral
+     * @param params - Set move_lateral
+     */
+    setMoveLateral(params: LingbotWorld2SetMoveLateralParams): Promise<void>;
+    /**
+     * Set look_vertical
+     * @param params - Set look_vertical
+     */
+    setLookVertical(params: LingbotWorld2SetLookVerticalParams): Promise<void>;
+    /**
+     * Set look_horizontal
+     * @param params - Set look_horizontal
+     */
+    setLookHorizontal(params: LingbotWorld2SetLookHorizontalParams): Promise<void>;
+    /**
+     * Set move_longitudinal
+     * @param params - Set move_longitudinal
+     */
+    setMoveLongitudinal(params: LingbotWorld2SetMoveLongitudinalParams): Promise<void>;
+    /**
+     * Set rotation_speed_deg
+     * @param params - Set rotation_speed_deg
+     */
+    setRotationSpeedDeg(params: LingbotWorld2SetRotationSpeedDegParams): Promise<void>;
+    /**
+     * Subscribe to typed model messages.
+     * @param handler - Called with a discriminated LingbotWorld2Message
+     * @returns Unsubscribe function
+     */
+    onMessage(handler: (message: LingbotWorld2Message) => void): () => void;
+    /**
+     * Subscribe to "state" messages only.
+     * @returns Unsubscribe function
+     */
+    onState(handler: (message: LingbotWorld2StateMessage) => void): () => void;
+    /**
+     * Subscribe to "command_error" messages only.
+     * @returns Unsubscribe function
+     */
+    onCommandError(handler: (message: LingbotWorld2CommandErrorMessage) => void): () => void;
+    /**
+     * Subscribe to "chunk_complete" messages only.
+     * @returns Unsubscribe function
+     */
+    onChunkComplete(handler: (message: LingbotWorld2ChunkCompleteMessage) => void): () => void;
+    /**
+     * Subscribe to "image_accepted" messages only.
+     * @returns Unsubscribe function
+     */
+    onImageAccepted(handler: (message: LingbotWorld2ImageAcceptedMessage) => void): () => void;
+    /**
+     * Subscribe to "prompt_accepted" messages only.
+     * @returns Unsubscribe function
+     */
+    onPromptAccepted(handler: (message: LingbotWorld2PromptAcceptedMessage) => void): () => void;
+    /**
+     * Subscribe to "conditions_ready" messages only.
+     * @returns Unsubscribe function
+     */
+    onConditionsReady(handler: (message: LingbotWorld2ConditionsReadyMessage) => void): () => void;
+    /**
+     * Subscribe to "generation_reset" messages only.
+     * @returns Unsubscribe function
+     */
+    onGenerationReset(handler: (message: LingbotWorld2GenerationResetMessage) => void): () => void;
+    /**
+     * Subscribe to "generation_paused" messages only.
+     * @returns Unsubscribe function
+     */
+    onGenerationPaused(handler: (message: LingbotWorld2GenerationPausedMessage) => void): () => void;
+    /**
+     * Subscribe to "generation_resumed" messages only.
+     * @returns Unsubscribe function
+     */
+    onGenerationResumed(handler: (message: LingbotWorld2GenerationResumedMessage) => void): () => void;
+    /**
+     * Subscribe to "generation_started" messages only.
+     * @returns Unsubscribe function
+     */
+    onGenerationStarted(handler: (message: LingbotWorld2GenerationStartedMessage) => void): () => void;
+    /**
+     * Subscribe to "generation_complete" messages only.
+     * @returns Unsubscribe function
+     */
+    onGenerationComplete(handler: (message: LingbotWorld2GenerationCompleteMessage) => void): () => void;
+    /**
+     * Subscribe to the "main_video" recvonly video track the model publishes.
+     *
+     * The handler fires once the model starts publishing this track; it receives the live MediaStreamTrack and the parent MediaStream (useful for attaching to a `<video>` / `<audio>` element via `srcObject`).
+     * @param handler - Called with the received track and its stream
+     * @returns Unsubscribe function
+     */
+    onMainVideo(handler: (track: MediaStreamTrack, stream: MediaStream) => void): () => void;
+}
+
+export { type LingbotWorld2ChunkCompleteMessage, type LingbotWorld2CommandErrorMessage, type LingbotWorld2ConditionsReadyMessage, type LingbotWorld2GenerationCompleteMessage, type LingbotWorld2GenerationPausedMessage, type LingbotWorld2GenerationResetMessage, type LingbotWorld2GenerationResumedMessage, type LingbotWorld2GenerationStartedMessage, type LingbotWorld2ImageAcceptedMessage, type LingbotWorld2Message, LingbotWorld2Model, type LingbotWorld2Options, type LingbotWorld2PromptAcceptedMessage, type LingbotWorld2RecvTrackName, type LingbotWorld2SetAttnWindowParams, type LingbotWorld2SetCameraPoseParams, type LingbotWorld2SetImageParams, type LingbotWorld2SetLookHorizontalParams, type LingbotWorld2SetLookVerticalParams, type LingbotWorld2SetMoveLateralParams, type LingbotWorld2SetMoveLongitudinalParams, type LingbotWorld2SetPromptParams, type LingbotWorld2SetRotationSpeedDegParams, type LingbotWorld2SetSeedParams, type LingbotWorld2StateMessage, LingbotWorld2Tracks, MODEL_NAME, MODEL_VERSION };