v1.5.0

THIRD_PARTY_LICENSE

@@ -29,7 +29,7 @@ SOFTWARE.
 
 ---
 
-@skyway-sdk/core@1.4.1
+@skyway-sdk/core@1.5.0
 
 MIT
 
@@ -68,7 +68,7 @@ MIT
 
 ---
 
-@skyway-sdk/room@1.4.1
+@skyway-sdk/room@1.5.0
 
 MIT
 
@@ -192,7 +192,7 @@ SOFTWARE.
 
 ---
 
-@skyway-sdk/sfu-bot@1.4.1
+@skyway-sdk/sfu-bot@1.5.0
 
 MIT
 
@@ -809,7 +809,7 @@ SOFTWARE.
 
 ---
 
-node-fetch@2.6.11
+node-fetch@2.6.12
 
 MIT
 
@@ -903,7 +903,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ---
 
-supports-color@9.3.1
+supports-color@9.4.0
 
 MIT
 

packages/core/README.md

@@ -398,12 +398,12 @@ const data: LocalDataStream = await SkyWayStreamFactory.createDataStream();
 ```ts
 const displayStream = await navigator.mediaDevices.getDisplayMedia();
 const [displayTrack] = displayStream.getVideoTracks();
-const stream = new LocalVideoStream('label', displayTrack);
+const stream = new LocalVideoStream(displayTrack);
 
 const [audioTrack] = (
   await navigator.mediaDevices.getUserMedia({ audio: true })
 ).getTracks();
-const stream = new LocalAudioStream('label', audioTrack);
+const stream = new LocalAudioStream(audioTrack);
 ```
 
 ### AudioStream / VideoStream の再生方法

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/core",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "The official Next Generation JavaScript SDK for SkyWay",
   "homepage": "https://skyway.ntt.com/",
   "repository": {

packages/core/src/channel/index.ts

@@ -37,7 +37,7 @@ import {
 } from './event';
 import { SkyWayContext } from '../context';
 
-import { MemberKeepAliveConfig } from '../config';
+import { MemberInternalConfig, MemberKeepAliveConfig } from '../config';
 import { createLogPayload, createError } from '../util';
 import {
   LocalPerson,
@@ -486,12 +486,7 @@ export class SkyWayChannelImpl implements Channel {
     this.onPublicationUnsubscribed.emit({ subscription });
   }
 
-  async join(
-    options: {
-      name?: MemberInit['name'];
-      metadata?: MemberInit['metadata'];
-    } & Partial<MemberKeepAliveConfig> = {}
-  ) {
+  async join(options: PersonInit = {}) {
     const timestamp = log.info(
       '[start] join',
       await createLogPayload({
@@ -524,10 +519,8 @@ export class SkyWayChannelImpl implements Channel {
       }
     }
 
-    options.keepaliveIntervalSec =
-      options.keepaliveIntervalSec ?? this.config.member.keepaliveIntervalSec;
-    options.keepaliveIntervalGapSec =
-      options.keepaliveIntervalGapSec ??
+    options.keepaliveIntervalSec ??= this.config.member.keepaliveIntervalSec;
+    options.keepaliveIntervalGapSec ??=
       this.config.member.keepaliveIntervalGapSec;
 
     const init: MemberInit = {
@@ -549,10 +542,7 @@ export class SkyWayChannelImpl implements Channel {
       member,
     });
 
-    const person = await this._createLocalPerson(member, {
-      keepaliveIntervalSec: options.keepaliveIntervalSec,
-      keepaliveIntervalGapSec: options.keepaliveIntervalGapSec,
-    });
+    const person = await this._createLocalPerson(member, options);
     const adapter = new LocalPersonAdapter(person);
     log.elapsed(timestamp, '[end] join', { person });
 
@@ -609,22 +599,17 @@ export class SkyWayChannelImpl implements Channel {
     const member = await this._channelImpl.joinChannel(init);
     const person = await this._createLocalPerson(member, {
       keepaliveIntervalSec: adapter.keepaliveIntervalSec,
-      keepaliveIntervalGapSec: adapter.keepaliveIntervalSec,
+      keepaliveIntervalGapSec: adapter.keepaliveIntervalGapSec,
+      disableSignaling: adapter.disableSignaling,
     });
     adapter.apply(person);
   }
 
   private async _createLocalPerson(
     member: model.Member,
-    {
-      keepaliveIntervalSec,
-      keepaliveIntervalGapSec,
-    }: Partial<MemberKeepAliveConfig>
+    config: PersonInit
   ): Promise<LocalPersonImpl> {
-    const person = await createLocalPerson(this._context, this, member, {
-      keepaliveIntervalSec,
-      keepaliveIntervalGapSec,
-    });
+    const person = await createLocalPerson(this._context, this, member, config);
     this._localPerson = person;
 
     return person;
@@ -859,3 +844,9 @@ export class SkyWayChannel {
 }
 
 export type ChannelState = 'opened' | 'closed';
+
+export type PersonInit = {
+  name?: MemberInit['name'];
+  metadata?: MemberInit['metadata'];
+} & Partial<MemberKeepAliveConfig> &
+  MemberInternalConfig;

packages/core/src/config.ts

@@ -29,7 +29,7 @@ export type SkyWayConfigOptions = {
   token: { updateReminderSec?: number };
   log: Partial<{ level: LogLevel; format: LogFormat }>;
   /**@internal */
-  internal: { disableDPlane?: boolean; disableSignaling?: boolean };
+  internal: { disableDPlane?: boolean };
   member: Partial<MemberKeepAliveConfig>;
 };
 
@@ -48,6 +48,12 @@ export type MemberKeepAliveConfig = {
   keepaliveIntervalGapSec: number;
 };
 
+/**@internal */
+export type MemberInternalConfig = {
+  /**@internal */
+  disableSignaling?: boolean;
+};
+
 export type TurnPolicy = 'enable' | 'disable' | 'turnOnly';
 
 export type TurnProtocol = 'all' | 'udp' | 'tcp' | 'tls';
@@ -88,7 +94,6 @@ export class ContextConfig implements SkyWayConfigOptions {
   /**@internal */
   internal: Required<SkyWayConfigOptions['internal']> = {
     disableDPlane: false,
-    disableSignaling: false,
   };
   member: Required<SkyWayConfigOptions['member']> = {
     keepaliveIntervalGapSec: 30,

packages/core/src/media/stream/local/media.ts

@@ -1,4 +1,4 @@
-import { Event } from '@skyway-sdk/common';
+import { Event, EventDisposer, Logger } from '@skyway-sdk/common';
 
 import {
   AudioMediaTrackConstraints,
@@ -9,11 +9,23 @@ import {
 import { ContentType, attachElement, detachElement } from '../base';
 import { LocalStreamBase } from './base';
 
+const logger = new Logger('packages/core/src/media/stream/local/media.ts');
+
 export abstract class LocalMediaStreamBase extends LocalStreamBase {
   /**@description [japanese] PublicationのDisable/EnableなどでStreamのtrackが更新された時に発火するイベント */
   onTrackUpdated = new Event<MediaStreamTrack>();
+  /**
+   * @description [japanese] streamが破棄された時に発火するイベント (例. 画面共有が終了したときなど)
+   * @example [japanese] ハンドリング例
+   *  const publication = await member.publish(audio);
+      audio.onDestroyed.once(async () => {
+        await member.unpublish(publication);
+      });
+   * */
+  onDestroyed = new Event<void>();
   private _element?: HTMLVideoElement | HTMLAudioElement;
   private _track: MediaStreamTrack;
+  private _disposer = new EventDisposer();
   /**@internal */
   protected _oldTrack?: MediaStreamTrack;
   private _trackConstraints: MediaTrackConstraints = {};
@@ -52,6 +64,7 @@ export abstract class LocalMediaStreamBase extends LocalStreamBase {
     super(contentType);
 
     this._track = track;
+    this._listenTrackEvent();
     this._options = options;
 
     // iOS safari 15はgetConstraintsがバグってるのでここで入れておく
@@ -110,13 +123,26 @@ export abstract class LocalMediaStreamBase extends LocalStreamBase {
       this.attach(this._element);
     }
     this.onTrackUpdated.emit(track);
+    this._listenTrackEvent();
+  }
+
+  private _listenTrackEvent() {
+    const onended = () => {
+      logger.info('onDestroyed', this.toJSON());
+      this.onDestroyed.emit();
+    };
+    this._track.addEventListener('ended', onended);
+    this._disposer.push(() =>
+      this._track.removeEventListener('ended', onended)
+    );
   }
 
   /**
    * @description [japanese] Streamを解放します。
    * カメラやマイクなどのデバイスを解放するためにはそのデバイスに関連するすべてのStreamを解放する必要があります
    */
   release() {
+    this._disposer.dispose();
     this._track.stop();
   }
 }

packages/core/src/member/localPerson/adapter.ts

@@ -21,6 +21,9 @@ export class LocalPersonAdapter implements LocalPerson {
   get keepaliveIntervalGapSec() {
     return this._impl.keepaliveIntervalGapSec;
   }
+  get disableSignaling() {
+    return this._impl.disableSignaling;
+  }
   get type() {
     return this._impl.type;
   }

packages/core/src/member/localPerson/factory.ts

@@ -1,13 +1,12 @@
 import { Logger } from '@skyway-sdk/common';
 import model from '@skyway-sdk/model';
 
-import { SkyWayChannelImpl } from '../../channel';
+import { PersonInit, SkyWayChannelImpl } from '../../channel';
 import { MaxIceParamServerTTL } from '../../const';
 import { SkyWayContext } from '../../context';
 import { errors } from '../../errors';
 import { setupSignalingSession } from '../../external/signaling';
 import { LocalPersonImpl } from '.';
-import { MemberKeepAliveConfig } from '../../config';
 import { IceManager } from '../../external/ice';
 import { createError } from '../../util';
 
@@ -21,7 +20,8 @@ export async function createLocalPerson(
   {
     keepaliveIntervalSec,
     keepaliveIntervalGapSec,
-  }: Partial<MemberKeepAliveConfig> = {}
+    disableSignaling,
+  }: PersonInit = {}
 ) {
   log.debug('createLocalPerson', {
     channel,
@@ -33,7 +33,7 @@ export async function createLocalPerson(
   const { iceParamServer } = context.config;
 
   const signalingSession =
-    context.config.internal.disableSignaling === true
+    disableSignaling === true
       ? undefined
       : await setupSignalingSession(context, channel, memberDto);
 

packages/core/src/member/localPerson/index.ts

@@ -8,7 +8,7 @@ import {
 import { Encoding } from '@skyway-sdk/model';
 import { PublicationInit } from '@skyway-sdk/rtc-api-client';
 
-import { SkyWayChannelImpl } from '../../channel';
+import { PersonInit, SkyWayChannelImpl } from '../../channel';
 import { errors } from '../../errors';
 import { SignalingSession } from '../../external/signaling';
 import { Codec, EncodingParameters } from '../../media';
@@ -26,7 +26,6 @@ import { Person } from '../person';
 import { isRemoteMember } from '../remoteMember';
 import { PublishingAgent, SubscribingAgent } from './agent';
 import { SkyWayContext } from '../../context';
-import { MemberKeepAliveConfig } from '../../config';
 import { IceManager } from '../../external/ice';
 import {
   RemoteAudioStream,
@@ -105,6 +104,7 @@ export class LocalPersonImpl extends MemberImpl implements LocalPerson {
   ttlSec?: number;
   readonly keepaliveIntervalSec = this.args.keepaliveIntervalSec;
   readonly keepaliveIntervalGapSec = this.args.keepaliveIntervalGapSec;
+  readonly disableSignaling = this.args.disableSignaling;
   readonly config = this.context.config;
 
   readonly onStreamPublished = this._events.make<{
@@ -167,7 +167,7 @@ export class LocalPersonImpl extends MemberImpl implements LocalPerson {
       metadata?: string;
       iceManager: IceManager;
       context: SkyWayContext;
-    } & Partial<MemberKeepAliveConfig>
+    } & PersonInit
   ) {
     super(args);
 

packages/core/src/version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '1.4.1';
+export const PACKAGE_VERSION = '1.5.0';

packages/room/README.md

@@ -453,12 +453,12 @@ const data = await SkyWayStreamFactory.createDataStream();
 ```ts
 const displayStream = await navigator.mediaDevices.getDisplayMedia();
 const [displayTrack] = displayStream.getVideoTracks();
-const stream = new LocalVideoStream('label', displayTrack);
+const stream = new LocalVideoStream(displayTrack);
 
 const [audioTrack] = (
   await navigator.mediaDevices.getUserMedia({ audio: true })
 ).getTracks();
-const stream = new LocalAudioStream('label', audioTrack);
+const stream = new LocalAudioStream(audioTrack);
 ```
 
 ### AudioStream / VideoStream の再生方法

packages/room/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyway-sdk/room",
-  "version": "1.4.1",
+  "version": "1.5.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.4.1",
-    "@skyway-sdk/sfu-bot": "^1.4.1",
+    "@skyway-sdk/core": "^1.5.0",
+    "@skyway-sdk/sfu-bot": "^1.5.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {

packages/room/src/room/base.ts

@@ -3,6 +3,7 @@ import {
   ChannelState,
   LocalStream,
   MemberMetadataUpdatedEvent,
+  PersonInit,
   Publication,
   SkyWayChannelImpl,
   SubscriptionImpl,
@@ -336,8 +337,4 @@ export abstract class RoomImpl implements Room {
   }
 }
 
-export type RoomMemberInit = {
-  name?: string;
-  metadata?: string;
-  keepaliveIntervalSec?: number;
-};
+export type RoomMemberInit = PersonInit;