Allgemein

Die APIist, wenn sie aktiviert ist, unter "http://localhost:8989/api/v1" verfügbar. Dies ist die Basis URL die jeder Methode vorangestellt werden muss URL unten aufgeführt.

Wurde eine Ressource nach dem ursprünglichen Start des HTTP APIwird die Methode mit einem Verfügbar seit Informationen.

/

Unterstützte Methoden: "GET"
Leitet zur Liste der offenen Dokumente unter "/documents" weiter.

Dokumente

Abfrage von Dokumenten

/Dokumente

Unterstützte Methoden: "GET"
Ergibt eine Liste der geöffneten Dokumente. Welche Informationen die zurückgegebenen Objekte enthalten, entnehmen Sie bitte dem Datentyp Dokumente.

/Dokumente/(DokumentID)

Unterstützte Methoden: "GET"
Gibt ein einzelnes, durch die "(DocumentID)" spezifiziertes Dokument zurück. Im eingeschlossenen Teil der Antwort werden alle von diesem Dokument verwendeten "Layer"-Objekte und alle in diesem Dokument enthaltenen "Source"-Objekte ebenfalls zurückgegeben (Sideloading). Weitere Informationen zu den zurückgegebenen Daten finden Sie unter dem Datentyp des Dokuments.

/Dokumente/(DocumentID)/ProgrammAus

Unterstützte Methoden: "GET"
Die Programmausgabe, die derzeit von dem durch "(DocumentID)" angegebenen Dokument erzeugt wird.
Nimmt die gleichen Parameter wie die Quellvorschau an.

Dokument-Aktionen

/Dokumente/(DocumentID)/setLive

Unterstützte Methoden: "GET" "POST"
Startet eine Show/ein Dokument und löst alle zugehörigen Ereignisse aus. Der Aufruf dieses Befehls bei einem bereits laufenden Dokument führt nicht zu einem Fehler. Es wird das aktualisierte Dokumentobjekt zurückgegeben.

/Dokumente/(DocumentID)/setOff

Unterstützte Methoden: "GET" "POST"
Hält eine Sendung/ein Dokument an. Der Aufruf dieser Funktion bei einer bereits gestoppten Show führt nicht zu einem Fehler. Es wird das aktualisierte Dokumentobjekt zurückgegeben.

*Da ein Dokument nach dem Aufruf dieser Methode weiterlaufen kann, befindet sich das zurückgegebene Ebenenobjekt möglicherweise im Zustand "shutdown" statt "off".

/Dokumente/(DocumentID)/UmschaltenLive

Unterstützte Methoden: "GET" "POST"
Schaltet eine Sendung/ein Dokument zwischen Live und Aus um.

Schichten

Ebenen abfragen

/Dokumente/(DocumentID)/Schichten

Unterstützte Methoden: "GET"
Gibt eine Liste von Ebenen für das durch "(DocumentID)" angegebene Dokument zurück. Informationen zu den zurückgegebenen Objekten finden Sie unter dem Datentyp layers.

/Dokumente/(DokumentID)/Schichten/(SchichtID)

Unterstützte Methoden: "GET", "PUT"
Gibt eine einzelne durch "(LayerID)" spezifizierte Ebene in dem durch "(DocumentID)" spezifizierten Dokument zurück. Im Abschnitt "included" der Antwort werden auch alle mit dieser Ebene verbundenen "variant"-Objekte zurückgegeben (sideloading). Weitere Informationen zu den zurückgegebenen Daten finden Sie im Datentyp der Ebene. Bitte beachten Sie, dass die "input-values" des Layer-Endpunkts die "input-values" der zugehörigen "liveVariant"-Variante widerspiegeln.

Ändern einer Ebene

Unterstützte Methoden: "GET", "PUT"
Um den Namen der Ebene, die Audiolautstärke oder die Eingabewerte festzulegen, führen Sie einen "PUT" Anfrage mit einer JSON kodiertes Objekt an den Endpunkt der Ebene. Alternativ können Sie auch ein "GET"Anfrage durch Hinzufügen der JSON Daten an den URL mit dem Schlüssel "?update=". In diesem Fall wird die JSON müssen die Daten URL verschlüsselt.

Werte, die Sie nicht ändern wollen, sollten Sie einfach aus der JSON Daten. Beispiel:

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

Nach der Aktualisierung der Werte wird mimoLive mit einem aktualisierten Ebenenobjekt reagieren. Beachten Sie, dass nicht alle Werte sofort angewendet werden können oder sich erst nach einem weiteren Rendering-Zyklus auswirken können.

Hinweis: Das Attribut "Lautstärke" wurde in mimoLive 5.6 hinzugefügt und wird in früheren Versionen ignoriert oder wenn die Ebene keine Lautstärkeregelung hat. Der Wert wird auf (0, 1) beschnitten, wobei 0 für Stille und 1 für volle Lautstärke steht.

Ebenen-Aktionen

/Dokumente/(DocumentID)/Layer/(LayerID)/setLive

Unterstützte Methoden: "GET" "POST"
Aktiviert eine Ebene, wenn dies direkt auf der Ebene aufgerufen wird, wird die zuletzt ausgewählte Ebenenvariante verwendet. Der Aufruf dieser Funktion auf einer bereits aktiven Ebene führt nicht zu einem Fehler. Es wird das aktualisierte Ebenenobjekt zurückgegeben.

/Dokumente/(DocumentID)/Layer/(LayerID)/setOff

Unterstützte Methoden: "GET" "POST"
Deaktiviert eine Ebene. Der Aufruf dieser Funktion bei einer bereits deaktivierten Ebene führt nicht zu einem Fehler. Es wird das aktualisierte Ebenenobjekt zurückgegeben.

*Da eine Ebene nach dem Aufruf dieser Methode beschließen kann, einige Animationen durchzuführen, kann das zurückgegebene Ebenenobjekt im Zustand "shutdown" statt "off" sein.

/Dokumente/(DokumentID)/Ebenen/(EbenenID)/UmschaltenLive

Unterstützte Methoden: "GET" "POST"
Schaltet eine Ebene zwischen "live" und "aus" um.

/Dokumente/(DocumentID)/Schichten/(LayerID)/Signale/(SignalID)

Unterstützte Methoden: "GET" "POST"
Löst das durch "(SignalID)" angegebene Signal in der aktuellen "Live-Variante" oder, wenn die Ebene nicht live ist, in der "Aktiv-Variante" aus. Die "(SignalID)" können Sie dem Feld "input-values" der Ebene entnehmen (gekennzeichnet durch das Schlüsselsuffix "_TypeSignal").

/documents/(DocumentID)/layers/(LayerID)/cycleThroughVariants

Unterstützte Methoden: "GET" "POST"
Verfügbar seit: mimoLive 5.6
Wählt die nächste Variante nach der derzeit aktiven Variante des Layers "(LayerID)" als neue aktive Variante des Layers aus. Dies kann verwendet werden, um die Variante (z. B. eines Lower Third-Layers) auszuwählen, die aktiv werden soll nächste.
Wenn Sie diesen Endpunkt aufrufen, wird Ihre Show nicht gestört, wenn die Ebene gerade live ist. Der Effekt wird nur angezeigt, wenn die Ebene anschließend live geschaltet wird.

Varianten

Abfrage von Varianten

/Dokumente/(DocumentID)/Schichten/(LayerID)/Varianten

Unterstützte Methoden: "GET"
Gibt eine Liste von Varianten für den durch "(LayerID)" angegebenen Layer und das durch "(DocumentID)" angegebene Dokument zurück. Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "variants".

/Dokumente/(DocumentID)/Layer/(LayerID)/Varianten/(VariantID)

Unterstützte Methoden: "GET", "PUT"
Gibt eine einzelne Variante zurück, die durch "(VariantID)" und "(LayerID)" in dem durch "(DocumentID)" angegebenen Dokument angegeben ist. Weitere Informationen zu den zurückgegebenen Daten finden Sie unter dem Datentyp "variants".

Ändern einer Variante

Um den Namen der Variante oder der Eingabewerte festzulegen, führen Sie ein "PUT" Anfrage mit einer JSON kodiertes Objekt an den Variantenendpunkt. Werte, die Sie nicht ändern wollen, sollten Sie einfach aus dem JSON Sie "PUT". Beispiel:

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

Nach dem Aktualisieren der Werte antwortet mimoLive mit einem aktualisierten Variantenobjekt. Beachten Sie, dass nicht alle Werte sofort angewendet werden können oder sich erst nach einem weiteren Rendering-Zyklus auswirken können.

Abweichende Aktionen

/Dokumente/(DocumentID)/Layer/(LayerID)/Varianten/(VariantID)/setLive

Unterstützte Methoden: "GET" "POST"
Aktiviert eine Variante, wenn die eigene Ebene nicht aktiv ist, wird sie ebenfalls aktiv geschaltet. Der Aufruf dieser Funktion bei einer bereits aktiven Variante führt nicht zu einem Fehler. Es wird das aktualisierte Variantenobjekt zurückgegeben.

/Dokumente/(DocumentID)/Layer/(LayerID)/Varianten/(VariantID)/setOff

Unterstützte Methoden: "GET" "POST"
Deaktiviert eine Variante. Dadurch wird auch die zugehörige Ebene ausgeschaltet.

/Dokumente/(DocumentID)/Ebenen/(LayerID)/Varianten/(VariantID)/toggleLive

Unterstützte Methoden: "GET" "POST"
Schaltet eine Variante zwischen live und off um.

/Dokumente/(DocumentID)/Layer/(LayerID)/Varianten/(VariantID)/Signale/(SignalID)

Unterstützte Methoden: "GET" "POST"
Löst das durch "(SignalID)" angegebene Signal auf der Variante aus. Die "(SignalID)" können Sie dem Feld "input-values" des Layers entnehmen (gekennzeichnet durch das Schlüsselsuffix "_TypeSignal").

Quellen

Quellen abfragen

/Dokumente/(DocumentID)/Quellen

Unterstützte Methoden: "GET"
Gibt eine Liste der Quellen für das durch "(DocumentID)" angegebene Dokument zurück. Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "Quellenebene".

/Dokumente/(DocumentID)/Quellen/(SourceID)

Unterstützte Methoden: "GET", "PUT"
Gibt eine einzelne durch "(SourceID)" angegebene Quelle in dem durch "(DocumentID)" angegebenen Dokument zurück. Im eingeschlossenen Teil der Antwort werden auch alle mit dieser Quelle verbundenen "Filter"-Objekte zurückgegeben (Sideloading). Weitere Informationen zu den zurückgegebenen Daten finden Sie unter dem Datentyp "Quellen".

/Dokumente/(DocumentID)/Quellen/(SourceID)/Vorschau

Unterstützte Methoden: "GET"
Gibt eine grafische Vorschau der durch "(SourceID)" angegebenen Quelle in dem durch "(DocumentID)" angegebenen Dokument zurück. Der Endpunkt unterstützt die folgenden Parameter:

Parameter	Standard	Beschreibung
Format	png	Das Format, in dem die Vorschau zurückgegeben wird. Erlaubte Werte: png, jpeg, mjpeg, mpng
fps	10	Die Framerate für die Vorschau von Bewegtbildern. Gilt nur für die Formate mjpeg und mpng. Bitte beachten Sie, dass 1 fps ungefähr 1% von CPU Nutzung.
Breite	(Dokumentbreite)	Die maximale Breite der Vorschau. Das Bild wird verkleinert, damit es in die angegebene Breite passt.
Höhe	(Dokumentbreite)	Die maximale Höhe der Vorschau. Das Bild wird verkleinert, damit es in die angegebene Höhe passt.

Ändern einer Quelle

Um den Namen der Quelle oder der Eingabewerte festzulegen (nur wenn die Quelle welche hat, z. B. wenn es sich um eine Kompositionsquelle handelt), führen Sie einen "PUT" Anfrage mit einer JSON kodierten Objekts an den Quellendpunkt. Werte, die Sie nicht ändern wollen, sollten Sie einfach aus dem JSON Sie "PUT". Beispiel:

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

*Das Attribut "gain" wurde in mimoLive 5.6 hinzugefügt und wird in früheren Versionen ignoriert oder wenn die Quelle keinen Gain-Regler hat. Der Wert wird auf (0, 2) beschnitten, wobei 0 stumm ist, 1 die Standardeinstellung und 2 ungefähr die doppelte Lautstärke.

Quelle: Aktionen

/Dokumente/(DocumentID)/Quellen/(SourceID)/Signale/(SignalID)

Unterstützte Methoden: "GET" "POST"
Löst das durch "(SignalID)" spezifizierte Signal an der Quelle aus (nur wenn die Quelle "input-values" hat, z. B. wenn es sich um eine Composition Source handelt). Die "(SignalID)" können Sie dem Feld "input-values" der Quelle entnehmen (gekennzeichnet durch das Schlüsselsuffix "_TypeSignal").

Filter

Abfrage von Filtern

/Dokumente/(DocumentID)/Quellen/(SourceID)/Filter

Unterstützte Methoden: "GET"
Gibt eine Liste von Filtern für die durch "(SourceID)" angegebene Quelle und das durch "(DocumentID)" angegebene Dokument zurück. Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "filters".

/Dokumente/(DocumentID)/Quellen/(SourceID)/Filter/(FilterID)

Unterstützte Methoden: "GET", "PUT"
Gibt einen einzelnen, durch "(FilterID)" und "(SourceID)" spezifizierten Filter in dem durch "(DocumentID)" angegebenen Dokument zurück. Weitere Informationen zu den zurückgegebenen Daten finden Sie unter dem Datentyp "filters".

Ändern eines Filters

Zum Einstellen der Eingabewerte führen Sie einen "PUT" Anfrage mit einer JSON kodiertes Objekt an den Filterendpunkt. Werte, die Sie nicht ändern wollen, sollten Sie einfach aus dem JSON Sie "PUT". Beispiel:

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

/Dokumente/(DocumentID)/Quellen/(SourceID)/Filter/(FilterID)/Signale/(SignalID)

Unterstützte Methoden: "GET" "POST"
Löst das durch "(SignalID)" angegebene Signal im Filter aus. Die "(SignalID)" kann dem Feld "input-values" des Filters entnommen werden (gekennzeichnet durch den Schlüsselzusatz "_TypeSignal").

Ausgabeziele

Abfrage von Ausgabezielen

/documents/(DocumentID)/output-destinations

textileRef:9996801466400ba8908856:linkStartMarker:“Unterstützte Methoden: "GET"
Verfügbar seit: mimoLive 4.2
Listet alle Ausgabeziele für das angegebene Dokument auf.
Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "output-destinations": {TOPIC-LINK+data-typesh1(}. section-output-destinations).

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

Unterstützte Methoden: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Verfügbar seit: mimoLive 4.2
Gibt das durch "(OutputDestinationID)" angegebene Ausgabeziel zurück.
Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "output-destinations": {TOPIC-LINK+data-typesh1(}. section-output-destinations).

Ändern eines Ausgabeziels

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

Unterstützte Methoden: "PATCH"
Verfügbar seit: mimoLive 4.2
Aktualisierung ausgewählter Eigenschaften des durch "(OutputDestinationID)" angegebenen Ausgabeziels.
Gibt das aktualisierte Ausgabeziel zurück.

Die folgenden Eigenschaften sind änderbar:

• "Titel"
• "beginnt-mit-Schau"
• "Stoppt-mit-Show"
• Inhalt des Objekts "Einstellungen" (siehe die Beschreibung der Einstellungen. section-individual-settings) für weitere Informationen)

Die Beschreibung der Aktualisierung muss in JSON:API-Aktualisierungsformat . crud-updating). Beispiel:

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

Ausgabeziel Aktionen

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

Unterstützte Methoden: "GET" "POST"
Verfügbar seit: mimoLive 4.2
Bewirkt, dass das durch "(OutputDestinationID)" angegebene Ausgabeziel live geschaltet wird, wenn es ordnungsgemäß konfiguriert ist und live geschaltet werden darf (z. B. auf der Grundlage des mimoLive-Lizenzierungsstatus).
Wenn das Ausgabeziel live gehen kann, wird das Ausgabeziel mit seinem neuen "Live-Status" zurückgegeben, andernfalls wird ein "409 Conflict"-Fehler zurückgegeben.

*Da ein Ausgabeziel unter Umständen noch einige Arbeiten durchführen muss, bevor es live geschaltet wird (z. B. Kontaktaufnahme mit einem externen Dienst, um einen Live-Stream zu erstellen), kann sich das zurückgegebene Ausgabezielobjekt im Zustand "startup" statt "live" befinden.

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

Unterstützte Methoden: "GET" "POST"
Verfügbar seit: mimoLive 4.2
Bewirkt, dass das durch "(OutputDestinationID)" angegebene Ausgabeziel angehalten wird.
Wenn das Ausgabeziel anhalten darf, wird das Ausgabeziel zurückgegeben, andernfalls wird ein "409 Conflict"-Fehler zurückgegeben.

*Da ein Ausgabeziel vor dem Beenden des Vorgangs möglicherweise noch einige Arbeiten durchführen muss, kann sich das zurückgegebene Ausgabeziel im Zustand "shutdown" statt "preview" befinden (was bei einem gut konfigurierten Ausgabeziel der Standardzustand wäre).

Ebenen-Sets

Ebenensets wurden in mimoLive 5.0 eingeführt und erlauben es, den Live-Status mehrerer Ebenen gleichzeitig zu setzen, wodurch die Erstellung von leichtgewichtigen Szenen für verschiedene Situationen in einer Show. Sie können nur in mimoLive erstellt und verwaltet werden. API der Zugang ist beschränkt auf die Erlangung und abrufen. (aktivierende) Schichtgruppen.

Abfrage von Ebenensätzen

/documents/(DocumentID)/layer-sets

textileRef:9996801466400ba8908856:linkStartMarker:“Unterstützte Methoden: "GET"
Verfügbar seit: mimoLive 5.0
Listet alle Ebenensätze für das angegebene Dokument auf.
Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "Layersets": {TOPIC-LINK+data-typesh1(}. section-layer-sets).

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

Unterstützte Methoden: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Verfügbar seit: mimoLive 5.0
Gibt den durch "(LayerSetID)" angegebenen Layersatz zurück.
Informationen zu den zurückgegebenen Objekten finden Sie im Datentyp "Layersets": {TOPIC-LINK+data-typesh1(}. section-layer-sets).

Ebenensatz-Aktionen

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

Unterstützte Methoden: "GET" "POST"
Verfügbar seit: mimoLive 5.0
Ruft den durch "(LayerSetID)" angegebenen Ebenensatz auf (aktiviert ihn), wodurch alle Ebenen den im Ebenensatz aufgezeichneten Live-Zustand annehmen.
Gibt die Ebene zurück, die nach dem Aufrufen eingestellt wurde, d. h. mit "aktiv == true".

Daten-Speicher

/Dokumente/(DocumentID)/Datenspeicher/(StoreID)

Unterstützte Methoden: "GET", "PUT", "DELETE"
mimoLive bietet die Möglichkeit, von Ihnen bereitgestellte Daten innerhalb der Dokumentendatei zu speichern, um z.B. einen Zustand zu einem späteren Zeitpunkt wiederherzustellen. Es steht Ihnen frei, eine "StoreID" selbst zu wählen, aber beachten Sie, dass es keine Möglichkeit gibt, alle mit einem Dokument verbundenen Datenspeicher aufzulisten (Sie können jedoch eine Art von Index Speicher, der den Überblick über Ihre anderen, dynamisch benannten Speicher behält).

Erstellen/Aktualisieren eines Datenspeichers

Um einen Datenspeicher zu erstellen oder zu aktualisieren, senden Sie eine "PUT"Anfrage an eine "StoreID" Ihrer Wahl mit den zugehörigen Daten im Body Ihrer Anfrage. Wenn die Operation erfolgreich war, antwortet mimoLive mit einem "200 OK" Status.

Inhalt eines Datenspeichers lesen

Um einen zuvor gespeicherten Datenspeicher zu lesen, fordern Sie ihn einfach über "GET". Die Daten werden genau so zurückgegeben, wie Sie sie im Feld "PUT"Anfrage, um es zu speichern. Wenn kein Datenspeicher mit dieser ID für dieses Dokument gefunden wurde, gibt mimoLive einen "404 Not Found"-Fehler zurück.

Einen bestehenden Datenspeicher löschen

Um einen Datenspeicher zu löschen, wenn Sie ihn nicht mehr benötigen, geben Sie einfach eine "DELETE"Anfrage für die "StoreID", die Sie löschen möchten. Für den Fall, dass der Datenspeicher gar nicht vorhanden war, antwortet mimoLive mit einem "404 Not Found"-Fehler.