Generale

Il API, se abilitata, è disponibile all'indirizzo "http://localhost:8989/api/v1". Questa è la base URL che deve essere anteposto ad ogni metodo URL elencati di seguito.

Se una risorsa è stata introdotta dopo il lancio iniziale dell'applicazione HTTP API, il metodo è contrassegnato da un simbolo Disponibile da informazioni.

/

Metodi supportati: "GET"
Reindirizza all'elenco dei documenti aperti in "/documents".

Documenti

Interrogazione dei documenti

/documenti

Metodi supportati: "GET"
Visualizza un elenco di documenti aperti. Vedere il tipo di dati documents per sapere quali informazioni contengono gli oggetti restituiti.

/documenti/(ID documento)

Metodi supportati: "GET"
Restituisce un singolo documento specificato da "(DocumentID)". Nella sezione inclusa della risposta verranno restituiti anche tutti gli oggetti "layer" utilizzati da questo documento e tutti gli oggetti "source" contenuti in questo documento (sideloading). Per ulteriori informazioni sui dati restituiti, vedere il tipo di dati documents.

/documenti/(ID documento)/programmaOut

Metodi supportati: "GET"
L'output del programma attualmente prodotto dal documento specificato da "(DocumentID)".
Assume gli stessi parametri delle anteprime della sorgente.

Azioni del documento

/documenti/(ID documento)/setLive

Metodi supportati: "GET" "POSTA"
Avvia uno spettacolo/documento e attiva tutti gli eventi associati. Il richiamo di questo comando su un documento già in esecuzione non produrrà un errore. Verrà restituito l'oggetto documento aggiornato.

/documenti/(ID documento)/setOff

Metodi supportati: "GET" "POSTA"
Arresta uno spettacolo/documento. Se si chiama questo comando su uno spettacolo già arrestato, non si verificherà alcun errore. Verrà restituito l'oggetto documento aggiornato.

*Poiché un documento può decidere di continuare a funzionare anche dopo aver chiamato questo metodo, l'oggetto layer restituito potrebbe essere nello stato "shutdown" anziché "off".

/documenti/(ID documento)/toggleLive

Metodi supportati: "GET" "POSTA"
Alterna uno spettacolo/documento tra live e off.

Strati

Interrogazione dei livelli

/documenti/(ID documento)/layers

Metodi supportati: "GET"
Restituisce un elenco di livelli per il documento specificato da "(DocumentID)". Per informazioni sugli oggetti restituiti, vedere il tipo di dati layers.

/documenti/(DocumentID)/layers/(LayerID)

Metodi supportati: "GET", "INSERIRE"
Restituisce un singolo livello specificato da "(LayerID)" nel documento specificato da "(DocumentID)". Nella sezione "incluso" della risposta verranno restituiti anche tutti gli oggetti "variant" relativi a questo livello (sideloading). Per ulteriori informazioni sui dati restituiti, consultare il tipo di dati dei livelli. Si tenga presente che i "valori di input" dell'endpoint del layer riflettono i "valori di input" della variante "liveVariant" associata.

Modifica di un livello

Metodi supportati: "GET", "INSERIRE"
Per impostare il nome del livello, il volume audio o i valori di ingresso, eseguire un'operazione di "INSERIRE" con una richiesta JSON all'endpoint del livello. In alternativa, si può usare un oggetto "GET" aggiungendo l'opzione JSON dati al sistema URL con la chiave "?update=". In questo caso l'elemento JSON i dati devono essere URL codificato.

I valori che non si vogliono modificare devono essere semplicemente esclusi dal file JSON dati. Esempio:

{
    "name": "New name of the Layer",
    "volume": 0.5,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Dopo aver aggiornato i valori, mimoLive risponderà con un oggetto layer aggiornato. Tenere presente che non tutti i valori possono essere applicati istantaneamente o possono avere effetto solo dopo un altro ciclo di rendering.

Nota: l'attributo "volume" è stato aggiunto in mimoLive 5.6 e viene ignorato nelle versioni precedenti o se il livello non ha un controllo del volume. Il valore sarà ritagliato su (0, 1), dove 0 è silenzioso e 1 è il volume massimo.

Azioni sui livelli

/documents/(DocumentID)/layers/(LayerID)/setLive

Metodi supportati: "GET" "POSTA"
Attiva un livello; quando viene richiamato direttamente sul livello, verrà utilizzata l'ultima variante di livello selezionata. Se viene richiamato su un livello già attivo, non si verificherà alcun errore. Verrà restituito l'oggetto layer aggiornato.

/documents/(DocumentID)/layers/(LayerID)/setOff

Metodi supportati: "GET" "POSTA"
Disattiva un livello. La chiamata di questo metodo su un livello già disattivato non produrrà un errore. Verrà restituito l'oggetto layer aggiornato.

*Poiché un livello può decidere di eseguire alcune animazioni dopo aver chiamato questo metodo, l'oggetto livello restituito potrebbe essere nello stato "shutdown" (spento) anziché "off".

/documenti/(ID documento)/layers/(ID livello)/toggleLive

Metodi supportati: "GET" "POSTA"
Alterna un livello tra "live" e "off".

/documents/(DocumentID)/layers/(LayerID)/signals/(SignalID)

Metodi supportati: "GET" "POSTA"
Attiva il segnale specificato da "(SignalID)" nella "live-variant" corrente o se il livello non è live nella "active-variant". È possibile ottenere il "(SignalID)" dal campo "input-values" del layer (identificato dal suffisso chiave "_TypeSignal").

/documenti/(ID documento)/layers/(ID livello)/cicloVarianti

Metodi supportati: "GET" "POSTA"
Disponibile da: mimoLive 5.6
Seleziona la variante successiva alla variante attualmente attiva del livello "(LayerID)" come nuova variante attiva del livello. Questo può essere usato per selezionare la variante (ad esempio di un livello Lower Third) che deve essere attivata. prossimo.
La chiamata di questo endpoint non disturba lo spettacolo se il livello è attualmente in diretta. L'effetto viene visualizzato solo quando il livello viene successivamente impostato come live.

Varianti

Interrogazione delle varianti

/documenti/(DocumentID)/layers/(LayerID)/varianti

Metodi supportati: "GET"
Restituisce un elenco di varianti per il livello specificato da "(LayerID)" e il documento specificato da "(DocumentID)". Per informazioni sugli oggetti restituiti, vedere il tipo di dati "variants".

/documenti/(DocumentID)/layers/(LayerID)/varianti/(VariantID)

Metodi supportati: "GET", "INSERIRE"
Restituisce una singola variante specificata da "(VariantID)" e "(LayerID)" nel documento specificato da "(DocumentID)". Per ulteriori informazioni sui dati restituiti, vedere il tipo di dati "variants".

Modifica di una variante

Per impostare il nome della variante o dei valori di input, eseguire un'operazione di "INSERIRE" con una richiesta JSON codificato all'endpoint della variante. I valori che non si vogliono modificare devono essere semplicemente esclusi dall'oggetto JSON voi "INSERIRE". Esempio:

{
    "name": "New name of the Variant",
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Dopo aver aggiornato i valori, mimoLive risponderà con un oggetto variante aggiornato. Si tenga presente che non tutti i valori possono essere applicati istantaneamente o possono avere effetto solo dopo un altro ciclo di rendering.

Azioni varianti

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setLive

Metodi supportati: "GET" "POSTA"
Attiva una variante; se il livello proprietario non è in tensione, anche questo verrà commutato in tensione. Il richiamo di questa funzione su una variante già attiva non produce errori. Verrà restituito l'oggetto variante aggiornato.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setOff

Metodi supportati: "GET" "POSTA"
Disattiva una variante. In questo modo si disattiva anche il livello proprietario.

/documenti/(DocumentID)/layers/(LayerID)/varianti/(VariantID)/toggleLive

Metodi supportati: "GET" "POSTA"
Alterna una variante tra live e off.

/documenti/(DocumentID)/layers/(LayerID)/varianti/(VariantID)/segnali/(SignalID)

Metodi supportati: "GET" "POSTA"
Attiva il segnale specificato da "(SignalID)" sulla variante. È possibile ottenere il "(SignalID)" dal campo "input-values" del livello (identificato dal suffisso chiave "_TypeSignal").

Fonti

Interrogazione delle fonti

/documenti/(ID documento)/fonti

Metodi supportati: "GET"
Restituisce un elenco di fonti per il documento specificato da "(DocumentID)". Per informazioni sugli oggetti restituiti, vedere il tipo di dati "livello fonti".

/documenti/(ID documento)/fonti/(ID fonte)

Metodi supportati: "GET", "INSERIRE"
Restituisce una singola sorgente specificata da "(SourceID)" nel documento specificato da "(DocumentID)". Nella sezione inclusa della risposta verranno restituiti anche tutti gli oggetti "filtro" relativi a questa sorgente (sideloading). Per ulteriori informazioni sui dati restituiti, vedere il tipo di dati "sources".

/documenti/(ID documento)/fonti/(ID fonte)/anteprima

Metodi supportati: "GET"
Restituisce un'anteprima grafica della sorgente specificata da "(SourceID)" nel documento specificato da "(DocumentID)". L'endpoint supporta i seguenti parametri:

Parametro	Predefinito	Descrizione
formato	png	Il formato in cui viene restituita l'anteprima. Valori ammessi: png, jpeg, mjpeg, mpng
fps	10	Il framerate per le anteprime delle immagini in movimento. Si applica solo ai formati mjpeg e mpng. Si noti che 1 fps equivale all'incirca a 1% di CPU utilizzo.
larghezza	(larghezza del documento)	La larghezza massima dell'anteprima. L'immagine verrà ridimensionata per adattarsi alla larghezza indicata.
altezza	(larghezza del documento)	L'altezza massima dell'anteprima. L'immagine verrà ridimensionata per adattarsi all'altezza indicata.

Modifica di una sorgente

Per impostare il nome della sorgente o i valori di ingresso (solo se la sorgente ne ha, ad esempio se è una sorgente di composizione), eseguire un'operazione di "INSERIRE" con una richiesta JSON codificato all'endpoint di origine. I valori che non si vogliono modificare devono essere semplicemente esclusi dall'oggetto JSON voi "INSERIRE". Esempio:

{
    "name": "New name of the Source",
    "gain": 1.25,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

*L'attributo "gain" è stato aggiunto in mimoLive 5.6 e viene ignorato nelle versioni precedenti o se la sorgente non ha un controllo del gain. Il valore sarà ritagliato su (0, 2), dove 0 è silenzioso, 1 è predefinito e 2 raddoppia approssimativamente il volume.

Fonte Azioni

/documenti/(ID documento)/fonti/(ID fonte)/segnali/(ID segnale)

Metodi supportati: "GET" "POSTA"
Attiva il segnale specificato da "(SignalID)" sulla sorgente (solo se la sorgente ha "valori di ingresso", ad esempio se è una sorgente di composizione). Il "(SignalID)" si ottiene dal campo "input-values" della sorgente (identificato dal suffisso "_TypeSignal").

Filtri

Interrogazione dei filtri

/documenti/(ID documento)/fonti/(ID fonte)/filtri

Metodi supportati: "GET"
Restituisce un elenco di filtri per la fonte specificata da "(SourceID)" e il documento specificato da "(DocumentID)". Per informazioni sugli oggetti restituiti, vedere il tipo di dati "filters".

/documenti/(ID documento)/fonti/(ID fonte)/filtri/(ID filtro)

Metodi supportati: "GET", "INSERIRE"
Restituisce un singolo filtro specificato da "(FilterID)" e "(SourceID)" nel documento specificato da "(DocumentID)". Per ulteriori informazioni sui dati restituiti, vedere il tipo di dati "filters".

Modifica di un filtro

Per impostare i valori di ingresso, eseguire un comando "INSERIRE" con una richiesta JSON codificato all'endpoint del filtro. I valori che non si vogliono modificare devono essere semplicemente esclusi dal filtro JSON voi "INSERIRE". Esempio:

{
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

/documents/(DocumentID)/sources/(SourceID)/filters/(FilterID)/signals/(SignalID)

Metodi supportati: "GET" "POSTA"
Attiva il segnale specificato da "(SignalID)" sul filtro. È possibile ottenere il "(SignalID)" dal campo "input-values" del filtro (identificato dal suffisso chiave "_TypeSignal").

Destinazioni di uscita

Interrogazione delle destinazioni di uscita

/documenti/(ID documento)/destinazioni di uscita

textileRef:9996801466400ba8908856:linkStartMarker:“Metodi supportati: "GET"
Disponibile da: mimoLive 4.2
Elenca tutte le destinazioni di output per il documento specificato.
Per informazioni sugli oggetti restituiti, vedere il tipo di dati ""output-destinazioni":{TOPIC-LINK+dati-tipoh1(}. sezione-uscita-destinazioni).

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Metodi supportati: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponibile da: mimoLive 4.2
Restituisce la destinazione di uscita specificata da "(OutputDestinationID)".
Per informazioni sugli oggetti restituiti, vedere il tipo di dati ""output-destinazioni":{TOPIC-LINK+dati-tipoh1(}. sezione-uscita-destinazioni).

Modifica di una destinazione di uscita

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Metodi supportati: "PATCH"
Disponibile da: mimoLive 4.2
Aggiorna le proprietà selezionate della destinazione di output specificata da "(OutputDestinationID)".
Restituisce la destinazione di uscita aggiornata.

Le seguenti proprietà sono modificabili:

• "titolo"
• "inizia con lo spettacolo"
• "si ferma con lo spettacolo"
• Contenuto dell'oggetto "impostazioni" (si veda il file descrizione delle impostazioni. sezione-impostazioni-individuali) per maggiori informazioni)

La descrizione dell'aggiornamento deve essere fornita in JSON:Formato di aggiornamento API . crud-updating). Esempio:

{
  "data": {
    "type": "output-destinations",
    "id": "4FF003EA-D071-43FD-845F-DCD4A25DFA00",
    "attributes": {
      "title": "Our Recording",
      "starts-with-show": true,
      "settings": {
        "location": "~/Movies"
      }
    }
  }
}

Azioni della destinazione di uscita

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setLive

Metodi supportati: "GET" "POSTA"
Disponibile da: mimoLive 4.2
Fa sì che la destinazione di uscita specificata da "(OutputDestinationID)" diventi attiva, se è configurata correttamente e se è autorizzata a diventarlo (ad esempio in base allo stato della licenza mimoLive).
Se la destinazione di uscita può essere attivata, viene restituita la destinazione di uscita con il suo nuovo "live-state", altrimenti viene restituito un errore "409 Conflict".

*Poiché una destinazione di output potrebbe dover eseguire alcune operazioni prima di essere live (ad esempio, contattare un servizio esterno per creare un flusso live), l'oggetto di destinazione di output restituito potrebbe essere in stato "startup" anziché "live".

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setOff

Metodi supportati: "GET" "POSTA"
Disponibile da: mimoLive 4.2
Arresta la destinazione di uscita specificata da "(OutputDestinationID)".
Se la destinazione di uscita è autorizzata a fermarsi, viene restituita la destinazione di uscita, altrimenti viene restituito un errore "409 Conflict".

*Poiché una destinazione di uscita può avere bisogno di eseguire alcune operazioni prima di interrompere le operazioni, la destinazione di uscita restituita può trovarsi nello stato "shutdown" (arresto) anziché "preview" (anteprima) (che sarebbe il valore predefinito per una destinazione di uscita ben configurata).

Set di livelli

I set di livelli sono stati introdotti in mimoLive 5.0 e permettono di impostare lo stato live di più livelli contemporaneamente, consentendo la creazione di scene per le diverse situazioni di uno spettacolo. Possono essere creati e gestiti solo in mimoLive. API L'accesso è limitato all'ottenimento e ricordando (attivando) gli insiemi di strati.

Interrogazione degli insiemi di livelli

/documenti/(ID documento)/insiemi di strati

textileRef:9996801466400ba8908856:linkStartMarker:“Metodi supportati: "GET"
Disponibile da: mimoLive 5.0
Elenca tutti i set di livelli per il documento specificato.
Per informazioni sugli oggetti restituiti, vedere il tipo di dati ""set di livelli":{TOPIC-LINK+data-typesh1(}. sezione-layer-sets).

/documents/(DocumentID)/layer-sets/(LayerSetID)

Metodi supportati: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Disponibile da: mimoLive 5.0
Restituisce il set di livelli specificato da "(LayerSetID)".
Per informazioni sugli oggetti restituiti, vedere il tipo di dati ""set di livelli":{TOPIC-LINK+data-typesh1(}. sezione-layer-sets).

Azioni di set di livelli

/documenti/(DocumentID)/layer-set/(LayerSetID)/recall

Metodi supportati: "GET" "POSTA"
Disponibile da: mimoLive 5.0
Richiama (attiva) il set di layer specificato da "(LayerSetID)", facendo sì che tutti i layer assumano lo stato live registrato nel set di layer.
Restituisce il livello impostato dopo il richiamo, cioè con "active == true".

Archivi di dati

/documenti/(DocumentID)/datastores/(StoreID)

Metodi supportati: "GET", "INSERIRE", "CANCELLARE"
mimoLive offre la possibilità di memorizzare i dati forniti dall'utente all'interno del file del documento, ad esempio per ripristinare uno stato in un momento successivo. L'utente è libero di scegliere uno "StoreID", ma è bene tenere presente che non c'è modo di elencare tutti i negozi di dati associati a un documento (tuttavia, è possibile creare una sorta di indice che tiene traccia degli altri negozi con nomi dinamici).

Creare/aggiornare un archivio dati

Per creare o aggiornare un archivio dati, inviare un messaggio "INSERIRE" a uno "StoreID" di propria scelta con i dati associati nel corpo della richiesta. Se l'operazione ha avuto successo, mimoLive risponderà con lo stato "200 OK".

Leggere il contenuto di un archivio dati

Per leggere un archivio di dati precedentemente memorizzato, è sufficiente richiederlo tramite "GET". I dati saranno restituiti esattamente come sono stati forniti nel campo "INSERIRE" per memorizzarlo. Se non è stato trovato un archivio dati con quell'ID per questo documento, mimoLive restituirà un errore "404 Not Found".

Cancellare un archivio dati esistente

Per eliminare un archivio di dati quando non se ne ha più bisogno, è sufficiente inviare un messaggio "CANCELLARE" per lo "StoreID" che si vuole cancellare. Nel caso in cui l'archivio dati non fosse presente, mimoLive risponderà con un errore "404 Not Found".