Non classé

API PLAYDECK

26 octobre 2025 par

Intégrez PLAYDECK à des scripts, des systèmes d'automatisation et des interfaces utilisateur personnalisées grâce à notre API REST standard (OpenAPI 3) et à notre interface WebSocket, pour un contrôle en temps réel via un seul port.

Dans cet article :
→ De quelle interface ai-je besoin ?
→ Guide de démarrage rapide de l'API REST
→ Référence interactive de l'API
→ Canal en temps réel WebSocket
→ Saisie des commandes TCP héritées
→ Exemples d'intégration

De quelle interface ai-je besoin ?

PLAYDECK propose différentes interfaces en fonction de vos besoins d'intégration. Reportez-vous au tableau ci-dessous pour sélectionner le protocole et le port appropriés :

Cas d'utilisationInterface recommandéePort
Scripts, cURL, Postman, intégrations HTTP personnaliséesAPI REST /api/v1 (OpenAPI 3)11411
Statut en temps réel, événements, superpositions HTML, Bitfocus CompanionCanal WebSocket11411
Surfaces de contrôle prêtes à l'emploiBitfocus Companion (via WebSocket)11411
Clients TCP hérités / Pipelines d'automatisation existantsCommandes TCP dans11375

Recommandation : La plupart des nouveaux projets d'intégration devraient commencer par la API REST. Passez à cette option ou associez-la à WebSocket uniquement si vous avez besoin de mises à jour d'état continues à faible latence ou de déclencheurs d'événements en temps réel.

Guide de démarrage rapide de l'API REST

Lorsque PLAYDECK est en cours d'exécution, l'API REST HTTP est automatiquement accessible sur le port 11411 (utilisant le même service que la commande à distance Web intégrée).

URL de base

http://HOST:11411/api/v1


Remplacer HÔTE en indiquant l'adresse IP réelle de votre appareil PLAYDECK, que vous trouverez sous Paramètres ➔ Réseau ➔ API développeur.

Tests au sein de PLAYDECK

Vous n'avez pas besoin d'outils externes pour commencer à tester. Ouvrez Paramètres ➔ Réseau ➔ API développeur au sein de l'application logicielle pour envoyer des demandes d'échantillons directement depuis l'interface utilisateur ou ouvrir la documentation interactive.

Exemples de requêtes HTTP

1. Bilan de santé du service :

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


2. Récupérer le statut de Playout (réponse JSON) :

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


3. Déclenchement de la fonction « Play » sur le canal Playout 1 :

POST /api/v1/channels/1/play HTTP/1.1
Hôte : HOST:11411


4. Lire le bloc 1, clip 2 sur la chaîne 1 de Playout :

POST /api/v1/channels/1/play/1/2 HTTP/1.1
Hôte : HOST:11411


De nombreuses actions acceptent des paramètres de chemin d'accès facultatifs permettant un contrôle ciblé (tels que les identifiants de bloc/clip, les décalages de timecode ou les identifiants de superposition).

Trappe de secours « Legacy Command »

Si vous avez besoin d'une prise en charge complète du langage de commande classique PLAYDECK via HTTP, vous pouvez transmettre des commandes au format « pipe » au point de terminaison dédié aux commandes :

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

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


Remarque : dans la version actuelle, aucune clé API ni aucun jeton d'authentification n'est requis pour les opérations sur le réseau local (LAN).

Référence interactive de l'API

Le contrat complet lisible par machine pour cette interface est fourni sous la forme d'un document de spécification OpenAPI 3.

➔ Télécharger : Spécification OpenAPI (YAML)

Pour une navigation interactive, l'inspection des données utiles et des tests directs via la fonction “ Essayer ” sur votre instance PLAYDECK active :

  1. Lancement PLAYDECK.
  2. Accéder à Paramètres ➔ Réseau ➔ API développeur puis cliquez sur Référence de l'API ouverte.
  3. Vous pouvez également ouvrir un navigateur Web sur n'importe quel ordinateur du même réseau et vous rendre à l'adresse suivante : http://HOST:11411/api/v1/docs

Cette page de documentation répertorie de manière dynamique tous les points de terminaison REST disponibles, les paramètres requis, les définitions de schéma et les données de réponse attendues.

    Canal en temps réel WebSocket

    Port 11411 gère simultanément les connexions WebSocket. Ce canal bidirectionnel est spécialement conçu pour les opérations nécessitant un flux de données continu :

    • Statut continu Playout : Suivi de la position de lecture à haute fréquence et mises à jour du timecode.
    • Déclencheurs d'événements : Des notifications immédiates lorsqu'un extrait, un bloc ou une liste de lecture démarre, s'arrête ou passe en boucle.
    • Commandes classiques de Pipe : Traitement direct des commandes de contrôle natives au format <play|1|...>.

    Le responsable Module PLAYDECK de Bitfocus Companion, le Interface utilisateur Web à distance, les superpositions graphiques HTML personnalisées et les modèles Director View utilisent ce canal spécifique en temps réel. La documentation complète sur la syntaxe des commandes et des types d'événements est disponible directement dans le package de l'application ou dans votre répertoire de modèles local :

    Interface utilisateur Web à distance :
c:\Program Files\JoyEventMedia\Playdeck\html\webremote.html

Modèles HTML :
C:\Users\Public\Documents\JoyEventMedia\Playdeck\HTML-Templates\
ou
c:\Users\\AppData\Local

    Saisie des commandes TCP héritées

    Afin de garantir la compatibilité ascendante avec l'infrastructure d'automatisation de diffusion existante, PLAYDECK continue d'accepter les connexions TCP brutes entrantes sur le port 11375.

    Ce paramètre est géré sous Paramètres ➔ Réseau ➔ Entrant ➔ Commandes TCP entrantes. La syntaxe de la charge utile correspond au format délimité par des barres verticales utilisé par le canal WebSocket et l'API REST /api/v1/commandes point de terminaison.

    • Note des développeurs : Pour tous les projets de développement partant de zéro et toutes les nouvelles intégrations de scripts, nous recommandons vivement d'utiliser l'API REST plutôt que des sockets TCP bruts.

    Exemples d'intégration

    • Bitfocus Companion : Déploiement rapide de surfaces de contrôle matérielles grâce à notre module natif prêt à l'emploi via WebSockets.
    • Commande à distance via le Web : Interface de contrôle de production complète, accessible depuis n'importe quel navigateur sur le port 11411.
    • Affichage « Director » et superpositions HTML : Modèles Web intégrés illustrant la liaison en temps réel des états.
    • Outils logiciels sur mesure : Développement rapide d'applications à l'aide de clients HTTP standard générés à partir de notre spécification OpenAPI, avec, en option, l'utilisation de WebSockets pour la télémétrie.

    Vous avez des questions ou des besoins spécifiques en matière de flux de travail ? Contactez notre équipe d'ingénieurs à l'adresse suivante : [email protected].