sora.conf リファレンス

Sora の設定ファイルは key = value 形式です。 文字列であっても "" で囲わないでください。

単位指定

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

• 利用できる単位

  • ミリ秒 ms

  • 秒 s

  • 分 min

  • 時 h

• 数値と単位の間にはスペースを入れてください

設定例

 webhook_response_timeout = 30 s

注釈

利用できる単位が制限されている設定項目も存在します。

範囲表記

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

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

license_file

デフォルト:

"etc/license.json"

ライセンスファイルのパスを指定してください、可能な限り 絶対パス を指定してください。

設定例

 license_file = etc/license.json

label

デフォルト:

"WebRTC SFU Sora"

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

設定例

 label = sora-node-001.example.com

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

devtools

デフォルト:

false

Sora には機能をすぐに試してもらえるように開発ツールが含まれています。

開発ツールを有効にする場合は、 true を指定し、有効にしてください。

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

設定例

 devtools = true

media_publish_worker_number

デフォルト:

1

音声や映像の 1 配信に利用する配信ワーカー数を指定してください。

設定例

 media_publish_worker_number = 1

auth_webhook_url

デフォルト:

指定なし

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

設定例

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

auth_webhook_log

デフォルト:

true

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

設定例

 auth_webhook_log = true

session_webhook_url

デフォルト:

指定なし

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

設定例

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

session_webhook_worker_number

デフォルト:

5

範囲:

5..5000

セッションウェブフックのワーカー数を指定してください。

設定例

 session_webhook_worker_number = 5

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

event_webhook_url

デフォルト:

指定なし

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

設定例

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

event_webhook_worker_number

デフォルト:

5

範囲:

5..5000

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

設定例

 event_webhook_worker_number = 5

stats_webhook_url

デフォルト:

指定なし

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

設定例

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

stats_webhook_log

デフォルト:

false

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

設定例

 stats_webhook_log = true

stats_webhook_worker_number

デフォルト:

5

範囲:

5..5000

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

設定例

 stats_webhook_worker_number = 5

webhook_ipv6

デフォルト:

false

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

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

設定例

 webhook_ipv6 = true

webhook_response_timeout

デフォルト:

5 s

範囲:

1..600 s

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

設定例

 webhook_response_timeout = 5 s

connection_updated_webhook_interval

デフォルト:

1 min

範囲:

1..10 min

単位:

min のみ

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

設定例

 connection_updated_webhook_interval = 1 min

webhook_insecure

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

設定例

 webhook_insecure = true

webhook_basic_authn

デフォルト:

false

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

設定例

 webhook_basic_authn = true

webhook_basic_authn_user_id

デフォルト:

指定なし

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

設定例

 webhook_basic_authn_user_id = basic-authn-user-id

webhook_basic_authn_password

デフォルト:

指定なし

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

設定例

 webhook_basic_authn_password = basic-authn-password

webhook_proxy_url

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

デフォルト:

指定なし

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

設定例

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

webhook_proxy_auth_user

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

デフォルト:

指定なし

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

設定例

 webhook_proxy_auth_user = proxy-auth-user

webhook_proxy_auth_password

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

デフォルト:

指定なし

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

設定例

 webhook_proxy_auth_password = proxy-auth-password

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

重要

この設定がない場合、 OS 組み込みのルート CA 証明書を利用してサーバー証明書をチェックします。 OS 組み込みのルート CA 証明書については ウェブフックリクエストなどの送信先サーバー証明書の検証に利用する OS 組み込みのルート CA 証明書について をご確認ください。

ignore_connection_updated_webhook

デフォルト:

false

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

設定例

 ignore_connection_updated_webhook = false

ignore_connection_failed_webhook

デフォルト:

true

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

設定例

 ignore_connection_failed_webhook = false

ignore_session_updated_webhook

デフォルト:

false

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

設定例

 ignore_session_updated_webhook = false

ignore_session_vanished_webhook

デフォルト:

true

モードが block_new_session または block_new_connection の際に、 session_webhook_url に指定された URL に session.vanished リクエストを送るかどうか指定してください。

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

設定例

 ignore_session_vanished_webhook = false

ignore_audio_streaming_webhook

デフォルト:

true

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

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

設定例

 ignore_audio_streaming_webhook = false

ignore_audio_streaming_failed_webhook

デフォルト:

true

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

設定例

 ignore_audio_streaming_failed_webhook = false

ignore_spotlight_changed_webhook

デフォルト:

true

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

設定例

 ignore_spotlight_changed_webhook = true

ignore_recording_started_webhook

デフォルト:

false

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

設定例

ignore_recording_started_webhook = true

ignore_archive_started_webhook

デフォルト:

false

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

設定例

 ignore_archive_started_webhook = true

ignore_split_archive_available_webhook

デフォルト:

false

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

設定例

 ignore_split_archive_available_webhook = true

ignore_connection_rtc_webhook

デフォルト:

false

クライアントから RTC 統計情報が送られてきた際、 統計ウェブフック connection.rtc リクエストを送信するかどうか指定してください。 デフォルトではリクエストの送信を行います。

設定例

 ignore_connection_rtc_webhook = true

archive_dir

デフォルト:

archive

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

設定例

 archive_dir = /path/to/archive

注意

archive_dir と archive_tmp_dir は違うディレクトリを指定してください

archive_tmp_dir

デフォルト:

tmp/archive

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

重要

録画が失敗した場合には、このディレクトリに保存されたファイルは自動的に削除されません。 そのため録画失敗時には一時ファイルが残り続けます。

設定例

 archive_tmp_dir = /path/to/tmp/archive

注意

archive_dir と archive_tmp_dir は違うディレクトリを指定してください

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

recording_expire_time_required

デフォルト:

false

重要

この設定は一括録画時に録画ファイルが大きくなりすぎるのを防ぐための設定です。

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

設定例

 recording_expire_time_required = true

recording_dual_output

デフォルト:

true

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

重要

この設定が false になっている際に一括＆分割録画をしようとするとエラーになります

設定例

 recording_dual_output = false

signaling_port

デフォルト:

5000

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

設定例

 signaling_port = 5000

signaling_loopback_address_only

デフォルト:

false

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

設定例

 signaling_loopback_address_only = true

signaling_notify

デフォルト:

true

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

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

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

設定例

 signaling_notify = true

signaling_notify_session_id

デフォルト:

true

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

設定例

 signaling_notify_session_id = true

signaling_notify_client_id

デフォルト:

true

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

設定例

 signaling_notify_client_id = true

signaling_notify_bundle_id

デフォルト:

true

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

設定例

 signaling_notify_bundle_id = true

signaling_notify_connection_id

デフォルト:

true

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

設定例

 signaling_notify_connection_id = true

signaling_notify_connection_created_timestamp

デフォルト:

true

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

設定例

 signaling_notify_connection_created_timestamp = 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_authn_metadata_max_size

デフォルト:

64512

範囲:

0..1048576

注釈

この設定を 0 にすることでクライアントからシグナリング通知メタデータを指定できなくなります。

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

設定例

 signaling_notify_authn_metadata_max_size = 64512

signaling_notify_network

デフォルト:

true

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

設定例

 signaling_notify_network = true

signaling_notify_rtp_stream

デフォルト:

true

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

設定例

 signaling_notify_rtp_stream = true

signaling_notify_recording

デフォルト:

true

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

設定例

 signaling_notify_recording = true

signaling_notify_forwarding_filter

デフォルト:

true

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

設定例

 signaling_notify_forwarding_filter = true

signaling_notify_audio_streaming_failed

デフォルト:

false

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

設定例

 signaling_notify_audio_streaming_failed = true

signaling_vp9_params

デフォルト:

false

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

設定例

 signaling_vp9_params = true

signaling_av1_params

デフォルト:

false

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

設定例

 signaling_av1_params = true

signaling_h264_params

デフォルト:

false

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

設定例

 signaling_h264_params = true

signaling_h265_params

デフォルト:

false

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

設定例

 signaling_h265_params = true

signaling_bundle_id

デフォルト:

false

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

設定例

 signaling_bundle_id = true

websocket_signaling_ping_interval

単位指定必須

デフォルト:

5 s

範囲:

5..300 s

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

重要

ここで指定する値は websocket_signaling_pong_timeout より短くしてください。

設定例

websocket_signaling_ping_interval = 5 s

websocket_signaling_pong_timeout

単位指定必須

デフォルト:

60 s

範囲:

60..600 s

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

重要

ここで指定する値は websocket_signaling_ping_interval より長くしてください。

設定例

websocket_signaling_pong_timeout = 60 s

websocket_stats_timer_interval

単位指定必須

デフォルト:

60 s

範囲:

5..600 s

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

設定例

websocket_stats_timer_interval = 60 s

default_data_channel_signaling

注意

この機能を本番環境で利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

設定例

 default_data_channel_signaling = false

default_ignore_disconnect_websocket

注意

この機能を本番環境で利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

設定例

 default_ignore_disconnect_websocket = false

data_channel_messaging

注意

この機能を本番環境で利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

設定例

 data_channel_messaging = false

data_channel_messaging_only

注意

この機能を本番環境で利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

設定例

 data_channel_messaging_only = false

data_channel_stats_timer_interval

単位指定必須

デフォルト:

60 s

範囲:

5..600 s

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

設定例

 data_channel_stats_timer_interval = 60 s

data_channel_stats_max_retransmits

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

指定なし

範囲:

0..8

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

設定例

 data_channel_stats_max_retransmits = 1

whip

デフォルト:

false

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

設定例

 whip_whep = true

whip_bearer_token_metadata_key

デフォルト:

指定なし

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

設定例

 whip_bearer_token_metadata_key = access_token

whip_turn

重要

この設定は OBS が TURN に正式に対応したタイミングで廃止します。

デフォルト:

false

OBS の WHIP/WebRTC で TURN 経由で配信するかどうかを指定してください。

設定例

 whip_turn = true

whep

デフォルト:

false

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

設定例

 whip_whep = true

whep_bearer_token_metadata_key

デフォルト:

指定なし

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

設定例

 whep_bearer_token_metadata_key = access_token

whep_turn

重要

この設定は OBS が TURN に正式に対応したタイミングで廃止します。

デフォルト:

false

OBS の WHEP/WebRTC で TURN 経由で配信するかどうかを指定してください。

設定例

 whep_turn = true

api_port

デフォルト:

3000

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

設定例

 api_port = 3000

api_loopback_address_only

デフォルト:

false

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

設定例

 api_loopback_address_only = true

api_cors_origin

デフォルト:

指定なし

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

設定例

 api_cors_origin = http://127.0.0.1:5000

turn

デフォルト:

true

注意

この機能を false にする場合は事前にサポートまでご連絡ください

使用しない場合の設定

設定例

 turn = false

turn_realm

デフォルト:

"sora-turn.example.com"

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

設定例

 turn_realm = sora-turn.example.com

turn_fqdn

デフォルト:

なし

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

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

ドメイン名が sora-turn.example.com の場合

設定例

 turn_fqdn = sora-turn.example.com

turn_tls_fqdn

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

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

ドメイン名が sora.example.com の場合

設定例

 turn_tls_fqdn = 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_port

デフォルト:

turn_tcp_listen_port の値を利用

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

設定例

 turn_tcp_port = 3478

turn_tcp_only

デフォルト:

false

危険

この機能はあくまで検証時のみ有効にしてください

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

検証する場合

turn_tcp_only = true

turn_tls

デフォルト:

false

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

設定例

 turn_tls = true

turn_tls_port

デフォルト:

5349

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

設定例

 turn_tls_port = 443

turn_tls_only

デフォルト:

false

危険

この機能はあくまで検証時のみ有効にしてください

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

検証する場合

turn_tls_only = true

rtx

注意

この設定を無効にする場合は事前にサポートまでご連絡ください

デフォルト:

true

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

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

設定例

 rtx = false

ulpfec

注意

この設定を有効にする場合は事前にサポートまでご連絡ください

デフォルト:

false

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

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

設定例

 ulpfec = false

audio_red

注意

この設定を有効にする場合は事前にサポートまでご連絡ください

デフォルト:

false

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

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

設定例

 audio_red = true

generic_nack

注意

この設定を無効にする場合は事前にサポートまでご連絡ください

デフォルト:

true

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

設定例

 generic_nack = true

default_audio_bit_rate

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

単位:

k(キロ)bps

範囲:

6..510

デフォルト:

指定なし

音声が使用できるビットレートを指定してください。デフォルトの場合はブラウザ側の判断に依存します。

設定例

 default_audio_bit_rate = 32

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 = 2

default_av1_param_profile

デフォルト:

0

範囲:

0..2

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

設定例

default_av1_param_profile = 0

default_h264_param_profile_level_id

デフォルト:

42e01f

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

設定例

default_h264_param_profile_level_id = 42e01f

default_h265_param_level_id

重要

2024 年 6 月 現在、このプロファイルを利用できる WebRTC クライアントが存在しません。

デフォルト:

93

範囲:

0..255

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

設定例

default_h265_param_level_id = 93

default_simulcast_rid

デフォルト:

r0

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

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

r1 または r2 にすることもできます。

設定例

 default_simulcast_rid = r0

simulcast_encodings_file

デフォルト:

なし

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

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

設定例

 simulcast_encodings_file = etc/simulcast_encodings.json

simulcast_multicodec

デフォルト:

false

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

設定例

 simulcast_multicodec = true

simulcast_codecs_file

デフォルト:

なし

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

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

設定例

 simulcast_codecs_file = etc/simulcast_codecs.json

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 が適用されます。

forwarding_simulcast

注意

この設定を利用する場合は事前にサポートまでご連絡ください

単位指定必須

デフォルト:

single

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

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

• all はすべてのストリームを転送します

設定例

 forwarding_simulcast = all

signaling_forwarding_filter

デフォルト:

false

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

設定例

signaling_forwarding_filter = true

audio_streaming_url

デフォルト:

指定なし

統計コレクターの URL を指定してください。 http を指定した場合は HTTP/2 (h2c) で送られます。 https の場合は HTTP/2 (h2) で送られます。

統計コレクターは HTTP/2 に対応している必要があります。

HTTP 設定例

audio_streaming_url = http://192.0.2.10:48080/speech

HTTPS 設定例

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

default_audio_streaming_result_push

デフォルト:

true

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

設定例

default_audio_streaming_result_push = true

default_audio_streaming_language_code

デフォルト:

指定なし

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

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

設定例

default_audio_streaming_language_code = ja-JP

audio_streaming_max_retries

デフォルト:

0

設定例

audio_streaming_max_retries = 3

audio_streaming_retry_interval

デフォルト:

5 s

設定例

audio_streaming_retry_interval = 3 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

重要

この設定がない場合、 OS 組み込みのルート CA 証明書を利用してサーバー証明書をチェックします。 OS 組み込みのルート CA 証明書については ウェブフックリクエストなどの送信先サーバー証明書の検証に利用する OS 組み込みのルート CA 証明書について をご確認ください。

recycle_media_section

デフォルト:

true

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

設定例

recycle_media_section = false

hide_origin_username

デフォルト:

false

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

設定例

 hide_origin_username = false

connection_created_wait_timeout

単位指定必須

デフォルト:

30 s

範囲:

1..600 s

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

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

設定例

 connection_created_wait_timeout = 30 s

default_spotlight_focus_rid

デフォルト:

r1

指定できる rid:

none / r0 / r1 / r2

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

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

設定例

 default_spotlight_focus_rid = r1

default_spotlight_unfocus_rid

デフォルト:

r0

範囲:

none, r0, r1, r2

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

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

設定例

 default_spotlight_unfocus_rid = none

default_spotlight_unfocus_audio

デフォルト:

true

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

設定例

 default_spotlight_unfocus_audio = false

default_spotlight_unfocus_audio_rate_limit

デフォルト:

2

範囲:

0..5

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

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

設定例

 default_spotlight_unfocus_audio_rate_limit = 2

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_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_focus_min_interval

デフォルト:

2000 ms

範囲:

0 ms 以上 60 s 以下

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

設定例

 default_spotlight_focus_min_interval = 2000 ms

default_spotlight_number

デフォルト:

1

範囲:

1..8

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

設定例

 default_spotlight_number = 2

spotlight_encodings_file

デフォルト:

なし

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

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

設定例

 spotlight_encodings_file = etc/spotlight_encodings.json

multistream_auto_sharing_video_bit_rate

デフォルト:

true

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

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

設定例

 multistream_auto_sharing_video_bit_rate  = true

default_rtc_stats

デフォルト:

true

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

設定例

 rtc_stats = true

user_agent_stats

注意

この設定は 2024 年 12 月に廃止されます。 default_rtc_stats を利用してください。

デフォルト:

true

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

設定例

 user_agent_stats = true

ice_connection_state_disconnected_timeout

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

5 s

範囲:

1..300 s

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

設定例

ice_connection_state_disconnected_timeout = 5 s

ice_connection_state_failed_timeout

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

10 s

範囲:

1..300 s

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

設定例

ice_connection_state_failed_timeout = 10 s

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" に書き換えます

e2ee

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

クライアントによる E2EE の利用を許可します。

設定例

e2ee = true

stats_collector_url

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

指定なし

統計コレクターの URL を指定してください。 http を指定した場合は HTTP/2 (h2c) で送られます。 https の場合は HTTP/2 (h2) で送られます。

統計コレクターは HTTP/2 に対応している必要があります。

HTTP 設定例

stats_collector_url = http://192.0.2.10:5890/collector

HTTPS 設定例

stats_collector_url = https://kohaku.example.com/collector

default_stats_exporter

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

true

stats_collector_url に URL が指定されている場合に、 統計エクスポーターをデフォルトで有効にするかどうかを指定してください。

この設定を false にした場合に、統計エクスポーターを有効にするには、 認証成功時の払い出しで "stats_exporter": true を払い出す必要があります。

HTTPS 設定例

default_stats_exporter = true

stats_exporter_number

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

5

統計エクスポーターの数を指定してください。同時接続数が多くなった場合増やすことを検討してください。

設定例

stats_exporter_number = 10

stats_exporter_tls_fullchain_file

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

指定なし

統計コレクターサーバーとの通信に HTTPS で mTLS を利用するための設定で、 中間証明書を含むクライアント証明書を PEM 形式で設定してください。

設定例

stats_exporter_tls_fullchain_file = /path/to/fullchain.pem

stats_exporter_tls_privkey_file

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

指定なし

統計コレクターサーバーとの通信に HTTPS で mTLS を利用するための設定で、 クライアント証明書の秘密鍵を PEM 形式で設定してください。

重要

秘密鍵にはパスフレーズが設定されている場合エラーとなります

設定例

stats_exporter_tls_privkey_file = /path/to/privkey.pem

stats_exporter_tls_verify_cacert_file

注意

この設定は 2024 年 12 月に廃止されます。

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

指定なし

統計コレクターサーバーとの通信に HTTPS を利用した際、サーバー証明書のチェックを行う CA ファイルを PEM 形式で設定してください。

設定例

stats_exporter_tls_verify_cacert_file = /path/to/server_cacert.pem

重要

この設定がない場合、 OS 組み込みのルート CA 証明書を利用してサーバー証明書をチェックします。 OS 組み込みのルート CA 証明書については ウェブフックリクエストなどの送信先サーバー証明書の検証に利用する OS 組み込みのルート CA 証明書について をご確認ください。

node_name

デフォルト:

指定なし

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

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

設定例

node_name = sora@192.0.2.10

cluster

デフォルト:

false

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

設定例

cluster = true

cluster_temporary_node

デフォルト:

false

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

設定例

cluster_temporary_node = true

cluster_relay

注意

この機能を利用するには 最大ノード数ライセンス が必要です。

デフォルト:

true

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

設定例

cluster_relay = true

default_cluster_affinity

注意

この機能を利用するには 最大ノード数ライセンス が必要です。

デフォルト:

true

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

設定例

default_cluster_affinity = true

external_signaling_url

デフォルト:

指定なし

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

設定例

external_signaling_url = ws://127.0.0.1:5000/signaling

external_api_url

デフォルト:

指定なし

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

設定例

external_api_url = http://127.0.0.1:3000/

contact_node_name_list

デフォルト:

指定なし

クラスターが有効な時、起動時に自動で RegisterClusterNode を試行するノード名のリストを指定してください。

カンマ区切りで指定してください。

注釈

自分自身のノード名を含めても問題ありません。

設定例

node_name = sora@192.0.2.10
contact_node_name_list = sora@192.0.2.10, sora11@192.0.2.11, sora12@192.0.2.12

cluster_listen_min_port

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

49010

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

設定例

cluster_listen_min_port = 49010

cluster_listen_max_port

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

49020

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

設定例

cluster_listen_max_port = 49020

data_dir

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

data

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

設定例

 data_dir = /path/to/data

av1

デフォルト:

true

AV1 が利用できるようになります。

設定例

 av1 = true

h265

デフォルト:

true

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

設定例

 h265 = true

h264_b_frame

重要

2024 年 6 月 現時点で Sora SDK では B-frame を利用する事はできません。

デフォルト:

false

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

設定例

 h264 = true

h265_b_frame

重要

2024 年 6 月 現時点で Sora SDK では B-frame を利用する事はできません。

デフォルト:

false

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

設定例

 h265 = true

legacy_recording

デフォルト:

true

危険

この設定は 2025 年 12 月リリースの Sora にて廃止されます

注意

この設定は 2024 年 12 月リリースの Sora にてデフォルトが false に変更されます

レガシー録画を利用するかどうかを指定してください。 false にすることでレガシー録画の API が利用できなくなります。

設定例

 legacy_recording = false

legacy_recording を false にする際の注意点

クラスター機能利用時にレガシー録画の録画予約が存在する状態で、 legacy_recording を false にした場合でも、レガシー録画の録画予約は停止されません。

そのため、 legacy_recording を false にする際は、レガシー録画の録画予約を全て停止してください。

legacy_event_webhook_connection_destroyed_reason

デフォルト:

false

危険

この設定は 2024 年 12 月リリースの Sora にて廃止されます

この設定は Sora 2023.2.x 以前と同様の挙動を維持します。

コネクションウェブフック connection.destroyed の reason に、 "disconnected_api_reason" と同じ値を含める、 または "disconnected_api_reason" が含まれなかった際 null を含める設定を有効にするかどうか指定してください。

設定例

 legacy_event_webhook_connection_destroyed_reason = true

rtp_hdrext_video_orientation

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_video_content_type

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_video_timing

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_playout_delay

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_color_space

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_sdes_mid

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

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

rtp_hdrext_abs_capture_time

デフォルト:

true

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

rtp_packet_loss_simulator_incoming

危険

この機能はあくまで検証時のみ有効にしてください

デフォルト:

0

範囲:

0..100

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

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

Sora が受信する RTP パケットを 10 % パケロスさせる場合

設定例

 rtp_packet_loss_simulator_incoming = 10

rtp_packet_loss_simulator_outgoing

危険

この機能はあくまで検証時のみ有効にしてください

デフォルト:

0

範囲:

0..100

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

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

Sora が送信する RTP パケットを 10 % パケロスさせる場合

設定例

 rtp_packet_loss_simulator_outgoing = 10

data_channel_packet_loss_simulator_incoming

危険

この機能はあくまで検証時のみ有効にしてください

デフォルト:

0

範囲:

0..100

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

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

Sora が受信する DataChannel パケットを 10 % パケロスさせる場合

設定例

 data_channel_packet_loss_simulator_incoming = 10

data_channel_packet_loss_simulator_outgoing

危険

この機能はあくまで検証時のみ有効にしてください

デフォルト:

0

範囲:

0..100

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

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

Sora が送信する DataChannel パケットを 10 % パケロスさせる場合

設定例

 data_channel_packet_loss_simulator_outgoing = 10

opus_param_channels

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

2

範囲:

1..8

opus_param_maxplaybackrate

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

48000

範囲:

8000..48000

opus_param_stereo

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

true

opus_param_sprop_stereo

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

true

opus_param_ptime

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

20

範囲:

3..120

opus_param_minptime

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

10

範囲:

3..120

opus_param_useinbandfec

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

true

opus_param_usedtx

注意

この設定を利用する場合は事前にサポートまでご連絡ください

デフォルト:

false

コンテンツ

• sora.conf リファレンス
  • 単位指定
  • 範囲表記
  • license_file
  • label
  • ipv4_address
  • ipv6
  • ipv6_address
  • ipv6_only
  • devtools
  • media_publish_worker_number
  • auth_webhook_url
  • auth_webhook_log
  • session_webhook_url
  • session_webhook_worker_number
  • session_created_timeout
  • session_destroyed_timeout
  • session_updated_webhook_interval
  • event_webhook_url
  • event_webhook_worker_number
  • stats_webhook_url
  • stats_webhook_log
  • stats_webhook_worker_number
  • webhook_ipv6
  • webhook_response_timeout
  • connection_updated_webhook_interval
  • webhook_insecure
  • webhook_basic_authn
  • webhook_basic_authn_user_id
  • webhook_basic_authn_password
  • webhook_proxy_url
  • webhook_proxy_auth_user
  • webhook_proxy_auth_password
  • webhook_tls_fullchain_file
  • webhook_tls_privkey_file
  • webhook_tls_verify_cacert_file
  • ignore_connection_updated_webhook
  • ignore_connection_failed_webhook
  • ignore_session_updated_webhook
  • ignore_session_vanished_webhook
  • ignore_audio_streaming_webhook
  • ignore_audio_streaming_failed_webhook
  • ignore_spotlight_changed_webhook
  • ignore_recording_started_webhook
  • ignore_archive_started_webhook
  • ignore_split_archive_available_webhook
  • ignore_connection_rtc_webhook
  • archive_dir
  • archive_tmp_dir
  • recording_max_expire_time
  • recording_max_split_duration
  • recording_expire_time_required
  • recording_dual_output
  • signaling_port
  • signaling_loopback_address_only
  • signaling_notify
  • signaling_notify_session_id
  • signaling_notify_client_id
  • signaling_notify_bundle_id
  • signaling_notify_connection_id
  • signaling_notify_connection_created_timestamp
  • signaling_notify_media
  • signaling_notify_metadata
  • signaling_notify_metadata_ext
  • signaling_notify_authn_metadata_max_size
  • signaling_notify_network
  • signaling_notify_rtp_stream
  • signaling_notify_recording
  • signaling_notify_forwarding_filter
  • signaling_notify_audio_streaming_failed
  • signaling_vp9_params
  • signaling_av1_params
  • signaling_h264_params
  • signaling_h265_params
  • signaling_bundle_id
  • websocket_signaling_ping_interval
  • websocket_signaling_pong_timeout
  • websocket_stats_timer_interval
  • default_data_channel_signaling
  • default_ignore_disconnect_websocket
  • data_channel_messaging
  • data_channel_messaging_only
  • data_channel_stats_timer_interval
  • data_channel_stats_max_retransmits
  • whip
  • whip_bearer_token_metadata_key
  • whip_turn
  • whep
  • whep_bearer_token_metadata_key
  • whep_turn
  • api_port
  • api_loopback_address_only
  • api_cors_origin
  • turn
    • 使用しない場合の設定
  • turn_realm
  • turn_fqdn
    • ドメイン名が sora-turn.example.com の場合
  • turn_tls_fqdn
    • ドメイン名が sora.example.com の場合
  • turn_tcp
    • 使用しない場合の設定
  • turn_tcp_allocate_success_delay_time
  • turn_tcp_listen_port
  • turn_tcp_port
  • turn_tcp_only
    • 検証する場合
  • turn_tls
  • turn_tls_port
  • turn_tls_only
    • 検証する場合
  • rtx
  • ulpfec
  • audio_red
  • generic_nack
  • default_audio_bit_rate
  • default_video_bit_rate
  • default_vp9_param_profile_id
  • default_av1_param_profile
  • default_h264_param_profile_level_id
  • default_h265_param_level_id
  • default_simulcast_rid
  • simulcast_encodings_file
  • simulcast_multicodec
  • simulcast_codecs_file
  • default_forwarding_pli_interval
  • forwarding_simulcast
  • signaling_forwarding_filter
  • audio_streaming_url
  • default_audio_streaming_result_push
  • default_audio_streaming_language_code
  • audio_streaming_max_retries
  • audio_streaming_retry_interval
  • audio_streaming_tls_fullchain_file
  • audio_streaming_tls_privkey_file
  • audio_streaming_tls_verify_cacert_file
  • recycle_media_section
  • hide_origin_username
  • connection_created_wait_timeout
  • default_spotlight_focus_rid
  • default_spotlight_unfocus_rid
  • default_spotlight_unfocus_audio
  • default_spotlight_unfocus_audio_rate_limit
  • default_spotlight_delayed_focus
  • default_spotlight_delayed_focus_interval
  • default_spotlight_auto_unfocus
  • default_spotlight_auto_unfocus_interval
  • default_spotlight_focus_min_interval
  • default_spotlight_number
  • spotlight_encodings_file
  • multistream_auto_sharing_video_bit_rate
  • default_rtc_stats
  • user_agent_stats
  • ice_connection_state_disconnected_timeout
  • ice_connection_state_failed_timeout
  • skip_redact_sensitive_data
  • e2ee
  • stats_collector_url
  • default_stats_exporter
  • stats_exporter_number
  • stats_exporter_tls_fullchain_file
  • stats_exporter_tls_privkey_file
  • stats_exporter_tls_verify_cacert_file
  • node_name
  • cluster
  • cluster_temporary_node
  • cluster_relay
  • default_cluster_affinity
  • external_signaling_url
  • external_api_url
  • contact_node_name_list
  • cluster_listen_min_port
  • cluster_listen_max_port
  • data_dir
  • av1
  • h265
  • h264_b_frame
  • h265_b_frame
  • legacy_recording
    • legacy_recording を false にする際の注意点
  • legacy_event_webhook_connection_destroyed_reason
  • rtp_hdrext_video_orientation
  • rtp_hdrext_video_content_type
  • rtp_hdrext_video_timing
  • rtp_hdrext_playout_delay
  • rtp_hdrext_color_space
  • rtp_hdrext_sdes_mid
  • rtp_hdrext_abs_capture_time
  • rtp_packet_loss_simulator_incoming
    • Sora が受信する RTP パケットを 10 % パケロスさせる場合
  • rtp_packet_loss_simulator_outgoing
    • Sora が送信する RTP パケットを 10 % パケロスさせる場合
  • data_channel_packet_loss_simulator_incoming
    • Sora が受信する DataChannel パケットを 10 % パケロスさせる場合
  • data_channel_packet_loss_simulator_outgoing
    • Sora が送信する DataChannel パケットを 10 % パケロスさせる場合
  • opus_param_channels
  • opus_param_maxplaybackrate
  • opus_param_stereo
  • opus_param_sprop_stereo
  • opus_param_ptime
  • opus_param_minptime
  • opus_param_useinbandfec
  • opus_param_usedtx