リリースノート¶

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

2025.1.0-canary¶

メジャーアップデート

リリース予定:: 2025 年 6 月 19 日

重要

Sora 2024.2.x から 2025.1.x への移行については 2024.2.x から 2025.1.x への移行をご確認ください。

ハイライト¶

正式版¶

今回のリリースで以下の機能が実験的機能から正式版になりました。

破壊的変更¶

廃止情報¶

レガシーストリームを廃止しました
- multistream 項目をウェブフック、ログ、API から削除しました
- multistream を false にして接続した場合バリデーションエラーになります
モード機能のウェブフック session.vanished を廃止しました

非推奨情報¶

2025 年 12 月リリース予定の Sora からウェブフックとログから multistream 項目を廃止します
- sora.conf の legacy_multistream_log を true にすることで 2024.2.x までと同様にログに multistream 項目を出力します
  - この項目は 2025 年 12 月リリース予定の Sora にて廃止します
- sora.conf の legacy_multistream_webhook を true にすることで 2024.2.x までと同様にウェブフックに multistream 項目を出力します
  - この項目は 2025 年 12 月リリース予定の Sora にて廃止します

変更履歴¶

sora.conf¶

[CHANGE] sora.conf の legacy_stream を廃止しました
[CHANGE] sora.conf の ignore_session_vanished_webhook を廃止しました
[ADD] sora.conf に 2024.2.x までと同様にログに multistream 項目を出力する legacy_multistream_log を追加しました
- この項目は 2025 年 12 月リリース予定の Sora にて廃止します
[ADD] sora.conf に 2024.2.x までと同様にウェブフックに multistream 項目を出力する legacy_multistream_webhook を追加しました
- この項目は 2025 年 12 月リリース予定の Sora にて廃止します

API¶

レガシーストリーム廃止¶

[CHANGE] レガシーストリーム機能を廃止しました
- multistream 項目をウェブフック、ログ、API から削除しました
- multistream を false にして接続した場合バリデーションエラーになります
[CHANGE] レガシーストリーム機能廃止に伴い Sora_20170814.StartForwardingRtp API の connection_id を必須にしました
[CHANGE] レガシーストリーム機能廃止に伴い Sora_20170814.StopForwardingRtp API の connection_id を必須にしました

クラスターリレー多段機能¶

これは実験的機能です

今までのクラスターリレー機能は他のノードへの転送はクライアントが配信しているノードが担当していました。この場合多くのノードにリレーが発生するとそのノードの負荷が高くなってしまいます。そこで、ノードの負荷分散を行うためにクラスターリレー多段機能を追加しました。

クラスターリレー多段機能はデフォルトで有効です。

[ADD] クラスターリレー多段機能を追加しました
[ADD] sora.conf に sora_conf-legacy_cluster_relay を追加しました
- デフォルトは false です
- この設定を true にするとクラスターリレー時に多段リレーを行わなくなります
- この設定は 2026 年 6 月リリース予定の Sora にて廃止します

統計機能¶

[ADD] 実験的機能として GetStatsReport に Sora 内部で発生した遅延の累積値 (マイクロ秒単位) total_sent_srtp_sfu_delay_us を追加しました
[ADD] 実験的機能として GetStatsConnection に Sora 内部で発生した遅延の累積値 (マイクロ秒単位) total_sent_rtp_sfu_delay_us を追加しました
[ADD] 実験的機能として GetStatsClient に Sora 内部で発生した遅延の累積値 (マイクロ秒単位) total_sent_rtp_sfu_delay_us を追加しました
[ADD] 実験的機能として 20171101.GetStatsAllConnection に Sora 内部で発生した遅延の累積値 (マイクロ秒単位) total_sent_rtp_sfu_delay_us を追加しました

帯域推定機能¶

帯域推定機能を追加しました、様々な情報を利用し帯域推定を行います。

以下を参考にしています。

シグナリング通知 network.status に帯域推定結果を追加¶

これは実験的機能です

実験的機能としてシグナリング通知の network.status に帯域推定結果を通知する機能を追加しました。これは受信者の帯域推定結果を通知するもので、送信者の帯域推定結果は通知しません。そのため role が sendrecv または recvonly の場合に有効になります。

[ADD] sora.conf に sora_conf-legacy_signaling_notify_network_status を追加しました
- デフォルトは false です
- この設定を true にするとシグナリング通知 network.status のフォーマットを 2024.2.x までと同様にします
[ADD] sora.conf にシグナリング通知 network.status の通知間隔を設定する sora_conf-signaling_notify_network_status_interval を追加しました
- デフォルトは 10 s です
- 最小は 20 ms で、最大は 10 min です
[ADD] シグナリング通知 network.status に estimated_bandwidth を追加しました
- sora.conf の sora_conf-legacy_signaling_notify_network_status が true の場合に有効になります
- この通知は role が sendrecv または recvonly の場合に通知します

サイマルキャスト帯域推定による自動 rid 切り替え機能¶

これは実験的機能です

実験的機能としてサイマルキャストに rid を Sora 側で自動で切り替える auto を指定できるようになりました。この機能を利用することで帯域推定を利用する事で最適な rid を Sora 側で選択するようになります。

[ADD] サイマルキャスト機能利用時の rid に auto を指定できるようになりました
- auto を指定した場合、帯域推定機能を利用して最適な rid を選択するようになります
[ADD] サイマルキャスト機能利用時の rid に none を指定できるようになりました
- none を指定した場合、映像が配信されなくなります

ICE コネクションステート機能¶

[ADD] 認証成功時の払い出しに ice_connection_state_disconnected_timeout_ms を追加しました
[ADD] 認証成功時の払い出しに ice_connection_state_failed_timeout_ms を追加しました
[ADD] sora.conf に sora_conf-default_ice_connection_state_disconnected_timeout を追加しました
- sora.conf の ice_connection_state_disconnected_timeout は 2026 年 6 月リリース予定の Sora にて廃止します
[ADD] sora.conf に sora_conf-default_ice_connection_state_failed_timeout を追加しました
- sora.conf の ice_connection_state_failed_timeout は 2026 年 6 月リリース予定の Sora にて廃止します

WHIP/WHEP 機能¶

ブラウザから WHIP/WHEP を利用する場合は CORS (Cross-Origin Resource Sharing) の設定を払い出す必要があり、検証用として Sora 側でも簡易的な CORS の払い出し設定を追加しました。

重要

プロダクション環境では NGINX などで CORS の設定をすることを強く推奨します。

[ADD] sora.conf にブラウザ向け Cross-Origin Resource Sharing の(CORS) 設定 sora_conf-whip_cors_origin を追加しました
- デフォルトは未指定です
- http://localhost:8080 や * のように指定します
- sora_conf-whip_cors_origin が指定されている場合、 /whip/:channel_id に対して CORS を有効にします
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Origin に sora_conf-whip_cors_origin の値を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Methods に POST を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Headers に Content-Type と Authorization を設定します
  - POST のレスポンスヘッダーに Access-Control-Expose-Headers に Location と ``Link``を設定します
- sora_conf-whip_cors_origin が指定されている場合、 /whip-resource/:channel_id/:secret/ に対して CORS を有効にします
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Origin に sora_conf-whip_cors_origin の値を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Methods に DELETE を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Headers に Content-Type と Authorization を設定します
[ADD] sora.conf にブラウザ向け Cross-Origin Resource Sharing の(CORS) 設定 sora_conf-whep_cors_origin を追加しました
- デフォルトは未指定です
- http://localhost:8080 や * のように指定します
- sora_conf-whep_cors_origin が指定されている場合、 /whep/:channel_id に対して CORS を有効にします
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Origin に sora_conf-whep_cors_origin の値を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Methods に POST を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Headers に Content-Type と Authorization を設定します
  - POST のレスポンスヘッダーに Access-Control-Expose-Headers に Location と ``Link``を設定します
- sora_conf-whep_cors_origin が設定されている場合、 /whep-resource/:channel_id/:secret/ に対して CORS を有効にします
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Origin に sora_conf-whep_cors_origin の値を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Methods に DELETE を設定します
  - OPTIONS のレスポンスヘッダーに Access-Control-Allow-Headers に Content-Type と Authorization を設定します