WHIP 機能¶

概要¶

Sora は RFC 9725 で定義されている WHIP (WebRTC-HTTP Ingestion Protocol) の仕様に準拠した WHIP 機能を提供しています。

ただし、 OBS Studio での WHIP での動作を優先しています。そのため、 RFC 9725 で定義されている WHIP の仕様とは異なる場合があります。

注意¶

• Sora SDK は WHIP へ対応していません
• 現時点では WHIP を利用した接続の統計ウェブフックの送信には対応していません

WHIP とは何か¶

WHIP は WebRTC-HTTP ingestion protocol の略で、 WebRTC では標準化されていないシグナリングをブロードキャスト/ストリーミング系の配信ツール向けに規定した規格です。

WHIP は仕様を小さくして、実装を簡単にすることで配信ツールが取り込みやすくしています。

クライアントが HTTP POST で Offer SDP を送信して、Answer SDP を受け取るというシンプルなシグナリング規格です。

OBS Studio の WHIP 対応について¶

2023 年 12 月リリースの OBS Studio 30.0 にて WebRTC/WHIP が正式にサポートされました。

最新版は以下からダウンロードができます。

https://obsproject.com/download

2026 年 6 月 時点での OBS Studio の WHIP 対応では輻輳制御が実装されていません。 これは OBS Studio が WHIP 対応のために利用している libdatachannel が輻輳制御に対応していないためです。

そのため、回線が不安定になったとしても、ビットレートを下げたりするといったことは行いません。

OBS Studio の WHIP サイマルキャスト対応について¶

Sora は、2026 年 3 月リリースの OBS Studio 32.1 以降で利用できる OBS Studio の WHIP サイマルキャスト機能に対応しています。

Sora の OBS Studio 向けの WHIP サイマルキャスト機能はデフォルトで有効です。無効にしたい場合は whip_simulcast を false に設定してください。

OBS Studio で WHIP サイマルキャストを利用する場合は合計レイヤー数を 2 または 3 に指定してください。 合計レイヤー数に 1 を指定した場合は、WHIP サイマルキャストではなく通常の WHIP として扱われます。 OBS Studio の WHIP サイマルキャストは合計レイヤー数を 4 まで指定できますが、 Sora では合計レイヤー数 4 には対応していません。

• サイマルキャストのエンコーディングに simulcast_encodings_file を設定しても、 OBS Studio 側の設定が採用されるため適用されません
• 認証成功時に simulcast_encodings の払い出し を指定しても、 OBS Studio 側の設定が採用されるため適用されません
• OBS Studio の WHIP サイマルキャスト利用時には、認証ウェブフックで whip と simulcast が true で送られてきます
• OBS Studio の WHIP サイマルキャスト利用時に認証成功時の払い出しで simulcast に false を指定すると、 Sora の接続に失敗します
• OBS Studio の WHIP サイマルキャスト利用時に合計レイヤー数に 4 を指定すると、 Sora の接続に失敗します
• whip_simulcast が false の場合、 OBS Studio の WHIP サイマルキャストを利用すると、 Sora の接続に失敗します

OBS Studio 以外の WHIP クライアントへの対応について¶

新しい WHIP クライアントへの対応は有償での優先実装として対応を検討できますので、 対応希望の WHIP クライアントと優先実装については、サポートまでメールにてご連絡ください。

Sora での利用方法¶

sora.conf にて whip を true に指定してください。

whip = true

whip_bearer_token_metadata_key = whip_access_token

OBS Studio での WHIP 利用方法¶

OBS Studio での利用方法は以下の通りです。

1. サービスに WHIP を選ぶ
2. サーバーに Sora が提供する WHIP エンドポイント URL を指定する
   • デフォルトでは http://127.0.0.1:5000/whip/<channel_id>
3. Bearer トークンには好きな文字列を指定する
   • Sora の認証ウェブフックの項目 whip_bearer_token_metadata_key で指定した値をキーとして、 "metadata": {"<whip_bearer_token_metadata_key>": "<bearer_token>"} が認証サーバーに送信されます

Sora の OBS Studio (WHIP) の挙動¶

• Sora は WHIP エンドポイント URL を提供します
  • デフォルトでは http://127.0.0.1:5000/whip/<channel_id> です
• Sora の WHIP エンドポイントからの配信は、マルチストリームかつ配信のみ(sendonly)として扱われます
• Sora の WHIP エンドポイントを利用した配信では、シグナリング通知は現時点では利用できません
• Sora の WHIP セッション URL は WHIP エンドポイントのレスポンスに含まれる Location ヘッダーにて払い出されます

WHIP エンドポイント URL¶

Sora の OBS Studio (WHIP) 対応は "role": "sendonly" として機能します。

https://sora.example.com/whip/sora

WHIP セッション URL¶

Sora では WHIP セッション URL は WHIP エンドポイントのレスポンスに含まれる Location ヘッダーにて払い出されます。

以下は切断する例です。

HTTP DELETE https://sora.example.com/whip-session/<channel_id>/<secret>

以下は Trickle ICE を利用する例です。

HTTP PATCH https://sora.example.com/whip-session/<channel_id>/<secret>

<secret> は 32 バイトのランダムな値を base32 でエンコードした文字列です。

WHIP セッション URL 例:

https://sora.example.com/whip-session/sora/QBF6AFDWZGWM97BNS5YCBSXM54M01D0TFQ48MC9Z3ZJG8YPRQ1Z0

認証仕様¶

WHIP では認証に Bearer トークンを指定することができます。

OBS Studio でも認証情報に Bearer トークンを指定できます。

Sora は sora.conf で whip_bearer_token_metadata_key に文字列を指定していた場合、 OBS Studio の HTTP POST 時に Authentication ヘッダーで送られてきた Bearer トークンを、 認証ウェブフックの metadata に {"<whip_bearer_token_metadata_key>": "<bearer_token>"} を設定して認証サーバーに送信します。

Sora 自体は Bearer トークンのチェックやデコードなどは行いません。これらは認証ウェブフックのリクエストを受信した認証サーバーが行う必要があります。

ウェブフック仕様¶

whip_bearer_token_metadata_key = whip_bearer_token

"sora_client": {
  "raw": "Mozilla/5.0 (OBS-Studio/30.1.0; Mac OS X; ja-JP)",
  "type": "OBS-Studio-WHIP",
  "version": "30.1.0",
  "environment": "Mozilla/5.0 (OBS-Studio/30.1.0; Mac OS X; ja-JP)"
},

認証ウェブフック成功時の払い出し¶

基本的には OBS Studio で指定した値がそのまま利用されますので、 以下の値以外は指定しないでください。

• client_id
• bundle_id
• event_metadata
• recording_block
• signaling_notify_metadata
• connection_lifetime
• cluster_affinity
• playout_delay_min_delay
• playout_delay_max_delay
• rtp_packet_loss_simulator_incoming
• turn_tcp_only
  • ただし 2026 年 6 月 現在では OBS Studio WHIP は TURN-TCP には対応していません
• turn_tls_only
  • ただし 2026 年 6 月 現在では OBS Studio WHIP は TURN-TLS には対応していません

クラスター利用時の認証ウェブフックの挙動¶

クラスター利用時に、 WHIP で接続したノードではないノードに接続を振り分ける場合、 Sora は認証情報を担当ノードに Proxy を行います。

接続は接続したノードで行われますが、認証ウェブフックは担当ノードから送信されます。 その後 WebRTC 接続確立は担当ノードと行います。

TURN の利用¶

Sora はデフォルトで WHIP 利用時に Link ヘッダーに TURN URLs を払い出し、 TURN のみの通信 を行います。 TURN の利用を無効にすることはできません。

録画利用時の注意¶

• OBS Studio WHIP で H.264 を利用し、 Sora で録画を行う場合、エンコーダーには x264 以外を利用することを推奨します。 x264 を利用すると、録画時に期待どおりに処理できない場合があります。

クラスター利用時の挙動¶

クラスター利用時に、接続したノードが指定した channel_id の担当ノードではない場合、 担当ノードの TURN URLs を Link ヘッダーにて払い出します。

シーケンス図¶