OBS (WHIP) 対応機能¶

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

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

URL:

https://discord.gg/shiguredo

Sora の WHIP クライアントに関するチャンネルは #sora-whip です。

WHIP のシーケンス図¶

Sora の WHIP のシーケンス図¶

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

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

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

whip_bearer_token_metadata_key = access_token

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

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

切断方法¶

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

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

チャネル ID の指定¶

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

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

WHIP エンドポイント URL 例:

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

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

whip¶

true が入ってきます。

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 側に設定した Bearer Token の値がそのまま入ってきます。

multistream¶

true が入ってきます。

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 の接続にフォーカスを当てる必要があります。

詳細は 既知の問題 - OBS (WHIP) 対応機能 を参照してください。

audio / video¶

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

• audio: true
• audio_codec_type: "OPUS"
• video: true
• video_codec_type: "H264"

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

simulcast¶

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

その他¶

• e2ee: false
• spotlight: false
• data_channel_signaling: false
• ignore_disconnect_webhook: false
• turn_transport_type: udp
  • TURN が利用不可能な WHIP 実装の場合は udp が割り当てられます
  • TURN が利用可能な WHIP 実装の場合は udp または tcp が適切に割り当てられます

将来的に OBS の WHIP 対応で TURN が対応された場合¶

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

シングルノード¶

マルチノード¶

マルチノードを利用する場合、OBS に設定する WHIP エンドポイントは LB が提供するエンドポイントを利用します。

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