WHEP 機能¶

概要¶

OBS Studio が対応を予定している WHEP を利用したメディアソースに対応しています。

ここでは Sora や OBS Studio の WHEP 仕様について説明します。

注意¶

• OBS Studio の WHEP での動作を優先しており RFC ドラフトの WHEP 仕様とは異なる可能性があります
• Sora SDK は WHEP へ対応していません
• OBS Studio の WHEP 実装では Opus と H.264 の組み合わせでのみ利用できます
• 現時点では WHEP を利用した接続の統計ウェブフックの送信には対応していません
• Sora の WHEP 対応は 406 Not Acceptable を利用したサーバーからのカウンター Offer には現時点では対応していません
  • https://datatracker.ietf.org/doc/html/draft-ietf-wish-whep#section-4.2.2

WHEP とは何か¶

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

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

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

将来的に OBS Studio で WebRTC/WHEP がサポートされる予定です。

OBS Studio の WHEP 対応について¶

|date| 時点での最新版である OBS Studio 32.0 では WHEP に対応していません。

以下の Pull-Request がマージされ、正式リリースされることで WHEP に対応予定です。 https://github.com/obsproject/obs-studio/pull/10353

WHEP は WHEP ソース として利用できるようになります。

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

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

Sora での利用方法¶

whep = true

whep_bearer_token_metadata_key = whep_access_token

OBS Studio での WHEP 利用方法¶

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

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

Sora の OBS Studio (WHEP) の挙動¶

• Sora は WHEP エンドポイント URL を提供します
  • デフォルトでは http://127.0.0.1:5000/whep/<channel_id> です
• Sora の WHEP エンドポイントからの配信は、マルチストリームかつ視聴のみ(recvonly)として扱われます
• Sora の WHEP エンドポイントを利用した配信では、シグナリング通知は現時点では利用できません
• Sora の WHEP セッション URL は WHEP エンドポイントのレスポンスに含まれる Location ヘッダーにて払い出されます
• 同一チャネルに複数の配信が存在する場合、 WHEP での接続を認証前に接続を拒否します
• 同一チャネルに複数の配信が始まった場合、 WHEP での接続を切断します

WHEP エンドポイント URL¶

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

https://sora.example.com/whep/sora

WHEP セッション URL¶

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

以下は切断する例です。

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

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

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

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

WHEP セッション URL 例:

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

認証仕様¶

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

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

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

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

認証成功時の払い出し¶

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

• client_id
• bundle_id
• event_metadata
• connection_lifetime
• playout_delay_min_delay
• playout_delay_max_delay
• turn_tcp_only
  • ただし |date| 現在では OBS Studio WHEP は TURN-TCP には対応していません
• turn_tls_only
  • ただし |date| 現在では OBS Studio WHEP は TURN-TLS には対応していません

ウェブフック仕様¶

whep_bearer_token_metadata_key = whep_bearer_token

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

TURN の利用¶

WHIP と同様の挙動です。 TURN の利用 をご確認ください。

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

WHIP と同様の挙動です。 クラスター利用時の挙動 をご確認ください。

シーケンス図¶