# sora.conf リファレンス Sora の設定ファイルは `key = value` 形式です。 文字列であっても `""` で囲わないでください。 ## 単位指定 `sora.conf` では一部の設定に単位の指定が必須です。 - 利用できる単位- ミリ秒 `ms` - 秒 `s` - 分 `min` - 時 `h` - 数値と単位の間にはスペースを入れてください ```ini webhook_response_timeout = 30 s ``` > **注釈** > > 利用できる単位が制限されている設定項目も存在します。 ## 範囲表記 - `2..10` と書いてある場合 2 以上、10 以下の値を指定できることを表しています - `2..10 s` と書いてある場合は 2 秒以上、10 秒以下の値を指定できることを表しています ## 環境変数による設定上書き機能 *バージョン 2025.2.0 で追加。* Sora の設定ファイル `sora.conf` の設定は環境変数で上書きすることができます。 `SORA_` に続けて設定項目名を大文字にし、アンダースコア `_` に置き換えた名前を環境変数として指定することで、設定を上書きできます。 例えば `sora.conf` の `api_port` を環境変数で上書きする場合は、以下のように指定します。 ```bash export SORA_API_PORT=18000 ``` `connection_created_wait_timeout` のように値に単位が含まれる設定項目も同様に指定できます。 `sora.conf` と同様に値の後ろにスペースを入れて指定してください。 ```bash export SORA_CONNECTION_CREATED_WAIT_TIMEOUT="60 s" ``` ### 注意点 - Sora 起動後に環境変数を変更しても設定は反映されません - Sora 起動後に環境変数を削除しても設定は反映されません ## api_cors_origin **デフォルト**: 指定なし API の戻りのヘッダーに CORS (Cross-Origin Resource Sharing) を含める際のドメインを指定してください。 http から始めて、パスの / は含まないでください。 ```ini api_cors_origin = http://127.0.0.1:5000 ``` ## api_loopback_address_only **デフォルト**: false API へのアクセスをループバックアドレスからのみに制限します。できる限り有効にしてください。 ```ini api_loopback_address_only = true ``` ## api_port **デフォルト**: 3000 API に使用するポート番号を指定してください。 ```ini api_port = 3000 ``` ## archive_dir **デフォルト**: archive 録画ファイルが保存されるディレクトリを指定してください。できる限り **絶対パス** で指定してください。 ```ini archive_dir = /path/to/archive ``` > **注意** > > `archive_dir` と `archive_tmp_dir` は違うディレクトリを指定してください ## archive_tmp_dir **デフォルト**: tmp/archive 録画に使用する一時ファイルを保存するディレクトリを指定してください。できる限り **絶対パス** で指定してください。 > **重要** > > 録画が失敗した場合には、このディレクトリに保存されたファイルは自動的に削除されません。 > そのため録画失敗時には一時ファイルが残り続けます。 ```ini archive_tmp_dir = /path/to/tmp/archive ``` > **注意** > > `archive_dir` と `archive_tmp_dir` は違うディレクトリを指定してください ## audio_red > **注意** > > この設定を有効にする場合は事前にサポートまでご連絡ください **デフォルト**: false 音声冗長化を有効にするかどうかを指定してください。デフォルトでは無効になっています。 現時点では Chrome M95 以降で使用できます。非対応ブラウザが混在していても利用できます。 ```ini audio_red = true ``` ## audio_streaming_header **デフォルト**: false 音声ストリーミングヘッダーを有効にするかどうかを指定してください。 ```ini audio_streaming_header = true ``` ## audio_streaming_max_retries **デフォルト**: 0 音声ストリーミングゲートウェイへの接続が失敗した場合の最大リトライ回数を指定してください。 リトライが発生するのは、 この値と [audio_streaming_retry_interval](SORA_CONF.html#15f73d) が `0` 以外が指定されており、 音声ストリーミングゲートウェイへの接続確立が失敗、または音声ストリーミングゲートウェイが 5xx 系でエラーを返した場合です。 ```ini audio_streaming_max_retries = 3 ``` ## audio_streaming_retry_interval **デフォルト**: 5 s 音声ストリーミングゲートウェイへの接続が失敗した場合のリトライ間隔を指定してください。 ```ini audio_streaming_retry_interval = 10 s ``` ## audio_streaming_tls_fullchain_file > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 指定なし 音声ストリーミングゲートウェイとの通信に HTTPS で mTLS を利用するための設定で、 中間証明書を含むクライアント証明書を PEM 形式で設定してください。 ```ini audio_streaming_tls_fullchain_file = /path/to/fullchain.pem ``` ## audio_streaming_tls_privkey_file > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 指定なし 音声ストリーミングゲートウェイとの通信に HTTPS で mTLS を利用するための設定で、 クライアント証明書の秘密鍵を PEM 形式で設定してください。 > **重要** > > 秘密鍵にはパスフレーズが設定されている場合エラーとなります ```ini audio_streaming_tls_privkey_file = /path/to/privkey.pem ``` ## audio_streaming_tls_verify_cacert_file > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 指定なし 音声ストリーミングゲートウェイとの通信に HTTPS を利用した際、サーバー証明書のチェックを行う CA ファイルを PEM 形式で設定してください。 ```ini audio_streaming_tls_verify_cacert_file = /path/to/server_cacert.pem ``` > **重要** > > この設定がない場合、 OS 組み込みのルート CA 証明書を利用してサーバー証明書をチェックします。 > OS 組み込みのルート CA 証明書については [ウェブフックリクエストなどの送信先サーバー証明書の検証に利用する OS 組み込みのルート CA 証明書について](WEBHOOK.html#e8a845) をご確認ください。 ## audio_streaming_url **デフォルト**: 指定なし 音声ストリーミングゲートウェイの URL を指定してください。 http を指定した場合は HTTP/2 (h2c) で送られます。 https の場合は HTTP/2 (h2) で送られます。 音声ストリーミングゲートウェイは HTTP/2 に対応している必要があります。 ```ini audio_streaming_url = http://192.0.2.10:48080/speech ``` ```ini audio_streaming_url = https://suzu.example.com/speech ``` ## auth_webhook_log **デフォルト**: true 認証ウェブフックをすべてログファイルに出力します。詳細は [認証ウェブフックログ](AUTH_WEBHOOK.html#d4693f) をご確認ください。 ```ini auth_webhook_log = true ``` ## auth_webhook_recording **デフォルト**: false 認証ウェブフックの戻り値で録画を開始できるかどうかを指定してください。 ```ini auth_webhook_recording = true ``` ## auth_webhook_url **デフォルト**: 指定なし 認証機能を有効にしたときに、問い合わせに行く HTTP URL を指定してください。その戻り値に含まれる値によって認証の可否を判定します。 ```ini auth_webhook_url = https://example.com/sora/webhook/auth ``` ## cluster **デフォルト**: false クラスター機能を利用するかどうかを指定してください。 ```ini cluster = true ``` ## cluster_affinity_threshold > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 10 **範囲**: 1..10000 クラスターのリレー機能とアフィニティ機能が有効な場合、 別ノードにセッションを作成するノード単位の同一セッションに対する同時接続数の基準値を指定してください。 ```ini cluster_affinity_threshold = 50 ``` ## cluster_listen_max_port > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 49020 `sora.conf` にクラスター利用時のノード間通信に使用するポート番号範囲の最大値を指定してください。 ```ini cluster_listen_max_port = 49020 ``` ## cluster_listen_min_port > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 49010 `sora.conf` にクラスター利用時のノード間通信に使用するポート番号範囲の最小値を指定してください。 ```ini cluster_listen_min_port = 49010 ``` ## cluster_relay > **注意** > > この機能を利用するには [最大ノード数ライセンス](LICENSE.html#aee259) が必要です。 **デフォルト**: true クラスターリレー機能を利用するかどうかを指定してください。 ```ini cluster_relay = true ``` ## cluster_temporary_node **デフォルト**: false テンポラリーノードとして利用するかどうかを指定してください。 ```ini cluster_temporary_node = true ``` ## connection_created_wait_timeout **単位指定必須** **デフォルト**: 30 s **範囲**: 0..600 s WebRTC SFU と WebRTC の接続が確立するまでの許容時間を指定してください。 基本的に WebRTC SFU との接続確立は数百ミリ秒で終わります。 ただし iOS などでカメラの使用などを許可するといった設定が入る場合を考慮しデフォルトは 30 秒としています。 ```ini connection_created_wait_timeout = 30 s ``` > **注釈** > > 値を 0 s にすることで、意図的に connection_created_wait_timeout のエラーを発生させることができます。 ## connection_updated_webhook_interval **デフォルト**: 1 min **範囲**: 1..10 min **単位**: min のみ 接続更新時のイベントウェブフック `connection.updated` の間隔を指定してください。 時間単位には 分 `min` のみ指定できます。 ```ini connection_updated_webhook_interval = 1 min ``` ## copy_websocket_signaling_header_names **デフォルト**: 未指定 ウェブフックやログにコピーしたい WebSocket シグナリングの HTTP ヘッダー名を指定してください。 ヘッダー名は複数指定することができます。ヘッダー名はカンマ区切りで指定してください。 ウェブフックの場合は **HTTP ヘッダー** にコピーされます。ログの場合は **copy_headers** 項目にコピーされます。 ```ini copy_websocket_signaling_header_names = X-Forwarded-For, X-Real-IP, Tracestate ``` ### ヘッダーがコピーされるウェブフック - 認証ウェブフック ### copy_headers が出力されるログ - `auth_webhook.jsonl` - `auth_webhook_error.jsonl` - `rtc_stats.jsonl` - `connection.jsonl` ## data_channel_messaging **デフォルト**: false DataChannel を使用したメッセージング機能を利用するかどうかを指定してください。 ```ini data_channel_messaging = false ``` ## data_channel_messaging_only **デフォルト**: false DataChannel メッセージングの利用時に、音声と映像を `false` にした場合でも接続できるようにするかどうかを指定してください。 ```ini data_channel_messaging_only = false ``` ## data_channel_packet_loss_simulator_incoming > **危険** > > この機能はあくまで検証時のみ有効にしてください **デフォルト**: 0 **範囲**: 0..100 Sora が受信する DataChannel パケットを指定したパーセント分ドロップさせます。 値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。 ### Sora が受信する DataChannel パケットを 10 % パケロスさせる場合 ```ini data_channel_packet_loss_simulator_incoming = 10 ``` ## data_channel_packet_loss_simulator_outgoing > **危険** > > この機能はあくまで検証時のみ有効にしてください **デフォルト**: 0 **範囲**: 0..100 Sora が送信する DataChannel パケットを指定したパーセント分ドロップさせます。 値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。 ### Sora が送信する DataChannel パケットを 10 % パケロスさせる場合 ```ini data_channel_packet_loss_simulator_outgoing = 10 ``` ## data_channel_rpc **デフォルト**: true DataChannel を使用した RPC 機能を利用するかどうかを指定してください。 この機能を利用する場合は必ず認証成功時に [rpc_methods の払い出し](AUTH_WEBHOOK_RETURN.html#a2e307) で利用できる RPC メソッド名一覧を払い出す必要があります。 ```ini data_channel_rpc = true ``` ## data_channel_signaling_close_message **デフォルト**: false Sora から DataChannel シグナリングを切断する際に `"type": "close"` メッセージを送信するかどうかを指定してください。 ```ini data_channel_signaling_close_message = true ``` ## data_channel_stats_max_retransmits > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 指定なし **範囲**: 0..8 シグナリング経路を DataChannel に切り替えた際にクライアントが統計情報を送信するときのメッセージの再送回数を指定してください。 ```ini data_channel_stats_max_retransmits = 1 ``` ## data_channel_stats_timer_interval **単位指定必須** **デフォルト**: 60 s **範囲**: 5..600 s シグナリング経路を DataChannel に切り替えた際にクライアントへの統計情報を要求する間隔を指定してください。 ```ini data_channel_stats_timer_interval = 60 s ``` ## data_dir > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: data Sora 内部で利用する情報を書き出すディレクトリを指定してください。できる限り **絶対パス** で指定してください。 ```ini data_dir = /path/to/data ``` ## default_audio_bit_rate **設定しないことをおすすめします** **単位**: k(キロ)bps **範囲**: 6..510 **デフォルト**: 指定なし 音声が使用できるビットレートを指定してください。デフォルトの場合はクライアント側の挙動に依存します。 ```ini default_audio_bit_rate = 192 ``` ## default_audio_streaming_language_code **デフォルト**: 指定なし 音声ストリーミングゲートウェイ接続時に HTTP ヘッダー `sora-audio-streaming-language-code` にデフォルトで含める文字列を指定してください。 この設定がない場合、接続時に `audio_streaming_language_code` で文字列が指定されていない場合、 音声ストリーミングが有効になっても Sora は接続の音声ストリーミングを開始しません。 ```ini default_audio_streaming_language_code = ja-JP ``` ## default_audio_streaming_result_push **デフォルト**: true 音声ストリーミングゲートウェイからのレスポンスをシグナリングプッシュ通知で送ることをデフォルトで行うかを指定してください。 ```ini default_audio_streaming_result_push = true ``` ## default_av1_param_profile **デフォルト**: 0 **範囲**: 0..2 AV1 で利用するプロファイルのデフォルト値を指定してください。 ```ini default_av1_param_profile = 0 ``` ## default_cluster_affinity > **注意** > > この機能を利用するには [最大ノード数ライセンス](LICENSE.html#aee259) が必要です。 **デフォルト**: true クラスターリレー機能利用時にアフィニティ機能を利用するかどうかのデフォルト値を指定してください。 ```ini default_cluster_affinity = true ``` ## default_connection_lifetime **デフォルト**: 未指定 **範囲**: 0..720 h デフォルトのコネクションライフタイムを指定してください。デフォルトは未指定です。 ```ini default_connection_lifetime = 1 h ``` ## default_data_channel_signaling **デフォルト**: false シグナリング経路を WebSocket から DataChannel に切り替えるかどうかを指定してください。 ```ini default_data_channel_signaling = false ``` ## default_duplicate_client_id **デフォルト**: allow **範囲**: allow, evict クライアント ID の重複による既存コネクションを破棄するかどうかを指定してください。 ```ini default_duplicate_client_id = evict ``` ## default_forwarding_pli_interval > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **単位指定必須** **デフォルト**: 10 s **範囲**: 1..90 s RTP 転送 API 利用時に、クライアントに対して PLI を送る間隔を指定してください。 ```ini 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 のデフォルト値を文字列で指定してください。 ```ini default_h264_param_profile_level_id = 42e02a ``` ## default_h265_param_level_id **デフォルト**: 93 **範囲**: 0..255 H.265 で利用するレベル ID のデフォルト値を数値で指定してください。 ```ini default_h265_param_level_id = 93 ``` ## default_ice_connection_state_disconnected_timeout > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 5 s **範囲**: 1..300 s ICE コネクションステートが `checking` から `disconnected` の状態に移行するまでの時間を指定してください。 ```ini default_ice_connection_state_disconnected_timeout = 5 s ``` ## default_ice_connection_state_failed_timeout > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 10 s **範囲**: 1..300 s ICE コネクションステートが `disconnected` から `failed` の状態に移行するまでの時間を指定してください。 ```ini default_ice_connection_state_failed_timeout = 10 s ``` ## default_ignore_disconnect_websocket **デフォルト**: false シグナリング経路を DataChannel に切り替えた際に WebSocket が切断されても接続の切断と判断しないかどうかを指定してください。 ```ini default_ignore_disconnect_websocket = false ``` ## default_playout_delay_max_delay **デフォルト**: 未指定 **単位**: ms のみ **範囲**: 0..40950 プレイアウト遅延機能を利用する際の最大値(ミリ秒)を指定してください。 ```ini default_playout_delay_min_delay = 0 ms default_playout_delay_max_delay = 100 ms ``` ## default_playout_delay_min_delay **デフォルト**: 未指定 **単位**: ms のみ **範囲**: 0..40950 プレイアウト遅延機能を利用する際の最小値(ミリ秒)を指定してください。 ```ini default_playout_delay_min_delay = 0 ms default_playout_delay_max_delay = 100 ms ``` ## default_recording_format > **重要** > > Sora 2025.2.0 から録画機能(セッション単位)のデフォルト出力フォーマットを `webm` から `mp4` に変更しました。 **デフォルト**: mp4 録画ファイルのデフォルトのフォーマットを指定してください。 `mp4` と `webm` が指定できます。 ```ini default_recording_format = mp4 ``` ## default_recording_mp4_pli_interval **デフォルト**: 20 s **範囲**: 1..240 s 録画機能(セッション単位) 利用時に MP4 形式を利用した場合、クライアントへ送るキーフレーム要求 (PLI) の間隔を指定してください。 ```ini default_recording_mp4_pli_interval = 100 s ``` ## default_rtc_stats **デフォルト**: true Sora から SDK やクライアントへ RTC 統計情報を要求するかどうかを指定してください。 SDK やクライアント側がシグナリングの `"type": "stats"` に対応している必要があります。 ```ini default_rtc_stats = true ``` ## default_sdp_setup_role_passive > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください。 **デフォルト**: false SDP の `setup` 属性のデフォルト値を `passive` にするかどうかを指定してください。 ```ini default_sdp_setup_role_passive = true ``` ## default_simulcast_auto_rids *バージョン Sora 2025.2.0 で追加。* **デフォルト**: 未指定 サイマルキャスト利用時に、視聴側の環境に合わせて rid を自動で切り替える場合に、利用する rid のリストを指定してください。 未指定の場合は自動で切り替わりません。 > **重要** > > `simulcast_rid_auto` が `true` の場合、 Sora 2025.2.0 ではまだ「視聴環境が悪化した場合に、ビットレートが低い映像に自動的に下げる」機能のみになります。「視聴環境が改善した場合にビットレートが高い映像に自動的に上げる」機能は 2026 年リース予定の Sora にて対応予定です。 ```ini default_simulcast_auto_rids = "r0", "r1" ``` ## default_simulcast_request_rid *バージョン Sora 2025.2.0 で追加。* **デフォルト**: r0 **範囲**: auto / r0 / r1 / r2 / none サイマルキャスト利用時に、視聴する rid を指定せずに接続した場合に採用される rid の値を指定してください。 デフォルトでは r0 になっています。 ```ini default_simulcast_request_rid = r2 ``` ## default_simulcast_rid > **警告** > > この設定では Sora 2025.2.0 に新しく追加された `auto` や `none` を指定することはできません。 > [default_simulcast_request_rid](SORA_CONF.html#9891c8) をご利用ください。 > **注意** > > この設定は 2027 年 12 月リリース予定の Sora にて廃止しします。 > 今後は [default_simulcast_request_rid](SORA_CONF.html#9891c8) をご利用ください。 **デフォルト**: r0 **範囲**: r0 / r1 / r2 サイマルキャスト利用時に、視聴する rid を指定せずに接続した場合に採用される rid の値を指定してください。 デフォルトでは r0 になっています。 ```ini default_simulcast_rid = r2 ``` ## default_spotlight_auto_unfocus **デフォルト**: true スポットライト機能利用時の自動アンフォーカスの有無を指定してください。 ```ini default_spotlight_auto_unfocus = true ``` ## default_spotlight_auto_unfocus_interval **デフォルト**: 10 s **範囲**: 1 ms .. 30 s スポットライト機能の自動アンフォーカスの時間間隔を指定してください。 ```ini default_spotlight_auto_unfocus_interval = 10 s ``` ## default_spotlight_delayed_focus **デフォルト**: true スポットライト機能利用時に、遅延フォーカスの有無を指定してください。 遅延フォーカスは音声が有効になってもすぐにフォーカスせず、一定時間音声が有効な際に初めてフォーカスする仕組みです。 ```ini default_spotlight_delayed_focus = true ``` ## default_spotlight_delayed_focus_interval **デフォルト**: 2000 ms **範囲**: 1..60000 ms スポットライト機能利用時に、遅延フォーカスが有効な際に、どの程度遅延をさせるか指定してください。 ```ini default_spotlight_delayed_focus_interval = 2000 ms ``` ## default_spotlight_focus_min_interval **デフォルト**: 2000 ms **範囲**: 0 ms .. 60 s スポットライト機能でフォーカスしてからアンフォーカスされるまでの最低時間間隔を指定してください。 ```ini default_spotlight_focus_min_interval = 2000 ms ``` ## default_spotlight_focus_rid **デフォルト**: r1 **指定できる rid**: none / r0 / r1 / r2 スポットライト機能利用時に、フォーカスした際に利用する rid を指定してください。 none は映像自体を配信しません。 ```ini default_spotlight_focus_rid = r1 ``` ## default_spotlight_number **デフォルト**: 1 **範囲**: 1..8 スポットライトで同時にフォーカスされるデフォルトの数を指定してください。 ```ini default_spotlight_number = 2 ``` ## default_spotlight_unfocus_audio **デフォルト**: true スポットライト機能利用時に、フォーカスなしでの音声配信を指定してください。 ```ini default_spotlight_unfocus_audio = false ``` ## default_spotlight_unfocus_audio_rate_limit **デフォルト**: 5 **範囲**: 0..20 スポットライト機能利用時に、フォーカスなしの音声転送の上限レートを指定してください。 単位は 1 音声ストリーム = 50 packets / s となります。 ```ini default_spotlight_unfocus_audio_rate_limit = 5 ``` ## default_spotlight_unfocus_rid **デフォルト**: r0 **範囲**: none, r0, r1, r2 スポットライト機能利用時に、フォーカスなしで利用する rid を指定してください。 none は映像自体を配信しません。 ```ini default_spotlight_unfocus_rid = none ``` ## default_video_bit_rate **デフォルト**: 500 **単位**: k(キロ)bps **範囲**: 1..50000 映像が使用できるビットレートを指定してください。デフォルトでは 500kbps です。この値を少なく指定すると解像度が不安定になります。 基本は 500 で余裕があるのであれば 800 などに設定することをお勧めします。 15000 より大きい値はまだ十分に検証ができていないため、現時点ではサポート外となります。ご了承ください。 ```ini default_video_bit_rate = 500 ``` ## default_vp9_param_profile_id **デフォルト**: 0 **範囲**: 0..3 VP9 で利用するプロファイル ID のデフォルト値を指定してください。 ```ini default_vp9_param_profile_id = 0 ``` ## event_webhook_connection_updated_log **デフォルト**: true `event_webhook.jsonl` に `connection.updated` を出力するかどうかを指定してください。デフォルトでは出力します。 ```ini event_webhook_connection_updated_log = false ``` ## event_webhook_url **デフォルト**: 指定なし クライアントの接続や切断、録画ファイル生成の終了などのイベントを通知する HTTP URL を指定してください。 ```ini event_webhook_url = https://example.com/sora/webhook/event ``` ## event_webhook_worker_key *バージョン 2025.1.0 で追加。* **デフォルト**: channel_id **範囲**: channel_id または connection_id イベントウェブフックのワーカー割り当てに利用する値を指定してください。 ```ini event_webhook_worker_key = connection_id ``` ## event_webhook_worker_number **デフォルト**: 100 **範囲**: 5..5000 イベントウェブフックのワーカー数を指定してください。 イベントウェブフックのワーカー割り当てに利用する値は [event_webhook_worker_key](SORA_CONF.html#d73d7a) で指定した値です。 ```ini event_webhook_worker_number = 100 ``` ## external_api_url **デフォルト**: 指定なし ノードに対する Sora API の URL を指定してください。クラスター機能のリダイレクト時に用います。 ```ini external_api_url = http://127.0.0.1:3000/ ``` ## external_signaling_url **デフォルト**: 指定なし ノードに対するシグナリング URL を指定してください。クラスター機能のリダイレクト時に用います。 ```ini external_signaling_url = ws://127.0.0.1:5000/signaling ``` ## forwarding_simulcast > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **単位指定必須** **デフォルト**: single RTP 転送 API 利用時にサイマルキャストの転送オプションを指定してください。 - `single` は最も優先度の低いストリームのみを転送します - `all` はすべてのストリームを転送します ```ini forwarding_simulcast = all ``` ## generic_nack > **注意** > > この設定を無効にする場合は事前にサポートまでご連絡ください **デフォルト**: true Generic NACK を有効にするかどうかを指定してください。一つのチャネルに対して、 視聴者がかなり多い場合などはこの設定を無効にすることで、サーバー側の負荷を抑えることができるようになります。 ```ini generic_nack = true ``` ## h264_b_frame > **重要** > > 2026 年 6 月 時点で Sora SDK では B-frame を利用することはできません。 **デフォルト**: false H.264 で B-frame が利用できるようになります。 ```ini h264_b_frame = true ``` ## h265_b_frame > **重要** > > 2026 年 6 月 時点で Sora SDK では B-frame を利用することはできません。 **デフォルト**: false H.265 で B-frame が利用できるようになります。 ```ini h265_b_frame = true ``` ## hide_origin_username **デフォルト**: false 有効にした場合は SDP の Offer 時に送られる o= の username の部分を `shiguredo...SORA-` から `_` に変更します。 ```ini hide_origin_username = false ``` ## ignore_archive_available_webhook **デフォルト**: false 録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック `split-archive.available` リクエストを `event_webhook_url` に登録された URL に送信するかどうかを指定してください。 ```ini ignore_archive_available_webhook = true ``` ## ignore_archive_failed_webhook **デフォルト**: false 録画機能で、録画が失敗した場合に、 `event_webhook_url` に登録された URL に `archive.failed` リクエストを送るかどうかを指定してください。 ```ini ignore_archive_failed_webhook = true ``` ## ignore_archive_started_webhook **デフォルト**: false 録画機能で、コネクションのアーカイブを開始した場合に、 イベントウェブフック `event_webhook_url` に登録された URL に `archive.started` リクエストを送信するかどうかを指定してください。 デフォルトではリクエストの送信を行います。 この設定が `true` の場合でも、 `event_webhook.jsonl` には `archive.started` のログが出力されます。 ```ini 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` のログが出力されます。 ```ini 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` のログが出力されます。 ```ini ignore_audio_streaming_webhook = false ``` ## ignore_connection_failed_webhook **デフォルト**: true 接続が失敗時に `event_webhook_url` に指定された URL へ `connection.failed` リクエストを送るかどうかを指定してください。 デフォルトではリクエストの送信を行いません。 この設定が `true` の場合でも、 `event_webhook.jsonl` には `connection.failed` のログが出力されます。 ```ini ignore_connection_failed_webhook = false ``` ## ignore_connection_rtc_webhook **デフォルト**: false クライアントから RTC 統計情報が送られてきた際、 統計ウェブフック `connection.rtc` リクエストを `stats_webhook_url` に登録された URL に送信するかどうか指定してください。 デフォルトではリクエストの送信を行います。 ログの出力は [stats_webhook_url](SORA_CONF.html#1f750f) をご確認ください。 ```ini ignore_connection_rtc_webhook = true ``` ## ignore_connection_updated_webhook **デフォルト**: false イベントウェブフックの接続の更新時に `event_webhook_url` に指定された URL へ `connection.updated` を送るかどうかを指定してください。 デフォルトではリクエストの送信を行います。 この設定が `true` の場合でも、 `event_webhook.jsonl` には `connection.updated` のログが出力されます。 ```ini ignore_connection_updated_webhook = false ``` ## ignore_recording_report_webhook **デフォルト**: false 録画レポートが送信された場合に、 `event_webhook_url` に登録された URL に `recording.report` リクエストを送るかどうかを指定してください。 ```ini 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` のログが出力されます。 ```ini ignore_recording_started_webhook = true ``` ## ignore_session_destroyed_webhook **デフォルト**: false セッションが破棄された場合に、 `session_webhook_url` に登録された URL に `session.destroyed` リクエストを送るかどうかを指定してください。 ```ini ignore_session_destroyed_webhook = true ``` ## ignore_session_updated_webhook **デフォルト**: false セッションウェブフックのセッションの更新時に `session_webhook_url` に指定された URL へ `session.updated` を送るかどうかを指定してください。 デフォルトではリクエストの送信を行います。 この設定が `true` の場合でも、 `session_webhook.jsonl` には `session.updated` のログが出力されます。 ```ini ignore_session_updated_webhook = false ``` ## ignore_split_archive_available_webhook **デフォルト**: false 録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック `split-archive.available` リクエストを送信するかどうかを指定してください。 デフォルトではリクエストの送信を行います。 この設定が `true` の場合でも、 `event_webhook.jsonl` には `split-archive.available` のログが出力されます。 ```ini ignore_split_archive_available_webhook = true ``` ## ignore_split_archive_end_webhook **デフォルト**: false 録画機能で、分割録画を含む場合に分割した録画ファイルが利用可能になった際、 イベントウェブフック `split-archive.available` リクエストを `event_webhook_url` に登録された URL に送信するかどうかを指定してください。 ```ini 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` のログが **出力されません** 。 ```ini ignore_spotlight_changed_webhook = true ``` ## ignore_turn_five_tuple > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false TURN 利用時に送られてくるパケットの 5-TUPLE を無視するかどうかを指定してください。 ```ini ignore_turn_five_tuple = true ``` ## ipv4_address **デフォルト**: 未指定 この値を有効にしなくても自動で IPv4 アドレスを収集しますが、 固定された IPv4 アドレスがサーバーに割り当てられている場合は指定することを推奨しています。 IPv4 アドレスを指定してください。 `192.0.2.10` のように指定してください。 ```ini ipv4_address = 192.0.2.10 ``` ## ipv6 **デフォルト**: false IPv6 機能を有効にするかどうか指定してください。デフォルトでは無効になっています。 この機能を有効にすると以下の機能が有効になります - ipv6_address が指定されていない場合は自動で IPv6 アドレスが収集される - ipv6_address で指定された値が使用される - IPv6 アドレスが使用できる場合、 TURN サーバーの URL が IPv6 でも払い出される この機能はシグナリングや API を IPv6 有効にする機能ではありません。シグナリングや API は IPv6 非対応です。 ```ini ipv6 = false ``` ## ipv6_address **デフォルト**: 未指定 この値を有効にしなくても ipv6 が true の場合は、自動で IPv6 アドレスを収集しますが、 固定された IPv6 アドレスがサーバーに割り当てられている場合は指定することを推奨しています。 IPv6 アドレスを指定してください。 `2001:0DB8::10` のように指定してください。 ```ini ipv6_address = 2001:0DB8::10 ``` ## ipv6_only **デフォルト**: false IPv6 アドレスのみを利用するようになります。この設定はシグナリングや API には影響しません。 ```ini ipv6_only = true ``` ## label **デフォルト**: "WebRTC SFU Sora" 認証やイベントウェブフックリクエスト送信時に送られる、サーバー固有の値を指定してください。 ```ini label = sora-node-001.example.com ``` ## legacy_cluster_relay > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください。 **デフォルト**: false クラスタリングリレー機能のレガシーモードを有効にするかどうかを指定してください。 ```ini legacy_cluster_relay = true ``` ## license_file **デフォルト**: "etc/license.json" ライセンスファイルのパスを指定してください。できる限り **絶対パス** を指定してください。 ```ini license_file = etc/license.json ``` ## log_dir **デフォルト**: log ログファイルの出力先ディレクトリを指定してください。デフォルトではパッケージディレクトリ以下の `log` ディレクトリに出力されます。 - 相対パスで指定した場合は Sora のパッケージディレクトリ (`sora-/`) からの相対パスになります - 絶対パスで指定した場合は指定したパスになります ```ini log_dir = /var/log/sora ``` ## max_connections **デフォルト**: ライセンスで許可された最大同時接続数 この Sora で許可する最大同時接続数を指定してください。 ```ini max_connections = 50 ``` ## media_publish_worker_autoscale_threshold *バージョン 2025.1.0 で追加。* **デフォルト**: 50 **範囲**: 1..1000 音声や映像の 1 配信ワーカーが担当する視聴者数を指定してください。ただし、デフォルトで十分なことがほとんどです。 ```ini media_publish_worker_autoscale_threshold = 20 ``` ## multistream_auto_sharing_video_bit_rate **デフォルト**: false マルチストリームで配信者が利用する映像ビットレートを自動で共有する機能です。 映像のビットレートに 1000kbps を指定した場合 4 人の配信者がいる場合はそれぞれの配信者のビットレートは 250kbps になります。 ```ini multistream_auto_sharing_video_bit_rate = true ``` ## node_name **デフォルト**: 指定なし クラスター機能で利用するノード名を指定してください。 ノード名の @ の前には、正規表現 `[0-9A-Za-z_\\-]+` にマッチする文字列を指定してください。 また @ の後ろには、サーバーのドメイン名（FQDN）や、IP アドレスを指定してください。 ```ini node_name = sora@192.0.2.10 ``` ## 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 録画で一括＆分割録画を利用できるようにするかどうかを指定してください。 > **重要** > > この設定が false になっている際に一括＆分割録画をしようとするとエラーになります ```ini recording_dual_output = false ``` ## recording_expire_time_required **デフォルト**: false > **重要** > > この設定は一括録画時に録画ファイルが大きくなりすぎるのを防ぐための設定です。 録画で一括または一括＆分割録画時に `expire_time` の指定を必須にするかどうかを指定してください。 ```ini recording_expire_time_required = true ``` ## recording_max_expire_time **デフォルト**: 86400 s **範囲**: 1..86400 s 録画時に指定する `expire_time` の最大値を指定してください。 ```ini recording_max_expire_time = 10 min ``` ## recording_max_split_duration **デフォルト**: 86400 s **範囲**: 1..86400 s 録画で分割または一括＆分割録画時に `split_duration` の最大値を指定してください。 ```ini recording_max_split_duration = 10 min ``` ## recycle_media_section **デフォルト**: true SDP でアクティブではなくなったメディアセクション （m=） を再利用する機能を有効化するかどうかを指定してください。 ```ini recycle_media_section = false ``` ## rtc_stats_log **デフォルト**: false SDK やクライアントから送られてきた RTC 統計情報をログとして保存するかどうかを指定してください。 デフォルトではログは保存されません。 > **警告** > > ログはかなりの量になるため、利用する際は注意してください ```ini rtc_stats_log = true ``` ## rtp_hdrext_abs_capture_time **デフォルト**: false RTP ヘッダー拡張 [http://www.webrtc.org/experiments/rtp-hdrext/abs-capture-time](https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/abs-capture-time) を利用するかどうかを指定してください。 ```ini rtp_hdrext_abs_capture_time = true ``` ## rtp_hdrext_color_space > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false RTP ヘッダー拡張 [http://www.webrtc.org/experiments/rtp-hdrext/color-space](https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/color-space) を利用するかどうかを指定してください。 ```ini rtp_hdrext_color_space = true ``` ## rtp_hdrext_dependency_descriptor_vp9 > **警告** > > この設定を `true` にした場合、 Firefox で VP9 が利用できなくなります。 **デフォルト**: false RTP ヘッダー拡張 [https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension](https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension) を VP9 で利用するかどうかを指定してください。 ```ini rtp_hdrext_dependency_descriptor_vp9 = true ``` ## rtp_hdrext_playout_delay **デフォルト**: true RTP ヘッダー拡張 [http://www.webrtc.org/experiments/rtp-hdrext/playout-delay](https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/playout-delay) を利用するかどうかを指定してください。 ```ini rtp_hdrext_playout_delay = false ``` ## rtp_hdrext_sdes_mid > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false RTP ヘッダー拡張 [urn:ietf:params:rtp-hdrext:sdes:mid](https://www.rfc-editor.org/rfc/rfc9143.html) を利用するかどうかを指定してください。 ```ini rtp_hdrext_sdes_mid = true ``` ## rtp_hdrext_video_content_type > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false RTP ヘッダー拡張 [http://www.webrtc.org/experiments/rtp-hdrext/video-content-type](https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/video-content-type) を利用するかどうかを指定してください。 ```ini rtp_hdrext_video_content_type = true ``` ## rtp_hdrext_video_orientation > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false RTP ヘッダー拡張 `urn:3gpp:video-orientation` を利用するかどうかを指定してください。 ```ini rtp_hdrext_video_orientation = true ``` ## rtp_hdrext_video_timing > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false RTP ヘッダー拡張 [http://www.webrtc.org/experiments/rtp-hdrext/video-timing](https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/video-timing) を利用するかどうかを指定してください。 ```ini rtp_hdrext_video_timing = true ``` ## rtp_packet_loss_simulator_incoming > **危険** > > この機能はあくまで検証時のみ有効にしてください **デフォルト**: 0 **範囲**: 0..100 Sora が受信する RTP パケットを指定したパーセント分ドロップさせます。 値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。 ### Sora が受信する RTP パケットを 10 % パケロスさせる場合 ```ini rtp_packet_loss_simulator_incoming = 10 ``` ## rtp_packet_loss_simulator_outgoing > **危険** > > この機能はあくまで検証時のみ有効にしてください **デフォルト**: 0 **範囲**: 0..100 Sora が送信する RTP パケットを指定したパーセント分ドロップさせます。 値を 0 より大きくした場合、クライアントが接続するたびに warning が発生します。 ### Sora が送信する RTP パケットを 10 % パケロスさせる場合 ```ini rtp_packet_loss_simulator_outgoing = 10 ``` ## rtx > **注意** > > この設定を無効にする場合は事前にサポートまでご連絡ください **デフォルト**: true RTX を有効にするかどうかを指定してください。デフォルトでは true で有効になっています。 現時点では Chrome / Safari / Edge / Firefox が使用できます。 iOS / Android / Unity は libwebrtc の最新版を利用している場合は対応しています。 ```ini rtx = false ``` ## session_created_response_validate_warning_as_error > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false セッションウェブフック [session.created](SESSION_WEBHOOK.html#1d1984) の戻り値が正常でない場合にエラーとし、セッションを破棄するかどうかを指定してください。 > **注釈** > > この設定が false の場合、戻り値が正常でない場合は sora ログに警告が出力され、デフォルトの戻り値が設定されます。 > セッションも破棄されません。 ```ini session_created_response_validate_warning_as_error = true ``` ## session_created_timeout **デフォルト**: 5 s **範囲**: 0..300 s セッションが存在しない状態で、新規接続が来た際にセッション生成に利用できる時間を指定してください。 この時間はセッションウェブフックにかかる時間も含まれます。 ```ini session_created_timeout = 5 s ``` ## session_destroyed_timeout **デフォルト**: 15 s **範囲**: 0..300 s セッションに同時接続数が 0 になった場合、セッション破棄する時間を指定してください。 ```ini session_destroyed_timeout = 15 s ``` ## session_updated_webhook_interval **デフォルト**: 1 min **範囲**: 1..10 min **単位**: min のみ セッション更新時のセッションウェブフック `session.updated` の間隔を指定してください。 時間単位には 分 `min` のみ指定できます。 ```ini session_updated_webhook_interval = 1 min ``` ## session_webhook_session_updated_log **デフォルト**: true `session_webhook.jsonl` に `session.updated` を出力するかどうかを指定してください。デフォルトでは出力します。 ```ini session_webhook_session_updated_log = false ``` ## session_webhook_url **デフォルト**: 指定なし セッションに関連するウェブフックリクエスト送信先の HTTP URL を指定してください。 ```ini session_webhook_url = https://example.com/sora/webhook/session ``` ## signaling_av1_params **デフォルト**: false シグナリングで AV1 のパラメーターを指定できるようにするかを指定してください。 ```ini signaling_av1_params = true ``` ## signaling_bundle_id **デフォルト**: false シグナリングでバンドル ID を指定できるようにするかを指定してください。 ```ini signaling_bundle_id = true ``` ## signaling_forwarding_filters **デフォルト**: false 転送フィルターをシグナリング接続時に設定できるかどうかを指定してください。 ```ini signaling_forwarding_filters = true ``` ## signaling_h264_params **デフォルト**: false シグナリングで H.264 のパラメーターを指定できるようにするかを指定してください。 ```ini signaling_h264_params = true ``` ## signaling_h265_params **デフォルト**: false シグナリングで H.265 のパラメーターを指定できるようにするかを指定してください。 ```ini signaling_h265_params = true ``` ## signaling_loopback_address_only **デフォルト**: false シグナリングへのアクセスをループバックアドレスからのみに制限します。できる限り有効にしてください。 ```ini signaling_loopback_address_only = true ``` ## signaling_normal_close_reason **デフォルト**: true 正常切断時の `reason` に切断理由を含むかどうかを指定してください。 `false` を指定した場合は空文字 `""` が含まれるようになります。 ```ini signaling_normal_close_reason = false ``` ## signaling_notify **デフォルト**: true シグナリング経由で接続や切断、更新の通知を受け取るかどうか指定してください。この設定はすべての設定に影響します。 個別の設定の場合は認証ウェブフックのレスポンス時で指定してください。 シグナリング経由での通知機能の詳細は [シグナリング通知機能](SIGNALING_NOTIFY.html) をご確認ください 認証の戻り値に関しては [認証ウェブフックの戻り値での指定](SIGNALING_NOTIFY.html#28d39f) を確認してください。 ```ini signaling_notify = true ``` ## signaling_notify_audio_streaming_failed **デフォルト**: false シグナリング通知機能が有効な際、音声ストリーミングサーバーへの接続が失敗した際にチャネル参加者全員に通知をするかどうかを指定してください。 ```ini signaling_notify_audio_streaming_failed = true ``` ## signaling_notify_authn_metadata_max_size **デフォルト**: 64512 **範囲**: 0..1048576 > **注釈** > > この設定を 0 にすることでクライアントからシグナリング通知メタデータを指定できなくなります。 クライアントから接続時に送られてくるシグナリング通知メタデータの最大サイズをバイト単位で指定してください。 ```ini signaling_notify_authn_metadata_max_size = 64512 ``` ## signaling_notify_bundle_id **デフォルト**: true シグナリング通知機能が有効な際、通知にバンドル ID を含むかどうかを指定してください。 ```ini signaling_notify_bundle_id = true ``` ## signaling_notify_client_id **デフォルト**: true シグナリング通知機能が有効な際、通知にクライアント ID を含むかどうかを指定してください。 ```ini signaling_notify_client_id = true ``` ## signaling_notify_connection_created_timestamp **デフォルト**: true シグナリング通知機能が有効な際、 `"event_type": "connection.created"` に `timestamp` を含むかどうかを指定してください。 ```ini signaling_notify_connection_created_timestamp = true ``` ## signaling_notify_connection_id **デフォルト**: true シグナリング通知機能が有効な際、通知にコネクション ID を含むかどうかを指定してください。 ```ini signaling_notify_connection_id = true ``` ## signaling_notify_forwarding_filter **デフォルト**: true シグナリング通知機能が有効な際、 転送フィルターのブロック開始とブロック解除の通知をするかどうかを指定してください。 ```ini signaling_notify_forwarding_filter = true ``` ## signaling_notify_ice_connection_state **デフォルト**: false シグナリング通知機能が有効な際、 ICE 接続の状態を自分を含む同一セッションに参加しているクライアント全員に通知するかどうかを指定してください。 ```ini signaling_notify_ice_connection_state = true ``` ## signaling_notify_media **デフォルト**: true シグナリング通知機能が有効な際、通知に音声や映像が有効かどうかを含むかどうかを指定してください。 ```ini signaling_notify_media = true ``` ## signaling_notify_metadata **デフォルト**: true シグナリング通知機能が有効な際、 `"type": "connect"` の `signaling_notify_metadata` で指定した値、 または認証ウェブフックの戻り値の `signaling_notify_metadata` で指定した値を通知するかどうかを指定してください。 ```ini signaling_notify_metadata = true ``` ## signaling_notify_metadata_ext **デフォルト**: false シグナリング通知メタデータ拡張機能を有効にするかどうかを指定してください。 シグナリング通知機能が無効でも通知されないだけで API は利用できます。 詳細は [シグナリング通知メタデータ拡張機能](SIGNALING_NOTIFY_METADATA_EXT.html) をご確認ください。 ```ini signaling_notify_metadata_ext = true ``` ## signaling_notify_network **デフォルト**: true シグナリング通知機能が有効な際、ネットワークの状態を通知するかどうかを指定してください。 ```ini signaling_notify_network = true ``` ## signaling_notify_network_status_interval **デフォルト**: 10 s **範囲**: `20 ms` .. `10 min` シグナリング通知が有効な際、ネットワーク状態の通知間隔を指定してください。 ```ini signaling_notify_network_status_interval = 30 s ``` ## signaling_notify_recording **デフォルト**: true シグナリング通知機能が有効な際、 録画の開始と停止の状態を通知するかどうかを指定してください。 ```ini signaling_notify_recording = true ``` ## signaling_notify_session_id **デフォルト**: true シグナリング通知機能が有効な際、通知にセッション ID を含むかどうかを指定してください。 ```ini signaling_notify_session_id = true ``` ## signaling_notify_simulcast_switched **デフォルト**: true シグナリング通知機能が有効な際、サイマルキャストの rid の切り替わりを通知するかどうかを指定してください。 ```ini signaling_notify_simulcast_switched = true ``` ## signaling_notify_spotlight **デフォルト**: true シグナリング通知が有効な際、スポットライトがフォーカス/アンフォーカスに切り替わったことを通知するかどうかを指定してください。 ```ini signaling_notify_spotlight = false ``` ## signaling_port **デフォルト**: 5000 シグナリングに使用するポート番号を指定してください。 ```ini signaling_port = 5000 ``` ## signaling_vp9_params **デフォルト**: false シグナリングで VP9 のパラメーターを指定できるようにするかを指定してください。 ```ini signaling_vp9_params = true ``` ## simulcast_auto_min_switch_interval **デフォルト**: 5 s **範囲**: 1..300 s サイマルキャスト機能利用時に、 `simulcast_auto_rids` を指定した際、自動で切り替わる最小の間隔を秒数で指定してください。 ```ini simulcast_auto_min_switch_interval = 10 s ``` ## simulcast_codecs_file > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: なし サイマルキャストマルチコーデックで利用するコーデックパラメーターのカスタマイズを JSON 形式のファイルで指定してください。 詳細は [サイマルキャストマルチコーデックのデフォルト値を変更する](SIMULCAST_MULTICODEC.html#48a6a7) をご確認ください。 ```ini simulcast_codecs_file = etc/simulcast_codecs.json ``` ## simulcast_encodings_file **デフォルト**: なし サイマルキャストで利用するエンコーディングパラメーターのカスタマイズを JSON 形式のファイルで指定してください。 詳細は [映像のエンコーディングパラメーターのカスタマイズ](SIMULCAST.html#6c680e) をご確認ください。 ```ini simulcast_encodings_file = etc/simulcast_encodings.json ``` ## simulcast_multicodec > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false サイマルキャストマルチコーデックを有効にするかどうかを指定してください。 ```ini simulcast_multicodec = true ``` ## skip_redact_sensitive_data **デフォルト**: false ログファイル中のセンシティブなデータを **"REDACTED"** という文字列に書き換えて出力する処理をスキップします。 ```ini 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.html#bd05eb) をご確認ください。 ```ini spotlight_encodings_file = etc/spotlight_encodings.json ``` ## stats_webhook_log **デフォルト**: false 統計ウェブフックのログをファイルに出力します。 ```ini stats_webhook_log = true ``` ## stats_webhook_url **デフォルト**: 指定なし 統計情報を通知する HTTP URL を指定してください。 ```ini stats_webhook_url = https://example.com/sora/webhook/stats ``` ## stats_webhook_worker_number **デフォルト**: 5 **範囲**: 5..5000 統計ウェブフックのワーカー数を指定してください。 統計ウェブフックのワーカー割り当てに利用する値は `channel_id` です。 ```ini stats_webhook_worker_number = 5 ``` ## switched_websocket_signaling_ping_interval **デフォルト**: 15 s **範囲**: 5..300 s シグナリングが DataChannel に切り替わった後、サーバーからクライアントへ WebSocket 経由でネットワーク死活監視のために `"type": "ping"` を送信する間隔を指定してください。 ```ini switched_websocket_signaling_ping_interval = 15 s ``` > **重要** > > デフォルト値を 15 秒にしているのは、一部の Apple iPad Safari で `"type": "switched"` 後に `"type": "ping"` の送信間隔が 30 秒だと WebSocket が切断されてしまう問題が発生したためです。 ## test_api **デフォルト**: false テスト用 API 機能を有効にするかどうかを指定してください。デフォルトでは無効になっています。 ```ini test_api = true ``` ## turn_fqdn **デフォルト**: なし TURN 機能の URL で使用する FQDN (最後の . なし) を指定してください。 指定した場合は TURN-UDP, TURN-TCP, TURN-TLS に共通で採用されます。 TURN-TLS の FQDN は `turn_tls_fqdn` 設定で上書きできます。 ### ドメイン名が sora-turn.example.com の場合 ```ini turn_fqdn = sora-turn.example.com ``` ## turn_realm **デフォルト**: "sora-turn.example.com" TURN 機能で使用するレルムを指定してください。 文字列であれば何でも良いのですが、会社のドメインなどを指定することをおすすめします。 ```ini turn_realm = sora-turn.example.com ``` ## turn_tcp **デフォルト**: true TURN 機能で TURN-TCP を使用するかどうかを指定してください。使用しない場合は false を指定してください。 ### 使用しない場合の設定 ```ini turn_tcp = false ``` ## turn_tcp_allocate_success_delay_time **デフォルト**: 100 ms **範囲**: 0..1 s TURN 機能で TURN-TCP 時の Allocate-Success を返す時間を遅らせます。 ```ini turn_tcp_allocate_success_delay_time = 100 ms ``` ## turn_tcp_listen_port **デフォルト**: 3478 TURN 機能で TURN-TCP を有効にした際に使用するポート番号を指定してください。デフォルトでは 3478 番ポートが使用されます。 ```ini turn_tcp_listen_port = 3478 ``` ## turn_tcp_only **デフォルト**: false > **危険** > > この機能はあくまで検証時のみ有効にしてください TURN-TCP を強制的に利用するようになります。この機能を有効にした場合 warning ログが出力されます。 ### 検証する場合 ```ini turn_tcp_only = true ``` ## turn_tcp_port **デフォルト**: turn_tcp_listen_port の値を利用 TURN 機能で TURN-TCP URL 払い出し時のポート番号を指定してください。デフォルトでは turn_tcp_listen_port の値が利用されます。 ```ini turn_tcp_port = 3478 ``` ## turn_tls **デフォルト**: false TURN 機能で TURN-TLS の URL 払い出し機能を使用するかどうかを指定してください。使用しない場合は false を指定してください。 ```ini turn_tls = true ``` ## turn_tls_fqdn TURN 機能で TURN-TLS の URL で使用する FQDN (最後の . なし) を指定してください。 指定しない場合は `turn_fqdn` の値が採用されます。 どちらも設定されていない場合 TURN-TLS を利用することはできません。 ### ドメイン名が sora.example.com の場合 ```ini turn_tls_fqdn = sora-turn.example.com ``` ## turn_tls_only **デフォルト**: false > **危険** > > この機能はあくまで検証時のみ有効にしてください TURN-TLS を強制的に利用するようになります。この機能を有効にした場合 warning ログが出力されます。 ### 検証する場合 ```ini turn_tls_only = true ``` ## turn_tls_port **デフォルト**: 5349 TURN 機能で TURN-TLS の URL 払い出し機能を有効にした際に使用するポート番号を指定してください。デフォルトでは 5349 番ポートが使用されます。 ```ini 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](SORA_CONF.html#56ea52) で指定した秒数の間に 60 回を超えた場合、 サイレントディスカードします。 ```ini 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](SORA_CONF.html#5deefa) で指定した回数を超えた場合、 サイレントディスカードします。 ```ini turn_udp_allocate_request_401_rate_limit_window = 60 s ``` ## ulpfec > **注意** > > この設定を有効にする場合は事前にサポートまでご連絡ください **デフォルト**: false ULPFEC を有効にするかどうかを指定してください。デフォルトでは無効になっています。 現時点では Chrome と Safari が使用でき、 Firefox は対応しておりません。 iOS/Android は libwebrtc を使用した場合は対応しています。 ```ini ulpfec = false ``` ## webhook_basic_authn **デフォルト**: false ウェブフックで HTTP ベーシック認証を利用するかどうかを指定してください。 ```ini webhook_basic_authn = true ``` ## webhook_basic_authn_password **デフォルト**: 指定なし ウェブフックで HTTP ベーシック認証を利用する際のパスワードを指定してください。 `basic-authn-password` のように文字列で指定してください。 ```ini webhook_basic_authn_password = basic-authn-password ``` ## webhook_basic_authn_user_id **デフォルト**: 指定なし ウェブフックで HTTP ベーシック認証を利用する際のユーザー ID を指定してください。 `basic-authn-user-id` のように文字列で指定してください。 ```ini webhook_basic_authn_user_id = basic-authn-user-id ``` ## webhook_connect_timeout **デフォルト**: 30 s **範囲**: 1..600 s ウェブフックの接続確立までのタイムアウト時間を指定してください。 ```ini webhook_connect_timeout = 120 s ``` ## webhook_insecure > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false ウェブフックで HTTPS を利用する際に証明書のチェックを行わない場合はこの設定を有効にしてください。 ```ini webhook_insecure = true ``` ## webhook_ipv6 **デフォルト**: false ウェブフックで IPv6 を利用するかどうかを指定してください。 この設定を `true` にしない限り、ウェブフックでは IPv4 が利用されます。 ```ini webhook_ipv6 = true ``` ## webhook_proxy_auth_password **指定しない場合はコメントアウトしたままにしてください** **デフォルト**: 指定なし ウェブフックで利用する HTTP Proxy の認証パスワードを指定してください。 `proxy-auth-password` のように文字列で指定してください。 ```ini webhook_proxy_auth_password = proxy-auth-password ``` ## webhook_proxy_auth_user **指定しない場合はコメントアウトしたままにしてください** **デフォルト**: 指定なし ウェブフックで利用する HTTP Proxy の認証ユーザーを指定してください。 `proxy-auth-user` のように文字列で指定してください。 ```ini webhook_proxy_auth_user = proxy-auth-user ``` ## webhook_proxy_url **指定しない場合はコメントアウトしたままにしてください** **デフォルト**: 指定なし ウェブフックで利用する HTTP Proxy の URL を指定してください。 `http://proxy.example.com:8080` のように URL を指定してください。 ```ini webhook_proxy_url = http://proxy.example.com:8080 ``` ## webhook_response_timeout **デフォルト**: 5 s **範囲**: 1..600 s ウェブフックのレスポンス受信までのタイムアウト時間を指定してください。 ```ini webhook_response_timeout = 5 s ``` ## webhook_tls_fullchain_file **デフォルト**: 指定なし ウェブフックリクエスト送信先との通信に HTTPS で mTLS を利用するための設定で、 中間証明書を含むクライアント証明書を PEM 形式で設定してください。 ```ini webhook_tls_fullchain_file = /path/to/fullchain.pem ``` ## webhook_tls_privkey_file **デフォルト**: 指定なし ウェブフックリクエスト送信先との通信に HTTPS で mTLS を利用するための設定で、 クライアント証明書の秘密鍵を PEM 形式で設定してください。 > **危険** > > 秘密鍵にパスフレーズが設定されている場合エラーとなります ```ini webhook_tls_privkey_file = /path/to/privkey.pem ``` ## webhook_tls_verify_cacert_file **指定しない場合はコメントアウトしたままにしてください** **デフォルト**: 指定なし ウェブフックリクエスト送信先との通信に HTTPS を利用した際、サーバー証明書のチェックを行う CA ファイルを PEM 形式で設定してください。 ```ini webhook_tls_verify_cacert_file = /path/to/server_cacert.pem ``` > **重要** > > この設定がない場合、 OS 組み込みのルート CA 証明書を利用してサーバー証明書をチェックします。 > OS 組み込みのルート CA 証明書については [ウェブフックリクエストなどの送信先サーバー証明書の検証に利用する OS 組み込みのルート CA 証明書について](WEBHOOK.html#e8a845) をご確認ください。 ## websocket_signaling_ping_interval **デフォルト**: 5 s **範囲**: 5..300 s WebSocket 経由のシグナリングの場合に、サーバーからクライアントへネットワーク死活監視のために `"type": "ping"` を送信する間隔を指定してください。 > **重要** > > ここで指定する値は [websocket_signaling_pong_timeout](SORA_CONF.html#140464) より短くしてください。 ```ini websocket_signaling_ping_interval = 5 s ``` ## websocket_signaling_pong_timeout **デフォルト**: 60 s **範囲**: 60..600 s WebSocket 経由のシグナリングの場合に、クライアントから返却される `"type": "pong"` のタイムアウト時間を指定してください。 この時間内に `"type": "pong"` が返却されない場合はサーバーから接続を切断します。 > **重要** > > ここで指定する値は [websocket_signaling_ping_interval](SORA_CONF.html#27aae2) より長くしてください。 ```ini websocket_signaling_pong_timeout = 60 s ``` ## websocket_stats_timer_interval **デフォルト**: 60 s **範囲**: 5..600 s WebSocket 経由のシグナリングの場合に、サーバーからクライアントに統計情報の送信を要求する `"stats": true` を設定する間隔を指定してください。 ```ini websocket_stats_timer_interval = 60 s ``` ## whep > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: false OBS の WHEP 形式のシグナリングを有効にするかどうか指定してください。 ```ini whep = true ``` ## whep_bearer_token_metadata_key > **注意** > > この設定を利用する場合は事前にサポートまでご連絡ください **デフォルト**: 指定なし OBS の WHEP 形式のシグナリング時の Authentication ヘッダーに含まれるトークンを、メタデータとして送信する際のキーを指定してください。 ```ini whep_bearer_token_metadata_key = access_token ``` ## whip **デフォルト**: false OBS の WHIP 形式のシグナリングを有効にするかどうか指定してください。 ```ini whip = true ``` ## whip_bearer_token_metadata_key **デフォルト**: 指定なし OBS の WHIP 形式のシグナリング時の Authentication ヘッダーに含まれるトークンを、メタデータとして送信する際のキーを指定してください。 ```ini whip_bearer_token_metadata_key = access_token ``` ## whip_simulcast **デフォルト**: true WHIP 利用時にサイマルキャストを受け付けるかどうかを指定してください。 詳細は [WHIP](WHIP.html) をご確認ください。 ```ini whip_simulcast = true ``` ## workaround_20250515 **デフォルト**: 未指定 この設定項目については [Safari タイムスタンプバグに対するワークアラウンド](WORKAROUND.html#e73b7a) をご確認ください。 ```ini workaround_20250515 = 18.4,18.4.1,18.5 ```