未分類

PLAYDECK API

2025年10月26日 著：

当社の標準REST API（OpenAPI 3）およびWebSocketインターフェースを活用して、PLAYDECKをスクリプト、自動化システム、およびカスタムユーザーインターフェースに統合し、単一のポート上でリアルタイム制御を実現できます。.

この記事の内容：
→ どのインターフェースが必要ですか？
→ REST API クイックスタート
→ インタラクティブなAPIリファレンス
→ WebSocketリアルタイムチャネル
→ 従来のTCPコマンドの入力
→ 統合事例

どのインターフェースが必要ですか？

PLAYDECKでは、統合要件に応じてさまざまなインターフェースを提供しています。以下の概要を参照して、適切なプロトコルとポートを選択してください：

ユースケース推奨インターフェースポート
スクリプト、cURL、Postman、カスタムHTTP連携REST API /api/v1 (OpenAPI 3)11411
ライブステータス、イベント、HTMLオーバーレイ、Bitfocus CompanionWebSocketチャネル11411
既製の制御面Bitfocus Companion（WebSocket経由）11411
レガシーTCPクライアント／既存の自動化パイプラインTCP コマンド（In）11375

推奨事項： ほとんどの新しく立ち上げる統合プロジェクトは、まず REST API. これに切り替えるか、これと組み合わせて使用してください WebSocket 継続的な低遅延のステータス更新や、リアルタイムのイベントトリガーが必要な場合に限り。.

REST API クイックスタート

PLAYDECK の実行中は、HTTP REST API がポート 11411 （組み込みのWeb Remoteと同じサービスを利用しています）。.

ベースURL

http://HOST:11411/api/v1


置換 ホスト PLAYDECKマシンの実際のIPアドレスを、以下の場所から確認して入力してください。 設定 ➔ ネットワーク ➔ 開発者向けAPI.

PLAYDECK内でのテスト

テストを開始するのに、外部ツールは必要ありません。開いてください 設定 ➔ ネットワーク ➔ 開発者向けAPI ソフトウェアアプリケーション内で、UIから直接サンプルリクエストを送信したり、インタラクティブなドキュメントを起動したりできます。.

HTTPリクエストの例

1. サービスのヘルスチェック：

GET /api/v1/health HTTP/1.1
Host: HOST:11411


2. Playoutのステータスを取得する（JSONレスポンス）：

GET /api/v1/status HTTP/1.1
Host: HOST:11411


3. Playout チャンネル 1 でのトリガー再生：

POST /api/v1/channels/1/play HTTP/1.1
Host: HOST:11411


4. Playoutのチャンネル1で、ブロック1のクリップ2を再生します：

POST /api/v1/channels/1/play/1/2 HTTP/1.1
Host: HOST:11411


多くのアクションでは、対象を細かく制御するために、オプションのパスパラメータ（ブロックID、クリップID、タイムコードオフセット、オーバーレイIDなど）を受け付けます。.

レガシー・コマンド・エスケープハッチ

HTTP 経由でクラシックな PLAYDECK コマンド言語の全機能を網羅したい場合は、パイプ形式のコマンドを専用のコマンドエンドポイントに渡すことができます：

POST /api/v1/commands HTTP/1.1
Host: HOST:11411
Content-Type: application/json

{
  "command": "play",
  "args": ["1", "1", "2"]
}


注：現在のバージョンでは、ローカルエリアネットワーク（LAN）での操作にAPIキーや認証トークンは必要ありません。.

インタラクティブなAPIリファレンス

このインターフェースに関する完全な機械可読契約は、OpenAPI 3 仕様書として提供されています。.

➔ ダウンロード： OpenAPI仕様（YAML）

アクティブなPLAYDECKインスタンスに対して、インタラクティブなブラウジング、ペイロードの検査、および直接の「試してみる」テストを行うには：

  1. リリース PLAYDECK.
  2. [ここに移動] 設定 ➔ ネットワーク ➔ 開発者向けAPI そして、クリックして Open API リファレンス.
  3. あるいは、同じネットワーク内の任意のマシンでウェブブラウザを開き、次のURLにアクセスしてください： http://HOST:11411/api/v1/docs

このドキュメントページでは、利用可能なすべてのRESTエンドポイント、必須パラメータ、スキーマ定義、および期待されるレスポンスペイロードを動的に一覧表示します。.

    WebSocketリアルタイムチャネル

    ポート 11411 WebSocket接続を同時に処理します。この双方向チャネルは、持続的なデータストリーミングを必要とする操作のために特別に設計されています：

    • Playoutの継続状況： 高頻度の再生位置追跡およびタイムコードの更新。.
    • イベントのトリガー： クリップ、ブロック、またはプレイリストの再生開始、停止、ループ時に、即座に通知が届きます。.
    • 定番のパイプコマンド： 次のような形式で記述されたネイティブ制御コマンドの直接処理 <play|1|...>.

    公式の Bitfocus Companion PLAYDECK モジュール, その WebリモートUI, 、カスタムHTMLグラフィックオーバーレイ、およびDirector Viewテンプレートは、この特定のリアルタイムチャネルを利用しています。コマンドおよびイベントタイプの完全な構文ドキュメントは、アプリケーションパッケージ内、またはローカルのテンプレートディレクトリ内で直接確認できます：

    WebリモートUI：
c:\Program Files\JoyEventMedia\Playdeck\html\webremote.html

HTMLテンプレート：
C:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\
または
c:\Users\\AppData\Local

    従来のTCPコマンドの入力

    既存の放送自動化インフラとの下位互換性を維持するため、PLAYDECK は引き続き、ポート 11375.

    この設定は、以下の場所で管理されています。 設定 ➔ ネットワーク ➔ 受信 ➔ TCP コマンド（受信）. ペイロードの構文は、WebSocketチャネルおよびRESTで使用されるパイプ区切り形式と一致しています。 /api/v1/commands エンドポイント。.

    • 開発者からの注記： ゼロから開発するすべてのプロジェクトおよび新しいスクリプトの統合については、生のTCPソケットの代わりにREST APIを利用することを強くお勧めします。.

    統合事例

    • Bitfocus Companion： WebSocketsを介して、本番環境対応のネイティブモジュールを活用し、物理ハードウェアのコントロールサーフェスを迅速に展開します。.
    • Webリモート： ポート経由で、どのブラウザからでもアクセス可能な、充実した機能を備えた生産管理インターフェース 11411.
    • ディレクタービューとHTMLオーバーレイ： ライブステータスのバインディングを実演する、組み込みのWebテンプレート。.
    • カスタムソフトウェアツール： 当社のOpenAPI仕様から生成された標準的なHTTPクライアントを用いた迅速なアプリケーション開発。必要に応じて、テレメトリ用にWebSocketsを活用することも可能です。.

    ご質問や、ワークフローのカスタマイズに関するご要望がございましたら、当社のエンジニアリングチームまでお問い合わせください。 [email protected].