WHIP 機能¶

OBS Studio と組み合わせて利用する際の注意¶

Sora 2025.2.0 以前と OBS Studio 32.1 以降 の組み合わせでは、 OBS Studio の WHIP が利用できなくなる不具合が発生することを確認しています。

• OBS Studio 32.1 以降を利用される場合は、Sora 2025.2.1 以降のバージョンをご利用ください
• Sora 2025.2.0 以前のバージョンを利用される場合は、 OBS Studio 32.0 をご利用ください

WHIP クライアントのお問い合わせについて¶

WHIP クライアントに関する質問などの報告は Discord の利用をお願いします。

URL:

https://discord.gg/shiguredo

Sora の WHIP クライアントについての質問やバグ報告は Discord の #sora-sdk-faq チャンネルにお願いします。

映像コーデックパラメータについて¶

WHIP では映像コーデックのパラメーターを認証払い出し時に指定しても有効になりません。

WHIP のシーケンス図¶

Sora の WHIP のシーケンス図¶

Sora では WHIP エンドポイント、WHIP セッション、メディアサーバーすべてを Sora が担当します。

サイマルキャスト対応¶

OBS Studio の WHIP サイマルキャスト機能は OBS Studio 32.1.0 から利用でき、Sora も対応しています。

もし利用しない場合で、明示的に無効にしたい場合は sora_conf-whip_simulcast を false にしてください。

ブラウザでの WHIP 対応¶

ブラウザからの WHIP 接続は条件付きでサポートしています。

• 音声は Opus のみ
• 映像は AV1 / H.264 / H.265 のみ
• コーデックは音声、映像ともに 1 つのみ
  • setCodecPreferences を利用して 1 つのみを指定してください
• mode は sendonly のみ
  • offer は a=sendonly のみ
• Link ヘッダーを利用した TURN 接続のみ

FFmpeg での WHIP 対応¶

FFmpeg の WHIP 対応は仕様がとても古く RFC 9725 に準拠していないため、|date| 時点での実装では対応は難しいと考えています。

Bearer トークンを利用した認証機能を利用する場合¶

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

whip_bearer_token_metadata_key = whip_access_token

例えば、 access_token という文字列を指定した場合、 WHIP 接続時、認証ウェブフックに "metadata": {"access_token": "<bearer_token>"} が入ってきます。 whip_token を指定した場合は "metadata": {"whip_token": "<bearer_token>"} が入ってきます。

whip_bearer_token_metadata_key が未指定の場合は、 Bearer トークンが WHIP 接続時に送られてきたとしても Sora は無視して、 metadata も生成しません。

切断方法¶

Location ヘッダーに入ってくるセッション URL に DELETE リクエストを送ることで切断できます。

OBS Studio は配信終了することで切断リクエストを送りますので、意識する必要はありません。

チャネル ID の指定¶

OBS Studio ではリクエスト時に JSON でチャネル ID を指定することができません。そのため WHIP エンドポイント URL に channel_id を含めて指定します。 channel_id に URL に利用できない文字が含まれている場合は URL エンコードしてください。

HTTP POST https://sora.example.com/whip/<channel_id>

channel_id が sora の WHIP エンドポイント URL 例:

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

WHIP エンドポイントへの HTTP リクエストに対するレスポンスコードは 201 Created です。

whip¶

true が入ってきます。

ignore_disconnect_websocket¶

false が入ってきます。

metadata¶

sora.conf にて whip_bearer_token_metadata_key に指定した文字列をキーとして metadata に入ってきます。

whip_bearer_token_metadata_key = whip_bearer_token

もし文字列を whip_bearer_token にしていた場合は、 "metadata": {"whip_bearer_token": "<bearer-token>"} が送られてきます。

OBS Studio 側に設定した Bearer Token の値がそのまま入ってきます。

role¶

sendonly が入ってきます。

channel_id¶

WHIP エンドポイント URL に渡した値が利用されます。

client_id¶

WHIP エンドポイント URL にクエリ文字列として client_id=<client_id> を指定した場合、その値が利用されます。

bundle_id¶

WHIP エンドポイント URL にクエリ文字列として bundle_id=<bundle_id> を指定した場合、その値が利用されます。

spotlight¶

WHIP エンドポイント URL にクエリ文字列として spotlight=<boolean> を指定した場合、その値が利用されます。

既知の問題として spotlight = true を指定して接続した場合、音声がそのままでは配信されません。 FocusSpotlightFixed API を利用して OBS Studio の接続にフォーカスを当てる必要があります。

詳細は 既知の問題 - OBS Studio 対応機能 をご確認ください。

audio / video¶

OBS Studio 側で指定した値を利用します。 OBS Studio では音声は Opus のみ、映像は AV1 と H.264 と H.265 が利用できます。

• audio: true
• audio_codec_type: "OPUS"
• video: true
• video_codec_type: "AV1" | "H264" | "H265"

OBS Studio 利用時にはビットレートの指定できないため、 Sora のデフォルトの値が入ってきますが、 OBS Studio の WHIP 実装では SDP での最大ビットレートを無視します。 そのため OBS Studio 側で設定したビットレートで配信が行われます。

simulcast¶

現時点では false が入ってきます。

sora_client¶

OBS Studio WHIP で User-Agent として送られてくる情報を sora_client に含めています。

"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)"
},

その他¶

• e2ee: false
• spotlight: false
• data_channel_signaling: false
• ignore_disconnect_webhook: false
• turn_transport_type: udp
  • OBS Studio 30.2 での TURN 対応は TURN-UDP のみのため tcp になる事はありません

シーケンス図¶

OBS Studio の TURN 機能¶

OBS Studio は 2024 年 7 月にリリースされた OBS Studio 30.2 で TURN に対応しており、Sora の WHIP は TURN を前提としているため、これより古い OBS Studio は利用できません。

単独¶

クラスターかつロードバランサー¶

クラスターを利用する場合、OBS Studio に設定する WHIP エンドポイントはロードバランサーが提供するエンドポイントをお勧めしています。

このシーケンス図では Sora が 2 ノードになっていますが、最低 3 ノード必要です。