janus-simple-videoroom-client 1.0.3 → 1.0.4

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

@@ -35,7 +35,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 +47,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 {

package/dist/index.js

@@ -468,6 +468,7 @@ function createVideoRoomPublisher(handle, publisherId, opts) {
                                 });
                             },
                             restart: function (mediaOptions) {
+                                if (mediaOptions === void 0) { mediaOptions = options.mediaOptions; }
                                 return __awaiter(this, void 0, void 0, function () {
                                     var offerJsep, response;
                                     return __generator(this, function (_a) {
@@ -489,6 +490,7 @@ function createVideoRoomPublisher(handle, publisherId, opts) {
                                                 return [4 /*yield*/, new Promise(function (fulfill, reject) {
                                                         handle.handleRemoteJsep({
                                                             jsep: response.jsep,
+                                                            customizeSdp: mediaOptions === null || mediaOptions === void 0 ? void 0 : mediaOptions.customizeRemoteSdp,
                                                             success: fulfill,
                                                             error: reject
                                                         });
@@ -688,6 +690,7 @@ function createVideoRoomSubscriber(session, roomId, streams, opts) {
                                 });
                             },
                             restart: function (mediaOptions) {
+                                if (mediaOptions === void 0) { mediaOptions = options.mediaOptions; }
                                 return __awaiter(this, void 0, void 0, function () {
                                     var response;
                                     return __generator(this, function (_a) {
@@ -736,13 +739,12 @@ function createVideoRoomSubscriber(session, roomId, streams, opts) {
         });
     });
 }
-function createStreamingSubscriber(session, mountPointId, opts) {
+function createStreamingSubscriber(session, mountPointId, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var options, cleanup, callbacks, handle_3, response, err_4;
+        var cleanup, callbacks, handle_3, response, err_4;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    options = __assign({}, opts);
                     cleanup = makeCleanup();
                     callbacks = makeCallbacks();
                     _a.label = 1;
@@ -785,14 +787,14 @@ function createStreamingSubscriber(session, mountPointId, opts) {
                         }
                     });
                     return [4 /*yield*/, handle_3.sendAsyncRequest({
-                            message: __assign(__assign({}, options.watchOptions), { request: "watch", id: mountPointId }),
+                            message: __assign(__assign({}, options === null || options === void 0 ? void 0 : options.watchOptions), { request: "watch", id: mountPointId }),
                             expectResponse: function (r) { var _a; return r.message.streaming == "event" && ((_a = r.message.result) === null || _a === void 0 ? void 0 : _a.status) == "preparing"; }
                         })];
                 case 3:
                     response = _a.sent();
                     if (!response.jsep)
                         throw new Error("Missing offer Jsep");
-                    return [4 /*yield*/, handleOffer(handle_3, response.jsep, options.mediaOptions)
+                    return [4 /*yield*/, handleOffer(handle_3, response.jsep, options === null || options === void 0 ? void 0 : options.mediaOptions)
                         // construct and return the StreamingSubscriber object
                     ];
                 case 4:
@@ -870,22 +872,21 @@ function createStreamingSubscriber(session, mountPointId, opts) {
                                     });
                                 });
                             },
-                            restart: function (newOpts) {
+                            restart: function (newOptions) {
+                                if (newOptions === void 0) { newOptions = options; }
                                 return __awaiter(this, void 0, void 0, function () {
-                                    var newOptions, response;
+                                    var response;
                                     return __generator(this, function (_a) {
                                         switch (_a.label) {
-                                            case 0:
-                                                newOptions = __assign({}, newOpts);
-                                                return [4 /*yield*/, handle_3.sendAsyncRequest({
-                                                        message: __assign(__assign({}, newOptions.watchOptions), { request: "watch", id: mountPointId }),
-                                                        expectResponse: function (r) { var _a; return r.message.streaming == "event" && ((_a = r.message.result) === null || _a === void 0 ? void 0 : _a.status) == "preparing"; }
-                                                    })];
+                                            case 0: return [4 /*yield*/, handle_3.sendAsyncRequest({
+                                                    message: __assign(__assign({}, newOptions === null || newOptions === void 0 ? void 0 : newOptions.watchOptions), { request: "watch", id: mountPointId }),
+                                                    expectResponse: function (r) { var _a; return r.message.streaming == "event" && ((_a = r.message.result) === null || _a === void 0 ? void 0 : _a.status) == "preparing"; }
+                                                })];
                                             case 1:
                                                 response = _a.sent();
                                                 if (!response.jsep)
                                                     throw new Error("Missing offer Jsep");
-                                                return [4 /*yield*/, handleOffer(handle_3, response.jsep, newOptions.mediaOptions)];
+                                                return [4 /*yield*/, handleOffer(handle_3, response.jsep, newOptions === null || newOptions === void 0 ? void 0 : newOptions.mediaOptions)];
                                             case 2:
                                                 _a.sent();
                                                 options = newOptions;

package/dist/janus.d.ts

@@ -0,0 +1,95 @@
+
+declare global {
+  const Janus: {
+    new(options: unknown): JanusSession
+    init(options: unknown): void
+  }
+}
+
+export interface JanusSession {
+  isConnected(): boolean
+  destroy(options: unknown): void
+  attach(options: unknown): void
+}
+
+interface JanusPluginHandle {
+  createOffer(options: unknown): void
+  createAnswer(options: unknown): void
+  handleRemoteJsep(options: unknown): void
+  send(options: unknown): void
+  detach(options: unknown): void
+}
+
+type JanusMessage = {[key: string]: any}
+
+interface Jsep {
+    sdp: string
+}
+
+interface JanusStreamSpec {
+    feed: unknown
+    mid?: JanusMid
+}
+
+type JanusMid = unknown
+
+interface JanusSessionOptions {
+    iceServers?: string[]
+    ipv6?: boolean
+    withCredentials?: boolean
+    max_poll_events?: number
+    destroyOnUnload?: boolean
+    token?: unknown
+    apisecret?: 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 JanusWatchOptions {
+    pin?: string
+    media?: string[]
+}
+
+interface JanusMediaOptions {
+    tracks?: JanusTrackSpec[]
+    trickle?: boolean
+    stream?: MediaStream
+    customizeSdp?: (jsep: Jsep) => void
+    customizeRemoteSdp?: (jsep: Jsep) => void
+}
+
+interface JanusTrackSpec {
+    type: string
+    mid?: JanusMid
+    capture?: boolean|string|{deviceId: unknown, width?: number, height?: number}
+    simulcast?: boolean
+    svc?: unknown
+    recv?: boolean
+    add?: boolean
+    replace?: boolean
+    remove?: boolean
+    dontStop?: boolean
+    transforms?: unknown
+}
+
+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
+}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "janus-simple-videoroom-client",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Provides a simple high-level API that makes it easy to work with the Janus VideoRoom plugin",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc && cp src/janus.d.ts dist"
   },
   "repository": {
     "type": "git",

package/src/index.ts

@@ -29,7 +29,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>
 }
 
@@ -42,7 +42,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>
 }
 
@@ -428,7 +428,7 @@ async function createVideoRoomPublisher(
                     expectResponse: r => r.message.videoroom == "event" && r.message.configured == "ok"
                 })
             },
-            async restart(mediaOptions) {
+            async restart(mediaOptions = options.mediaOptions) {
                 const offerJsep = await new Promise<Jsep>(function(fulfill, reject) {
                     handle.createOffer({
                         ...mediaOptions,
@@ -446,6 +446,7 @@ async function createVideoRoomPublisher(
                 await new Promise(function(fulfill, reject) {
                     handle.handleRemoteJsep({
                         jsep: response.jsep,
+                        customizeSdp: mediaOptions?.customizeRemoteSdp,
                         success: fulfill,
                         error: reject
                     })
@@ -565,7 +566,7 @@ async function createVideoRoomSubscriber(
                     expectResponse: r => r.message.videoroom == "event" && r.message.configured == "ok"
                 })
             },
-            async restart(mediaOptions) {
+            async restart(mediaOptions = options.mediaOptions) {
                 const response = await handle.sendAsyncRequest({
                     message: {
                         request: "configure",
@@ -593,13 +594,12 @@ async function createVideoRoomSubscriber(
 async function createStreamingSubscriber(
     session: JanusSession,
     mountPointId: number,
-    opts?: {
+    options?: {
         watchOptions?: JanusWatchOptions
         mediaOptions?: JanusMediaOptions
     }
 ): Promise<StreamingSubscriber> {
 
-    let options = {...opts}
     const cleanup = makeCleanup()
     const callbacks = makeCallbacks()
 
@@ -634,7 +634,7 @@ async function createStreamingSubscriber(
         // send the watch request
         const response = await handle.sendAsyncRequest({
             message: {
-                ...options.watchOptions,
+                ...options?.watchOptions,
                 request: "watch",
                 id: mountPointId
             },
@@ -642,7 +642,7 @@ async function createStreamingSubscriber(
         })
 
         if (!response.jsep) throw new Error("Missing offer Jsep")
-        await handleOffer(handle, response.jsep, options.mediaOptions)
+        await handleOffer(handle, response.jsep, options?.mediaOptions)
 
         // construct and return the StreamingSubscriber object
         return {
@@ -684,18 +684,17 @@ async function createStreamingSubscriber(
                 })
                 mountPointId = newMountPointId
             },
-            async restart(newOpts) {
-                const newOptions = {...newOpts}
+            async restart(newOptions = options) {
                 const response = await handle.sendAsyncRequest({
                     message: {
-                        ...newOptions.watchOptions,
+                        ...newOptions?.watchOptions,
                         request: "watch",
                         id: mountPointId
                     },
                     expectResponse: r => r.message.streaming == "event" && r.message.result?.status == "preparing"
                 })
                 if (!response.jsep) throw new Error("Missing offer Jsep")
-                await handleOffer(handle, response.jsep, newOptions.mediaOptions)
+                await handleOffer(handle, response.jsep, newOptions?.mediaOptions)
                 options = newOptions
             },
             async unsubscribe() {

package/tsconfig.json

@@ -6,6 +6,7 @@
     "target": "es5",
     "strict": true,
     "moduleResolution": "node",
+    "skipLibCheck": true,
     "newLine": "LF",
     "rootDir": "src",
     "outDir": "dist"