Controllo remoto

Fauste Player si può leggere e usare in rete tramite un’API HTTP, con aggiornamenti in tempo reale, e tramite OSC. Possono usarli una pagina web, un’app per telefono, l’automazione di una stazione o una superficie di controllo. È disattivato finché non lo attivi, e all’inizio risponde solo su questo computer.

Attivarlo

Apri Impostazioni → Remoto e spunta Consenti il controllo remoto via HTTP (o Consenti il controllo via OSC). La riga sotto ogni interruttore dice se il server è in ascolto, e dove, o perché non si è avviato. Le modifiche si applicano subito; non serve riavviare. Un campo di testo (un indirizzo, il token, un elenco) si applica quando lo lasci, apri un’altra sezione o chiudi le Impostazioni; un valore non ancora valido mantiene quello in uso, ed Esc annulla ciò che hai digitato.

Puoi anche modificare config.json mentre Fauste Player è chiuso (vedi Dati e backup per sapere dove si trova). Dentro l’oggetto "config", imposta remote.http.enabled su true:

{
  "schema_version": 1,
  "config": {
    …
    "remote": {
      "http": { "enabled": true }
    }
  }
}

Ascolta su http://127.0.0.1:7380. Avviarlo non riproduce mai nulla; agiscono solo le richieste.

In ascolto sulla rete dello studio

Per raggiungerlo da altri computer, imposta bind su 0.0.0.0 (o su uno degli indirizzi di questo computer) e imposta un token di almeno 16 caratteri. In Impostazioni → Remoto, Genera crea un token casuale lungo. Resta nascosto finché non premi Mostra, e Copia lo mette negli appunti per il client. Senza un token il server rifiuta di avviarsi, e il log dice perché.

"remote": {
  "http": {
    "enabled": true,
    "bind": "0.0.0.0",
    "port": 7380,
    "token": "a-long-random-secret-of-your-own"
  }
}

I client inviano il token come Authorization: Bearer <token>. L’API non è cifrata. Tienila su una rete di studio fidata, oppure mettila dietro un reverse proxy con HTTPS.

Pagine web

Una pagina web servita da un altro indirizzo può usare l’API solo se la sua origine (per esempio https://studio.example) è elencata in cors_origins. Le richieste da altre pagine vengono rifiutate, anche su questo computer, così una pagina che capita di avere aperta non può pilotare il lettore. "*" (qualsiasi origine) è accettato solo insieme a un token.

Cosa può fare un client

Un client può:

• leggere i lettori, le playlist, i brani (con copertina e forma d’onda) e la cartwall;
• riprodurre, mettere in pausa, fermare, dissolvere, riavviare e tornare indietro;
• scegliere la voce successiva (anche la voce in onda: suona ancora una volta), preascoltare e spostarsi (su un lettore fermo uno spostamento sceglie da dove Play avvia la voce successiva, e uno spostamento prima del suo cue-in parte dal cue-in);
• impostare volumi, modalità, stop alla fine del brano attuale, e i segni di ripetizione e di stop dopo di una voce;
• lanciare, fermare e preascoltare i cart, e cambiare la pagina di cart mostrata;
• modificare: creare, rinominare ed eliminare playlist; aggiungere un brano già caricato, e rimuovere, spostare o duplicare voci; creare, rinominare, ridimensionare ed eliminare pagine di cart, e configurare un cart con un brano caricato; impostare o reimpostare i marker.

Rimuovere ciò che è in onda viene rifiutato, come sullo schermo. I file non ancora caricati non si possono aggiungere da remoto: si trovano su questo computer, quindi aggiungili prima qui.

Anche un pulsante disattivato sullo schermo viene rifiutato da remoto. Il riferimento completo è nella documentazione tecnica.

Provalo da un terminale:

curl -s http://127.0.0.1:7380/api/v1/players
curl -s -X POST http://127.0.0.1:7380/api/v1/players/<id>/play

Aggiornamenti in tempo reale

Un client può seguire i cambiamenti man mano che avvengono invece di chiedere ancora e ancora. GET /api/v1/events è un flusso di eventi: prima l’intero stato, poi ogni modifica a un lettore, a una playlist, a un brano o alla cartwall, e i tempi di ciò che sta suonando alcune volte al secondo.

curl -sN http://127.0.0.1:7380/api/v1/events

Una pagina web usa EventSource. I browser non possono inviare lì il token come header, quindi va nell’indirizzo: /api/v1/events?token=<token>.

OSC

OSC è il protocollo abituale delle superfici di controllo, dei banchi luci e dei software di controllo degli spettacoli. Attivalo con remote.osc.enabled. Ascolta sulla porta UDP 7381 di questo computer. Per accettare pacchetti da altri computer, imposta remote.osc.bind su 0.0.0.0 ed elenca i loro indirizzi o sottoreti in remote.osc.allowed_sources (per esempio "192.168.1.0/24"). OSC non ha una password, quindi tienilo su una rete di studio fidata.

I lettori sono numerati 1, 2, 3… come compaiono sullo schermo. I cart sono numerati nella pagina mostrata.

oscsend localhost 7381 /fauste/player/1/play
oscsend localhost 7381 /fauste/player/2/volume f 0.8
oscsend localhost 7381 /fauste/cart/3/fire

Una superficie che vuole mostrare lo stato (luci, nomi, conti alla rovescia) si sottoscrive, e poi riceve ogni valore una volta e in seguito solo ciò che cambia. Quando un lettore o un pulsante di cart sparisce (meno lettori, una pagina più piccola), i suoi indirizzi ricevono una volta un valore vuoto, in modo che la superficie li cancelli. Deve sottoscriversi di nuovo entro un minuto (subscription_ttl_secs) per continuare a ricevere:

oscdump 9000 &
oscsend localhost 7381 /fauste/subscribe i 9000

Un sottoscrittore può indicare qualsiasi porta del proprio indirizzo, e ne vengono mantenuti fino a max_subscribers. Chiunque abbia il permesso di inviare può quindi anche sottoscriversi. È un altro motivo per tenere OSC su una rete fidata.

oscsend e oscdump fanno parte di liblo (liblo-tools su Debian e Ubuntu). L’elenco completo degli indirizzi è nella documentazione tecnica.

Tutte le impostazioni

I valori fuori intervallo vengono corretti quando il file viene caricato, e la correzione viene registrata nel log.