L'API di PLAYDECK è uno strumento che consente a chiunque di interagire con PLAYDECK. Questo articolo illustra come iniziare a sviluppare con l'API:
In questo articolo:
→ Introduzione
→ Esempi
→ Implementare l'API
Introduzione
L'API di PLAYDECK è bidirezionale: ricevi lo stato di riproduzione, ma puoi anche inviare comandi a PLAYDECK.
L'API si basa sui WebSocket: essendo parte integrante di JavaScript, è possibile sviluppare in JavaScript, NodeJS o TypeScript. La porta WebSocket è fissata al numero 11411 ed è sempre attiva su PLAYDECK.
Abbiamo deciso di optare per i WebSocket perché:
- Supporta entrambe le direzioni: da e verso PLAYDECK
- Non è richiesta alcuna installazione: basta un qualsiasi editor di testo
- Non è richiesta alcuna misura specifica di sicurezza di rete
- È facile creare la propria interfaccia utente o animazione con l'HTML
Cosa si può inviare a PLAYDECK?
- Riproduci o avvia blocchi, clip, sovrapposizioni o azioni
- Avvia/interrompi i contenuti video come gli streaming
Cosa offre PLAYDECK?
- Eventi (ad esempio, l'avvio di un blocco o di una clip)
- Stato della trasmissione (ad es. cosa è in onda e il tempo rimanente del blocco)
- Contenuto (ad es. playlist completa con blocchi e clip)
Esempi
1) Compagno
L'API PLAYDECK viene utilizzata da bitfocus Companion nel modulo PLAYDECK. Questo ti offre una rapida panoramica delle potenzialità dell'API:
https://playdeck.tv/howto/companion/
2) Vista del regista
L'API viene utilizzata anche dalla Director View, che fa parte di PLAYDECK. I modelli HTML sono disponibili qui:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Director-View
3) Sovrapposizioni HTML
L'API viene utilizzata anche in alcuni esempi di panoramica sull'HTML, che potete trovare qui:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Modelli-Overlay
Implementare l'API
Abbiamo preparato alcuni esempi per consentirti di esaminare rapidamente uno script funzionante. Ti invitiamo a seguirli in ordine, poiché si basano l'uno sull'altro.
Suggerimento n. 1: È possibile fare doppio clic su qualsiasi file HTML per aprirlo nel browser e avviare lo script/l'API
Suggerimento 2: È possibile modificare il file “WebSocketSDK\Version.js” per cambiare l'indirizzo IP
1) Connessione nativa (senza API)
Cominciamo con qualcosa di molto essenziale:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\SampleMinimalistic.html
Questo aprirà il WebSocket verso PLAYDECK utilizzando codice JavaScript nativo e invierà un comando per riprodurre il primo clip nel primo blocco.
Ecco un altro esempio: in questo caso è possibile cliccare sui pulsanti in HTML per avviare la riproduzione in PLAYDECK:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\SampleUserInterface.html
2) Connessione minimalista (CON API)
Questo esempio illustra l'API:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\SampleMinimalisticSDK.html
Utilizza la sottocartella “WebSocketAPI” e include il suo SCRIPT PRINCIPALE “AppInterface.js”, che funge in qualche modo da “caricatore” per l'intera API.
L'API gestirà ora la connessione WebSocket a PLAYDECK, quindi non è necessario implementarla manualmente. L'API mette inoltre a disposizione di JavaScript un framework di modelli. Il nome del modello deriva dal nome del file, quindi deve corrispondere. Sono disponibili diverse funzioni predefinite. Per questo esempio utilizzeremo solo “Start”: questa funzione verrà chiamata dall'API una volta che la connessione WebSocket a PLAYDECK sarà stata stabilita con successo. In questo esempio riprodurrà il primo clip del canale 1.
3) Altre funzioni del framework
Oltre a “Start”, sono disponibili molte altre funzioni del framework:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\SamplePlayRandomClip.html
Per conoscere tutte le funzioni disponibili, consultare i commenti nel file JS.
Se apri la console del browser (di solito con il tasto F12), puoi vedere i risultati delle istruzioni “console.log”.
4) Analizzare i dati del progetto
Per accedere a tutti i clip è disponibile la funzione “DataProject”; questo esempio mostra come enumerare i dati del progetto:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\SampleShowPlaylist.html
5) Esempio di orario personalizzato
L'ultimo esempio mostra uno script completo e funzionante per una pianificazione personalizzata al di fuori di PLAYDECK:
c:\Utenti\Pubblico\Documenti\JoyEventMedia\Playdeck\Modelli-HTML\Automazione-e-Interfaccia-Utente\Programma-Settimanale-Esempio.html
