53のエンドポイント:ショー全体を自動化する方法
OpenAPI 3.1、4つのセキュリティスコープ、SSEストリーム、そしてn8n、vMix、OBSとの実践的な自動化事例。
· 技術解説 · 11 min read
すべてのプロダクションチームの進化において、マスターコントロールルームで個々のツールについて考えることをやめ、システムについて考え始める瞬間があります。タイマーはもはや単なるタイマーではありません。リアルタイムで通信し、連携し、互いに応答する必要のある相互接続されたプロダクションシステムのネットワーク内のノードです。その瞬間が到来したとき、APIがツールがネットワークに参加できるか、それとも孤立した島であり続けるかを決定します。
Timers StudioはOpenAPI 3.1仕様に基づいて文書化された53のREST APIエンドポイントを公開しています。これはインテグレーションへの形だけのジェスチャーではありません。システム内のすべての意味のあるパラメータとアクションをプログラマティックアクセスに公開する包括的なコントロールサーフェスです。
APIは4つのセキュリティスコープで構成されています。READはすべての監視および状態取得エンドポイントへのアクセスを提供します。TRANSPORTはタイマー再生制御を追加します。MUTATIONはデータ変更機能を追加します。ADMINはセッション管理を含む完全なアクセスを提供します。各APIキーは作成時に特定のスコープが割り当てられます。この粒度は、異なるシステムが異なるアクセスレベルを必要とするプロダクション環境において重要です。
認証はBearerトークンを使用します。すべてのAPIリクエストにはトークンを含むAuthorizationヘッダーが含まれ、サーバーはリクエストを処理する前にトークンを検証しスコープを確認します。
リアルタイム監視機能はServer-Sent Events上に構築されています。状態変化を検出するためにAPIをポーリングする代わりに、クライアントがSSE接続を開き、イベントが発生次第受信します。タイマー開始、一時停止、リセット、メッセージ送信、テーマ変更、デバイス接続、切断。すべての状態遷移が構造化されたJSONペイロードを持つSSEイベントを生成します。
3つの実践的な自動化シナリオでAPIの価値を説明しましょう。
第一のシナリオはオープンソースのワークフロー自動化プラットフォームであるn8nを使用します。プロダクションチームは固定フォーマットの週次ライブショーを管理しています。オープニング、3つのインタビューセグメント、クロージング。プロデューサーが更新するGoogleシートから毎週自動的にショーランダウンを作成したいと考えています。n8nワークフローが毎週月曜の朝にトリガーされ、Google Sheetを読み取り、API呼び出しでスタジオセッションを作成し、正しい時間とタイトルのタイマーを追加し、スピーカー名を割り当て、SlackでプロダクションチームにスタジオURLを送信します。プロデューサーが朝のコーヒーを飲み終える頃には、その週のランダウンはプログラム済みでリハーサルの準備ができています。
第二のシナリオはマルチカメラスイッチングとストリーミングに使用されるライブプロダクションソフトウェアvMixと統合します。プロダクションチームはタイマートランジション時にカメラ切り替えを自動的に行いたいと考えています。軽量スクリプトがTimers StudioのSSEストリームを監視し、タイマートランジションイベントを検出すると、対応する入力切り替えコマンドをvMixのTCP APIに送信します。結果として、オペレーターの介入なしに、タイマーランダウンに同期した自動カメラ切り替えが実現します。
第三のシナリオはオープンソースのストリーミングソフトウェアOBSを使用します。コンテンツクリエイターがストリームオーバーレイに現在のタイマー値、スピーカー名、セグメントタイトルを表示したいと考えています。OBSのブラウザソースがTimers StudioのSSEストリームに接続し、現在の状態を透明なオーバーレイとしてレンダリングするカスタムHTMLページを指します。オーバーレイはタイマーの進行に伴いリアルタイムで更新され、ランダウンが進むにつれて正しいスピーカー名とセグメントタイトルを自動的に表示します。
これらのシナリオを超えて、APIはより洗練された自動化パターンを可能にします。タイマー状態に基づく条件付きロジック、スケジュールされた操作、データ収集、外部トリガーなどです。
API文書はインタラクティブです。各エンドポイントには説明、パラメータ定義、リクエストボディスキーマ、レスポンス例が含まれています。APIキーを使用してドキュメントページから直接エンドポイントをテストできます。OpenAPI 3.1仕様ファイルもダウンロード可能で、Postman、Insomnia、またはOpenAPI形式をサポートするAPIクライアントにインポートすれば、すぐに使える完全にドキュメント化されたコレクションが手に入ります。
手動操作の限界を超え、統合された自動ショーコントロールシステムを構築する準備ができたプロダクションチームにとって、APIは基盤です。Studioインターフェースで利用可能なすべての機能はAPIを通じて利用可能です。人間のオペレーターがクリックとキーストロークで行うことを、自動化プラットフォームがHTTPリクエストで行えます。
[今すぐ体験する] 最初のAPIキーを生成し、ショーコーラーがキューリストを自動化するエンドポイントを探索してください。インタラクティブなドキュメントにより、数分以内にAPIコールを成功させることができます。[スタジオを開く] [コンソールを見る]