リリースノート¶

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

2022.3.1¶

リリース日:: 2022-12-21

[FIX] E2EE が有効かどうかの判定を undefined ではなく null で行うよう修正しました

2022.3.0¶

リリース日:: 2022-12-20

[UPDATE] E2EE 有効時に Lyra コーデックを使用できるようにしました

2022.2.0¶

リリース日:: 2022-12-13

[CHANGE] ts-jest を @swc/jest に変更しました
[CHANGE] サンプルの sora-e2ee-wasm のダウンロード先を変更しました
[CHANGE] sora.min.js を削除しました
[ADD] audioCodecType に "LYRA" を追加しました
- 注意: 現時点では Lyra コーデックと E2EE の併用はできず、両方が指定された場合には E2EE が優先されます
[ADD] Sora.initLyra() 関数を追加しました
- Lyra でエンコードされた音声を送信ないし受信する場合には、事前にこの関数を呼び出しておく必要があります
- wasm やモデルファイルのダウンロードは実際に必要になったタイミングで遅延して行われます
[ADD] ConnectOptions に audioLyraParamsUsedtx を追加しました
[ADD] ConnectOptions に audioLyraParamsBitrate を追加しました
[ADD] audio_streaming_language_code を追加しました
[FIX] 廃止になった opus_params の clock_rate を削除しました

2022.1.0¶

リリース日:: 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 を追加しました

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