Die PLAYDECK-API ist eine Schnittstelle, die es jedem ermöglicht, mit PLAYDECK zu kommunizieren. In diesem Artikel erfahren Sie, wie Sie mit der Entwicklung mit der API beginnen können:
In diesem Artikel:
→ Einleitung
→ Beispiele
→ Die API implementieren
Einleitung
Die PLAYDECK-API ist bidirektional: Sie erhalten den Playout-Status, können aber auch Befehle an PLAYDECK senden.
Die API basiert auf WebSockets: Da diese Teil von JavaScript sind, kannst du in JavaScript, Node.js oder TypeScript programmieren. Der WebSocket-Port ist fest auf 11411 eingestellt und in PLAYDECK immer aktiviert.
Wir haben uns für WebSockets entschieden, weil:
- Es unterstützt beide Richtungen: Von und zu PLAYDECK
- Keine Installation erforderlich: Verwenden Sie einen beliebigen Texteditor
- Es sind keine besonderen Netzwerksicherheitsmaßnahmen erforderlich
- Einfaches Erstellen eigener Benutzeroberflächen oder Animationen mit HTML
Was kann an PLAYDECK gesendet werden?
- Blöcke, Clips, Overlays oder Aktionen abspielen
- Videoinhalte wie Streams starten/stoppen
Was kann man bei PLAYDECK erhalten?
- Ereignisse (z. B. ein Block oder Clip hat begonnen)
- Wiedergabestatus (z. B. Was gerade läuft und die verbleibende Sendezeit)
- Inhalt (z. B. vollständige Wiedergabeliste mit Blöcken und Clips)
Beispiele
1) Begleiter
Die PLAYDECK-API wird von bitfocus Companion im PLAYDECK-Modul verwendet. So erhalten Sie einen schnellen Eindruck davon, was die API alles kann:
https://playdeck.tv/howto/companion/
2) Ansicht „Direktor“
Die API wird auch von der Director-Ansicht genutzt, die Teil von PLAYDECK ist. Die HTML-Vorlagen finden Sie hier:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Director-View
3) HTML-Overlays
Die API wird auch in einigen HTML-Beispielen verwendet, die Sie hier finden:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Overlay-Vorlagen
Die API implementieren
Wir haben einige Beispiele für Sie vorbereitet, damit Sie sich schnell einen Überblick über ein funktionierendes Skript verschaffen können. Bitte sehen Sie sich diese der Reihe nach an, da sie aufeinander aufbauen.
Tipp 1: Sie können auf eine beliebige HTML-Datei doppelklicken, um sie im Browser zu öffnen und das Skript/die API zu starten
Tipp 2: Sie können die Datei “WebSocketSDK\Version.js” bearbeiten, um die IP-Adresse zu ändern
1) Native Verbindung (ohne API)
Fangen wir mit etwas ganz Minimalistischem an:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-Benutzeroberfläche\SampleMinimalistic.html
Dadurch wird die WebSocket-Verbindung zu PLAYDECK mit nativem JavaScript-Code hergestellt und ein Befehl gesendet, den ersten Clip im ersten Block abzuspielen.
Ein weiteres Beispiel ist dieses, bei dem Sie auf HTML-Schaltflächen klicken können, um die Wiedergabe in PLAYDECK zu starten:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-Benutzeroberfläche\Beispiel-Benutzeroberfläche.html
2) Minimalistische Verbindung (MIT API)
In diesem Beispiel wird die API vorgestellt:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-UI\SampleMinimalisticSDK.html
Es nutzt den Unterordner “WebSocketAPI” und enthält dessen Hauptskript “AppInterface.js”, das gewissermaßen als “Loader” für die gesamte API fungiert.
Die API übernimmt nun die WebSocket-Verbindung zu PLAYDECK, sodass Sie dies nicht manuell programmieren müssen. Die API stellt außerdem ein Vorlagen-Framework für JavaScript bereit. Der Name der Vorlage leitet sich vom Dateinamen ab und muss daher mit diesem übereinstimmen. Es stehen mehrere vordefinierte Funktionen zur Verfügung. In diesem Beispiel verwenden wir nur “Start”: Diese Funktion wird von der API aufgerufen, sobald die WebSocket-Verbindung zu PLAYDECK erfolgreich hergestellt wurde. In diesem Beispiel wird der erste Clip von Kanal 1 abgespielt.
3) Weitere Framework-Funktionen
Neben “Start” stehen noch viele weitere Framework-Funktionen zur Verfügung:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-Benutzeroberfläche\Beispiel:Zufälligen-Clip-abspielen.html
Alle verfügbaren Funktionen finden Sie in den Kommentaren der JS-Datei.
Wenn Sie die Browser-Konsole öffnen (in der Regel mit F12), sehen Sie die Ausgabe der “console.log”-Anweisungen.
4) Projektdaten auswerten
Um auf alle Clips zuzugreifen, steht die Funktion “DataProject” zur Verfügung. Dieses Beispiel zeigt, wie man die Projektdaten auflistet:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-Benutzeroberfläche\Beispiel-Show-Playlist.html
5) Beispiel für einen individuellen Zeitplan
Das letzte Beispiel zeigt ein voll funktionsfähiges und vollständiges Skript für eine benutzerdefinierte Zeitplanung außerhalb von PLAYDECK:
c:\Benutzer\Öffentlich\Dokumente\JoyEventMedia\Playdeck\HTML-Vorlagen\Automation-und-Benutzeroberfläche\Beispiel-Wochenplan.html
