janus-simple-videoroom-client 1.0.3 → 2.0.0

package/README.md

@@ -1,8 +1,13 @@
 # janus-simple-videoroom-client
 Built on top of janus.js, this thin client library provides a simple high-level API that makes it easy to work with the Janus VideoRoom plugin.
 
+## Install
+`npm install janus-simple-videoroom-client`
+
 ## Usage
 ```javascript
+import { createVideoRoomClient } from "janus-simple-videoroom-client"
+
 async function joinRoom(server, roomId, displayName) {
     const client = await createVideoRoomClient()
     const session = await client.createSession(server)
@@ -45,7 +50,9 @@ Check out the [example](https://ken107.github.io/janus-videoroom-js/example.html
 | -------- | ----------- |
 | isValid() | Return whether the session is connected and valid |
 | joinRoom(_roomId_) | Joins a room, returns a VideoRoom object |
+| watch(_mountpointId_, _options_) | Subscribe to a streaming mountpoint, return a StreamingSubscriber object |
 | attachToPlugin() | Attach to the VideoRoom plugin without joining a room, returns a JanusPluginHandleEx object |
+| destroy() | Destroy the session |
 
 ### VideoRoom
 
@@ -62,6 +69,7 @@ Check out the [example](https://ken107.github.io/janus-videoroom-js/example.html
 
 | Property | Description |
 | -------- | ----------- |
+| publisherId | |
 | onTrackAdded(_callback_) | Register a callback for when a local MediaStreamTrack is available to display |
 | onTrackRemoved(_callback_) | Register a callback for when a local MediaStreamTrack terminates |
 | configure(_options_) | Modify publisher properties |
@@ -72,6 +80,7 @@ Check out the [example](https://ken107.github.io/janus-videoroom-js/example.html
 
 | Property | Description |
 | -------- | ----------- |
+| pluginHandle | The JanusPluginHandleEx object associated with this subscriber |
 | onTrackAdded(_callback_) | Register a callback for when a remote MediaStreamTrack is available to display |
 | onTrackRemoved(_callback_) | Register a callback for when a remote MediaStreamTrack terminates |
 | addStreams(_streams_) | Add additional streams to this (multi-stream) subscriber |

package/dist/index.d.ts

@@ -1,4 +1,55 @@
-import { JanusMediaOptions, JanusMessage, JanusMid, JanusPluginHandle, JanusPublishOptions, JanusSessionOptions, JanusStreamSpec, JanusSubscriberConfigureOptions, JanusWatchOptions, Jsep } from "./janus";
+import Janus from "janus-gateway";
+export { Janus };
+type JanusSessionOptions = ConstructorParameters<typeof Janus>[0];
+type JanusPluginOptions = Parameters<Janus["attach"]>[0];
+type JanusPluginHandle = Parameters<NonNullable<JanusPluginOptions["success"]>>[0];
+type JanusMid = unknown;
+type JanusOfferParams = Parameters<JanusPluginHandle["createOffer"]>[0];
+type JanusTrackOption = NonNullable<JanusOfferParams["tracks"]>[number];
+type Jsep = Parameters<NonNullable<JanusOfferParams["success"]>>[0];
+interface JanusMessage {
+    [key: string]: any;
+}
+interface JanusMediaOptions {
+    tracks?: JanusTrackOption[];
+    trickle?: boolean;
+    stream?: MediaStream;
+    customizeSdp?: (jsep: Jsep) => void;
+    customizeRemoteSdp?: (jsep: Jsep) => void;
+}
+interface JanusStreamSpec {
+    feed: unknown;
+    mid?: JanusMid;
+}
+interface JanusWatchOptions {
+    pin?: string;
+    media?: string[];
+}
+interface JanusPublishOptions {
+    audiocodec?: string;
+    videocodec?: string;
+    bitrate?: number;
+    record?: boolean;
+    filename?: string;
+    display?: string;
+    audio_level_average?: number;
+    audio_active_packets?: number;
+    descriptions?: {
+        mid: JanusMid;
+        description: string;
+    }[];
+}
+interface JanusSubscriberConfigureOptions {
+    mid?: JanusMid;
+    send?: boolean;
+    substream?: number;
+    temporal?: number;
+    fallback?: number;
+    spatial_layer?: number;
+    temporal_layer?: number;
+    audio_level_average?: number;
+    audio_active_packets?: number;
+}
 export interface VideoRoomClient {
     createSession(server: string | string[], options?: JanusSessionOptions): Promise<VideoRoomSession>;
 }
@@ -35,7 +86,7 @@ export interface VideoRoomPublisher {
     onTrackAdded(callback: (track: MediaStreamTrack) => void): void;
     onTrackRemoved(callback: (track: MediaStreamTrack) => void): void;
     configure(configureOptions: JanusPublishOptions): Promise<void>;
-    restart(mediaOptions: JanusMediaOptions): Promise<void>;
+    restart(mediaOptions?: JanusMediaOptions): Promise<void>;
     unpublish(): Promise<void>;
 }
 export interface VideoRoomSubscriber {
@@ -47,7 +98,7 @@ export interface VideoRoomSubscriber {
     pause(): Promise<void>;
     resume(): Promise<void>;
     configure(configureOptions: JanusSubscriberConfigureOptions): Promise<void>;
-    restart(mediaOptions: JanusMediaOptions): Promise<void>;
+    restart(mediaOptions?: JanusMediaOptions): Promise<void>;
     unsubscribe(): Promise<void>;
 }
 export interface StreamingSubscriber {
@@ -66,24 +117,27 @@ export interface StreamingSubscriber {
 }
 export interface JanusPluginHandleEx extends JanusPluginHandle {
     eventTarget: ReturnType<typeof makeEventTarget>;
-    sendRequest(message: JanusMessage): Promise<JanusMessage>;
+    sendRequest(message: JanusMessage & {
+        request: string;
+    }): Promise<JanusMessage>;
     sendAsyncRequest(options: {
-        message: JanusMessage;
+        message: JanusMessage & {
+            request: string;
+        };
         jsep?: Jsep;
         expectResponse: (response: AsyncResponse) => boolean;
     }): Promise<AsyncResponse>;
+    handleRemoteJsep(params: Parameters<JanusPluginHandle["handleRemoteJsep"]>[0] & {
+        customizeSdp?: (jsep: Jsep) => void;
+    }): void;
 }
 interface AsyncResponse {
     message: JanusMessage;
     jsep?: Jsep;
 }
-export declare function createVideoRoomClient(options?: {
-    debug?: boolean | string[];
-    dependencies?: unknown;
-}): Promise<VideoRoomClient>;
+export declare function createVideoRoomClient(options?: Parameters<typeof Janus.init>[0]): Promise<VideoRoomClient>;
 declare function makeEventTarget(): {
     addEventListener(name: string, callback: (event: CustomEvent) => void): void;
     removeEventListener(name: string, callback: (event: CustomEvent) => void): void;
     dispatchEvent(event: Event): void;
 };
-export {};