Hivee 運営管理画面

配信オーバーレイ

OBS などの配信ソフトに重ねるスコアボードと TOP 8 を、Hivee がそのまま貼れるページとして用意しています。自作のオーバーレイを作るときは、同じデータを JSON で取れます。

ページ

ページURL内容
スコアボード/overlay/{eventId}/scoreboard?token=...配信中の試合の両選手・スコア・使用キャラ。デザインは配信管理で 3 種から選ぶ
TOP 8/overlay/{eventId}/top8?token=...&program=...ダブルイリミネーションの終盤(TOP 8)のトーナメント表。program を省くと配信中の試合のプログラムを出す
  • どちらも 1920 × 1080・背景透過です。OBS のブラウザソースに URL を貼り、幅 1920・高さ 1080 にします
  • 試合の結果や配信の順番が変わると、ページが自動で書き換わります
  • URL は、イベントの運営画面の「配信」→「オーバーレイ」タブでコピーできます(配信を管理できる運営だけ)
  • URL に含まれるトークンが鍵です。再発行すると、それまでの URL はすぐに使えなくなります

JSON で取る

ページと同じデータを JSON で返します。認証はページと同じトークンだけで、API キーは要りません。

curl "https://hivee.jp/api/events/{eventId}/overlay?token={token}&view=scoreboard"
パラメータ説明
token必須。オーバーレイの URL のトークン
viewscoreboard(配信中の試合と配信キュー)または top8(TOP 8 だけ)。省くとすべて
top8view を省いたときに 1 を付けると TOP 8 も返す
programTOP 8 にするプログラム ID

主な項目は次のとおりです。API v1 と違い、項目名は camelCase です。

項目内容
eventイベントの id・title・logoUrl(主催コミュニティのアイコン)
colors配信管理で決めたテーマ色・アクセント色(theme・accent。未設定は null)
designスコアボードのデザイン(universal / topleft / simple)
current配信中の試合。無ければ null
queue配信キュー(position 付きの試合の並び)
top8TOP 8 のカード(status が ok のときだけ cards が入る)

試合(current・queue の各要素)には roundLabel・stationName・programName と、左右の選手 playerA・playerB が入ります。選手の項目は name・score・seed・xHandle・avatarUrl・losers(グランドファイナルで敗者側から来た選手)・characters(キャラコードの並び)です。

  • トークンが違う・イベントが無いときは、区別せずに 404 を返します
  • 返すのは公開ブラケットで見える範囲までです。X の ID と画像は、本人の公開プロフィールにあるときだけ入ります
  • Hivee のページは変化の合図を受けて取り直していますが、この合図は Hivee のページ専用です。自作のツールでは数秒おきに取り直してください。配信キューを中心に使うなら、API v1 の GET /events/{id}/stream-queue を ETag 付きで取り直す方法もあります
配信オーバーレイ | Hivee 開発者向け