WebRTC SFU Sora ドキュメント¶

重要なお知らせについて¶

重要なお知らせ をご確認ください。

古いドキュメントについて¶

古いドキュメント をご確認ください。

映像ビットレート自動シェアリング機能の無効化について¶

マルチストリームにおける映像ビットレート自動シェアリング機能 は スポットライト機能 がまだない時代に、参加者が増えた場合でも視聴側の負担を減らす機能でした。

しかし、現在はスポットライト機能を利用することで、参加者が増えた場合でも視聴側の負荷を減らせることや、シェアリング機能の結果、指定したビットレートとは異なる配信が行われて混乱を招くことが多いことから、デフォルトで無効にすることにしました。

今後は、同一チャネルで複数人により双方向配信を行う場合は、スポットライト機能の利用を強くおすすめします。

もしスポットライト機能を利用していない場合で、映像ビットレート自動シェアリング機能を利用したい場合は、 multistream_auto_sharing_video_bit_rate を true に設定してください。

Safari 18.4 から Safari 18.5 において H.264 または H.265 の録画が正常に行えない問題が発生します¶

これは Safari の問題で、Sora の問題ではありません。

Safari が H.264 または H.265 の映像を配信する際に、正常なタイムスタンプを生成できない問題が発生しています。

この問題により、Safari で H.264 または H.265 の録画が正常に行われません。

この問題に対応したワークアラウンドを Sora 2024.2.3 で追加しています。

詳細は workaround_20250515 をご確認ください。

Sora RHEL 版の追加料金について¶

Sora RHEL 版をご利用の場合、2027 年 6 月 1 日以降に有効期間が開始するライセンスについて、 サポート費用としてライセンス料金に 10% (ただし、一契約あたり最大で 10 万円) の料金を加算させていただきます。

Red Hat Enterprise Linux 10 x86_64 版の提供開始について¶

Sora 2025.1.0 から RHEL 10 x86_64 版の提供を開始しました。

RHEL 10 x86_64 版への切り替えをご希望のお客様はサポートまでご連絡ください。

概要¶

2025.1.x から 2025.2.x への移行について変更点や注意点をまとめています。

もし不明点がある場合はサポートまでお問い合わせください。

マルチストリームにおける映像ビットレート自動シェアリング機能をデフォルト無効にしました¶

マルチストリームにおける映像ビットレート自動シェアリング機能 は スポットライト機能 がまだない時代に、参加者が増えた場合でも視聴側の負担を減らす機能でした。

しかし、現在はスポットライト機能を利用することで、参加者が増えた場合でも視聴側の負荷を減らせることや、シェアリング機能の結果、指定したビットレートとは異なる配信が行われて混乱を招くことが多いことから、デフォルトで無効にすることにしました。

今後は、同一チャネルで複数人により双方向配信を行う場合は、スポットライト機能の利用を強くおすすめします。

もしスポットライト機能を利用していない場合で、映像ビットレート自動シェアリング機能を利用したい場合は、 multistream_auto_sharing_video_bit_rate を true に設定してください。

レガシー録画機能を廃止しました¶

レガシー録画機能を廃止しました。今後は 録画機能(セッション単位) をご利用ください。

• StartRecording API を廃止しました
• StopRecording API を廃止しました
• GetStartedRecording API を廃止しました
• ListStartedRecording API を廃止しました
• ListArchiving API を廃止しました

それに伴い sora.conf の legacy_recording 設定を廃止しました。

録画機能(セッション単位)のデフォルト出力フォーマットが MP4 形式になりました¶

WebM は現時点で広くサポートされていますが、MP4 形式の方がより多くの環境でサポートされているため、 録画機能(セッション単位)のデフォルト出力フォーマット設定する sora.conf の default_recording_format のデフォルトを mp4 に変更しました。

もし WebM 形式での出力をデフォルトにしたい場合は webm を設定してください。

組み込みでの開発ツール提供を廃止しました¶

組み込みで提供していた開発ツールを廃止しました。

今後はオンライン版またはオフライン版の開発ツールを利用してください。

詳細は 開発ツール をご確認ください。

WHIP/WHEP 時のリソース URL を廃止しました¶

WHIP の RFC 9725 化に伴い WHIP/WHEP 時のリソース URL をセッション URL に変更しました。

• /whip-resource/:channel_id/:secret/ を廃止しました
• /whep-resource/:channel_id/:secret/ を廃止しました
• 2025 年 12 月リリースの Sora にて /whip-resource/:channel_id/:secret/ は廃止しました
• 2025 年 12 月リリースの Sora にて /whep-resource/:channel_id/:secret/ は廃止しました
• /whip-session/:channel_id/:secret/ を利用してください
• /whep-session/:channel_id/:secret/ を利用してください

location ~ ^/(whip|whip-session|whep|whep-session)/ {
   # ...
}

location ~ ^/(whip|whip-session|whep|whep-session)/ {
   # ...
}

ICE コネクションステート機能のタイムアウト値の古い設定を廃止しました¶

ICE コネクションステート機能のタイムアウトの値を認証成功時に払い出せる仕組みを追加したため、 sora.conf の ice_connection_state_disconnected_timeout と ice_connection_state_failed_timeout を廃止しました。

default_ice_connection_state_disconnected_timeout と default_ice_connection_state_failed_timeout を利用してください。

• 2025 年 6 月リリースの Sora にて sora.conf の ice_connection_state_disconnected_timeout と ice_connection_state_failed_timeout を非推奨にしました
• 2025 年 12 月リリースの Sora にて sora.conf の ice_connection_state_disconnected_timeout と ice_connection_state_failed_timeout を廃止しました

組み込み TURN 機能無効の設定を廃止しました¶

組み込み TURN 機能は 2016 年 6 月にリリースされ、長年安定して動作してきたため、 組み込み TURN 機能を無効にする設定を非推奨にし、 無効にする設定を 2025 年 12 月リリースの Sora にて廃止しました。

• 2025 年 6 月リリースの Sora にて組み込み TURN 機能を無効にする turn を false にする設定を非推奨にしました
• 2025 年 12 月リリースの Sora にて組み込み TURN 機能の設定 turn を廃止しました

組み込み TURN 機能を無効にすることができなくなりました。

WHIP/WHEP の TURN 機能を無効にする設定を廃止しました¶

WHIP/WHEP の TURN 機能をデフォルトで有効にしたため、無効にする設定を廃止しました。

OBS を利用する場合は WHIP の TURN 機能に対応している 2024 年 7 月にリリースされたバージョン 30.2 以降をご利用ください。

• 2025 年 6 月リリースの Sora にて WHIP/WHEP の TURN を無効にする whip_turn を false にする設定を非推奨にしました
• 2025 年 12 月リリースの Sora にて WHIP/WHEP の TURN 機能の設定を廃止しました

WHIP/WHEP の TURN を無効にすることができなくなりました。

role が recvonly の場合、認証ウェブフックやコネクションログに audio_* と video_* から始まる項目を廃止しました¶

今まで 2025.1.0 に廃止したレガシーストリームの互換性を維持するため、 シグナリングで指定した audio と video に含まれる codec_type や bit_rate を認証ウェブフックに含めていましたが、 レガシーストリームを廃止したことや誤解を招きやすいことから Sora 2025.2.0 では含めないようにしました。

role が recvonly の場合認証ウェブフックとコネクションログに audio_ と video_ から始まる項目が含まれなくなります。

• audio_codec_type
• audio_bit_rate
• video_codec_type
• video_bit_rate
• video_vp9_params
• video_av1_params
• video_h264_params
• video_h265_params

RTP ストリーム停止と再開機能の廃止¶

RTP ストリーム停止/再開 関連 API を 2025 年 12 月リリースの Sora にて廃止しました。

それに伴い sora.conf の signaling_notify_rtp_stream 設定を廃止しました。

• PauseRtpStream API を廃止しました
• ResumeRtpStream API を廃止しました
• ListPauseRtpStreams API を廃止しました

今後は 転送フィルター をご利用ください。

再送要求の頻度を利用した不安定レベルの通知機能の廃止¶

再送要求頻度を利用した不安定レベルの通知機能を 2025 年 12 月リリースの Sora にて廃止しました。

それに伴い sora.conf の legacy_signaling_notify_network_status を廃止しました。

sora.conf の signaling_forwarding_filter 廃止¶

マルチ転送フィルター機能に合わせて設定名を変更し、 2025 年 12 月リリースの Sora にて廃止しました。

今後は signaling_forwarding_filters をご利用ください。

サイマルキャスト機能の機能追加に伴う設定項目や API 名の変更¶

Sora 2025.2.0 からサイマルキャスト機能で新しく none と auto という二つの機能ができるようになります。これに伴いサイマルキャスト機能の設定や API の名前をよりわかりやすい名前に変更しました。

none や auto といった新しい機能を利用する場合は新しい名前の設定や API でのみ利用できます。

sora.conf の av1 を廃止し常に利用できる用にしました¶

AV1 は Chrome/Edge 利用できる用になってか 3 年以上経過したことから、 sora.conf の av1 を 2025 年 12 月リリースの Sora にて廃止しました。

sora.conf の h265 を廃止し常に利用できる用にしました¶

H.265 は Safari や Chrome で利用できる用になったことから、 sora.conf の h265 を 2025 年 12 月リリースの Sora にて廃止しました。

テスト API をデフォルト無効にしました¶

検証環境以外で利用する事がほとんど無いとため、 2025 年 12 月リリースの Sora にてテスト API をデフォルトで無効化しました。

利用する場合は test_api を true に設定してください。

クラスターのローリングアップデートについて¶

2025.1.x から 2025.2.x へのローリングアップデートができます。

1 台ずつローリングアップデートを行ってください。

2024.2.x から 2025.2.x へのローリングアップデートはできません。 必ず 2025.1.x を経由してから 2025.2.x へアップデートを行ってください。

レガシー録画機能ではできて、新しい録画機能ではできないこと¶

変更点¶

レガシー録画機能と新しい録画機能の同時利用¶

レガシー録画機能と新しい録画機能 (セッション単位) は、異なるチャネルであれば同時に利用できます。 例えば、channel_id a ではレガシー録画機能、channel_id b では新しい録画機能（セッション単位）といった利用ができます。

2026.1.0¶

メジャーアップデート

リリース:

2026 年 6 月 24 日

クライアント¶

クライアントは Sora と WebSocket や WebRTC で接続している個を指し、各接続にはユニークな ID が与えられます。

1. 1 接続 1 クライアントの原則:
   • Sora における各接続はそれぞれ別個のクライアントとして扱われます。つまり、1 つの接続は 1 つのクライアントとして扱われます
2. ユニークな ID であるコネクション ID の割り当て:
   • クライアントが Sora に接続すると、その接続には固有の ID (コネクション ID) が割り当てられます
3. 複数クライアントのサポート:
   • SDK を利用することで、ユーザーは複数のクライアントを使用し、複数の接続を確立することができます
4. 同一ユーザーによる接続の統合:
   • 同じユーザーが複数の接続を行う場合、これらの接続に同じクライアント ID を指定することで、ユーザーを一意に識別できます
5. クライアント ID の自動割り当て:
   • クライアント ID を指定しない場合、 Sora はコネクション ID をクライアント ID として自動的に割り当てます

チャネル¶

チャネルは Sora で使用される「ルーム」や「グループ」として機能する、独立したコミュニケーションのスペースです。

1. コミュニケーションの制限:
   • チャネルに接続したクライアントは、そのチャネル内でのみ音声、映像、データのやりとりができます。 異なるチャネルのクライアント間での直接のコミュニケーションはできません
2. 複数チャネルへのアクセス:
   • 一つのウェブブラウザを使用して、複数のクライアントが同時に複数のチャネルにアクセスすることができます
3. チャネル ID:
   • 利用者はチャネルに 255 バイトまでの値を ID として指定できます

セッション¶

セッションは実際にチャネルに参加しているクライアントの集まりを指し、各セッションにはユニークな ID が与えられます。

1. セッションの存在:
   • チャネルに 1 つ以上のクライアントが接続している状態を「セッションが存在する」と言い、 逆にクライアントが 1 人も接続していない場合は「セッションが存在しない」と言います
2. セッションの生成:
   • セッションは、セッションがまだ存在しないチャネルにクライアントが接続した時に生成されます。
3. セッションの破棄:
   • 全てのクライアントがチャネルから切断した後、一定期間が経過するとセッションは破棄されます。
4. セッション ID:
   • セッションには Sora が自動で生成する一意の ID が割り当てられます

コネクション¶

コネクションはクライアントが接続している状態を指し、各コネクションにはユニークな ID が与えられます。

1. コネクションの生成:
   • クライアントが接続し、認証に成功した後、WebRTCが確立されるとコネクションが生成されます
2. コネクションの破棄:
   • クライアントが切断すると、そのコネクションは破棄されます
3. コネクション ID の自動割り当て:
   • コネクションには Sora が自動で生成する一意の ID が割り当てられます

ロール¶

Sora のロールは、クライアントが音声や映像をどのように取り扱うかを決定する役割を果たします。

1. sendrecv (送受信):
   • sendrecv ロールを選択したクライアントは、音声および映像の送受信ができます。 これは、クライアントが他のクライアントと音声や映像を交換する、双方向のコミュニケーションができる状態を意味します
2. sendonly (送信のみ):
   • sendonly ロールを選択したクライアントは、音声および映像の送信のみができます。 これは、自分の音声や映像を他のクライアントに送ることはできますが、他からの音声や映像を受け取ることはできない状態を意味します
3. recvonly (受信のみ):
   • recvonly ロールを選択したクライアントは、音声および映像の受信のみができます。 これは、他のクライアントからの音声や映像は受け取ることができますが、自分から送ることはできない状態を意味します
4. ロールの選択タイミング:
   • クライアントは接続時にのみロールを選択できます。一度選択されたロールは、その後の接続中に変更することはできません
5. ロールとメッセージング機能の独立性:
   • ロールの選択はSoraのメッセージング機能には影響しません。 メッセージング機能の方向性（送信、受信、またはその両方）については、別の項目「direction」で管理されます

対応 OS¶

Sora は Ubuntu と Red Hat Enterprise Linux (RHEL) での動作をサポートしています。

Chrome/Edge の不具合による録画機能利用時の音ズレ問題について¶

Chrome/Edge の不具合により、音声トラックを削除し、その後音声トラックを追加した際に、 音声パケットやそれに関連するタイムスタンプが正しく処理されない場合があり、 これにより録画機能を利用する際に音ズレが発生する問題があります。

この Chrome/Edge の問題は残念ながら解決の見込みはありませんが、録画機能への影響があまりにも大きいため、 Sora 2024.1.0 でこの問題の改善を行いました。

しかし、この改善のための変更が Chrome の別の不具合の影響を受けて新たな問題が発生することが判明したため、 本変更をデフォルトで無効にすることにしました。

この問題への改善は今後も継続していく予定です。

この問題に関して不明点がありましたら、サポートまでご連絡ください。

署名アルゴリズムに SHA-1 が利用されている中間証明書をご利用されているお客様へ¶

Sora 2023.2.x から、署名アルゴリズムが SHA-1 の中間証明書を利用した場合、 Bad Certificate エラーとして接続が拒否されます。

影響のある機能は下記の機能です。

• ウェブフック機能
• 音声ストリーミング機能

もし、このエラーがログに出力された場合はサポートまでご連絡ください。

マルチストリーム機能¶

• "type": "sendrecv" 利用時に音声のみや映像のみを指定した場合でも、音声と映像の両方が送られてきます
  • 転送フィルター機能を利用してください
  • 将来的に改善予定です

OBS WHIP/WHEP 機能¶

仕様としての制限¶

概要¶

実験的機能とは、正式リリースに向けて積極的に改善を行っている機能、および正式リリースを行うかについて決定を保留にしている機能であり、 今後、後方互換性のない仕様変更を行う可能性があります。

また、実験的機能に関するお客様からのお問い合わせやフィードバックを基に、今後の開発方針を決定することがあります。

ごく稀に、正式リリースを見合わせて削除する機能もありますので、具体的な機能については以下の一覧でご確認いただくとともに、 実際に本番環境でご利用いただく場合は事前にサポートまでご連絡いただきますようお願いします。

実験的機能一覧¶

サイマルキャスト視聴 rid 指定 default_simulcast_rid の非推奨化と廃止¶

サイマルキャスト利用時に、視聴する rid を指定する設定である sora.conf の default_simulcast_rid を非推奨にしました。

今後は default_simulcast_request_rid を利用してください。

2027 年 12 月リリース予定の Sora にて sora.conf の default_simulcast_rid を廃止します。

シグナリング接続時と認証成功時の simulcast_rid の非推奨化と廃止¶

シグナリング接続時と認証成功時のサイマルキャスト視聴 rid 指定 simulcast_rid を非推奨にしました。

今後は simulcast_request_rid を利用してください。

2027 年 12 月リリース予定の Sora にて simulcast_rid を廃止します。

スポットライト機能 spotlight_number 項目の認証成功時の払い出しの非推奨化¶

セッションウェブフック session.created で spotlight_number の値を払い出すことができるようになりました。

そのためスポットライト機能の spotlight_number 項目を認証ウェブフック成功時の払い出しで利用するのは非推奨になります。 現時点では廃止予定はありませんが、将来的に 1 年以上の移行期間を経て廃止される予定です。

ウェブフックの HTTP ヘッダー x-sora prefix の非推奨化¶

x-sora prefix とは別に sora prefix の HTTP ヘッダーを追加しました。 これは RFC 6648 による x- prefix の非推奨化に準拠するためです。

x-sora prefix は非推奨になります。現時点では廃止予定はありませんが、将来的に 1 年以上の移行期間を経て廃止される予定です。

• セッションウェブフックの x-sora-session-webhook-type ヘッダーは非推奨です、 sora-session-webhook-type ヘッダーを利用してください
• イベントウェブフックの x-sora-event-webhook-type ヘッダーは非推奨です、 sora-event-webhook-type ヘッダーを利用してください

API¶

非推奨 API をご確認ください

概要¶

廃止機能とはすでに廃止された機能です。

API の廃止については 廃止 API をご確認ください。

レガシー録画機能の廃止¶

今後は 録画機能 (セッション単位) をご利用ください。

移行に関しては レガシー録画機能から新しい録画機能 (セッション単位) への移行 をご確認ください。

• 2024 年 12 月リリースの Sora にて legacy_recording のデフォルトを false に変更しました
• 2025 年 12 月リリースの Sora にて legacy_recording の設定を廃止し、レガシーレコーディングを廃止しました。

ICE コネクションステートのタイムアウト指定設定の変更による非推奨と廃止¶

ICE コネクションステートのタイムアウトを設定する sora.conf の ice_connection_state_disconnected_timeout と ice_connection_state_failed_timeout を非推奨にしました。

2025 年 12 月リリースの Sora にて sora.conf の ice_connection_state_disconnected_timeout と ice_connection_state_failed_timeout を廃止しました。

今後は sora.conf の default_ice_connection_state_disconnected_timeout と default_ice_connection_state_failed_timeout をご利用ください。

組み込み TURN 機能無効の廃止¶

TURN 機能を無効にする設定を廃止しました。それに伴い sora.conf の turn を false に設定することを廃止しました。

• 2025 年 6 月リリースの Sora にて組み込み TURN 機能を無効にする turn を false に設定することを非推奨にしました
• 2025 年 12 月リリースの Sora にて turn を廃止し、組み込み TURN 機能を無効にすることができなくなりました

WHIP/WHEP の TURN 機能無効の非推奨化と廃止¶

WHIP/WHEP の TURN 機能を無効にする設定を非推奨にしました。それに伴い sora.conf の whip_turn と whep_turn を false に設定することを非推奨にしました。

• 2025 年 6 月リリースの Sora にて WHIP/WHEP の TURN 機能を無効にする whip_turn と whep_turn を false に設定することを非推奨化しました
• 2025 年 12 月リリースの Sora にて whip_turn と whep_turn を廃止し、WHIP/WHEP の TURN 機能を無効にすることができなくなりました

ListForwardingFilters API の channel_forwarding_filter の廃止¶

ListForwardingFilters API の戻り値 channel_forwarding_filter を廃止しました。

今後は channel_forwarding_filters をご利用ください。

認証成功時とセッション生成時の forwarding_filter の廃止¶

認証成功時とセッション生成時の forwarding_filter を廃止しました。

今後は forwarding_filters をご利用ください。

RTP ストリーム停止/再開 API の廃止¶

RTP 転送ストリーム停止/再開 API は 転送フィルター により同等の機能が提供でき、 重複機能となるため廃止しました。

今後は 転送フィルター をご利用ください。

レガシーネットワークシグナリング通知機能の非推奨化と廃止¶

ネットワークシグナリング通知機能変更に伴い、レガシーなネットワークシグナリング通知機能を非推奨としました。

• 2025 年 6 月リリースの Sora にてレガシーなネットワークシグナリング通知機能を非推奨としました
• 2025 年 12 月リリースの Sora にてレガシーなネットワークシグナリング通知機能を廃止しました

AV1 無効の廃止¶

AV1 を試すために用意した av1 ですが、 既にデフォルト有効になっており、AV1 を無効にする必要がないと判断したため、 av1 を廃止しました。

• 2025 年 6 月リリースの Sora にて av1 を非推奨としました
• 2025 年 12 月リリースの Sora にて av1 を廃止し、AV1 を無効にすることができなくなりました

H.265 無効の廃止¶

H.265 を試すために用意した h265 ですが、 既にデフォルト有効になっており、H.265 を無効にする必要がないと判断したため、 h265 を廃止しました。

• 2025 年 6 月リリースの Sora にて h265 を非推奨としました
• 2025 年 12 月リリースの Sora にて h265 を廃止し、H.265 を無効にすることができなくなりました

Ubuntu 20.04 対応¶

Ubuntu 20.04 は 2025 年 4 月末でサポートが終了となるのにあわせて、Sora の Ubuntu 20.04 版については以下のとおりとなります。

パッケージの提供:

2024 年 6 月にリリースの 2024.1.0、およびその後リリースされる可能性のある 2024.1.x の提供をもって終了

サポートの終了:

2024.1.0 およびおよびその後リリースされる可能性のある 2024.1.x に対しては 2025 年 6 月末で終了

Ubuntu 20.04 版をご利用のお客様は、早めに OS の変更をご検討の上、移行先の OS をサポートまでご連絡下さい。

CentOS 7 対応¶

CentOS 7 は 2024 年 6 月末でサポートが終了となるのに合わせて、Sora の CentOS 7 版については以下のとおりとなります。

パッケージの提供:

2023 年 12 月にリリースの 2023.2.0、およびその後リリースされる可能性のある 2023.2.x の提供をもって終了

サポートの終了:

2023.2.0 およびおよびその後リリースされる可能性のある 2023.2.x に対しては 2024 年 12 月末で終了

• EOL CentOS | End of Life (EOL) | Lifecycle

CentOS 7 版をご利用のお客様は、早めに OS の変更をご検討の上、移行先の OS をサポートまでご連絡下さい。

統計エクスポーター機能の廃止¶

実験的機能として提供している統計エクスポーター機能を廃止しました。

今後は 統計ウェブフック をご利用ください。

ユーザーエージェント統計の廃止¶

統計エクスポーター機能廃止に伴い、ユーザーエージェント統計関連も廃止しました。

今後は RTC 統計を利用してください。

• 認証ウェブフック成功時の払い出しで利用する user_agent_stats を廃止しました
  • rtc_stats をご利用ください
• sora.conf の sora_conf-user_agent_stats を廃止しました
  • default_rtc_stats をご利用ください

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 が認証成功後に接続に失敗した時のみ通知します

mode_session_vanished の廃止¶

2025 年 6 月リリースの Sora にて廃止

mode_session_vanished を廃止しました。

代わりに GetStatsReport API の total_ongoing_connections をご利用ください。

また Sora Exporter をご利用いただくことで、Sora の統計情報を OpenMetrics 形式で取得できますので、 こちらもご利用ください。

レガシーストリーム(非マルチストリーム)機能の廃止¶

2025 年 6 月リリースの Sora にて廃止

レガシーストリーム(非マルチストリーム)機能を廃止しました。

今後はマルチストリームをご利用ください。

• 2024 年 6 月リリースの Sora にて legacy_stream の設定をデフォルト false にて追加しました
• 2025 年 6 月リリースの Sora にて legacy_stream の設定を廃止し、レガシーストリームを廃止しました

ListClusterNodes API の include_all_known_nodes の廃止¶

2024 年 12 月リリースの Sora にて廃止

ListClusterNodes API の include_all_known_nodes は廃止しました。

今後はそのクラスターへ登録されている全てのノード情報が常に含まれるようになります。

もし一時的に離脱しているノードを含めない場合は API の結果を "connected": true でフィルタリングしてください。

sora.conf の legacy_auth_webhook_log の廃止¶

2024 年 12 月リリースの Sora にて廃止

今まで認証ウェブフックが 200 番台を返さなかったり、 "allowed" 項目を含まなかったり、 "allowed": false なのに "reason" が含まれていなかったり、送信先から応答がなくタイムアウトしたなどで、 処理が正常に行えなかった場合は auth_webhook.jsonl に res 項目なしで出力していました。

この仕様を維持する legacy_auth_webhook_log 設定を廃止しました。

今後は auth_webhook_error.jsonl に reason 項目を追加して出力するように変更しました。

sora.conf の legacy_event_webhook_connection_destroyed_reason の廃止¶

2024 年 12 月リリースの Sora にて廃止

Sora 2023.2.x まで connection.destroyed の reason には、 disconnect_api_reason と同じ値が含まれており、 コネクション切断系 API で reason が指定されていない場合は null が含めていました。

この仕様を維持する legacy_event_webhook_connection_destroyed_reason 設定を廃止しました。

今後は connection.destroyed の reason には以下のような値が入ります。

• "normal" は通常のコネクション破棄
• "disconnected_api" はコネクション切断系 API によるコネクション破棄
• "session_destroyed" はセッションライフタイム期限切れ、または API によるセッション破棄によるコネクション破棄
• "lifetime_expired" はライフタイム期限切れによるコネクション破棄

認証成功時の払い出し h264_profile_level_id の廃止¶

2024 年 6 月リリースの Sora にて廃止

認証成功時の払い出しで H264 のプロファイルレベルの値を指定する h264_profile_level_id を廃止しました。

"video_h264_params": {"profile_level_id": ...} をご利用ください。

sora.conf の default_h264_profile_level_id の廃止¶

2024 年 6 月リリースの Sora にて廃止

H264 のプロファイルレベルのデフォルト値を指定する default_h264_profile_level_id を廃止しました。

default_h264_param_profile_level_id をご利用ください。

Lyra コーデック対応の廃止¶

2024 年 6 月リリースの Sora にて廃止

Lyra コーデック対応を廃止しました。

Opus 1.5 で Lyra 同様の低ビットレートが利用可能になったこと、Lyra が 2 年間更新がないことが廃止の理由です。

sora.conf の legacy_log_format の廃止¶

2023 年 12 月リリースの Sora にて廃止

sora ログや internal ログをレガシーフォーマットで出力する sora.conf の legacy_log_format 設定を廃止しました。

sora.conf の legacy_log_extension の廃止¶

2023 年 12 月リリースの Sora にて廃止

JSONL 形式で出力するログの拡張子を .log でファイル出力する sora.conf の legacy_log_extension 設定を廃止しました。

sora.conf の legacy_webhook_audio_video_json_structure の廃止¶

2023 年 12 月リリースの Sora にて廃止

ウェブフックで利用する audio と video の JSON 構造を {"audio": {"codec_type": "OPUS"}} といった入れ子構造にする sora.conf の legacy_webhook_audio_video_json_structure 設定を廃止しました。

DataChannel で利用している SCTP 関連の実験的な設定の廃止¶

2023 年 6 月リリースの Sora にて廃止

DataChannel で利用している SCTP 関連の実験的な設定である dcsctp_heartbeat_interval と dcsctp_slow_start_tcp_style の設定を廃止しました。

Ubuntu 18.04 サポートの終了¶

サポート提供終了:

2023 年 4 月末

Ubuntu release cycle | Ubuntu

Ubuntu 18.04 は 2023 年 6 月末で通常サポートが終了しました。

Ubuntu 側から 4 月末での通常サポート終了が 6 月末まで延長されましたが、 Sora は当初の予定のまま 2023 年 4 月末をもって Ubuntu 18.04 版のサポートとパッケージの提供を終了しました。

Ubuntu 20.04 または Ubuntu 22.04 版への移行をお願いいたします。

Ubuntu 18.04 を利用しているお客様は、サポートまで切り替え先の OS をご連絡ください。

sora.conf の split_archive_legacy_prefix の廃止¶

2023 年 6 月リリースの Sora にて廃止

sora.conf の split_archive_legacy_prefix 設定を廃止しました。

• 分割録画ファイル名 archive-<connection_id>_<index>.(json|webm) が利用できなくなりました
  • split-archive-<connection_id>_<index>.(json|webm) を利用するように変更してください
• 分割録画時のイベントウェブフックタイプ "type": "archive.split" が利用できなくなりました
  • "type": "split-archive.available" を利用するように変更してください
• 分割録画時のイベントウェブフックタイプ "type": "archive.end" が利用できなくなりました
  • "type": "split-archive.end" を利用するように変更してください

sora.conf の default_multistream の廃止¶

2023 年 6 月リリースの Sora にて廃止

sora.conf の default_multistream 設定を廃止しました。

今後は接続時に multistream を指定せずに接続した場合は常にマルチストリームが有効になります。

redact_archive_metadata_sensitive_data と redact_api_sensitive_data の廃止¶

2022 年 12 月リリースの Sora にて廃止

録画メタデータと API のセンシティブデータを "REDACTED" という文字列に書き換えを廃止しました。 今後はこれらのデータは書き換えを行いません。

recording.report の metadata_filename と metadata_file_path の廃止¶

2022 年 12 月リリースの Sora にて廃止

録画イベントウェブフックの recording.report に含まれる metadata_filename と metadata_file_path が filename と file_path に変更されます。

2021 年 12 月リリースの Sora にて filename と file_path が追加されていますので、そちらを利用するように変更してください。

シグナリング通知メタデータ metadata_list の廃止¶

2022 年 6 月リリースの Sora にて廃止

metadata_list が data に変更されました。

"type": "update" の廃止¶

2022 年 6 月リリースの Sora にて廃止

マルチストリーム機能利用時のシグナリングで利用する "type": "update" を廃止し、 "type": "re-offer" と "type": "re-answer" に変更しました。

sora.conf の demo の廃止¶

2022 年 6 月リリースの Sora にて廃止

sora.conf の demo を廃止しました。今後は devtools を利用してください。

これは デモ機能 が 開発ツール へと名前を変更したことによる影響です。

sora.conf の remote_stats の廃止¶

2022 年 6 月リリースの Sora にて廃止

sora.conf の remote_stats を廃止しました。今後は user_agent_stats を利用してください。

これは リモート統計情報 が ユーザーエージェント統計情報 へと名前を変更したことによる影響です。

StopRecording API の redirect の配信¶

2022 年 6 月リリースの Sora にて廃止

録画機能がクラスターで共有できるようになったことにより、 redirect 指定が不要になったため廃止しました。

CentOS 8 対応¶

サポート提供終了:

2021 年 12 月

• CentOS Project shifts focus to CentOS Stream – Blog.CentOS.org
• FAQ - CentOS Project shifts focus to CentOS Stream
• FAQ: CentOS Stream Updates

CentOS 8 は 2021 年 12 月をもってサポートが終了しました。 それに伴い Sora は 2021 年 12 月末をもって CentOS 8 版のサポートとパッケージの提供を終了しました。

extmap_allow_mixed 設定のデフォルト有効化と廃止¶

2021 年 12 月リリースの Sora にて廃止

Chrome M89 にて a=extmap-allow-mixed がデフォルトで設定されるようになり、 また Firefox 側でも動作に問題がなくなったことからこちらの設定が不要となりました。 2021 年 6 月リリースの Sora でデフォルト有効とし、2021 年 12 月リリースの Sora にて設定を廃止しました。

スポットライトレガシー機能の廃止¶

2021 年 12 月リリースの Sora にて廃止

スポットライトレガシー機能は 2021 年 12 月リリースの Sora で廃止しました。

今後は スポットライト機能 を利用してください。

rtp にある RTCP 関連統計情報を廃止¶

2021 年 12 月リリースの Sora にて廃止

統計 API の rtp 項目に入っている RTCP 関連統計情報を rtcp 項目として独立させました。

これに伴い rtp にある RTCP 関連統計情報を廃止しました。

sora.conf の opus_param_clock_rate を廃止¶

2021 年 12 月リリースの Sora にて廃止

実験的機能として提供していた opus_param_clock_rate を廃止しました。

sora.conf の dcsctp_association_max_retrans を廃止¶

2021 年 12 月リリースの Sora にて廃止

実験的機能として提供していた dcsctp_association_max_retrans を廃止しました。

今後は ICE コネクションステート機能 を利用してください。

role の upstream と downstream を廃止¶

2021 年 6 月リリースの Sora にて廃止

upstream と downstream は 2021 年の 6 月リリースの Sora で廃止しました。

• マルチストリームの upstream は sendrecv をお使い下さい
• マルチストリームの downstream は recvonly をお使い下さい
• スポットライトの upstream は sendrecv をお使い下さい
• スポットライトの downstream は recvonly をお使い下さい
• 片方配信の upstream は sendonly をお使い下さい
• 片方配信の downstream は recvonly をお使い下さい

client_id を指定する設定の廃止¶

2021 年 6 月リリースの Sora にて廃止

sora.conf の allow_client_id_assignment 設定を廃止し client_id はクライアント側で指定できるようにします。

旧サイマルキャスト画質変更 API の廃止¶

2021 年 6 月リリースの Sora にて廃止しました

• Sora_20180820.ChangeSimulcastQuality
  • 今後は RequestRtpStream API をご利用ください

この API の廃止に伴い、シグナリング接続時や認証成功時に指定するサイマルキャストの quality での low / middle / high 指定を廃止しました。 今後は rid と r0 / r1 / r2 を利用してください。

bin/sora start の廃止¶

2020 年 12 月リリースの Sora にて廃止しました

bin/sora start は 2020 年 12 月リリースの Sora 2020.3 で廃止しました。 今後は bin/sora daemon を利用してください。

systemd を利用されている方は bin/sora foreground を利用されていると思いますが、こちらに変更はありません。

Ubuntu 16.04 サポートの終了¶

サポート提供終了:

2021 年 4 月末

Ubuntu release cycle | Ubuntu

Ubuntu 16.04 は 2021 年 4 月を持って通常サポートが終了しました。 それに伴い Sora は 2021 年 4 月末をもって Ubuntu 16.04 版のサポートとパッケージの提供を終了しました。

Ubuntu 18.04 または Ubuntu 20.04 版への移行をお願いいたします。

Ubuntu 16.04 を利用しているお客様は、サポートまで切り替え先の OS をご連絡ください。

概要¶

Sora の仕様に関して質問がある場合¶

Sora の使い方に関して質問がある場合¶

Sora が期待どおりに動かない場合¶

Sora の動作に問題がある場合¶

Sora のサポートライフサイクルポリシー¶

事前確認¶

問い合わせの前に、まずは以下の項目について事前に確認をお願いします。

問い合わせの場合、お送り頂く情報¶

情報をお送り頂くときは テキストファイル でお送りください。

• サーバーやクライアントのスペック
  • わかれば機種名
  • CPU
  • メモリ
  • ディスク
• Linux Kernel のバージョン
  • uname -a の出力
• OS の種類、バージョン
  • Ubuntu と Red Hat Enterprise Linux のどちらを利用しているか
  • 利用している OS のバージョン
  • x86_64 または arm64 のどちらのアーキテクチャを利用しているのか
• Sora のバージョン
  • 2024.2.2 など
• クラスターを利用している場合はクラスターの構成
• Sora の sora.conf 設定ファイル
  • 環境変数による設定上書き機能 を利用している場合は、環境変数で上書きしている設定内容もお送りください
• Sora の log ディレクトリ以下すべてのログファイル
  • クラスターを利用している場合は全ノードのログ
  • tar.gz または zip などで圧縮し、パッケージ提供時にお送りしているログアップローダーを利用してお送りください
  • 評価中の場合は tar.gz または zip などで圧縮し、メールにてお送り下さい
  • 問題発生時の前後 1 週間分をめどにお送りください

録画関連の問い合わせについて¶

録画については以下の点をご注意ください

概要¶

Sora 2023.1.0 より、サポートの提供期間を変更しています。

変更内容¶

これまでは Sora の最新バージョンの利用に対してのみサポートを提供していましたが、Sora 2023.1.0 以降はサポートの提供期間をより長く変更します。 また、合わせて Sora のアップデートを以下のとおりに区別します。

サポートライフサイクル例¶

対応 OS のサポートライフサイクル¶

WebRTC 全般¶

シグナリング¶

認証¶

通知¶

HTTP API¶

RPC¶

録画¶

TURN¶

ウェブフック¶

DataChannel¶

制限¶

クラスター機能¶

その他¶

性能¶

運用¶

$ sysctl -n net.ipv4.ip_local_port_range
32768 60999

ブラウザで WebRTC の詳細情報を取得することはできますか？¶

できます。

• Chrome であれば URL に chrome://webrtc-internals を入力してみてください
• Firefox であれば URL に about:webrtc を入力してみてください
• Edge であれば URL に edge://webrtc-internals を入力してみてください
• Safari であれば JavaScript コンソールの設定の一般から WebRTC を設定できます

SDK¶

Sora の SDK は基本的にシグナリング処理のための SDK です。 WebRTC 部分は webrtc.org が提供しているライブラリを利用しています。

ライセンス¶

アップデート¶

YYYY.MAJOR.FIX

サポート¶

突然切断された¶

Intel GPU を利用した端末で VP9 で配信または視聴した際に視聴している映像が乱れる¶

Windows で Intel の GPU (内蔵 GPU を含みます) を利用している場合に、VP9 のハードウェアアクセラレーターが正常に動作しないことがあります。

この問題は Intel 特有のチップセットでのみ発生することが確認されています。これは Chrome または Intel のドライバーの不具合である可能性が高いため、 Sora 側の対応で解決することはできません。そのため、他のコーデックを利用する事で回避してください。

ただし Chrome 側で VP9 のハードウェアアクセレーターの利用を停止することで回避することもできます。

有効(デフォルト)¶

ハードウェアアクセラレーターが 有効 になっている状態です。

chrome://gpu にてハードウェアアクセラレーターが有効になっているか確認できます。 Video Decode: Hardware accelerated と Video Encode: Hardware accelerated のように表示されていればハードウェアアクセレーターが有効になっています。

停止中¶

ハードウェアアクアクセラレーターが 停止中 になっている状態です。

停止中 に設定変更した場合 chrome://gpu にてハードウェアアクセラレーターが停止しているかを確認することができます。

Video Decode: Software only. Hardware acceleration disabled と Video Encode: Software only. Hardware acceleration disabled のように表示されていればハードウェアアクセラレーターが停止しています。

この状態では libvpx を利用したソフトウェアエンコード/デコードが利用されます。

概要¶

Sora 以外の要因で発生している問題に対するワークアラウンドを提供しています。

Safari タイムスタンプバグに対するワークアラウンド¶

Safari の問題により、 2025 年 8 月 1 日 時点で Safari 18.4-18.5 において、 H.264 または H.265 の録画が正常に行えない問題が発生することに対するワークアラウンド機能です。

この問題は macOS / iOS / iPadOS 全てのプラットフォームで発生することを確認しています。

また、iOS 版 Chrome や Firefox でも同様の問題が発生することを確認しています。

弊社ではこの問題が確認できているバージョンの Safari は以下になります。

• Safari 18.4
• Safari 18.4.1
• Safari 18.5

workaround_20250515 = 18.4,18.4.1,18.5

概要¶

Sora DevTools は時雨堂が開発し Apache-2.0 ライセンスとしてオープンソースで GitHub に公開している Sora の開発者向けのツールです。

Sora DevTools は、Sora の機能を試したり、アプリケーションの開発中に機能を確認したり、Sora で何か問題が発生した場合に再現を行うために利用できます。

Sora DevTools はオンライン版とオフライン版の 2 種類があります。

オンライン版はブラウザから直接アクセスして利用できます。

オフライン版は閉鎖ネットワーク環境下などで、オンライン版にアクセスできない場合に、 ローカルに NGINX でホスティングして利用できます。

Sora DevTools オンライン版を利用する¶

Sora DevTools のオンライン版は、 https://sora-devtools.shiguredo.app へアクセスし、 signalingUrlCandidates に Sora のシグナリング URL を指定することで利用できます。

Sora DevTools オンライン版を NGINX でリバースプロキシして利用する¶

NGINX の location / ディレクティブで https://sora-devtools.shiguredo.app へリバースプロキシしてください。

location / {
    proxy_http_version 1.1;
    proxy_pass https://sora-devtools.shiguredo.app;
    proxy_set_header Host sora-devtools.shiguredo.app;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

    proxy_ssl_server_name on;
    proxy_ssl_name sora-devtools.shiguredo.app;
    proxy_ssl_protocols TLSv1.2 TLSv1.3;        
}

Sora DevTools オフライン版を NGINX でホスティングして利用する¶

https://github.com/shiguredo/sora-devtools/releases/latest から sora-devtools-<version>.tar.gz をダウンロードして解凍してください。

解凍したディレクトリを NGINX の root ディレクティブに指定してください。

location / {
    root /path/to/sora-devtools-<version>;
    index index.html;
    try_files $uri $uri/ /index.html;
}

Sora DevTools オフライン版を Python3 でホスティングして利用する¶

ローカルで簡単に動かしたい場合はこの方法がおすすめです。

https://github.com/shiguredo/sora-devtools/releases/latest から sora-devtools-<version>.tar.gz をダウンロードして解凍してください。

cd /path/to/sora-devtools-<version>
python3 -m http.server 8000

ブラウザから http://localhost:8000 にアクセスすることで利用できます。 signalingUrlCandidates に Sora のシグナリング URL を指定することで利用できます。

サポート¶

• Sora DevTools の正式版については、 Sora のサポート対象です
• Sora DevTools の開発版については、 Sora のサポート対象外です

概要¶

このチュートリアルでは、Sora に組み込まれている開発ツールを動かして、ひととおり使ってみるところまでを説明します。

チュートリアルの注意点¶

• このチュートリアルでは、リバースプロキシとしての NGINX や HTTPS の知識を必要とします
• Sora は TCP と UDP の両方を利用します
  • TCP はデフォルトであれば 3000 番と 5000 番を利用します
  • UDP はデフォルトであればエフェメラルポートの範囲を利用します
• Sora のシグナリングは WebSocket over TLS 非対応のため、nginx をリバースプロキシとして利用して、 TLS 終端を行い Sora のシグナリングへ繋ぐ必要があります

Sora の展開¶

tar.gz で圧縮されていますので、展開して下さい。

$ tar xfz sora-<version>-<os>-<arch>.tar.gz

ライセンスファイルの配置¶

ライセンスファイルを etc/ において、cp コマンドを利用して license.json に変更して下さい。

起動¶

設定が終わったらサーバーを起動します。

$ sora-<version>/bin/sora daemon

$ sora-<version>/bin/sora stop

シグナリングへの HTTPS の適用¶

HTTPS (WebSocket over TLS を含む) の適用は必ず行ってください。HTTPS への接続以外はサポート対象外となります

ブラウザで WebRTC の機能の一つである getUserMedia を利用する場合は HTTPS が必須となります。 ただし、Sora 自体は HTTPS 非対応のため、Sora の前段にリバースプロキシとして NGINX を設置して TLS 終端を行ってください。

NGINX の location ディレクティブの設定については nginx を参考にして設定をお願いします。

証明書については Let's Encrypt - Free SSL/TLS Certificates の利用をおすすめします。

リバースプロキシとしての NGINX の役割:

// 開発者ツールの静的ファイルの場合
クライアント -> <HTTPS:443> -> NGINX -> <HTTP:5000> -> Sora

// シグナリングの場合
クライアント -> <WebSocket over TLS:443> -> NGINX -> <WebSocket:5000> -> Sora

開発者ツールを利用してみる¶

Sora では開発ツールを利用して、Sora の機能を試すことができます。まずはオンライン版の利用をお勧めします。

オンライン版を利用する¶

オンライン版の開発ツールは https://sora-devtools.shiguredo.app から利用することができます。 Sora のシグナリング URL を指定する必要があります。

Sora のシグナリング URL を signalingUrlCandidates に指定してください。

シグナリング URL は wss://sora.example.com/signaling のように wss:// で始まる WebSocket over TLS の URL を指定してください。

location / {
  proxy_http_version 1.1;
  proxy_pass https://sora-devtools.shiguredo.app;
  proxy_set_header Host sora-devtools.shiguredo.app;
  proxy_set_header X-Real-IP $remote_addr;
  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  proxy_set_header X-Forwarded-Proto $scheme;

  proxy_ssl_server_name on;
  proxy_ssl_name sora-devtools.shiguredo.app;
  proxy_ssl_protocols TLSv1.2 TLSv1.3;        
}

location / {
  root /path/to/sora-devtools-<version>;
  index index.html;
  try_files $uri $uri/ /index.html;
}

動作確認¶

ビデオ会議システムなどで利用されるような双方向での配信機能です。 受信だけ、送信だけでの利用もできます。

connect を押して、その後、別のブラウザやタブで同じ URL を開いて、 connect を押して下さい。

追加でタブを開いて connect していけば参加者を増やせます。

開発ツールでは気軽にいろいろな設定を試せるようになっています。触ってみてください。

次のステップ¶

本番稼働に向けて で Sora の本番稼働向けの設定を行ってください。

Sora はいろいろな機能を持っていますので、一通りドキュメントをご確認下さい。 ドキュメントで不明な点がありましたら、お気軽にお問い合わせください。

トラブルシューティング¶

## https://sora-doc.shiguredo.jp/SORA_CONF#sora-conf-ipv4-address
ipv4_address = 192.0.2.10

優先順位¶

Sora で外部から指定する値には優先順位があります。

上から順に優先度が高く、同じ優先度の場合は後から指定した値が優先されます。

1. セッション生成時の払い出しで指定した値
2. 認証成功時の払い出しで指定した値
3. シグナリング接続時に指定した値
4. sora.conf で設定した値

• sora.conf で設定した値は、シグナリング接続時の値で上書きできます
• シグナリング接続時の値は、認証成功時の払い出しで上書きできます
• 認証成功時の払い出しは、セッション生成時の払い出しで上書きできます

本番環境ではシグナリング接続時の値を利用するのは避けて、 認証成功時やセッション生成時の値を利用するようにしてください。

IPv4 アドレスの固定¶

sora.conf の ipv4_address にサーバーの IP アドレスを指定してください。

ipv4_address = 192.0.2.10

IPv6 アドレスの利用について¶

Safari は IPv6 環境での動作が不安定なため、 Safari をターゲットデバイスに含んでいる場合は sora.conf の IPv6 設定を無効にする ipv6 = false を推奨しています。

ファイアーウォールを利用される場合は IPv6 向け設定もご確認ください。

sora.conf の turn_fqdn を設定する¶

iOS の場合は TURN は FQDN を利用しないと接続ができない場合があるため、 TURN-UDP / TURN-TCP で利用するドメインを指定してください。

sora.conf の ipv4_address に指定した IP アドレスを設定してある FQDN を指定してください。

turn_fqdn = sora-turn.example.com

ウェブフックなどで利用する CA 証明書のインストール¶

もしウェブフックなどで HTTPS サーバへのアクセスを行う場合に、 自前で CA 証明書を設定しない場合、信頼された CA 証明書のインストールを行ってください。

• Ubuntu は apt install ca-certificates でインストールされる証明書を利用します
• RHEL (または CentOS) は dnf install ca-certificates でインストールされる証明書を利用します

HTTP API のループバックアドレスからのみのアクセス¶

Sora の HTTP API は TLS を利用したセキュアな通信機能や認証機能を持ち合わせていません。

そのため、本番環境では sora.conf の api_loopback_address_only の値を true にしてください。 こうすることでループバックアドレスからのみ HTTP API が叩けるようになります。

アプリケーションからの HTTP API へのアクセスは Nginx などのリバースプロキシ経由で利用してください。

シグナリングのループバックアドレスからのみのアクセス¶

Sora の WebSocket は TLS を利用したセキュアな通信機能を持ち合わせていません。

そのため、本番環境では sora.conf の signaling_loopback_address_only の値を true にしてください。 こうすることでループバックアドレスからのみシグナリングが叩けるようになります。

WebRTC クライアントからシグナリングへのアクセスは Nginx などのリバースプロキシ経由で利用してください。

ファイルディスクリプタ数の設定¶

Sora は 1 接続で少なくとも 2 つ以上のファイルディスクリプタを利用します。 また、ウェブフックやログの書き込みでも追加でファイルディスクリプタを利用します。 同時接続数が 100 の場合は Linux のデフォルト値である 1024 でも足りるとは思いますが、 ある程度大きめのファイルディスクリプタ数に変更してください。

systemd の適用¶

Sora の起動/停止に bin/sora daemon を利用するのではなく systemd を適用してください。

デーモン化せずに Sora を動かすには bin/sora foreground を利用します。

詳細は systemd をご確認ください。

TURN-TLS、TURN-TCP、シグナリングで 443 番ポートを使用する¶

この設定はある程度の NGINX や証明書の知識が必要になります

NGINX のバージョンは 1.11.5 以降が必須です。

TURN-TLS、TURN-TCP、シグナリング（HTTPS）を 443 番ポートのみで受信する場合は次の設定を追加してください。

stream {
    # SNI のサーバー名が取得できない場合、または、該当するサーバー名が指定されていない場合は TURN-TCP へ
    # 該当するサーバー名が指定されている場合は TURN-TLS または シグナリングへ
    map $ssl_preread_server_name $upstream {
        default sora-turn.example.com;
        "sora-turn.example.com" unix:/tmp/tls.sock;
        "sora.example.com" unix:/tmp/https.sock;
    }

    # Sora の TURN-TCP へ転送
    upstream sora-turn.example.com {
        # Sora の TURN-TCP へ
        # ここの IP アドレスは Sora の ipv4_address に指定した値を指定してください
        # ここを 127.0.0.1 にすると Firefox で繋がらなくなることを確認しています
        server 192.0.2.1:3478;
    }


    # TURN-TCP, TURN-TLS, シグナリングを TCP で待ち受け
    server {
        listen 443;
        # IPv6 を利用している場合は下記を有効にしてください
        # listen [::]:443;

        proxy_pass $upstream;
        proxy_protocol on;

        ssl_preread on;
    }

    # TURN-TLS, シグナリングの TLS 終端し TURN-TCP へ転送
    server {
        listen unix:/tmp/tls.sock ssl proxy_protocol;

        # SNI を見て TURN-TLS の場合は TURN-TCP へ転送
        # シグナリング（HTTPS）の場合は HTTP へ転送
        proxy_pass $ssl_server_name;
        proxy_protocol on;

        ssl_certificate /etc/letsencrypt/live/sora.example.com/fullchain.pem;
        ssl_certificate_key /etc/letsencrypt/live/sora.example.com/privkey.pem;

        ssl_protocols TLSv1.2;
        ssl_prefer_server_ciphers on;

        ssl_handshake_timeout 10s;

        ssl_session_cache off;
        ssl_session_tickets off;
    }
}

http {
    include mime.types;
    default_type application/octet-stream;
    sendfile on;
    keepalive_timeout 65;
    gzip on;

    # $proxy_protocol_addr を利用することでクライアントの IP が保持できるようになる
    log_format proxy '$proxy_protocol_addr - $remote_user [$time_local] '
                        '"$request" $status $body_bytes_sent '
                        '"$http_referer" "$http_user_agent"';

    # 定義した proxy を利用する
    access_log /var/log/nginx/access.log proxy;

    server {
        listen unix:/tmp/https.sock ssl proxy_protocol;

        root /var/www/html;

        index index.html index.htm;

        ssl_certificate /etc/letsencrypt/live/sora.example.com/fullchain.pem;
        ssl_certificate_key /etc/letsencrypt/live/sora.example.com/privkey.pem;

        ssl_protocols TLSv1.2;

        ssl_prefer_server_ciphers on;

        ssl_session_cache off;
        ssl_session_tickets off;

        real_ip_header proxy_protocol;

        server_name sora.example.com;

        # シグナリングを Sora に Proxy します
        location = /signaling {
                proxy_http_version 1.1;
                proxy_set_header Upgrade $http_upgrade;
                proxy_set_header Connection "upgrade";
                proxy_pass http://127.0.0.1:5000/signaling;

                proxy_set_header X-Real-IP       $proxy_protocol_addr;
                proxy_set_header X-Forwarded-For $proxy_protocol_addr;
        }

        # Sora の HTTP API に Proxy します
        # 本番環境では認証などの機能を利用してください
        location /api {
                proxy_http_version 1.1;
                proxy_pass http://127.0.0.1:3000/;
        }

        # OBS (WHIP/WHEP) 向けのシグナリングを Sora に Proxy します
        location ~ ^/(whip|whip-session|whep|whep-session)/ {
                proxy_pass http://127.0.0.1:5000;
                proxy_set_header Host $host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header Authorization $http_authorization;
        }

        # Sora のヘルスチェックに Proxy します
        # 公開するかどうかは検討してください
        location /.ok {
                proxy_http_version 1.1;
                proxy_pass http://127.0.0.1:5000;
        }
    }
}

## TURN 機能を有効にするかどうかを指定してください
turn = true

## TURN 機能で利用するレルムを指定してください
turn_realm = sora-turn.example.com

## TURN 機能で TURN URL 払い出し機能で利用する FQDN (最後の . なし)を指定してください
turn_fqdn = sora-turn.example.com

## TURN 機能で TURN-TCP を有効にするかどうかを指定してください
turn_tcp = true

## TURN 機能で TURN-TCP を有効にした際に利用するポート番号を指定してください
turn_tcp_listen_port = 3478

## TURN 機能で TURN-TCP URL 払い出し時のポート番号を指定してください
turn_tcp_port = 443

## TURN 機能で TURN-TLS URL 払い出し機能を有効にするかどうかを指定してください
## オプションでデフォルトは false です
turn_tls = true

## TURN 機能で TURN-TLS URL 払い出し機能で利用する FQDN (最後の . なし)を指定してください
## turn_tls_fqdn は turn_fqdn の値を上書きします
turn_tls_fqdn = sora-turn.example.com

## TURN 機能で TURN-TLS URL 払い出し機能を有効にした際に利用するポート番号を指定してください
turn_tls_port = 443

$ sudo vim  /lib/systemd/system/nginx.service

# Stop dance for nginx
# =======================
#
# ExecStop sends SIGSTOP (graceful stop) to the nginx process.
# If, after 5s (--retry QUIT/5) nginx is still running, systemd takes control
# and sends SIGTERM (fast shutdown) to the main process.
# After another 5s (TimeoutStopSec=5), and if nginx is alive, systemd sends
# SIGKILL to all the remaining processes in the process group (KillMode=mixed).
#
# nginx signals reference doc:
# http://nginx.org/en/docs/control.html
#
[Unit]
Description=A high performance web server and a reverse proxy server
Documentation=man:nginx(8)
After=network.target

[Service]
Type=forking
PIDFile=/run/nginx.pid
# 起動前に /tmp/tls.sock を削除する設定を追加
ExecStartPre=/bin/rm -f /tmp/tls.sock
# 起動前に /tmp/https.sock を削除する設定を追加
ExecStartPre=/bin/rm -f /tmp/https.sock   
ExecStartPre=/usr/sbin/nginx -t -q -g 'daemon on; master_process on;'
ExecStart=/usr/sbin/nginx -g 'daemon on; master_process on;'
ExecReload=/usr/sbin/nginx -g 'daemon on; master_process on;' -s reload
# 変更前の設定
# ExecStop=-/sbin/start-stop-daemon --quiet --stop --retry QUIT/5 --pidfile /run/nginx.pid
# 変更後の設定
ExecStop=-/sbin/start-stop-daemon --quiet --stop --signal TERM --pidfile /run/nginx.pid
TimeoutStopSec=5
KillMode=mixed

[Install]
 WantedBy=multi-user.target  

$ sudo systemctl daemon-reload
$ sudo systemctl restart nginx

カーネルパラメーターの適用¶

Sora は UDP を利用します。音声や映像の配信では大量の UDP を処理するため Linux のデフォルトの設定だと厳しい場合があります。

そのため、パラメーターの変更を推奨しています。

詳細は Linux カーネルチューニング をご確認ください。

コンテナ環境での利用する場合¶

$ grep processor /proc/cpuinfo | wc -l

SDK の利用¶

Sora へ接続をする場合は弊社がオープンソースとして公開している SDK を利用してください。

• https://github.com/shiguredo/sora-js-sdk
• https://github.com/shiguredo/sora-ios-sdk
• https://github.com/shiguredo/sora-android-sdk
• https://github.com/shiguredo/sora-unity-sdk
• https://github.com/shiguredo/sora-cpp-sdk
• https://github.com/shiguredo/sora-python-sdk
• https://github.com/shiguredo/sora-c-sdk

これらのライブラリは弊社によって最新版の Sora で動作するようにメンテナンスされています。

導入もとても簡単になっているので、是非利用してください。

https://discord.gg/shiguredo

SDK の質問や相談については sora-sdk-faq を利用してください。

• Sora JavaScript SDK
  • 投稿時に sora-js-sdk タグを指定してください
• Sora iOS SDK
  • 投稿時に sora-ios-sdk タグを指定してください
• Sora Android SDK
  • 投稿時に sora-android-sdk タグを指定してください
• Sora Unity SDK
  • 投稿時に sora-unity-sdk タグを指定してください
• Sora C++ SDK
  • 投稿時に sora-cpp-sdk タグを指定してください
• Sora Python SDK
  • 投稿時に sora-python-sdk タグを指定してください
• Sora C SDK
  • 投稿時に sora-c-sdk タグを指定してください

やりたいことが 1:1 の双方向配信の場合¶

配信が 1:1 の双方向の場合はマルチストリーム機能を利用してください。

詳細は マルチストリーム機能 をご確認ください。

やりたいことが複数人での双方向配信の場合¶

複数人で双方向の配信を行いたい場合はスポットライト機能を検討してください。

スポットライト機能を利用することで、クライアントとサーバー側の負荷をかなり抑えられるようになります。

詳細は スポットライト機能 をご確認ください。

やりたいことが 1:多 の双方向配信の場合¶

配信が 1:多 の片方向の場合でもマルチストリーム機能を利用してください。

role に sendonly と recvonly を利用してください。

詳細は マルチストリーム機能 をご確認ください。

やりたいことが 1:多 の片方向配信で、大規模の場合¶

配信が 1:多 の片方向で大規模な場合は、クラスターリレー機能を利用してください。

クラスターリレー機能を利用することで、1 チャネルで大規模な配信を行うことができます。

詳細は リレー機能 をご確認ください。

やりたいことが OBS からの配信の場合¶

OBS からの配信を行いたい場合は OBS (WHIP) 対応機能を利用してください。

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

やりたいことが OBS での取り込みの場合¶

OBS へ取り込みを行いたい場合は OBS (WHEP) 対応機能を利用してください。

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

Edge が機能要件に含まれている場合¶

最新の Edge であれば、ほとんど Chrome と同じ動きをしますので安心してお使いください。

Firefox が機能要件に含まれている場合¶

Firefox の WebRTC 実装はかなり中途半端なため、 できるだけ Firefox は機能要件から外すことをお勧めします。

認証を外部の指定した HTTP サーバーで判断したい場合¶

認証ウェブフック機能を利用してください。この機能は外部の指定した HTTP サーバーで認証を判断できるようになります。

外部の HTTP サーバーの URL 指定は sora.conf の auth_webhook_url に設定してください。

そうすることで、外部に認証を移譲できます。

詳細は 認証ウェブフック をご確認ください。

接続、切断の検知を外部の指定した HTTP サーバーで利用したい場合¶

イベントウェブフック機能を利用してください。この機能は外部の指定した HTTP サーバーでクライアント単位での接続、切断を検知できるようになります。

外部の HTTP サーバーの URL 指定は sora.conf の event_webhook_url に設定してください。

そうすることで、外部にイベントをリクエスト送信できます。

詳細は イベントウェブフック をご確認ください。

配信されている音声や映像を記録したい場合¶

Sora には録画機能があります。もし利用を検討されている場合はいくつか注意事項があります。

• 録画を終了させる、またはクライアントが切断するまで、録画ファイルは生成されない
• 複数人数が参加する会議の録画ファイルはクライアントごとに生成される
  • 5 人が会議に参加していれば 5 個ファイルが生成されます

これらを踏まえて録画機能の利用を検討してください。

録画機能の詳細は 録画機能 をご確認ください。

クライアント側で参加してきたユーザーの情報を通知したい場合¶

Sora では「〜さんが会議に参加しました」や「〜さんが会議から退席しました」というメッセージをクライアント側で流すことができます。

これにはシグナリング通知を利用します。

シグナリング通知機能はシグナリングで利用している WebSocket もしくは DataChannel を経由して、 参加しているチャネルに新しく参加、または退席した状態を通知する機能です。自分が参加したときも自身に参加通知は飛びます。

ただシグナリング通知に含まれる標準の情報はあくまでコネクション ID のみになるため、 そのコネクション ID が誰なのかはどこからか取得する必要があります。

そのコネクション ID が誰なのかを問い合わせる処理が毎回走ってしまうのは無駄なため、 認証ウェブフックの戻り値で、 signaling_notify_metadata （シグナリング通知メタデータ）にそのコネクション ID の値のユーザー名を含めてください。 そうすることで、Sora がその参加者のユーザー名を signaling_notify_metadata に含めて返すようになります。

この signaling_notify_metadata は新しく参加した人には data として、 既存の参加している人の signaling_notify_metadata が含まれたリストが参加時に通知されるようになっています。

さらに、新しく参加者がいた場合はその参加者の metadata が通知されます。もちろん退席者の場合でもその退席者の metadata が含まれて通知されます。

metadata にユーザー名が含まれるため、サーバーへ問い合わせをしなくても参加者や退席者のユーザー名を取得できます。

シグナリング通知の詳細は シグナリング通知 をご確認ください。

シグナリング通知メタデータの詳細は シグナリング通知メタデータ をご確認ください。

ライセンスファイルのパス設定と配置¶

ライセンスファイルのパスは sora.conf の license_file で設定できます。 Sora を起動する前に設定し、ライセンスファイルを配置してください。

デフォルト設定のまま使う場合は、ライセンスファイルを sora ディレクトリ以下の etc/license.json にコピーしてください。

$ cp 123ABC-SRA-E001-202301-100.json sora/etc/license.json

ライセンスの更新¶

ライセンスを更新する場合は sora.conf の license_file で指定しているファイルを cp コマンドで上書きしてください。 デフォルト設定では sora ディレクトリ以下にある etc/license.json です。

$ cp 123ABC-SRA-E002-201901-100.json sora/etc/license.json

その後、ライセンス更新 API である UpdateLicense API を実行することで更新されます。 Sora の再起動は不要です。

192.0.2.1 の部分には実際に利用している IP アドレスかドメインを指定してください

$ http POST 192.0.2.1:3000/ x-sora-target:Sora_20171218.UpdateLicense -vvv

正常に反映されているかを GetLicense API を実行して serial_code を確認してください。

$ http POST 192.0.2.1:3000/ x-sora-target:Sora_20171218.GetLicense -vvv

同時接続数制限を超えて接続しようとした場合¶

ライセンスファイルには最大同時接続数が定義してあり、その最大同時接続数を超えて接続することはできません。

ライセンス期限が過ぎている場合¶

ライセンスファイルのパスの更新¶

ライセンスファイルのパスの更新は、一度 Sora を停止し、 sora.conf の license_file のパスを変更して Sora を起動する必要があります。

最大ノード数ライセンス¶

2022 年 6 月から 最大ノード数ライセンス という形式のライセンスを提供しています。

通常の Sora のライセンスは Sora 1 起動 1 ライセンスと固定されており、 同一のライセンスを複数の Sora で利用することはできません。

最大ノード数ライセンス は、クラスター構築時に、あらかじめライセンスに定義されている最大ノード数までは同一のライセンスを利用できます。

最大ノード数に対応したライセンスファイルの中身の例

{
  "expired_at": "2013-03",
  "max_connections": 100,
  "max_nodes": 3,
  "product_name": "Sora",
  "serial_code": "DOC123-SRA-E002-201303-N3-100",
  "signature": "****",
  "type": "Experimental"
}

ファイルの中身に "max_nodes": 3 と書かれているライセンスでは、クラスターを組む際に最大 3 ノードまで同一のライセンスが利用できます。

最大ノード数ライセンス について不明な部分がある場合はサポートにお問い合わせください。

ライセンスエラー時の動作確認用ライセンスの提供について¶

ライセンス期限が過ぎたり、最大同時接続数を超過した際の動作確認を行うためのライセンスを提供しています。 動作確認用ライセンスが必要なお客様はサポートまでご連絡ください。

ライセンスエラー時の動作確認用ライセンスはクラスターでも確認できるよう、最大ノード数ライセンスでの提供となります。 最大ノード数ライセンスはクラスターを利用しない場合は通常のライセンスと同じように利用できます。

単位指定¶

sora.conf では一部の設定に単位の指定が必須です。

• 利用できる単位
  • ミリ秒 ms
  • 秒 s
  • 分 min
  • 時 h
• 数値と単位の間にはスペースを入れてください

webhook_response_timeout = 30 s

範囲表記¶

• 2..10 と書いてある場合 2 以上、10 以下の値を指定できることを表しています
• 2..10 s と書いてある場合は 2 秒以上、10 秒以下の値を指定できることを表しています

環境変数による設定上書き機能¶

Sora の設定ファイル sora.conf の設定は環境変数で上書きすることができます。

SORA_ に続けて設定項目名を大文字にし、アンダースコア _ に置き換えた名前を環境変数として指定することで、設定を上書きできます。

例えば sora.conf の api_port を環境変数で上書きする場合は、以下のように指定します。

export SORA_API_PORT=18000

connection_created_wait_timeout のように値に単位が含まれる設定項目も同様に指定できます。 sora.conf と同様に値の後ろにスペースを入れて指定してください。

export SORA_CONNECTION_CREATED_WAIT_TIMEOUT="60 s"

api_cors_origin¶

デフォルト:

指定なし

API の戻りのヘッダーに CORS (Cross-Origin Resource Sharing) を含める際のドメインを指定してください。 http から始めて、パスの / は含まないでください。

api_cors_origin = http://127.0.0.1:5000

api_loopback_address_only¶

デフォルト:

false

API へのアクセスをループバックアドレスからのみに制限します。できる限り有効にしてください。

api_loopback_address_only = true

api_port¶

デフォルト:

3000

API に使用するポート番号を指定してください。

api_port = 3000

archive_dir¶

デフォルト:

archive

録画ファイルが保存されるディレクトリを指定してください。できる限り 絶対パス で指定してください。

archive_dir = /path/to/archive

archive_tmp_dir¶

デフォルト:

tmp/archive

録画に使用する一時ファイルを保存するディレクトリを指定してください。できる限り 絶対パス で指定してください。

archive_tmp_dir = /path/to/tmp/archive

audio_red¶

デフォルト:

false

音声冗長化を有効にするかどうかを指定してください。デフォルトでは無効になっています。

現時点では Chrome M95 以降で使用できます。非対応ブラウザが混在していても利用できます。

audio_red = true

audio_streaming_header¶

デフォルト:

false

音声ストリーミングヘッダーを有効にするかどうかを指定してください。

audio_streaming_header = true

audio_streaming_max_retries¶

デフォルト:

0

音声ストリーミングゲートウェイへの接続が失敗した場合の最大リトライ回数を指定してください。

リトライが発生するのは、 この値と audio_streaming_retry_interval が 0 以外が指定されており、 音声ストリーミングゲートウェイへの接続確立が失敗、または音声ストリーミングゲートウェイが 5xx 系でエラーを返した場合です。

audio_streaming_max_retries = 3

audio_streaming_retry_interval¶

デフォルト:

5 s

音声ストリーミングゲートウェイへの接続が失敗した場合のリトライ間隔を指定してください。

audio_streaming_retry_interval = 10 s

audio_streaming_tls_fullchain_file¶

デフォルト:

指定なし

音声ストリーミングゲートウェイとの通信に HTTPS で mTLS を利用するための設定で、 中間証明書を含むクライアント証明書を PEM 形式で設定してください。

audio_streaming_tls_fullchain_file = /path/to/fullchain.pem

audio_streaming_tls_privkey_file¶

デフォルト:

指定なし

音声ストリーミングゲートウェイとの通信に HTTPS で mTLS を利用するための設定で、 クライアント証明書の秘密鍵を PEM 形式で設定してください。

audio_streaming_tls_privkey_file = /path/to/privkey.pem

audio_streaming_tls_verify_cacert_file¶

デフォルト:

指定なし

音声ストリーミングゲートウェイとの通信に HTTPS を利用した際、サーバー証明書のチェックを行う CA ファイルを PEM 形式で設定してください。

audio_streaming_tls_verify_cacert_file = /path/to/server_cacert.pem

audio_streaming_url¶

デフォルト:

指定なし

音声ストリーミングゲートウェイの URL を指定してください。 http を指定した場合は HTTP/2 (h2c) で送られます。 https の場合は HTTP/2 (h2) で送られます。

音声ストリーミングゲートウェイは HTTP/2 に対応している必要があります。

audio_streaming_url = http://192.0.2.10:48080/speech

audio_streaming_url = https://suzu.example.com/speech

auth_webhook_log¶

デフォルト:

true

認証ウェブフックをすべてログファイルに出力します。詳細は 認証ウェブフックログ をご確認ください。

auth_webhook_log = true

auth_webhook_recording¶

デフォルト:

false

認証ウェブフックの戻り値で録画を開始できるかどうかを指定してください。

auth_webhook_recording = true

auth_webhook_url¶

デフォルト:

指定なし

認証機能を有効にしたときに、問い合わせに行く HTTP URL を指定してください。その戻り値に含まれる値によって認証の可否を判定します。

auth_webhook_url = https://example.com/sora/webhook/auth

cluster¶

デフォルト:

false

クラスター機能を利用するかどうかを指定してください。

cluster = true

cluster_affinity_threshold¶

デフォルト:

10

範囲:

1..10000

クラスターのリレー機能とアフィニティ機能が有効な場合、 別ノードにセッションを作成するノード単位の同一セッションに対する同時接続数の基準値を指定してください。

cluster_affinity_threshold = 50

cluster_listen_max_port¶

デフォルト:

49020

sora.conf にクラスター利用時のノード間通信に使用するポート番号範囲の最大値を指定してください。

cluster_listen_max_port = 49020

cluster_listen_min_port¶

デフォルト:

49010

sora.conf にクラスター利用時のノード間通信に使用するポート番号範囲の最小値を指定してください。

cluster_listen_min_port = 49010

cluster_relay¶

デフォルト:

true

クラスターリレー機能を利用するかどうかを指定してください。

cluster_relay = true

cluster_temporary_node¶

デフォルト:

false

テンポラリーノードとして利用するかどうかを指定してください。

cluster_temporary_node = true

connection_created_wait_timeout¶

単位指定必須

デフォルト:

30 s

範囲:

0..600 s

WebRTC SFU と WebRTC の接続が確立するまでの許容時間を指定してください。 基本的に WebRTC SFU との接続確立は数百ミリ秒で終わります。

ただし iOS などでカメラの使用などを許可するといった設定が入る場合を考慮しデフォルトは 30 秒としています。

connection_created_wait_timeout = 30 s

connection_updated_webhook_interval¶

デフォルト:

1 min

範囲:

1..10 min

単位:

min のみ

接続更新時のイベントウェブフック connection.updated の間隔を指定してください。 時間単位には 分 min のみ指定できます。

connection_updated_webhook_interval = 1 min

copy_websocket_signaling_header_names¶

デフォルト:

未指定

ウェブフックやログにコピーしたい WebSocket シグナリングの HTTP ヘッダー名を指定してください。 ヘッダー名は複数指定することができます。ヘッダー名はカンマ区切りで指定してください。

ウェブフックの場合は HTTP ヘッダー にコピーされます。ログの場合は copy_headers 項目にコピーされます。

copy_websocket_signaling_header_names = X-Forwarded-For, X-Real-IP, Tracestate

data_channel_messaging¶

デフォルト:

false

DataChannel を使用したメッセージング機能を利用するかどうかを指定してください。

data_channel_messaging = false

data_channel_messaging_only¶

デフォルト:

false

DataChannel メッセージングの利用時に、音声と映像を false にした場合でも接続できるようにするかどうかを指定してください。

data_channel_messaging_only = false

data_channel_packet_loss_simulator_incoming¶

デフォルト:

0

範囲:

0..100

Sora が受信する DataChannel パケットを指定したパーセント分ドロップさせます。

値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。

data_channel_packet_loss_simulator_incoming = 10

data_channel_packet_loss_simulator_outgoing¶

デフォルト:

0

範囲:

0..100

Sora が送信する DataChannel パケットを指定したパーセント分ドロップさせます。

値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。

data_channel_packet_loss_simulator_outgoing = 10

data_channel_rpc¶

デフォルト:

true

DataChannel を使用した RPC 機能を利用するかどうかを指定してください。

この機能を利用する場合は必ず認証成功時に rpc_methods の払い出し で利用できる RPC メソッド名一覧を払い出す必要があります。

data_channel_rpc = true

data_channel_signaling_close_message¶

デフォルト:

false

Sora から DataChannel シグナリングを切断する際に "type": "close" メッセージを送信するかどうかを指定してください。

data_channel_signaling_close_message = true

data_channel_stats_max_retransmits¶

デフォルト:

指定なし

範囲:

0..8

シグナリング経路を DataChannel に切り替えた際にクライアントが統計情報を送信するときのメッセージの再送回数を指定してください。

data_channel_stats_max_retransmits = 1

data_channel_stats_timer_interval¶

単位指定必須

デフォルト:

60 s

範囲:

5..600 s

シグナリング経路を DataChannel に切り替えた際にクライアントへの統計情報を要求する間隔を指定してください。

data_channel_stats_timer_interval = 60 s

data_dir¶

デフォルト:

data

Sora 内部で利用する情報を書き出すディレクトリを指定してください。できる限り 絶対パス で指定してください。

data_dir = /path/to/data

default_audio_bit_rate¶

設定しないことをおすすめします

単位:

k(キロ)bps

範囲:

6..510

デフォルト:

指定なし

音声が使用できるビットレートを指定してください。デフォルトの場合はクライアント側の挙動に依存します。

default_audio_bit_rate = 192

default_audio_streaming_language_code¶

デフォルト:

指定なし

音声ストリーミングゲートウェイ接続時に HTTP ヘッダー sora-audio-streaming-language-code にデフォルトで含める文字列を指定してください。

この設定がない場合、接続時に audio_streaming_language_code で文字列が指定されていない場合、 音声ストリーミングが有効になっても Sora は接続の音声ストリーミングを開始しません。

default_audio_streaming_language_code = ja-JP

default_audio_streaming_result_push¶

デフォルト:

true

音声ストリーミングゲートウェイからのレスポンスをシグナリングプッシュ通知で送ることをデフォルトで行うかを指定してください。

default_audio_streaming_result_push = true

default_av1_param_profile¶

デフォルト:

0

範囲:

0..2

AV1 で利用するプロファイルのデフォルト値を指定してください。

default_av1_param_profile = 0

default_cluster_affinity¶

デフォルト:

true

クラスターリレー機能利用時にアフィニティ機能を利用するかどうかのデフォルト値を指定してください。

default_cluster_affinity = true

default_connection_lifetime¶

デフォルト:

未指定

範囲:

0..720 h

デフォルトのコネクションライフタイムを指定してください。デフォルトは未指定です。

default_connection_lifetime = 1 h

default_data_channel_signaling¶

デフォルト:

false

シグナリング経路を WebSocket から DataChannel に切り替えるかどうかを指定してください。

default_data_channel_signaling = false

default_duplicate_client_id¶

デフォルト:

allow

範囲:

allow, evict

クライアント ID の重複による既存コネクションを破棄するかどうかを指定してください。

default_duplicate_client_id = evict

default_forwarding_pli_interval¶

単位指定必須

デフォルト:

10 s

範囲:

1..90 s

RTP 転送 API 利用時に、クライアントに対して PLI を送る間隔を指定してください。

default_forwarding_pli_interval = 10 s

録画機能併用時には、 20 s より大きな値を指定したとしても、録画機能の PLI 送信間隔 20 s が適用されます。

もし default_forwarding_pli_interval に 20 s より小さな値を指定した場合は、 PLI 送信間隔には default_forwarding_pli_interval の値が適用されます。

録画機能の利用を継続し、RTP 転送機能を停止したタイミングで、 録画機能の PLI 送信間隔 20 s が適用されます。

default_h264_param_profile_level_id¶

デフォルト:

42e02a

H.264 で利用するプロファイルレベル ID のデフォルト値を文字列で指定してください。

default_h264_param_profile_level_id = 42e02a

default_h265_param_level_id¶

デフォルト:

93

範囲:

0..255

H.265 で利用するレベル ID のデフォルト値を数値で指定してください。

default_h265_param_level_id = 93

default_ice_connection_state_disconnected_timeout¶

デフォルト:

5 s

範囲:

1..300 s

ICE コネクションステートが checking から disconnected の状態に移行するまでの時間を指定してください。

default_ice_connection_state_disconnected_timeout = 5 s

default_ice_connection_state_failed_timeout¶

デフォルト:

10 s

範囲:

1..300 s

ICE コネクションステートが disconnected から failed の状態に移行するまでの時間を指定してください。

default_ice_connection_state_failed_timeout = 10 s

default_ignore_disconnect_websocket¶

デフォルト:

false

シグナリング経路を DataChannel に切り替えた際に WebSocket が切断されても接続の切断と判断しないかどうかを指定してください。

default_ignore_disconnect_websocket = false

default_playout_delay_max_delay¶

デフォルト:

未指定

単位:

ms のみ

範囲:

0..40950

プレイアウト遅延機能を利用する際の最大値(ミリ秒)を指定してください。

default_playout_delay_min_delay = 0 ms
default_playout_delay_max_delay = 100 ms

default_playout_delay_min_delay¶

デフォルト:

未指定

単位:

ms のみ

範囲:

0..40950

プレイアウト遅延機能を利用する際の最小値(ミリ秒)を指定してください。

default_playout_delay_min_delay = 0 ms
default_playout_delay_max_delay = 100 ms

default_recording_format¶

デフォルト:

mp4

録画ファイルのデフォルトのフォーマットを指定してください。 mp4 と webm が指定できます。

default_recording_format = mp4

default_recording_mp4_pli_interval¶

デフォルト:

20 s

範囲:

1..240 s

録画機能(セッション単位) 利用時に MP4 形式を利用した場合、クライアントへ送るキーフレーム要求 (PLI) の間隔を指定してください。

default_recording_mp4_pli_interval = 100 s

default_rtc_stats¶

デフォルト:

true

Sora から SDK やクライアントへ RTC 統計情報を要求するかどうかを指定してください。 SDK やクライアント側がシグナリングの "type": "stats" に対応している必要があります。

default_rtc_stats = true

default_sdp_setup_role_passive¶

デフォルト:

false

SDP の setup 属性のデフォルト値を passive にするかどうかを指定してください。

default_sdp_setup_role_passive = true

default_simulcast_auto_rids¶

デフォルト:

未指定

サイマルキャスト利用時に、視聴側の環境に合わせて rid を自動で切り替える場合に、利用する rid のリストを指定してください。

未指定の場合は自動で切り替わりません。

default_simulcast_auto_rids = "r0", "r1"

default_simulcast_request_rid¶

デフォルト:

r0

範囲:

auto / r0 / r1 / r2 / none

サイマルキャスト利用時に、視聴する rid を指定せずに接続した場合に採用される rid の値を指定してください。

デフォルトでは r0 になっています。

default_simulcast_request_rid = r2

default_simulcast_rid¶

デフォルト:

r0

範囲:

r0 / r1 / r2

サイマルキャスト利用時に、視聴する rid を指定せずに接続した場合に採用される rid の値を指定してください。

デフォルトでは r0 になっています。

default_simulcast_rid = r2

default_spotlight_auto_unfocus¶

デフォルト:

true

スポットライト機能利用時の自動アンフォーカスの有無を指定してください。

default_spotlight_auto_unfocus = true

default_spotlight_auto_unfocus_interval¶

デフォルト:

10 s

範囲:

1 ms .. 30 s

スポットライト機能の自動アンフォーカスの時間間隔を指定してください。

default_spotlight_auto_unfocus_interval = 10 s

default_spotlight_delayed_focus¶

デフォルト:

true

スポットライト機能利用時に、遅延フォーカスの有無を指定してください。

遅延フォーカスは音声が有効になってもすぐにフォーカスせず、一定時間音声が有効な際に初めてフォーカスする仕組みです。

default_spotlight_delayed_focus = true

default_spotlight_delayed_focus_interval¶

デフォルト:

2000 ms

範囲:

1..60000 ms

スポットライト機能利用時に、遅延フォーカスが有効な際に、どの程度遅延をさせるか指定してください。

default_spotlight_delayed_focus_interval = 2000 ms

default_spotlight_focus_min_interval¶

デフォルト:

2000 ms

範囲:

0 ms .. 60 s

スポットライト機能でフォーカスしてからアンフォーカスされるまでの最低時間間隔を指定してください。

default_spotlight_focus_min_interval = 2000 ms

default_spotlight_focus_rid¶

デフォルト:

r1

指定できる rid:

none / r0 / r1 / r2

スポットライト機能利用時に、フォーカスした際に利用する rid を指定してください。

none は映像自体を配信しません。

default_spotlight_focus_rid = r1

default_spotlight_number¶

デフォルト:

1

範囲:

1..8

スポットライトで同時にフォーカスされるデフォルトの数を指定してください。

default_spotlight_number = 2

default_spotlight_unfocus_audio¶

デフォルト:

true

スポットライト機能利用時に、フォーカスなしでの音声配信を指定してください。

default_spotlight_unfocus_audio = false

default_spotlight_unfocus_audio_rate_limit¶

デフォルト:

5

範囲:

0..20

スポットライト機能利用時に、フォーカスなしの音声転送の上限レートを指定してください。

単位は 1 音声ストリーム = 50 packets / s となります。

default_spotlight_unfocus_audio_rate_limit = 5

default_spotlight_unfocus_rid¶

デフォルト:

r0

範囲:

none, r0, r1, r2

スポットライト機能利用時に、フォーカスなしで利用する rid を指定してください。

none は映像自体を配信しません。

default_spotlight_unfocus_rid = none

default_video_bit_rate¶

デフォルト:

500

単位:

k(キロ)bps

範囲:

1..50000

映像が使用できるビットレートを指定してください。デフォルトでは 500kbps です。この値を少なく指定すると解像度が不安定になります。

基本は 500 で余裕があるのであれば 800 などに設定することをお勧めします。

15000 より大きい値はまだ十分に検証ができていないため、現時点ではサポート外となります。ご了承ください。

default_video_bit_rate = 500

default_vp9_param_profile_id¶

デフォルト:

0

範囲:

0..3

VP9 で利用するプロファイル ID のデフォルト値を指定してください。

default_vp9_param_profile_id = 0

event_webhook_connection_updated_log¶

デフォルト:

true

event_webhook.jsonl に connection.updated を出力するかどうかを指定してください。デフォルトでは出力します。

event_webhook_connection_updated_log = false

event_webhook_url¶

デフォルト:

指定なし

クライアントの接続や切断、録画ファイル生成の終了などのイベントを通知する HTTP URL を指定してください。

event_webhook_url = https://example.com/sora/webhook/event

event_webhook_worker_key¶

デフォルト:

channel_id

範囲:

channel_id または connection_id

イベントウェブフックのワーカー割り当てに利用する値を指定してください。

event_webhook_worker_key = connection_id

event_webhook_worker_number¶

デフォルト:

100

範囲:

5..5000

イベントウェブフックのワーカー数を指定してください。 イベントウェブフックのワーカー割り当てに利用する値は event_webhook_worker_key で指定した値です。

event_webhook_worker_number = 100

external_api_url¶

デフォルト:

指定なし

ノードに対する Sora API の URL を指定してください。クラスター機能のリダイレクト時に用います。

external_api_url = http://127.0.0.1:3000/

external_signaling_url¶

デフォルト:

指定なし

ノードに対するシグナリング URL を指定してください。クラスター機能のリダイレクト時に用います。

external_signaling_url = ws://127.0.0.1:5000/signaling

forwarding_simulcast¶

単位指定必須

デフォルト:

single

RTP 転送 API 利用時にサイマルキャストの転送オプションを指定してください。

• single は最も優先度の低いストリームのみを転送します
• all はすべてのストリームを転送します

forwarding_simulcast = all

generic_nack¶

デフォルト:

true

Generic NACK を有効にするかどうかを指定してください。一つのチャネルに対して、 視聴者がかなり多い場合などはこの設定を無効にすることで、サーバー側の負荷を抑えることができるようになります。

generic_nack = true

h264_b_frame¶

デフォルト:

false

H.264 で B-frame が利用できるようになります。

h264_b_frame = true

h265_b_frame¶

デフォルト:

false

H.265 で B-frame が利用できるようになります。

h265_b_frame = true

hide_origin_username¶

デフォルト:

false

有効にした場合は SDP の Offer 時に送られる o=<username> の username の部分を shiguredo...SORA-<version> から _ に変更します。

hide_origin_username = false

ignore_archive_available_webhook¶

デフォルト:

false

録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック split-archive.available リクエストを event_webhook_url に登録された URL に送信するかどうかを指定してください。

ignore_archive_available_webhook = true

ignore_archive_failed_webhook¶

デフォルト:

false

録画機能で、録画が失敗した場合に、 event_webhook_url に登録された URL に archive.failed リクエストを送るかどうかを指定してください。

ignore_archive_failed_webhook = true

ignore_archive_started_webhook¶

デフォルト:

false

録画機能で、コネクションのアーカイブを開始した場合に、 イベントウェブフック event_webhook_url に登録された URL に archive.started リクエストを送信するかどうかを指定してください。

デフォルトではリクエストの送信を行います。

この設定が true の場合でも、 event_webhook.jsonl には archive.started のログが出力されます。

ignore_archive_started_webhook = true

ignore_audio_streaming_failed_webhook¶

デフォルト:

true

音声ストリーミング機能利用時に、音声ストリーミング送り先から "type": "error" が送られてきたなどで、 正常に処理が行えなくなった場合に、 event_webhook_url に指定された URL に audio_streaming.failed リクエストを送るかどうかを指定してください。

この設定が true の場合でも、 event_webhook.jsonl には audio_streaming.failed のログが出力されます。

ignore_audio_streaming_failed_webhook = false

ignore_audio_streaming_webhook¶

デフォルト:

true

音声ストリーミング機能で音声が送信された場合に、 session_webhook_url に登録された URL に audio_streaming.started と audio_streaming.stopped リクエストを送るかどうかを指定してください。

デフォルトではリクエストの送信を行いません。

この設定が true の場合でも、 session_webhook.jsonl には audio_streaming.started と audio_streaming.stopped のログが出力されます。

ignore_audio_streaming_webhook = false

ignore_connection_failed_webhook¶

デフォルト:

true

接続が失敗時に event_webhook_url に指定された URL へ connection.failed リクエストを送るかどうかを指定してください。 デフォルトではリクエストの送信を行いません。

この設定が true の場合でも、 event_webhook.jsonl には connection.failed のログが出力されます。

ignore_connection_failed_webhook = false

ignore_connection_rtc_webhook¶

デフォルト:

false

クライアントから RTC 統計情報が送られてきた際、 統計ウェブフック connection.rtc リクエストを stats_webhook_url に登録された URL に送信するかどうか指定してください。

デフォルトではリクエストの送信を行います。

ログの出力は stats_webhook_url をご確認ください。

ignore_connection_rtc_webhook = true

ignore_connection_updated_webhook¶

デフォルト:

false

イベントウェブフックの接続の更新時に event_webhook_url に指定された URL へ connection.updated を送るかどうかを指定してください。 デフォルトではリクエストの送信を行います。

この設定が true の場合でも、 event_webhook.jsonl には connection.updated のログが出力されます。

ignore_connection_updated_webhook = false

ignore_recording_report_webhook¶

デフォルト:

false

録画レポートが送信された場合に、 event_webhook_url に登録された URL に recording.report リクエストを送るかどうかを指定してください。

ignore_recording_report_webhook = true

ignore_recording_started_webhook¶

デフォルト:

false

録画機能で、録画を開始した場合に、 event_webhook_url または session_webhook_url に登録された URL に recording.started リクエストを送るかどうかを指定してください。

デフォルトではリクエストの送信を行います。

この設定が true の場合でも、 event_webhook.jsonl または session_webhook.jsonl には recording.started のログが出力されます。

ignore_recording_started_webhook = true

ignore_session_destroyed_webhook¶

デフォルト:

false

セッションが破棄された場合に、 session_webhook_url に登録された URL に session.destroyed リクエストを送るかどうかを指定してください。

ignore_session_destroyed_webhook = true

ignore_session_updated_webhook¶

デフォルト:

false

セッションウェブフックのセッションの更新時に session_webhook_url に指定された URL へ session.updated を送るかどうかを指定してください。 デフォルトではリクエストの送信を行います。

この設定が true の場合でも、 session_webhook.jsonl には session.updated のログが出力されます。

ignore_session_updated_webhook = false

ignore_split_archive_available_webhook¶

デフォルト:

false

録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック split-archive.available リクエストを送信するかどうかを指定してください。

デフォルトではリクエストの送信を行います。

この設定が true の場合でも、 event_webhook.jsonl には split-archive.available のログが出力されます。

ignore_split_archive_available_webhook = true

ignore_split_archive_end_webhook¶

デフォルト:

false

録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック split-archive.available リクエストを event_webhook_url に登録された URL に送信するかどうかを指定してください。

ignore_split_archive_end_webhook = true

ignore_spotlight_changed_webhook¶

デフォルト:

true

スポットライト機能で発言者が切り替わった場合に、 event_webhook_url に登録された URL に spotlight.focused と spotlight.unfocused リクエストを送るかどうかを指定してください。

デフォルトではリクエストの送信を行いません。

この設定が true の場合でも、 event_webhook.jsonl には spotlight.focused と spotlight.unfocused のログが 出力されません 。

ignore_spotlight_changed_webhook = true

ignore_turn_five_tuple¶

デフォルト:

false

TURN 利用時に送られてくるパケットの 5-TUPLE を無視するかどうかを指定してください。

ignore_turn_five_tuple = true

ipv4_address¶

デフォルト:

未指定

この値を有効にしなくても自動で IPv4 アドレスを収集しますが、 固定された IPv4 アドレスがサーバーに割り当てられている場合は指定することを推奨しています。

IPv4 アドレスを指定してください。 192.0.2.10 のように指定してください。

ipv4_address = 192.0.2.10

ipv6¶

デフォルト:

false

IPv6 機能を有効にするかどうか指定してください。デフォルトでは無効になっています。

この機能を有効にすると以下の機能が有効になります

• ipv6_address が指定されていない場合は自動で IPv6 アドレスが収集される
• ipv6_address で指定された値が使用される
• IPv6 アドレスが使用できる場合、 TURN サーバーの URL が IPv6 でも払い出される

この機能はシグナリングや API を IPv6 有効にする機能ではありません。シグナリングや API は IPv6 非対応です。

ipv6 = false

ipv6_address¶

デフォルト:

未指定

この値を有効にしなくても ipv6 が true の場合は、自動で IPv6 アドレスを収集しますが、 固定された IPv6 アドレスがサーバーに割り当てられている場合は指定することを推奨しています。

IPv6 アドレスを指定してください。 2001:0DB8::10 のように指定してください。

ipv6_address = 2001:0DB8::10

ipv6_only¶

デフォルト:

false

IPv6 アドレスのみを利用するようになります。この設定はシグナリングや API には影響しません。

ipv6_only = true

label¶

デフォルト:

"WebRTC SFU Sora"

認証やイベントウェブフックリクエスト送信時に送られる、サーバー固有の値を指定してください。

label = sora-node-001.example.com

legacy_cluster_relay¶

デフォルト:

false

クラスタリングリレー機能のレガシーモードを有効にするかどうかを指定してください。

legacy_cluster_relay = true

license_file¶

デフォルト:

"etc/license.json"

ライセンスファイルのパスを指定してください。できる限り 絶対パス を指定してください。

license_file = etc/license.json

max_connections¶

デフォルト:

ライセンスで許可された最大同時接続数

この Sora で許可する最大同時接続数を指定してください。

max_connections = 50

media_publish_worker_autoscale_threshold¶

デフォルト:

50

範囲:

1..1000

音声や映像の 1 配信ワーカーが担当する視聴者数を指定してください。ただし、デフォルトで十分なことがほとんどです。

media_publish_worker_autoscale_threshold = 20

multistream_auto_sharing_video_bit_rate¶

デフォルト:

false

マルチストリームで配信者が利用する映像ビットレートを自動で共有する機能です。

映像のビットレートに 1000kbps を指定した場合 4 人の配信者がいる場合はそれぞれの配信者のビットレートは 250kbps になります。

multistream_auto_sharing_video_bit_rate  = true

node_name¶

デフォルト:

指定なし

クラスター機能で利用するノード名を指定してください。

ノード名の @ の前には、正規表現 [0-9A-Za-z_\\-]+ にマッチする文字列を指定してください。 また @ の後ろには、サーバーのドメイン名（FQDN）や、IP アドレスを指定してください。

node_name = [email protected]

opus_param_channels¶

デフォルト:

2

範囲:

1..8

opus_param_maxplaybackrate¶

デフォルト:

48000

範囲:

8000..48000

opus_param_minptime¶

デフォルト:

10

範囲:

3..120

opus_param_ptime¶

デフォルト:

20

範囲:

3..120

opus_param_sprop_stereo¶

デフォルト:

true

opus_param_stereo¶

デフォルト:

true

opus_param_usedtx¶

デフォルト:

false

opus_param_useinbandfec¶

デフォルト:

true

recording_dual_output¶

デフォルト:

true

録画で一括＆分割録画を利用できるようにするかどうかを指定してください。

recording_dual_output = false

recording_expire_time_required¶

デフォルト:

false

録画で一括または一括＆分割録画時に expire_time の指定を必須にするかどうかを指定してください。

recording_expire_time_required = true

recording_max_expire_time¶

デフォルト:

86400 s

範囲:

1..86400 s

録画時に指定する expire_time の最大値を指定してください。

recording_max_expire_time = 10 min

recording_max_split_duration¶

デフォルト:

86400 s

範囲:

1..86400 s

録画で分割または一括＆分割録画時に split_duration の最大値を指定してください。

recording_max_split_duration = 10 min

recycle_media_section¶

デフォルト:

true

SDP でアクティブではなくなったメディアセクション （m=） を再利用する機能を有効化するかどうかを指定してください。

recycle_media_section = false

rtc_stats_log¶

デフォルト:

false

SDK やクライアントから送られてきた RTC 統計情報をログとして保存するかどうかを指定してください。 デフォルトではログは保存されません。

rtc_stats_log = true

rtp_hdrext_abs_capture_time¶

デフォルト:

false

RTP ヘッダー拡張 http://www.webrtc.org/experiments/rtp-hdrext/abs-capture-time を利用するかどうかを指定してください。

rtp_hdrext_abs_capture_time = true

rtp_hdrext_color_space¶

デフォルト:

false

RTP ヘッダー拡張 http://www.webrtc.org/experiments/rtp-hdrext/color-space を利用するかどうかを指定してください。

rtp_hdrext_color_space = true

rtp_hdrext_dependency_descriptor_vp9¶

デフォルト:

false

RTP ヘッダー拡張 https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension を VP9 で利用するかどうかを指定してください。

rtp_hdrext_dependency_descriptor_vp9 = true

rtp_hdrext_playout_delay¶

デフォルト:

true

RTP ヘッダー拡張 http://www.webrtc.org/experiments/rtp-hdrext/playout-delay を利用するかどうかを指定してください。

rtp_hdrext_playout_delay = false

rtp_hdrext_sdes_mid¶

デフォルト:

false

RTP ヘッダー拡張 urn:ietf:params:rtp-hdrext:sdes:mid を利用するかどうかを指定してください。

rtp_hdrext_sdes_mid = true

rtp_hdrext_video_content_type¶

デフォルト:

false

RTP ヘッダー拡張 http://www.webrtc.org/experiments/rtp-hdrext/video-content-type を利用するかどうかを指定してください。

rtp_hdrext_video_content_type = true

rtp_hdrext_video_orientation¶

デフォルト:

false

RTP ヘッダー拡張 urn:3gpp:video-orientation を利用するかどうかを指定してください。

rtp_hdrext_video_orientation = true

rtp_hdrext_video_timing¶

デフォルト:

false

RTP ヘッダー拡張 http://www.webrtc.org/experiments/rtp-hdrext/video-timing を利用するかどうかを指定してください。

rtp_hdrext_video_timing = true

rtp_packet_loss_simulator_incoming¶

デフォルト:

0

範囲:

0..100

Sora が受信する RTP パケットを指定したパーセント分ドロップさせます。

値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。

rtp_packet_loss_simulator_incoming = 10

rtp_packet_loss_simulator_outgoing¶

デフォルト:

0

範囲:

0..100

Sora が送信する RTP パケットを指定したパーセント分ドロップさせます。

値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。

rtp_packet_loss_simulator_outgoing = 10

rtx¶

デフォルト:

true

RTX を有効にするかどうかを指定してください。デフォルトでは true で有効になっています。

現時点では Chrome / Safari / Edge / Firefox が使用できます。 iOS / Android / Unity は libwebrtc の最新版を利用している場合は対応しています。

rtx = false

session_created_response_validate_warning_as_error¶

デフォルト:

false

セッションウェブフック session.created の戻り値が正常でない場合にエラーとし、セッションを破棄するかどうかを指定してください。

session_created_response_validate_warning_as_error = true

session_created_timeout¶

デフォルト:

5 s

範囲:

0..300 s

セッションが存在しない状態で、新規接続が来た際にセッション生成に利用できる時間を指定してください。 この時間はセッションウェブフックにかかる時間も含まれます。

session_created_timeout = 5 s

session_destroyed_timeout¶

デフォルト:

15 s

範囲:

0..300 s

セッションに同時接続数が 0 になった場合、セッション破棄する時間を指定してください。

session_destroyed_timeout = 15 s

session_updated_webhook_interval¶

デフォルト:

1 min

範囲:

1..10 min

単位:

min のみ

セッション更新時のセッションウェブフック session.updated の間隔を指定してください。 時間単位には 分 min のみ指定できます。

session_updated_webhook_interval = 1 min

session_webhook_session_updated_log¶

デフォルト:

true

session_webhook.jsonl に session.updated を出力するかどうかを指定してください。デフォルトでは出力します。

session_webhook_session_updated_log = false

session_webhook_url¶

デフォルト:

指定なし

セッションに関連するウェブフックリクエスト送信先の HTTP URL を指定してください。

session_webhook_url = https://example.com/sora/webhook/session

signaling_av1_params¶

デフォルト:

false

シグナリングで AV1 のパラメーターを指定できるようにするかを指定してください。

signaling_av1_params = true

signaling_bundle_id¶

デフォルト:

false

シグナリングでバンドル ID を指定できるようにするかを指定してください。

signaling_bundle_id = true

signaling_forwarding_filters¶

デフォルト:

false

転送フィルターをシグナリング接続時に設定できるかどうかを指定してください。

signaling_forwarding_filters = true

signaling_h264_params¶

デフォルト:

false

シグナリングで H.264 のパラメーターを指定できるようにするかを指定してください。

signaling_h264_params = true

signaling_h265_params¶

デフォルト:

false

シグナリングで H.265 のパラメーターを指定できるようにするかを指定してください。

signaling_h265_params = true

signaling_loopback_address_only¶

デフォルト:

false

シグナリングへのアクセスをループバックアドレスからのみに制限します。できる限り有効にしてください。

signaling_loopback_address_only = true

signaling_normal_close_reason¶

デフォルト:

true

正常切断時の reason に切断理由を含むかどうかを指定してください。 false を指定した場合は空文字 "" が含まれるようになります。

signaling_normal_close_reason = false

signaling_notify¶

デフォルト:

true

シグナリング経由で接続や切断、更新の通知を受け取るかどうか指定してください。この設定はすべての設定に影響します。 個別の設定の場合は認証ウェブフックのレスポンス時で指定してください。

シグナリング経由での通知機能の詳細は シグナリング通知機能 をご確認ください

認証の戻り値に関しては 認証ウェブフックの戻り値での指定 を確認してください。

signaling_notify = true

signaling_notify_audio_streaming_failed¶

デフォルト:

false

シグナリング通知機能が有効な際、音声ストリーミングサーバーへの接続が失敗した際にチャネル参加者全員に通知をするかどうかを指定してください。

signaling_notify_audio_streaming_failed = true

signaling_notify_authn_metadata_max_size¶

デフォルト:

64512

範囲:

0..1048576

クライアントから接続時に送られてくるシグナリング通知メタデータの最大サイズをバイト単位で指定してください。

signaling_notify_authn_metadata_max_size = 64512

signaling_notify_bundle_id¶

デフォルト:

true

シグナリング通知機能が有効な際、通知にバンドル ID を含むかどうかを指定してください。

signaling_notify_bundle_id = true

signaling_notify_client_id¶

デフォルト:

true

シグナリング通知機能が有効な際、通知にクライアント ID を含むかどうかを指定してください。

signaling_notify_client_id = true

signaling_notify_connection_created_timestamp¶

デフォルト:

true

シグナリング通知機能が有効な際、 "event_type": "connection.created" に timestamp を含むかどうかを指定してください。

signaling_notify_connection_created_timestamp = true

signaling_notify_connection_id¶

デフォルト:

true

シグナリング通知機能が有効な際、通知にコネクション ID を含むかどうかを指定してください。

signaling_notify_connection_id = true

signaling_notify_forwarding_filter¶

デフォルト:

true

シグナリング通知機能が有効な際、 転送フィルターのブロック開始とブロック解除の通知をするかどうかを指定してください。

signaling_notify_forwarding_filter = true

signaling_notify_ice_connection_state¶

デフォルト:

false

シグナリング通知機能が有効な際、 ICE 接続の状態を自分を含む同一セッションに参加しているクライアント全員に通知するかどうかを指定してください。

signaling_notify_ice_connection_state = true

signaling_notify_media¶

デフォルト:

true

シグナリング通知機能が有効な際、通知に音声や映像が有効かどうかを含むかどうかを指定してください。

signaling_notify_media = true

signaling_notify_metadata¶

デフォルト:

true

シグナリング通知機能が有効な際、 "type": "connect" の signaling_notify_metadata で指定した値、 または認証ウェブフックの戻り値の signaling_notify_metadata で指定した値を通知するかどうかを指定してください。

signaling_notify_metadata = true

signaling_notify_metadata_ext¶

デフォルト:

false

シグナリング通知メタデータ拡張機能を有効にするかどうかを指定してください。 シグナリング通知機能が無効でも通知されないだけで API は利用できます。

詳細は シグナリング通知メタデータ拡張機能 をご確認ください。

signaling_notify_metadata_ext = true

signaling_notify_network¶

デフォルト:

true

シグナリング通知機能が有効な際、ネットワークの状態を通知するかどうかを指定してください。

signaling_notify_network = true

signaling_notify_network_status_interval¶

デフォルト:

10 s

範囲:

20 ms .. 10 min

シグナリング通知が有効な際、ネットワーク状態の通知間隔を指定してください。

signaling_notify_network_status_interval = 30 s

signaling_notify_recording¶

デフォルト:

true

シグナリング通知機能が有効な際、 録画の開始と停止の状態を通知するかどうかを指定してください。

signaling_notify_recording = true

signaling_notify_session_id¶

デフォルト:

true

シグナリング通知機能が有効な際、通知にセッション ID を含むかどうかを指定してください。

signaling_notify_session_id = true

signaling_notify_simulcast_switched¶

デフォルト:

true

シグナリング通知機能が有効な際、サイマルキャストの rid の切り替わりを通知するかどうかを指定してください。

signaling_notify_simulcast_switched = true

signaling_notify_spotlight¶

デフォルト:

true

シグナリング通知が有効な際、スポットライトがフォーカス/アンフォーカスに切り替わったことを通知するかどうかを指定してください。

signaling_notify_spotlight = false

signaling_port¶

デフォルト:

5000

シグナリングに使用するポート番号を指定してください。

signaling_port = 5000

signaling_vp9_params¶

デフォルト:

false

シグナリングで VP9 のパラメーターを指定できるようにするかを指定してください。

signaling_vp9_params = true

simulcast_auto_min_switch_interval¶

デフォルト:

5 s

範囲:

1..300 s

サイマルキャスト機能利用時に、 simulcast_auto_rids を指定した際、自動で切り替わる最小の間隔を秒数で指定してください。

simulcast_auto_min_switch_interval = 10 s

simulcast_codecs_file¶

デフォルト:

なし

サイマルキャストマルチコーデックで利用するコーデックパラメーターのカスタマイズを JSON 形式のファイルで指定してください。

詳細は サイマルキャストマルチコーデックのデフォルト値を変更する をご確認ください。

simulcast_codecs_file = etc/simulcast_codecs.json

simulcast_encodings_file¶

デフォルト:

なし

サイマルキャストで利用するエンコーディングパラメーターのカスタマイズを JSON 形式のファイルで指定してください。

詳細は 映像のエンコーディングパラメーターのカスタマイズ をご確認ください。

simulcast_encodings_file = etc/simulcast_encodings.json

simulcast_multicodec¶

デフォルト:

false

サイマルキャストマルチコーデックを有効にするかどうかを指定してください。

simulcast_multicodec = true

skip_redact_sensitive_data¶

デフォルト:

false

ログファイル中のセンシティブなデータを "REDACTED" という文字列に書き換えて出力する処理をスキップします。

skip_redact_sensitive_data = true

センシティブなデータを書き換える対象は以下のとおりです。

• auth_webhook.jsonl の event_metadata を "REDACTED" に書き換えます
• session_webhook.jsonl の session_metadata と event_metadata を "REDACTED" に書き換えます
• event_webhook.jsonl の event_metadata を "REDACTED" に書き換えます

spotlight_encodings_file¶

デフォルト:

なし

スポットライトで利用するエンコーディングパラメーターのカスタマイズを JSON 形式のファイルで指定してください。

詳細は スポットライト利用時の映像のエンコーディングパラメーターのカスタマイズ をご確認ください。

spotlight_encodings_file = etc/spotlight_encodings.json

stats_webhook_log¶

デフォルト:

false

統計ウェブフックのログをファイルに出力します。

stats_webhook_log = true

stats_webhook_url¶

デフォルト:

指定なし

統計情報を通知する HTTP URL を指定してください。

stats_webhook_url = https://example.com/sora/webhook/stats

stats_webhook_worker_number¶

デフォルト:

5

範囲:

5..5000

統計ウェブフックのワーカー数を指定してください。 統計ウェブフックのワーカー割り当てに利用する値は channel_id です。

stats_webhook_worker_number = 5

test_api¶

デフォルト:

false

テスト用 API 機能を有効にするかどうかを指定してください。デフォルトでは無効になっています。

test_api = true

turn_fqdn¶

デフォルト:

なし

TURN 機能の URL で使用する FQDN (最後の . なし) を指定してください。

指定した場合は TURN-UDP, TURN-TCP, TURN-TLS に共通で採用されます。 TURN-TLS の FQDN は turn_tls_fqdn 設定で上書きできます。

turn_fqdn = sora-turn.example.com

turn_realm¶

デフォルト:

"sora-turn.example.com"

TURN 機能で使用するレルムを指定してください。 文字列であれば何でも良いのですが、会社のドメインなどを指定することをおすすめします。

turn_realm = sora-turn.example.com

turn_tcp¶

デフォルト:

true

TURN 機能で TURN-TCP を使用するかどうかを指定してください。使用しない場合は false を指定してください。

turn_tcp = false

turn_tcp_allocate_success_delay_time¶

デフォルト:

100 ms

範囲:

0..1 s

TURN 機能で TURN-TCP 時の Allocate-Success を返す時間を遅らせます。

turn_tcp_allocate_success_delay_time = 100 ms

turn_tcp_listen_port¶

デフォルト:

3478

TURN 機能で TURN-TCP を有効にした際に使用するポート番号を指定してください。デフォルトでは 3478 番ポートが使用されます。

turn_tcp_listen_port = 3478

turn_tcp_only¶

デフォルト:

false

TURN-TCP を強制的に利用するようになります。この機能を有効にした場合 warning ログが出力されます。

turn_tcp_only = true

turn_tcp_port¶

デフォルト:

turn_tcp_listen_port の値を利用

TURN 機能で TURN-TCP URL 払い出し時のポート番号を指定してください。デフォルトでは turn_tcp_listen_port の値が利用されます。

turn_tcp_port = 3478

turn_tls¶

デフォルト:

false

TURN 機能で TURN-TLS の URL 払い出し機能を使用するかどうかを指定してください。使用しない場合は false を指定してください。

turn_tls = true

turn_tls_fqdn¶

TURN 機能で TURN-TLS の URL で使用する FQDN (最後の . なし) を指定してください。

指定しない場合は turn_fqdn の値が採用されます。 どちらも設定されていない場合 TURN-TLS を利用することはできません。

turn_tls_fqdn = sora-turn.example.com

turn_tls_only¶

デフォルト:

false

TURN-TLS を強制的に利用するようになります。この機能を有効にした場合 warning ログが出力されます。

turn_tls_only = true

turn_tls_port¶

デフォルト:

5349

TURN 機能で TURN-TLS の URL 払い出し機能を有効にした際に使用するポート番号を指定してください。デフォルトでは 5349 番ポートが使用されます。

turn_tls_port = 443

turn_udp_allocate_request_401_rate_limit_count¶

デフォルト:

60

範囲:

0..300

TURN-UDP 利用時の認証エラーを返すレートリミット回数を指定してください。

60 の場合は turn_udp_allocate_request_401_rate_limit_window で指定した秒数の間に 60 回を超えた場合、 サイレントディスカードします。

turn_udp_allocate_request_401_rate_limit_count = 60

turn_udp_allocate_request_401_rate_limit_window¶

デフォルト:

60 s

範囲:

1..300 s

TURN-UDP 利用時の認証エラーを返すレートリミットウィンドウを指定してください。

60 s の場合は 60 秒の間に turn_udp_allocate_request_401_rate_limit_count で指定した回数を超えた場合、 サイレントディスカードします。

turn_udp_allocate_request_401_rate_limit_window = 60 s

ulpfec¶

デフォルト:

false

ULPFEC を有効にするかどうかを指定してください。デフォルトでは無効になっています。

現時点では Chrome と Safari が使用でき、 Firefox は対応しておりません。 iOS/Android は libwebrtc を使用した場合は対応しています。

ulpfec = false

webhook_basic_authn¶

デフォルト:

false

ウェブフックで HTTP ベーシック認証を利用するかどうかを指定してください。

webhook_basic_authn = true

webhook_basic_authn_password¶

デフォルト:

指定なし

ウェブフックで HTTP ベーシック認証を利用する際のパスワードを指定してください。 basic-authn-password のように文字列で指定してください。

webhook_basic_authn_password = basic-authn-password

webhook_basic_authn_user_id¶

デフォルト:

指定なし

ウェブフックで HTTP ベーシック認証を利用する際のユーザー ID を指定してください。 basic-authn-user-id のように文字列で指定してください。

webhook_basic_authn_user_id = basic-authn-user-id

webhook_connect_timeout¶

デフォルト:

30 s

範囲:

1..600 s

ウェブフックの接続確立までのタイムアウト時間を指定してください。

webhook_connect_timeout = 120 s

webhook_insecure¶

デフォルト:

false

ウェブフックで HTTPS を利用する際に証明書のチェックを行わない場合はこの設定を有効にしてください。

webhook_insecure = true

webhook_ipv6¶

デフォルト:

false

ウェブフックで IPv6 を利用するかどうかを指定してください。

この設定を true にしない限り、ウェブフックでは IPv4 が利用されます。

webhook_ipv6 = true

webhook_proxy_auth_password¶

指定しない場合はコメントアウトしたままにしてください

デフォルト:

指定なし

ウェブフックで利用する HTTP Proxy の認証パスワードを指定してください。 proxy-auth-password のように文字列で指定してください。

webhook_proxy_auth_password = proxy-auth-password

webhook_proxy_auth_user¶

指定しない場合はコメントアウトしたままにしてください

デフォルト:

指定なし

ウェブフックで利用する HTTP Proxy の認証ユーザーを指定してください。 proxy-auth-user のように文字列で指定してください。

webhook_proxy_auth_user = proxy-auth-user

webhook_proxy_url¶

指定しない場合はコメントアウトしたままにしてください

デフォルト:

指定なし

ウェブフックで利用する HTTP Proxy の URL を指定してください。 http://proxy.example.com:8080 のように URL を指定してください。

webhook_proxy_url = http://proxy.example.com:8080

webhook_response_timeout¶

デフォルト:

5 s

範囲:

1..600 s

ウェブフックのレスポンス受信までのタイムアウト時間を指定してください。

webhook_response_timeout = 5 s

webhook_tls_fullchain_file¶

デフォルト:

指定なし

ウェブフックリクエスト送信先との通信に HTTPS で mTLS を利用するための設定で、 中間証明書を含むクライアント証明書を PEM 形式で設定してください。

webhook_tls_fullchain_file = /path/to/fullchain.pem

webhook_tls_privkey_file¶

デフォルト:

指定なし

ウェブフックリクエスト送信先との通信に HTTPS で mTLS を利用するための設定で、 クライアント証明書の秘密鍵を PEM 形式で設定してください。

webhook_tls_privkey_file = /path/to/privkey.pem

webhook_tls_verify_cacert_file¶

指定しない場合はコメントアウトしたままにしてください

デフォルト:

指定なし

ウェブフックリクエスト送信先との通信に HTTPS を利用した際、サーバー証明書のチェックを行う CA ファイルを PEM 形式で設定してください。

webhook_tls_verify_cacert_file = /path/to/server_cacert.pem

websocket_signaling_ping_interval¶

デフォルト:

5 s

範囲:

5..300 s

WebSocket 経由のシグナリングの場合に、サーバーからクライアントへネットワーク死活監視のために "type": "ping" を送信する間隔を指定してください。

websocket_signaling_ping_interval = 5 s

websocket_signaling_pong_timeout¶

デフォルト:

60 s

範囲:

60..600 s

WebSocket 経由のシグナリングの場合に、クライアントから返却される "type": "pong" のタイムアウト時間を指定してください。 この時間内に "type": "pong" が返却されない場合はサーバーから接続を切断します。

websocket_signaling_pong_timeout = 60 s

websocket_stats_timer_interval¶

デフォルト:

60 s

範囲:

5..600 s

WebSocket 経由のシグナリングの場合に、サーバーからクライアントに統計情報の送信を要求する "stats": true を設定する間隔を指定してください。

websocket_stats_timer_interval = 60 s

whep¶

デフォルト:

false

OBS の WHEP 形式のシグナリングを有効にするかどうか指定してください。

whep = true

whep_bearer_token_metadata_key¶

デフォルト:

指定なし

OBS の WHEP 形式のシグナリング時の Authentication ヘッダーに含まれるトークンを、メタデータとして送信する際のキーを指定してください。

whep_bearer_token_metadata_key = access_token

whip¶

デフォルト:

false

OBS の WHIP 形式のシグナリングを有効にするかどうか指定してください。

whip = true

whip_bearer_token_metadata_key¶

デフォルト:

指定なし

OBS の WHIP 形式のシグナリング時の Authentication ヘッダーに含まれるトークンを、メタデータとして送信する際のキーを指定してください。

whip_bearer_token_metadata_key = access_token

workaround_20250515¶

デフォルト:

未指定

この設定項目については workaround_20250515 をご確認ください。

workaround_20250515 = 18.4,18.4.1,18.5

log_dir¶

デフォルト:

log

ログファイルの出力先ディレクトリを指定してください。デフォルトではパッケージディレクトリ以下の log ディレクトリに出力されます。

• 相対パスで指定した場合は Sora のパッケージディレクトリ (sora-<version>/) からの相対パスになります
• 絶対パスで指定した場合は指定したパスになります

log_dir = /var/log/sora

設定¶

[Unit]
Description=WebRTC SFU Sora Service
After=network.target

[Service]
Environment="HOME=/home/shiguredo"
ExecStart=/home/shiguredo/sora/bin/sora foreground
Type=simple
Restart=always
RestartSec=60s
User=shiguredo
KillMode=process

[Install]
WantedBy=multi-user.target

$ sudo systemctl enable sora.service

$ sudo systemctl start sora.service

$ sudo systemctl stop sora.service

確認方法¶

netstat コマンドで Errors が出ていた場合はバッファが足りない可能性が高いです。

$ netstat -su

Ubuntu¶

sudo sysctl -w net.core.rmem_default=33554432
sudo sysctl -w net.core.rmem_max=33554432

sudo sysctl -w net.core.wmem_default=33554432
sudo sysctl -w net.core.wmem_max=33554432

sudo sysctl -w net.core.somaxconn=65535
sudo sysctl -w net.core.optmem_max=25165824
sudo sysctl -w net.core.netdev_max_backlog=65536

sudo sysctl -w net.ipv4.tcp_mem='786432 1048576 26777216'
sudo sysctl -w net.ipv4.tcp_rmem='8192 87380 33554432'
sudo sysctl -w net.ipv4.tcp_wmem='8192 65536 33554432'

sudo sysctl -w net.ipv4.udp_mem='65536 131072 262144'
sudo sysctl -w net.ipv4.udp_rmem_min=16384
sudo sysctl -w net.ipv4.udp_wmem_min=16384

概要¶

Sora は WebRTC とウェブフックが IPv6 での動作に対応しています。ただし、ブラウザ側やサーバー側が非対応な場合があります。 特に、IPv6 での TURN 機能にクライアントが対応していない場合は接続できないことがあります。

お問い合わせの際の情報について¶

IPv6 環境は様々な組み合わせがあるため、問題を解析するには多くの情報が必要になります。

お問い合わせの際は以下の情報をお送りください。

• クライアント側の IPv6 の有無について
• Sora 側の IPv6 の設定の有無について
• Sora が動作しているサーバーの A または AAAA レコードの有無について
• クライアントが IPv4 または IPv6 または IPv4 と IPv6 どの環境かについて

他にも何か気づいた点などがありましたらそちらも合わせてお問い合わせください。

IPv6 のみ¶

Sora の WebRTC を IPv6 のみの通信のみでの動作させます。

sora.conf にて ipv6_only を true にすることで、 WebRTC の接続を IPv6 のみに制限することができます。

シグナリングや API 部分を IPv6 のみにしたい場合は Nginx 側の設定を変更してください。

ウェブフックの IPv6 対応¶

Sora のウェブフックは IPv6 での動作に対応しています。

sora.conf にて webhook_ipv6 を true にすることで、 ウェブフックの接続で IPv6 を利用する事ができます。

概要¶

Sora では様々なメタデータを扱っているため、それぞれのメタデータの説明をしています。

接続時の認証メタデータ指定¶

クライアントが Sora へ接続する際に、認証に利用する metadata を指定できます。 これは認証ウェブフックに metadata として含まれます。

{
  "type": "connect",
  "role": "sendrecv",
  "channel_id": "sora",
  "metadata": {"spam": "egg"}
}

この値はクライアントと Sora だけで共有される値です。他のクライアントには一切共有されません。

認証ウェブフック成功時のメタデータ払い出し¶

認証ウェブフック成功時に metadata を払い出すことができます。 この値は Sora が "type": "offer" をクライアントへ送る際に metadata として送られます。

{
  "allowed": true,
  "metadata": {"spam": "egg"}
}

{
  "type": "offer",
  "sdp": "...",
  "metadata": {"spam": "egg"}
}

この値は Sora とクライアントだけで共有される値です。他のクライアントには一切共有されません。

認証ウェブフック成功時のイベントメタデータ払い出し¶

認証ウェブフック成功時に event_metadata を払い出すことができます。 この値は Sora がイベントウェブフックリクエストを送信する際に event_metadata として含まれます。

{
  "allowed": true,
  "event_metadata": {"spam": "egg"}
}

{
  "type": "connection.created",
  "event_metadata": {"spam": "egg"}
}

この値は Sora と認証ウェブフックとイベントウェブフック先のサーバーとのみで共有されます。 クライアントには通知されません。

接続時のシグナリング通知メタデータ指定¶

シグナリング接続時の "type": "connect" で signaling_notify_metadata が指定できます。 ここで指定した値は同じチャネルに参加しているクライアントと新しく参加するクライアントに通知されます。

{
  "type": "connect",
  "signaling_notify_metadata": {"spam": "egg"}
}

{
  "type": "connection.created",
  "authn_metadata": {"spam": "egg"}
  "metadata": {"spam": "egg"}
}

{
  "type": "connection.created",
  "authn_metadata": {"spam": "egg"}
  "metadata": {}
}

認証ウェブフック成功時のシグナリング通知メタデータ払い出し¶

認証ウェブフック成功時に signaling_notify_metadata を払い出すことができます。 この値は同じチャネルに参加しているクライアントと新しく参加するクライアントに通知されます。

もし接続時に signaling_notify_metadata が指定されていた場合は、 認証成功時のシグナリング通知メタデータ払い出しで 上書き されます。

{
  "allowed": true,
  "signaling_notify_metadata": {"spam": "egg"}
}

{
  "type": "connection.created",
  "authz_metadata": {"spam": "egg"}
  "metadata": {"spam": "egg"}
}

{
  "type": "connection.created",
  "authz_metadata": {"spam": "egg"}
  "metadata": {}
}

シグナリング通知メタデータ拡張¶

シグナリング通知メタデータ拡張 を利用すると接続ごとに状態を持てるようになり、

API でそのメタデータを変更し、通知することができるようになります。

本来、シグナリング通知メタデータは接続時か認証成功払い出し時にしか指定できず一度指定したら変更できません。 シグナリング通知メタデータ拡張を利用した場合は HTTP API を利用して途中でメタデータの値を変更できます。

この機能を有効にするとシグナリング時の通知メタデータに指定した値は metadata に含まれなくなります。

セッション生成時のセッションメタデータ払い出し¶

セッション生成時に送信される session.created の戻り値に指定することで session_metadata を払い出すことができます。 この値は一定間隔で送られる session.updated と、 このセッションが破棄された時に送られる session.destroyed に含まれます。

{
  "session_metadata": "<JSON>"
}

一括録画ファイルメタデータ archive-<connection_id>.json¶

録画機能で一括録画を指定した際に archive/<recording-id>/ 以下に生成されるファイルです。 かならず archive-<connection_id>.webm ファイルとペアになります。

分割録画ファイルメタデータ split-archive-<connection_id>_<index>.json¶

録画機能で分割録画を指定した際に archive/<recording-id>/ 以下に生成されるファイルです。 かならず split-archive-<connection_id>_<index>.webm ファイルとペアになります。

録画(セッション単位) の StartRecording API で指定するメタデータ¶

StartRecording API では metadata を指定できます。

この値は以下のセッションウェブフックに recording_metadata として含まれます。

• recording.started
• recording.report
• session.updated

また、 report-<recording_id>.json ファイルにも記録されます。

録画(セッション単位) のセッションウェブフック session.created で指定するメタデータ¶

録画(セッション単位) ではセッションウェブフック session.created の戻り値として、 recording_metadata を払い出すことができます。

{
  "recording": true,
  "recording_metadata": "<JSON>"
}

この値は以下のセッションウェブフックに recording_metadata として含まれます。

• recording.started
• recording.report
• session.updated

また、 report-<recording_id>.json ファイルにも記録されます。

概要¶

Sora ではログに出力されるセンシティブデータを "REDACTED" という文字列に書き換えます。

対象ログと項目¶

Sora のログは以下の内容のセンシティブデータを "REDACTED" に書き換えて出力します。

• auth_webhook.jsonl の event_metadata を "REDACTED" に書き換えて出力します。
• session_webhook.jsonl の session_metadata と event_metadata を "REDACTED" に書き換えて出力します。
• event_webhook.jsonl の event_metadata を "REDACTED" に書き換えて出力します。

書き換えをスキップする¶

センシティブなデータを利用している場合は、 "REDACTED" への書き換えをスキップする設定を提供しています。

sora.conf の skip_redact_sensitive_data を true にすることでセンシティブなデータの "REDACTED" への書き換えをスキップします。

録画メタデータの扱いについて¶

StartRecording API やセッションウェブフックの戻り値で指定できる録画メタデータについてはセンシティブなデータとして扱っていません。 これは録画ファイル出力時の録画メタデータファイルに含まれ、映像合成時に利用することを想定しているためです。