はじめに

hedgehog とは

hedgehog は、 目的に合ったオリジナルサービスを構築できるライブ配信統合サービス です。

全てお任せ頂き、すぐに使い始める事が出来る完成品を納品するプランもありますが、「仕組み」の部分だけ提供して、フロントエンドは自由に作って頂く事も出来ます。

いずれの場合でも、イベント自体の管理はダッシュボードを使用して手軽に行う事が出来、実装者はあくまでも魅力的なフロントエンドを作る事に集中する事が出来ます。また、ダッシュボードを構成している API も全て公開されているので、必要であればサービスオリジナルのダッシュボードを作成することも出来ます。

その意味で、hedgehog は ライブ配信に特化したヘッドレス CMS と言い換える事も出来ます。

Hedgehog SDKは、hedgehog.live が提供している API を Javascript / Typescript の操作のみで呼び出せるようにしたものです。

パッケージは npm で公開されており、以下のように取得する事が可能です。

shell

npm i @hedgehog-live/sdk

あるいは、CDN を使用して読み込むことも出来ます。

html

<html lang="en">
  <head>
    <script src="https://unpkg.com/@hedgehog-live/sdk/dist/hhl.bundle.js"></script>
  </head>
</html>

SDK を使用するためには、まず参照するステージの UUID を知っている必要があります。

また、管理権限が必要な操作を実行する場合は適切なユーザーアカウントが必要になります。
管理権限は、以下のいずれかの方法で得る事が出来ます。

当ドキュメントの中で使用する用語/概念の意味を以下に記します。

Universal Unique ID の略で、文字列で表現された一意な ID です。以下のような形式になります。

d6035c4b-bad4-4b41-9d88-e22a995e1e8e

hedgehog ではステージやイベントを特定する際にこの UUID を使用しています。

hedgehog 上の仮想のイベント会場を指します。ライブハウスでアーティストがパフォーマンスする「ステージ」から名付けられました。hedgehog のほぼ全ての要素はステージと紐づいており、SDK を使用する上でも最初に必要になる要素になります。

作成したステージにはイベントの規模や運営形態に応じてゲストユーザーを追加する事が出来ます。