リリースノート¶

CHANGE: 下位互換のない変更
UPDATE: 下位互換がある変更
ADD: 下位互換がある追加
FIX: バグ修正

リリース日:: 2022-6-19

[CHANGE] 切断処理時に MediaStream の停止処理をしないように変更する
[CHANGE] ConnectionOptions からシグナリング type: connect メッセージを生成する仕組みを変更する
- multistream オプションが false の場合、シグナリングメッセージに multistream: false を含めるよう変更する
- multistream フラグの値に関係なく spotlight オプションをシグナリングメッセージに含めるよう変更する
- spotlight フラグの値に関係なく spotlightFocusRid オプションをシグナリングメッセージに含めるよう変更する
- spotlight フラグの値に関係なく spotlightUnfocusRid オプションをシグナリングメッセージに含めるよう変更する
- spotlight フラグの値に関係なく spotlightNumber オプションをシグナリングメッセージに含めるよう変更する
- simulcast フラグの値に関係なく spotlightNumber オプションをシグナリングメッセージに含めるよう変更する
[ADD] sendrecv オブジェクトのオプションに bundle_id を追加する
[UPDATE] sendrecv API を使用して接続する場合に multistream option の初期値が true になるよう修正する
[UPDATE] sendrecv API を使用して multistream: false で接続した場合、Sora との接続前に例外が発生するように修正する
[CHANGE] connectedSignalingUrl は現在接続中の WebSocket の URL ではなく type offer メッセージを受信した URL を返すようにする
- ignoreDisconnectWebSocket を使用して WebSocket を切断した場合にも URL を返すように修正する
[UPDATE] SendRecv オブジェクトに contactSignalingUrl プロパティを追加する

2021.2.3¶

リリース日:: 2022-02-10

[FIX] メッセージング機能で文字列データが送信されてきた場合にそのまま message callback に渡していた問題を修正しました

2021.2.2¶

リリース日:: 2022-02-02

[FIX] fflate package のバージョンを 0.7.1 から 0.7.3 に更新しました

2021.2.1¶

リリース日:: 2022-01-27

[FIX] type redirect 時のシグナリングで接続エラーになった場合、例外が発火しなかった問題を修正しました

2021.2.0¶

リリース日:: 2021-12-15

[UPDATE] simulcast 時の transceiver 判定条件に offer.mids.video での分岐を追加しました
[UPDATE] 複数パッケージの管理を lerna から npm workspace に変更しました
[ADD] メッセージング機能を追加しました
- sendrecv オブジェクトのオプションに datachannels を追加しました
- sendrecv オブジェクトに sendMessage API を追加しました
- sendrecv オブジェクトに datachannels プロパティを追加しました
- on callback に "message" を追加しました
- on callback に "datachannel" を追加しました
[CHANGE] 複数 Signaling URL への接続に対応しました
- Connection オブジェクト第一引数の type を string から string | string[] に変更しました
- Connection オブジェクト signalingUrl プロパティの戻り値の type を string から string | string[] に変更しました
- Connection オブジェクトに signalingUrlCandidates プロパティを追加しました
- SendRecv オブジェクト signalingUrl プロパティの戻り値の type を string から string | string[] に変更しました
- SendRecv オブジェクトに signalingUrlCandidates プロパティを追加しました
- SendRecv オブジェクトに connectedSignalingUrl プロパティを追加しました
- SendRecv オブジェクトに signalingCandidateTimeout オプションを追加しました
[UPDATE] type redirect 対応を追加しました
[CHANGE] spotlight_legacy 対応を削除しました
- ConnectionOptions の spotlight オプションの型を boolean のみに変更しました

2021.1.7¶

リリース日:: 2021-9-13

[ADD] SoraCloseEvent 関連の type を export しました

2021.1.6¶

リリース日:: 2021-8-10

[FIX] timeline ログに re-answer のログが出力されていなかったので修正しました
[UPDATE] timeline ログの ontrack ログに詳細情報を追加しました

2021.1.5¶

リリース日:: 2021-8-5

[FIX] dataChannelSignaling false の場合に Disconnect API 経由で切断すると disconnect callback が発火しない問題を修正しました
[UPDATE] 非同期で disconnect を複数回呼んだ場合の処理を修正しました

2021.1.4¶

リリース日:: 2021-8-3

[FIX] DataChannel 切断のタイムアウト処理中に WebSocket が切断すると Uncaught (in promise) が発生する問題を修正しました
[UPDATE] 切断処理中の WebSocket の onclose タイムラインログに code と reason を入れるようにしました

2021.1.3¶

リリース日:: 2021-7-30

[FIX] DataChannel 切断処理を修正しました
- 切断タイムアウト処理時にすでに DataChannel の readyState が closed 状態であれば onclose を待たないように修正しました

2021.1.2¶

注意

2021.1.3 をご利用ください

リリース日:: 2021-7-30

[CHANGE] disconnect API を修正しました
- type: disconnect メッセージに reason を追加するように修正しました
[CHANGE] disconnect callback を修正しました
- disconnect callback が受け取る event を CloseEvent から SoraCloseEvent に変更しました
- disconnect callback が受け取る event の type は "close" のみから "normal" か "abend" のどちらかが返るように変更しました
- disconnect callback が受け取る event の code, reason は undefined のパターンを追加しました
- disconnect callback が受け取る event に title を追加しました
- disconnect callback が受け取る event に params を追加しました
[CHANGE] connect signaling 時の意図しない WebSocket の切断時のメッセージを統一しました
- "Signaling failed. {reason}" に統一しました
[CHANGE] timeline callback Event の property を変更しました
- transportType を logType に変更しました
[CHANGE] signaling callback Event の property を変更しました
- transportType は必須項目にしました
[UPDATE] PeerConnecion の状態が不正な場合に切断処理に入るようにしました
- PeerConnecion connectionState が "failed" になった場合は切断するようにしました
- PeerConnecion connectionState が undefined の場合 iceConnectionState が disconnect になって 1000ms 変化がない場合は切断するようにしました
[UPDATE] 型を export しました

2021.1.1¶

リリース日:: 2021-6-29

[FIX] 接続処理が途中で失敗した場合の timeline ログに connected のログが出力されていた問題を修正しました

2021.1.0¶

リリース日:: 2021-6-18

[CHANGE] fflate を導入して Signaling zlib 対応を追加しました
[CHANGE] timeout option を connectionTimeout option に名前を変更しました
- timeout option を使用している場合は deprecated warning が出るように変更
[CHANGE] Notify callback, Push callback の第二引数に TransportType を追加しました
[CHANGE] role から upstream と downstream を削除しました
[CHANGE] publisher と subscriber を削除しました
[CHANGE] シグナリングメッセージに型定義を追加しました
[CHANGE] 型定義の修正しました
- Callbacks の各 callback 型定義を修正しました
- on メソッドに渡す第2引数の型定義を修正しました
- trace メソッドに渡す第3引数の型定義を any から unknown に変更しました
[CHANGE] packages 以下の npm*client を yarn に変更しました
[UPDATE] TypeScript を3系から4系に変更しました
[UPDATE] サイマルキャストのサンプルを low / middle / high から r0 / r1 / r2 へ変更しました
[ADD] ConnectionOptions に spotlightFocusRid / spotlightUnfocusRid を追加しました
[ADD] get audio, get video を追加して接続がそれぞれに対応しているかを返すようにしました
[ADD] stopAudioTrack, stopVideoTrack, replaceAudioTrack, replaceVideoTrack を追加しました
[ADD] helper メソッドを追加しました
[ADD] packages:upgrade コマンドを追加しました
[ADD] Switch DataChannel を実装しました
- ConnectionOptions に dataChannelSignaling を追加しました
- ConnectionOptions に ignoreDisconnectWebSocket を追加しました

2020.6.2¶

リリース日:: 2021-1-28

[FIX] simulcast が使用できるかどうかの判定を修正しました
- UserAgent を用いた判定から RTCRtpSender.getCapabilities を用いた判定に変更

2020.6.1¶

リリース日:: 2020-12-22

[FIX] simulcast 時に setParameters するための RTCRtpTransceiver 検索条件を変更しました
- getUserMedia constraints の audio/video と Sora signaling の audio/video が一致しなかった場合に DOMException: Read-only field modified in setParameters(). が発生します
- encodings が readonly な RTCRtpSender を持つ RTCRtpTransceiver を検索条件から除外して対応しました

2020.6.0¶

リリース日:: 2020-12-10

[UPDATE] e2ee 処理で signaling notify 時に metadata / authn_metadata どちらでも動作するように修正しました
[UPDATE] connect 時の例外に code と reason を含めるようにしました
- WebSocket の onclose が発火した場合のみ Error オブジェクトに close event の code と reason を含めました
[FIX] type offer 時に受け取った encodings を type update 時にも setParametes するように修正しました

2020.5.0¶

リリース日:: 2020-12-07

[CHANGE] simulcastQuality を simulcastRid に変更しました
[CHANGE] simulcast を bool のみに変更しました
[CHANGE] simulcast_rid を追加しました
[CHANGE] オプションの e2ee を boolean のみに変更しました
[UPDATE] clientId option に空文字列を渡せるように修正しました
[UPDATE] sora-e2ee パッケージを内包するように変更しました
- lerna を使って複数 package を管理するようにしました
- sdk package を作成して既存コードを sdk package 内へ移動しました
- e2ee package を作成して sora-e2ee コードを移植しました
- go-wasm package を作成して wasm_exec.js コードを内包しました

2020.4.2¶

リリース日:: 2020-11-30

[FIX] metadata に直接 undefined を渡せるように修正しました

2020.4.1¶

リリース日:: 2020-11-18

[FIX] timeout option を設定時に特定の条件で正しく動かない問題を修正しました
- peerconnection connectionState が undefined の場合に timeout error が強制的に発動してしまう
- peerconnection 接続前に timeout の時間に到達した場合 timeout error が発動しない

2020.4.0¶

リリース日:: 2020-10-30

[CHANGE] signaling 時に処理に失敗した場合の reject の引数を CloseEvent オブジェクトから Error オブジェクトに変更しました
[CHANGE] connect() のタイムアウト処理にデフォルト値を設定しました
- 60000 ms でタイムアウトするように設定しました
[UPDATE] connect() 実行時 PeerConnection connectionState が 'connected' になったら処理が完了するように変更しました
[UPDATE] disconnect 処理を修正しました
- WebSocket で type: "disconnect" を send するように変更しました
- WebSocket の readyState の監視をやめました
- peerConnection の切断監視を signalingState から connectionState に変更しました
[UPDATE] sora-e2ee のバージョンを 2020.3.0 に更新しました
[FIX] package.json に定義されているモジュールの向き先を dist/sora.mjs に変更し、対象ファイルがビルドされるよう Rollup の設定を追加しました
- https://github.com/shiguredo/sora-js-sdk/pull/44
[UPDATE] simulcast で active パラメータを有効にするための実装を追加しました

2020.3.0¶

リリース日:: 2020-09-30

[UPDATE] Safari 14 以降で Simulcast が使えるように変更しました

2020.2.0¶

リリース日:: 2020-09-08

[UPDATE] sora-e2ee を 2020.2.0 にアップデートしました
[UPDATE] 新スポットライトに対応しました
- ConnectionOptions に spotlightNumber を追加しました
- ConnectionOptions の spotlight に boolean を受け取れるよう修正しました
[FIX] disconnect() を複数回実行した場合に例外が発生しないように修正しました

2020.1.5¶

リリース日:: 2020-07-20

[FIX] metadata が undefined の場合以外は signaling connect message に metadata を含めるように変更しました

2020.1.4¶

リリース日:: 2020-07-08

[UPDATE] type.ts にある type Json のインデックスシグネチャに undefined を許可しました

2020.1.3¶

リリース日:: 2020-06-22

[CHANGE] type.ts にある Audio, Video をそれぞれ SignalingAudio, SignalingVideo に名前変更しました
[ADD] SoraConnection の型定義を export しました
[ADD] sendrecv, sendonly, recvonly の引数 options に signalingNotifyMetadata を追加しました

2020.1.2¶

リリース日:: 2020-06-18

[FIX] sendrecv, sendonly, recvonly の引数に渡す metadata の型を Json に変更しました
[FIX] authMetadata の型を Json に変更しました

2020.1.1¶

リリース日:: 2020-06-17

[UPDATE] type export を追加しました
- 以下の型定義を export しました
- AudioCodecType
- Callbacks
- ConnectionBase
- ConnectionOptions
- ConnectionPublisher
- ConnectionSubscriber
- Role
- SimulcastQuality
- VideoCodecType

2020.1.0¶

リリース日:: 2020-06-01

[CHANGE] @deprecated メッセージを追加しました
- publisher/subscriber を使用している場合に warning を出すように変更しました
- addstream/removestream を使用している場合に warning を出すように変更しました
- debug: true 時に disconnect の MediaStream close 処理で warning を出すように変更しました
[CHANGE] property 名の変更とアクセス制限の追加しました
- _pc を pc に名前変更しました
- _ws を ws に名前変更してアクセス制限を protected に変更しました
- _callbacks を callbacks に名前変更してアクセス制限を protected に変更しました
[CHANGE] method 名の変更とアクセス制限の追加しました
- _ がついているメソッド名から _ を削除してアクセス制限を追加しました
[UPDATE] E2EE 対応しました
[UPDATE] TypeScript 化しました
[UPDATE] async / await 化しました
[ADD] Sora から type: ping が送られてきた際に stats: true だった場合 type: pong 送信時に stats に getStats の結果を入れました

古いリリースノートはこちら