リリースノート¶

role が recvonly の場合の codec_type や bit_rate などの指定を無視する変更¶

マルチストリーム機能のみの提供になっても、 Sora 2025.1.0 で廃止したレガシーストリームとの互換性を維持するために、 role が recvonly の場合でもシグナリングや認証成功時の払い出しで、 codec_type や bit_rate などの指定ができていました。

Sora 2025.2.0 からは、下記のように codec_type や bit_rate などを指定したとしても無視する仕様に変更しました。

• [CHANGE] role が recvonly の場合、シグナリングや認証成功時に以下の指定が無視されるようになりました
  • audio の codec_type 、 bit_rate 、 opus_params
  • video の codec_type 、 bit_rate 、 simulcast 、 vp9_params 、 av1_params 、 h264_params 、 h265_params
• [CHANGE] role が recvonly の場合、connection ログに以下の情報が出力されなくなりました
  • audio の codec_type 、 bit_rate 、 opus_params
  • video の codec_type 、 bit_rate 、 simulcast 、 vp9_params 、 av1_params 、 h264_params 、 h265_params

環境変数による sora.conf の設定上書き機能¶

環境変数にて SORA_<設定項目名> を指定することで sora.conf の設定を上書きできる機能を追加しました。

例えば SORA_DEFAULT_VIDEO_BIT_RATE=500 という環境変数を指定することで sora.conf の default_video_bit_rate の設定を上書きできます。もし設定が default_video_bit_rate = 300 であっても、Sora は起動時に環境変数の値を優先して 500 として動作します。

• [ADD] 環境変数にて SORA_<設定項目名> を指定することで sora.conf の設定を上書きできるようになりました

詳細は 環境変数による設定上書き機能 をご確認ください。

RPC 機能¶

これは実験的機能です

クライアントから、Sora の一部の HTTP API をデータチャネル経由で呼び出すことができる RPC 機能を追加しました。 この機能を利用するにはデータチャネルシグナリングを有効にする必要があります。

• [ADD] sora.conf に RPC 機能を指定する data_channel_rpc を追加しました
  • デフォルトは true です
• [ADD] 認証成功時の払い出しに、利用できる RPC メソッドの一覧を指定する rpc_methods を追加しました
  • "rpc_methods": ["2025.2.0/RequestSimulcastRid"] のように指定します
  • 未指定または空リスト [] の場合は RPC 機能を利用できません
• [ADD] シグナリングメッセージ "type": "offer" に認証成功時に払い出した rpc_methods が含まれるようになりました
• [ADD] connection.jsonl に rpc_methods が含まれるようになりました
• [ADD] メタデータ拡張機能の PutSignalingNotifyMetadata API を RPC 機能で利用できるようになりました
  • メソッド名は 2025.2.0/PutSignalingNotifyMetadata です
  • channel_id と connection_id は省略することができます
• [ADD] メタデータ拡張機能の PutSignalingNotifyMetadataItem API を RPC 機能で利用できるようになりました
  • メソッド名は 2025.2.0/PutSignalingNotifyMetadataItem です
  • channel_id と connection_id は省略することができます
• [ADD] サイマルキャスト機能の RequestSimulcastRid API を RPC 機能で利用できるようになりました
  • メソッド名は 2025.2.0/RequestSimulcastRid です
  • channel_id と receiver_connection_id は省略することができます
• [ADD] スポットライト機能の RequestSpotlightRid API を RPC 機能で利用できるようになりました
  • メソッド名は 2025.2.0/RequestSpotlightRid です
  • channel_id と recv_connection_id は省略することができます
• [ADD] スポットライト機能の ResetSpotlightRid API を RPC 機能で利用できるようになりました
  • メソッド名は 2025.2.0/ResetSpotlightRid です
  • channel_id と recv_connection_id は省略することができます

詳細は RPC 機能 をご確認ください。

セッション単位でのクライアント ID 重複時の既存接続の追い出し機能¶

これは実験的機能です

• [ADD] クライアント ID 重複時の既存接続の追い出し機能が有効になっているセッションにおいて、追い出される対象の既存のコネクションが存在する場合に、そのクライアントの ice_connection_state を認証ウェブフックに含めるようになりました
  • シグナリング接続時に、その接続と重複した client_id が指定されている追い出し対象のコネクションがすでに存在する場合にのみ ice_connection_state が含まれます

サイマルキャスト新機能追加に関する設定項目名と API 名の変更¶

Sora 2025.2.0 から rid に none を設定できるようになりました。これに伴い sora.conf の設定や、接続時、認証成功時の払い出し項目、API の名前をよりわかりやすくしたものを追加しました。

Sora 2025.2.0 より前の古い設定項目名や API 名も引き続き利用できますが、2027 年 12 月リリース予定の Sora にて廃止予定です。新しい設定項目名や API 名をご利用ください。

古い設定項目や API では rid に none を指定することはできません。

ResetRtpStream API については活用場所が難しく、 RequestSimulcastRid で代替できることから 2026 年 12 月にて廃止することにしました。

• [CHANGE] ResetRtpStream API を非推奨にしました
  • 今後は RequestSimulcastRid API をご利用ください
• [ADD] rid の切り替えをリクエストする RequestSimulcastRid API を追加しました
  • rid は r0 、 r1 、 r2 に加えて none が指定できるようになりました
  • RequestRtpStream API は 2027 年 12 月リリース予定の Sora にて廃止予定です
  • send_connection_id を sender_connection_id へ変更しています
  • recv_connection_id を receiver_connection_id へ変更しています
• [ADD] サイマルキャスト視聴側がどの rid を視聴するかのデフォルトを指定する sora.conf の default_simulcast_request_rid を追加しました
  • デフォルトは r0 です
  • simulcast が true の場合にのみ有効です
  • sora.conf の default_simulcast_rid は 2027 年 12 月リリース予定の Sora にて廃止予定です
• [ADD] シグナリング接続時に視聴するストリームの rid を指定する simulcast_request_rid を追加しました
  • simulcast_request_rid には none 、 r0 、 r1 、 r2、 を指定できます
  • simulcast_request_rid は role が sendrecv または recvonly の場合にのみ有効です
  • simulcast が true の場合にのみ有効です
  • シグナリング接続時の simulcast_rid は 2027 年 12 月リリース予定の Sora にて廃止予定です
• [ADD] 認証成功時の払い出しにて視聴するストリームの rid を指定する simulcast_request_rid を追加しました
  • simulcast_request_rid には none 、 r0 、 r1 、 r2 を指定できます
  • simulcast_request_rid は role が sendrecv または recvonly の場合にのみ有効です
  • simulcast が true の場合にのみ有効です
  • 認証成功時の simulcast_rid は 2027 年 12 月リリース予定の Sora にて廃止予定です
• [ADD] 認証成功時の払い出しにて RPC 機能経由で 2025.2.0/RequestSimulcastRid で利用できる rid を指定する simulcast_rpc_rids を追加しました
  • デフォルトは未指定で、どれも指定できません
  • simulcast が true の場合にのみ有効です
  • "simulcast_rpc_rids": ["none", "r0", "r1"] のように指定します

サイマルキャスト機能利用時の視聴環境に合わせたストリーム自動切り替え機能¶

これは実験的機能です

実験的機能として、サイマルキャスト機能に Sora 側で視聴環境に合わせてストリームを自動で切り替える仕組みを追加しました。

例えば、 rid が r2 のストリームが高ビットレート、 r1 のストリームが低ビットレートの場合、視聴環境が悪化した場合に Sora が自動で r2 から r1 に切り替えます。

• [ADD] sora.conf にサイマルキャスト機能利用時に、視聴環境に合わせて Sora が自動で配信する rid ストリームを切り替える default_simulcast_auto_rids を追加しました
  • デフォルトは未指定で、自動では切り替わりません
  • default_simulcast_auto_rids はサイマルキャストが有効な場合のみ利用できます
  • default_simulcast_auto_rids = r0, r1 のように複数指定することができます
  • 指定した rid の中で視聴環境に合わせて Sora が自動で切り替えます
• [ADD] 認証成功時の払い出しに、サイマルキャスト利用時に、視聴側の環境に合わせて配信する rid ストリームを Sora が自動で切り替える simulcast_auto_rids の払い出し を追加しました
  • デフォルトは default_simulcast_auto_rids の値です
  • simulcast_auto_rids の払い出し を払い出す場合は同時に simulcast を true で払い出す必要があります
  • rids には ["r0", "r1"] のように複数指定できます
  • 指定した rid の中で視聴環境に合わせて Sora が自動で切り替えます
  • 空リスト [] で指定した場合は自動で切り替わらなくなります
• [ADD] サイマルキャスト機能利用時に視聴側の環境に合わせて Sora が自動で配信する rid ストリームを切り替えるように変更できる ChangeSimulcastAuto API を追加しました
  • デフォルトは default_simulcast_auto_rids の値です
  • ChangeSimulcastAuto API はサイマルキャストが有効な場合のみ利用できます
  • rids には ["r0", "r1"] のように複数指定できます
  • 指定した rid の中で視聴環境に合わせて Sora が自動で切り替えます
  • 空リスト [] を指定した場合、自動切り替えは無効になります
• [ADD] sora.conf にサイマルキャスト機能利用時に simulcast_auto_rids を指定した際、自動で切り替わる最小の間隔を秒数で指定します simulcast_auto_min_switch_interval を追加しました
  • デフォルトは 5 s です
  • 範囲は 1..300 s です
• [ADD] 統計情報にサイマルキャスト機能利用時に視聴環境に自動で切り替わる simulcast_auto を追加しました
  • target_sender_count
    • サイマルキャスト rid 切り替えの対象となった送信ストリーム数
  • total_switched
    • サイマルキャスト rid が自動で切り替わった回数
  • total_up_trend
    • 帯域推定が上昇傾向だった際に切り替えをスキップした回数
  • total_history_not_ready
    • 履歴サイズが十分でないために切り替えをスキップした回数の累計値

サイマルキャスト機能利用時の rid 切り替わり時のシグナリング通知機能¶

これは実験的機能です

今まで視聴側で simulcast の rid が切り替わったことを知る手段がありませんでした。 今回、サイマルキャストの rid が切り替わった際にシグナリング通知が送信される機能を追加しました。

• [ADD] サイマルキャスト機能で rid が切り替わった際に送信するシグナリング通知 simulcast.switched を追加しました
• [ADD] sora.conf にサイマルキャストの rid が切り替わった際にシグナリング通知を送信するかどうかを指定する signaling_notify_simulcast_switched を追加しました
  • デフォルトは true です

{
  "type": "notify",
  "timestamp": "string",
  "event_type": "simulcast.switched",
  "sender_connection_id": "string",
  "priority": "higher | lower",
  "trigger": "api | rpc | sender | receiver",
  // simulcast_rpc_rids を指定した場合に含まれます
  // 未指定の場合は "rpc_rids": [] になります
  "rpc_rids": ["none", "r0", "r1", "r2"],
  // simulcast_auto_rids を指定した場合に含まれます
  // 未指定の場合は "auto_rids": [] になります
  "auto_rids": ["none", "r0", "r1", "r2"],
  "request_rid": "none | r0 | r1 | r2",
  "current_rid": "none | r0 | r1 | r2",
  "previous_rid": "none | r0 | r1 | r2",
}

認証ウェブフック経由での録画開始機能¶

これは実験的機能です

録画はセッションウェブフック session.created のタイミングで開始するか StartRecording API を呼び出すことで開始できますが、ウェブフックを利用して途中から録画を開始する事ができませんでした。

今回、実験的機能として認証ウェブフックの戻り値で録画を開始できる仕組みを追加しました。

• [ADD] sora.conf に認証ウェブフック成功時の払い出しで録画を開始できるかどうかを指定する auth_webhook_recording を追加しました。
• [ADD] 認証ウェブフックの戻り値に recording を追加しました
  • recording に true を指定すると録画が既に開始されていない場合は録画を開始します
  • recording に false を指定した場合は無視します
• [ADD] 認証ウェブフックの戻りに recording に true を指定した際に利用できる録画用の項目を追加しました
  • recording_expire_time
  • recording_split_only
  • recording_split_duration
  • recording_metadata
  • recording_format
  • これらの設定の詳細については 認証ウェブフック をご確認ください。

ノード単位での最大同時接続数制限機能¶

これは実験的機能です

Sora は今までノード単位の同時接続数はライセンスでのみ制限をしていましたが、 低スペックのインスタンスを一時的に利用する際、ノード単位での最大同時接続数を制限したいという要望がありました。

今回 sora.conf にてノード単位での接続数を制限する仕組みを追加しました。

この機能を利用することで、例えば、ライセンスでは 300 同時接続まで許可されているが、ノード単位で 100 同時接続までに制限するといった運用が可能になります。

• [ADD] sora.conf にノード単位での最大同時接続数を制限する max_connections を追加しました
  • デフォルトは未指定で無制限です
  • 0 から 10000 までの値を指定できます
  • この値をチェックする前にライセンスによる最大同時接続数をチェックするため、ライセンスによる最大同時接続数を超えた接続はできません

セッション単位での最大同時接続数を無視する機能¶

これは実験的機能です

セッション作成時の max_connections にてセッション単位の最大同時接続数を制限できますが、 特定のクライアントは、このセッション単位の最大同時接続数の制限を無視して接続を許可したい場合があります。

今回、認証成功時の払い出しでセッション単位の最大同時接続数を無視して接続を許可する仕組みを追加しました。

• [ADD] 認証成功時の払い出しにて ignore_max_connections を指定できるようになりました
  • セッション単位の最大同時接続数制限が指定されている場合に有効になります
  • ignore_max_connections に true を指定するとセッション単位での最大同時接続数制限を無視して接続を許可します
• [ADD] コネクションログ connection.jsonl に ignore_max_connections を追加しました
  • コネクションログの ignore_max_connections が true の場合、セッション単位の最大同時接続数制限を無視して接続が許可されたことを示します