2024.2.x から 2025.1.x への移行¶
概要¶
2024.2.x から 2025.1.x への移行について変更点や注意点をまとめています。
もし不明点がある場合はサポートまでお問い合わせください。
レガシーストリームを廃止しました¶
シグナリング接続時に "multistream": false を指定して接続した場合バリデーションエラーになります。
詳細は レガシーストリーム(非マルチストリーム)機能からマルチストリームへの移行 をご確認ください。
multistream 項目の廃止¶
レガシーストリーム廃止に伴い、 multistream 項目をウェブフック、ログ、API から削除しました。
移行に際する不明点などはサポートまでお問い合わせください。
session.vanished ウェブフックを廃止しました¶
Sora Exporter を利用する事で、より柔軟なセッションの監視ができることから、
session.vanished ウェブフックを廃止しました。
移行に際する不明点などはサポートまでお問い合わせください。
WHIP/WHEP 時のリソース URL をセッション URL に変更しました¶
WHIP の RFC 9725 化に伴い WHIP/WHEP 時のリソース URL をセッション URL に変更しました。
/whip-session/:channel_id/:secret/を追加しました/whip-resource/:channel_id/:secret/を非推奨にしました
2025 年 12 月リリース予定の Sora にて /whip-resource/:channel_id/:secret/ は廃止します。
NGINX の設定変更¶
NGINX を利用している場合は Sora 2025.1.0 デプロイ時に location の設定を resource から session に変更してください。
location ~ ^/(whip|whip-session|whep|whep-session)/ {
# ...
}
クラスター利用時のローリングアップデート¶
クラスター機能を利用している場合、
Sora 2025.1.0 へローリングアップデートを行う前に whip-session と whep-session を許可するようにしてください。
location ~ ^/(whip|whip-resource|whip-session|whep|whep-resource|whep-session)/ {
# ...
}
ローリングアップデートが完了した後、 whip-resource と whep-resource を削除してください。
location ~ ^/(whip|whip-session|whep|whep-session)/ {
# ...
}
組み込み TURN 機能無効の設定を非推奨にしました¶
組み込み TURN 機能は 2016 年 6 月にリリースされ、長年安定して動作してきたため、 組み込み TURN 機能を無効にする設定を非推奨にし、無効にする設定を 2025 年 12 月リリース予定の Sora にて廃止します。
2025 年 6 月リリースの Sora にて組み込み TURN 機能を無効にする turn を
falseにする設定を非推奨にしました2025 年 12 月リリース予定の Sora にて組み込み TURN 機能の設定を廃止し、組み込み TURN 機能を無効にすることができなくなります
WHIP/WHEP の TURN 機能をデフォルトで有効にしました¶
2024 年 7 月リリースの OBS 30.2 で WHIP の TURN に対応したため、 WHIP/WHEP の TURN をデフォルトで有効にしました。
注釈
WHEP はまだ OBS にマージされていません。
WHIP/WHEP の TURN 機能を無効にする設定を非推奨にしました¶
WHIP/WHEP の TURN 機能をデフォルトで有効にしたため、無効にする設定を非推奨にしました。
2025 年 6 月リリースの Sora にて WHIP/WHEP の TURN を無効にする whip_turn を
falseにする設定を非推奨にしました2025 年 12 月リリース予定の Sora にて WHIP/WHEP の TURN 機能の設定を廃止し、WHIP/WHEP の TURN を無効にすることができなくなります
WHIP/WHEP の CORS 設定を追加しました¶
ブラウザから WHIP/WHEP を利用する際に必要になる CORS を Sora で設定できるようにしました。
この設定はあくまで検証目的の簡易的なものであるため、 プロダクション環境で利用する場合は NGINX などで CORS の設定を行ってください。
また、ブラウザの場合は WHIP/WHEP を利用せず、 Sora JavaScript SDK の利用を強く推奨します。
メディア配信ワーカー自動スケール対応¶
メディア配信ワーカー機能は Sora の内部で音声や映像を配信するワーカーを複数用意することで、 1 チャネルで高ビットレートの映像をより多くのクライアントに配信することをできるようにする機能です。
Sora 2025.1.0 までは事前に配信ワーカー数を設定する仕組みでしたが、 Sora 2025.1.0 から視聴者数に応じて動的にワーカー数を変更する機能になりました。
そのため media_publish_worker_number は廃止しました。
クラスターリレーのツリー化¶
クラスターリレー機能を利用した際に、ノード数が増えるとリレー数が増えてノード負荷が高くなる問題を解決するために、リレーをツリー化しました。
リレーをツリー化することで 1 ノード辺りのリレー数を削減し、ノード負荷を分散することができるようになりました。
セッションウェブフック session.created の払い出しに group_id の追加¶
セッションをグループ化する group_id を指定できるようになりました。
session.created ウェブフックの戻り値に group_id 項目でセッションのグループ ID を含める事ができます。
:ref:`20231220.ListSessions API にて group_id を指定することで、指定した group_id のセッションのみを表示できるようになりました。
主にマルチテナントで Sora を利用している際に、現在のセッションをグループ化を目的としている機能です。
セッション単位での最大同時接続数を制限する max_connections の追加¶
session.created の払い出しで、セッション単位での最大同時接続数を制限する max_connections を追加しました。
トライアルでは trial_max_connections という項目でしたが、正式版に伴い max_connections に変更しました。
trial_max_connections は 2025 年 12 月リリース予定の Sora にて廃止します。
詳細は max_connections を確認してください。
trial_max_connectionsは 2025 年 12 月リリース予定の Sora にて廃止します。trial_max_connectionsとmax_connectionsを同時に指定した場合はmax_connectionsが優先されますtrial_max_connections廃止後は無視します
クラスターのローリングアップデートについて¶
2024.2.x から 2025.1.x へのローリングアップデートができます。
1 台 1 台ローリングアップデートを行ってください。
2024.1.x から 2025.1.x へのローリングアップデートはできません、 かならず 2024.2.x からのアップデートを行う場合、 2024.2.x を経由してから 2025.1.x へアップデートを行ってください。
legacy_signaling_error の廃止¶
2024.1.x までのシグナリングエラー時のログ出力先やウェブフック connection.failed の通知タイミングを維持する legacy_signaling_error を廃止しました。
今後は以下の挙動になります。
シグナリング時のエラーが
sora.jsonlに出力しませんシグナリング時のエラーが
signaling_error.jsonlに出力します認証失敗時のエラーが
sora.jsonlに出力しません認証失敗時のエラーが
signaling_error.jsonlに出力しますイベントウェブフック connection.failed が認証失敗時には通知しません
イベントウェブフック connection.failed が認証成功後に接続に失敗した時のみ通知します
認証失敗時のエラーログの出力¶
認証失敗時のログを sora.jsonl から signaling_error.jsonl に出力します。
認証時失敗時のエラーはシグナリングエラーと同等として扱います。
sora.jsonl に ERROR で出力されるシグナリング失敗のエラーメッセージは connection.created 以降に変更します。
イベントウェブフック connection.failed の挙動¶
connection.failed はシグナリング時にエラーが発生した場合通知する仕組みでしたが、 今後は認証が成功した後に接続が失敗した場合のみ通知されます。
これにより、認証が失敗した場合には connection.failed ウェブフックは通知されません。