v1.4.0

skyway · Jun 2, 2023 · 3bf2591 · 3bf2591
1 parent 3310df5
commit 3bf2591
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 52 deletions.
diff --git a/THIRD_PARTY_LICENSE b/THIRD_PARTY_LICENSE
@@ -1,4 +1,4 @@
-@skyway-sdk/[email protected].3
+@skyway-sdk/[email protected].4
 
 MIT
 
@@ -29,7 +29,7 @@ SOFTWARE.
 
 ---
 
-@skyway-sdk/core@1.3.0
+@skyway-sdk/core@1.4.0
 
 MIT
 
@@ -68,7 +68,7 @@ MIT
 
 ---
 
-@skyway-sdk/room@1.3.0
+@skyway-sdk/room@1.4.0
 
 MIT
 
@@ -192,7 +192,7 @@ SOFTWARE.
 
 ---
 
-@skyway-sdk/sfu-bot@1.3.0
+@skyway-sdk/sfu-bot@1.4.0
 
 MIT
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/common",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "The official Next Generation JavaScript SDK for SkyWay",
   "homepage": "https://skyway.ntt.com/",
   "repository": {

diff --git a/packages/common/src/event.ts b/packages/common/src/event.ts
@@ -74,7 +74,9 @@ export class Event<T extends any> {
       const timeout =
         timeLimit &&
         setTimeout(() => {
-          reject('Event asPromise timeout : ' + timeLimit);
+          reject(
+            new SerializableError('Event asPromise timeout : ' + timeLimit)
+          );
         }, timeLimit);
       this.once((arg) => {
         if (timeout) clearTimeout(timeout);
@@ -95,7 +97,7 @@ export class Event<T extends any> {
       const timeout =
         timeLimit &&
         setTimeout(() => {
-          reject('Event watch timeout : ' + timeLimit);
+          reject(new SerializableError('Event watch timeout : ' + timeLimit));
         }, timeLimit);
 
       const { removeListener } = this.add((arg) => {
@@ -143,3 +145,13 @@ export class EventDisposer {
     this._disposer = [];
   }
 }
+
+class SerializableError extends Error {
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      stack: this.stack,
+    };
+  }
+}
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/core",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "The official Next Generation JavaScript SDK for SkyWay",
   "homepage": "https://skyway.ntt.com/",
   "repository": {

diff --git a/packages/core/src/media/factory.ts b/packages/core/src/media/factory.ts
@@ -158,30 +158,31 @@ export class StreamFactory {
   /**
    * @description [japanese]
    * PCブラウザでのみ利用可能なAPI。
-   * ディスプレイのVideoStreamとオプションとしてAudioStreamを作成する。
-   * AudioStreamはWindowsのChromeでしか取得できない。
+   * VideoStreamは常に取得される（AudioStreamのみ取得することはできない）
+   * audioオプションを有効にするとAudioStreamを取得することができる。
+   * audioオプションはWindowsのChromeにしか対応しておらず、
+   * それ以外の環境では有効にしても戻り値のaudioにはundefinedが返される。
    */
-  async createDisplayStreams(options: {
-    audio?:
-      | boolean
-      | (AudioMediaTrackConstraints & Partial<LocalMediaStreamOptions>);
-    /**default enable */
-    video?: DisplayMediaTrackConstraints &
-      VideoMediaTrackConstraints &
-      Partial<LocalMediaStreamOptions>;
-  }) {
+  async createDisplayStreams<T extends DisplayStreamOptions>(
+    options: T = {} as T
+  ): Promise<{
+    video: LocalVideoStream;
+    audio: T extends { audio: infer U }
+      ? U extends false | undefined | null
+        ? undefined
+        : LocalAudioStream | undefined
+      : undefined;
+  }> {
     const videoOption = options.video ?? {};
-    videoOption.stopTrackWhenDisabled =
-      videoOption.stopTrackWhenDisabled ?? true;
+    videoOption.stopTrackWhenDisabled ??= true;
 
     let audioOption = options.audio;
     if (audioOption) {
-      audioOption = {};
-      audioOption.stopTrackWhenDisabled =
-        audioOption.stopTrackWhenDisabled ?? true;
+      audioOption = typeof audioOption === 'boolean' ? {} : audioOption;
+      audioOption.stopTrackWhenDisabled ??= true;
     }
 
-    options = { audio: audioOption, video: videoOption };
+    options = { audio: audioOption, video: videoOption } as T;
 
     const stream = await navigator.mediaDevices.getDisplayMedia(options);
     const [video] = stream.getVideoTracks();
@@ -197,13 +198,14 @@ export class StreamFactory {
     }
 
     const videoStream = new LocalVideoStream(video, {
-      ...options.video,
+      ...videoOption,
       isDisplayMedia: true,
     });
     videoStream._setLabel('displayVideo');
+
     const audioStream = audio
       ? new LocalAudioStream(audio, {
-          ...(typeof options.audio === 'boolean' ? {} : options.audio),
+          ...audioOption,
           isDisplayMedia: true,
         })
       : undefined;
@@ -213,7 +215,7 @@ export class StreamFactory {
 
     return {
       video: videoStream,
-      audio: audioStream,
+      audio: audioStream as any,
     };
   }
 
@@ -320,9 +322,13 @@ export type DisplayMediaTrackConstraints = VideoMediaTrackConstraints & {
   // cursor?: CursorNever | CursorAlways | CursorMotion;
 };
 
-/** @description [japanese] キャプチャーしたディスプレイからカーソルを含まない。 */
-// export type CursorNever = 'never';
-/** @description [japanese] キャプチャーしたディスプレイからカーソルを含む。 */
-// export type CursorAlways = 'always';
-/** @description [japanese] カーソル／ポインタが動かされたとき、画面内のカーソルを含む。カーソルは、ある期間カーソルの更なる動きがないときに削除される。 */
-// export type CursorMotion = 'motion';
+export type DisplayStreamOptions = {
+  audio?:
+    | (AudioMediaTrackConstraints &
+        Partial<Pick<LocalMediaStreamOptions, 'stopTrackWhenDisabled'>>)
+    | boolean;
+  video?:
+    | DisplayMediaTrackConstraints &
+        VideoMediaTrackConstraints &
+        Partial<Pick<LocalMediaStreamOptions, 'stopTrackWhenDisabled'>>;
+};
diff --git a/packages/core/src/version.ts b/packages/core/src/version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '1.3.0';
+export const PACKAGE_VERSION = '1.4.0';
diff --git a/packages/room/package.json b/packages/room/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/room",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "The official Next Generation JavaScript SDK for SkyWay",
   "homepage": "https://skyway.ntt.com/",
   "repository": {
@@ -45,8 +45,8 @@
     "watch:tsc": "tsc -p tsconfig.build.json -w"
   },
   "dependencies": {
-    "@skyway-sdk/core": "^1.3.0",
-    "@skyway-sdk/sfu-bot": "^1.3.0",
+    "@skyway-sdk/core": "^1.4.0",
+    "@skyway-sdk/sfu-bot": "^1.4.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {

diff --git a/packages/room/src/version.ts b/packages/room/src/version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '1.3.0';
+export const PACKAGE_VERSION = '1.4.0';
diff --git a/packages/sfu-bot/package.json b/packages/sfu-bot/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/sfu-bot",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "The official Next Generation JavaScript SDK for SkyWay",
   "homepage": "https://skyway.ntt.com/",
   "repository": {
@@ -41,7 +41,7 @@
     "watch:tsc": "tsc -p tsconfig.build.json -w"
   },
   "dependencies": {
-    "@skyway-sdk/core": "^1.3.0",
+    "@skyway-sdk/core": "^1.4.0",
     "@skyway-sdk/sfu-api-client": "^1.2.3",
     "lodash": "4.17.21",
     "mediasoup-client": "3.6.82"

diff --git a/packages/sfu-bot/src/version.ts b/packages/sfu-bot/src/version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '1.3.0';
+export const PACKAGE_VERSION = '1.4.0';
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export const PACKAGE_VERSION = '1.3.0';
		export const PACKAGE_VERSION = '1.4.0';