@roboflow/inference-sdk 0.1.7 → 0.1.9

package/dist/webrtc.d.ts

@@ -1,4 +1,7 @@
 import { Connector, WebRTCParams } from "./inference-api";
+import { WebRTCOutputData } from "./webrtc-types";
+export type { WebRTCVideoMetadata, WebRTCOutputData } from "./webrtc-types";
+export { FileUploader } from "./video-upload";
 /**
  * Reassembles chunked binary messages from the datachannel
  */
@@ -29,24 +32,33 @@ export interface UseStreamParams {
     source: MediaStream;
     connector: Connector;
     wrtcParams: WebRTCParams;
-    onData?: (data: any) => void;
+    onData?: (data: WebRTCOutputData) => void;
     options?: UseStreamOptions;
 }
 /**
  * WebRTC Connection object
  *
- * Represents an active WebRTC connection to Roboflow for streaming inference.
+ * Represents an active WebRTC connection to Roboflow for streaming inference
+ * or file-based batch processing.
  */
 export declare class RFWebRTCConnection {
     private pc;
-    private _localStream;
+    private _localStream?;
     private remoteStreamPromise;
     private pipelineId;
     private apiKey;
     private dataChannel;
     private reassembler;
+    private uploadChannel?;
+    private uploader?;
+    private onComplete?;
     /** @private */
-    constructor(pc: RTCPeerConnection, localStream: MediaStream, remoteStreamPromise: Promise<MediaStream>, pipelineId: string | null, apiKey: string | null, dataChannel: RTCDataChannel, onData?: (data: any) => void);
+    constructor(pc: RTCPeerConnection, remoteStreamPromise: Promise<MediaStream>, pipelineId: string | null, apiKey: string | null, dataChannel: RTCDataChannel, options?: {
+        localStream?: MediaStream;
+        uploadChannel?: RTCDataChannel;
+        onData?: (data: any) => void;
+        onComplete?: () => void;
+    });
     /**
      * Get the remote stream (processed video from Roboflow)
      *
@@ -63,21 +75,23 @@ export declare class RFWebRTCConnection {
     /**
      * Get the local stream (original camera)
      *
-     * @returns The local MediaStream
+     * @returns The local MediaStream, or undefined if using file upload mode
      *
      * @example
      * ```typescript
      * const conn = await useStream({ ... });
      * const localStream = conn.localStream();
-     * videoElement.srcObject = localStream;
+     * if (localStream) {
+     *   videoElement.srcObject = localStream;
+     * }
      * ```
      */
-    localStream(): MediaStream;
+    localStream(): MediaStream | undefined;
     /**
      * Cleanup and close connection
      *
      * Terminates the pipeline on Roboflow, closes the peer connection,
-     * and stops the local media stream.
+     * and stops the local media stream (if applicable).
      *
      * @returns Promise that resolves when cleanup is complete
      *
@@ -89,6 +103,26 @@ export declare class RFWebRTCConnection {
      * ```
      */
     cleanup(): Promise<void>;
+    /**
+     * Start uploading a file through the connection
+     *
+     * @param file - The file to upload
+     * @param onProgress - Optional callback for progress updates (bytesUploaded, totalBytes)
+     * @returns Promise that resolves when upload is complete
+     * @throws Error if no upload channel is available
+     *
+     * @example
+     * ```typescript
+     * await connection.startUpload(videoFile, (uploaded, total) => {
+     *   console.log(`Upload progress: ${(uploaded / total * 100).toFixed(1)}%`);
+     * });
+     * ```
+     */
+    startUpload(file: File, onProgress?: (bytesUploaded: number, totalBytes: number) => void): Promise<void>;
+    /**
+     * Cancel any ongoing file upload
+     */
+    cancelUpload(): void;
     /**
      * Reconfigure pipeline outputs at runtime
      *
@@ -168,4 +202,110 @@ export declare class RFWebRTCConnection {
  * ```
  */
 export declare function useStream({ source, connector, wrtcParams, onData, options }: UseStreamParams): Promise<RFWebRTCConnection>;
+/**
+ * Parameters for useVideoFile function
+ */
+export interface UseVideoFileParams {
+    /** The video file to upload */
+    file: File;
+    /** Connector for WebRTC signaling */
+    connector: Connector;
+    /** WebRTC parameters for the workflow */
+    wrtcParams: WebRTCParams;
+    /** Callback for inference results */
+    onData?: (data: WebRTCOutputData) => void;
+    /** Callback for upload progress */
+    onUploadProgress?: (bytesUploaded: number, totalBytes: number) => void;
+    /** Callback when processing completes (datachannel closes) */
+    onComplete?: () => void;
+}
+/**
+ * Upload a video file for batch inference processing
+ *
+ * Creates a WebRTC connection to Roboflow for uploading a video file
+ * and receiving inference results. The file is uploaded via datachannel
+ * with intelligent backpressure handling.
+ *
+ * @param params - Connection parameters
+ * @returns Promise resolving to RFWebRTCConnection
+ *
+ * @example
+ * ```typescript
+ * import { connectors, webrtc } from './index.ts';
+ *
+ * const connector = connectors.withApiKey("your-api-key");
+ * const connection = await webrtc.useVideoFile({
+ *   file: videoFile,
+ *   connector,
+ *   wrtcParams: {
+ *     workflowSpec: { ... },
+ *     imageInputName: "image",
+ *     dataOutputNames: ["predictions"]
+ *   },
+ *   onData: (data) => {
+ *     console.log("Inference results:", data);
+ *     if (data.processing_complete) {
+ *       console.log("Processing complete!");
+ *     }
+ *   },
+ *   onUploadProgress: (uploaded, total) => {
+ *     console.log(`Upload: ${(uploaded / total * 100).toFixed(1)}%`);
+ *   }
+ * });
+ *
+ * // When done
+ * await connection.cleanup();
+ * ```
+ */
+export declare function useVideoFile({ file, connector, wrtcParams, onData, onUploadProgress, onComplete }: UseVideoFileParams): Promise<RFWebRTCConnection>;
+/**
+ * Parameters for useRtspStream function
+ */
+export interface UseRtspStreamParams {
+    /** RTSP URL for server-side video capture (e.g., "rtsp://camera.local/stream") */
+    rtspUrl: string;
+    /** Connector for WebRTC signaling */
+    connector: Connector;
+    /** WebRTC parameters for the workflow */
+    wrtcParams: WebRTCParams;
+    /** Callback for inference results */
+    onData?: (data: WebRTCOutputData) => void;
+}
+/**
+ * Connect to an RTSP stream for inference processing
+ *
+ * Creates a WebRTC connection where the server captures video from an RTSP URL
+ * and sends processed video back to the client. This is a receive-only mode -
+ * no video is sent from the browser to the server.
+ *
+ * @param params - Connection parameters
+ * @returns Promise resolving to RFWebRTCConnection
+ *
+ * @example
+ * ```typescript
+ * import { connectors, webrtc } from './index.ts';
+ *
+ * const connector = connectors.withApiKey("your-api-key");
+ * const connection = await webrtc.useRtspStream({
+ *   rtspUrl: "rtsp://camera.local/stream",
+ *   connector,
+ *   wrtcParams: {
+ *     workflowSpec: { ... },
+ *     imageInputName: "image",
+ *     dataOutputNames: ["predictions"]
+ *   },
+ *   onData: (data) => {
+ *     console.log("Inference results:", data);
+ *   }
+ * });
+ *
+ * // Get processed video stream from server
+ * const remoteStream = await connection.remoteStream();
+ * videoElement.srcObject = remoteStream;
+ *
+ * // When done
+ * await connection.cleanup();
+ * ```
+ */
+export declare function useRtspStream({ rtspUrl, connector, wrtcParams, onData }: UseRtspStreamParams): Promise<RFWebRTCConnection>;
 //# sourceMappingURL=webrtc.d.ts.map

package/dist/webrtc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webrtc.d.ts","sourceRoot":"","sources":["../src/webrtc.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,SAAS,EAAE,YAAY,EAAsB,MAAM,iBAAiB,CAAC;AASnG;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,aAAa,CAGN;IAEf;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI;IAqC9G;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,UAAU,CAAA;CAAE,CAQxI;AAED,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,YAAY,CAAC;IACzB,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAmID;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,EAAE,CAAoB;IAC9B,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAAiB;IACpC,OAAO,CAAC,WAAW,CAAmB;IAEtC,eAAe;gBAEb,EAAE,EAAE,iBAAiB,EACrB,WAAW,EAAE,WAAW,EACxB,mBAAmB,EAAE,OAAO,CAAC,WAAW,CAAC,EACzC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,cAAc,EAC3B,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAsD9B;;;;;;;;;;;OAWG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,WAAW,IAAI,WAAW;IAI1B;;;;;;;;;;;;;;OAcG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,kBAAkB,CAAC,MAAM,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI;IAclG;;;OAGG;IACH,OAAO,CAAC,QAAQ;CAajB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,SAAS,CAAC,EAC9B,MAAM,EACN,SAAS,EACT,UAAU,EACV,MAAM,EACN,OAAY,EACb,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA0F/C"}
+{"version":3,"file":"webrtc.d.ts","sourceRoot":"","sources":["../src/webrtc.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,SAAS,EAAE,YAAY,EAAsB,MAAM,iBAAiB,CAAC;AAEnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAIlD,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAG5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAQ9C;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,aAAa,CAGN;IAEf;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI;IAqC9G;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,UAAU,CAAA;CAAE,CAQxI;AAED,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,YAAY,CAAC;IACzB,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC1C,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AA6LD;;;;;GAKG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,EAAE,CAAoB;IAC9B,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAAiB;IACpC,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,aAAa,CAAC,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,CAAe;IAChC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC,eAAe;gBAEb,EAAE,EAAE,iBAAiB,EACrB,mBAAmB,EAAE,OAAO,CAAC,WAAW,CAAC,EACzC,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,cAAc,EAC3B,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,aAAa,CAAC,EAAE,cAAc,CAAC;QAC/B,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;QAC7B,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;KACzB;IAyDH;;;;;;;;;;;OAWG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAI1C;;;;;;;;;;;;;OAaG;IACH,WAAW,IAAI,WAAW,GAAG,SAAS;IAItC;;;;;;;;;;;;;;OAcG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8B9B;;;;;;;;;;;;;;OAcG;IACG,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9G;;OAEG;IACH,YAAY,IAAI,IAAI;IAMpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,kBAAkB,CAAC,MAAM,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI;IAclG;;;OAGG;IACH,OAAO,CAAC,QAAQ;CAajB;AAqJD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,SAAS,CAAC,EAC9B,MAAM,EACN,SAAS,EACT,UAAU,EACV,MAAM,EACN,OAAY,EACb,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAY/C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,qCAAqC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,yCAAyC;IACzC,UAAU,EAAE,YAAY,CAAC;IACzB,qCAAqC;IACrC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC1C,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IACvE,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,YAAY,CAAC,EACjC,IAAI,EACJ,SAAS,EACT,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,UAAU,EACX,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAYlD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,yCAAyC;IACzC,UAAU,EAAE,YAAY,CAAC;IACzB,qCAAqC;IACrC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,aAAa,CAAC,EAClC,OAAO,EACP,SAAS,EACT,UAAU,EACV,MAAM,EACP,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAYnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roboflow/inference-sdk",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Lightweight client for Roboflow's hosted inference API with WebRTC streaming support",
   "keywords": [
     "roboflow",
@@ -25,11 +25,12 @@
   },
   "scripts": {
     "dev": "vite",
-    "build": "vite build",
+    "build": "tsc --noEmit && vite build",
     "preview": "vite preview",
     "clean": "rm -rf dist",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
   },
   "author": "Roboflow",
   "license": "ISC",