REST-API

Die REST-API ermöglicht externen Anwendungen den Zugriff auf LEDVIZ über HTTP. Ein Aufruf wird wie eine Webseitenadresse gesendet und von LEDVIZ als Befehl ausgeführt. Anwendungen wie vMix können damit beispielsweise ein Video auf der Videowand und den passenden Inhalt auf der LED-Bande gemeinsam auslösen.

Verbindung einrichten

Öffne den Einstellungsdialog über Steuerung in der Menüleiste.

• Rest-API aktivieren: öffnet den Port für die externe Ansteuerung.
• Port: legt den verwendeten HTTP-Port fest. Der Standardwert ist 12400.

Externe Aufrufe müssen LEDVIZ über HTTP auf dem eingestellten Port erreichen. Die Beispiele auf dieser Seite verwenden localhost und richten sich damit an LEDVIZ auf demselben Rechner. Für den Zugriff von einem anderen Rechner verwenden Sie dessen LEDVIZ-Hostadresse.

Protokoll: Die Beispiele verwenden HTTP. Die ursprüngliche Schnittstellenreferenz beschreibt HTTP ohne TLS. Verwende für den Zugriff das Protokoll und den Port, die für Ihre Installation eingerichtet sind.

Sequenzen starten

http://localhost:12400/play
http://localhost:12400/play/5
http://localhost:12400/play/5?beispiel.xml

Aufruf	Wirkung
/play	Betätigt die Play-Schaltfläche.
/play/5	Startet Sequenz 5 im aktuellen Projekt.
/play/5?beispiel.xml	Startet Sequenz 5 im angegebenen Projekt.

Sequenzen lassen sich auch über ihre DMX- oder MIDI-Kennung starten:

http://localhost:12400/play/dmx/25
http://localhost:12400/play/midi/ABC

Projektübergreifende Suche: Eine DMX- oder MIDI-Kennung wird immer in allen Projekten gesucht.

Für zugewiesene Tastenkürzel können F1 bis F20 und 0 bis 9 angesprochen werden. Beispiel:

http://localhost:12400/key/F1

Wiedergabe steuern

Befehl	Wirkung
http://localhost:12400/pause	Pausiert die Wiedergabe über die Pause-Schaltfläche.
http://localhost:12400/stop	Stoppt die Wiedergabe über die Stop-Schaltfläche.
http://localhost:12400/continue	Setzt die pausierte Wiedergabe fort.
http://localhost:12400/next	Startet die nächste verfügbare Sequenz der Liste.
http://localhost:12400/prev	Startet die vorherige verfügbare Sequenz der Liste.
http://localhost:12400/ftb	Betätigt Fade-to-Black und blendet die Ausgabe auf Schwarz.

Zur ursprünglichen Playlist zurückkehren

http://localhost:12400/resume

Dieser Befehl beendet eine über ein Tastenkürzel gestartete Sequenz und kehrt zur ursprünglichen Position in der Playlist zurück. Die dortige Sequenz startet erneut von Anfang an.

Overlays können mit folgendem Befehl zurückgesetzt werden:

http://localhost:12400/overlay/reset

Helligkeit regeln

http://localhost:12400/brightness/???
http://localhost:12400/brightness/up
http://localhost:12400/brightness/down

Ersetze ??? durch einen Wert von 0 bis 100. Der Wert steuert den globalen Helligkeitsregler und repräsentiert laut Schnittstellendokumentation den prozentualen Transparenzwert einer schwarzen Ebene über der Ausgabe.

up und down ändern die Helligkeit jeweils um +5 % beziehungsweise −5 %. Diese relativen Aufrufe dienen unter anderem der Ansteuerung über Stream Deck TurnWheels.

Für einzelne Helligkeitszonen verwenden Sie /brightness1/ bis /brightness8/. Die Werte 0 bis 100, up und down gelten dort entsprechend.

Sequenzen sperren und freigeben

http://localhost:12400/sequence/lock/10
http://localhost:12400/sequence/lock/10:3
http://localhost:12400/sequence/unlock/10
http://localhost:12400/sequence/unlock/10:3

• lock/10 sperrt Sequenz 10 im aktuellen Preset.
• lock/10:3 sperrt Sequenz 10 in Preset 3.
• unlock gibt die entsprechende Sequenz wieder frei.

Das Preset wird bei Bedarf mit einem Doppelpunkt an die Sequenznummer angehängt.

Presets auswählen

http://localhost:12400/preset/<preset>

Ein Preset fasst die am rechten Bildschirmrand ausgewählten Sequenzen zusammen. Ersetze <preset> durch eine Nummer von 1 bis 9.

Die Nummer bleibt auch nach dem Umbenennen eines Presets unverändert. Eine Auswahl über den Presetnamen wird nicht unterstützt.

LiveText aktualisieren

http://localhost:12400/tags/<tag-name>?<tag-value>

Verwende im URL-Pfad den Tag-Namen ohne führendes #. Für den XML-Tag #TAG1 lautet ein Beispiel http://localhost:12400/tags/TAG1?2%3A0. Kodiere Sonderzeichen im Wert als URL-Zeichen.

Ersetze <tag-name> durch den Namen des LiveText-Tags und <tag-value> durch den zu übergebenden Wert.

CuePoints setzen und aufrufen

CuePoints sind Sprungmarken innerhalb einer Playlist. Sie ermöglichen den gezielten Rücksprung zu einer Sequenz, beispielsweise nach einer über ein Tastenkürzel gestarteten Einspielung.

Zum Setzen verwenden Sie /set/ und einen frei gewählten alphanumerischen Namen:

http://localhost:12400/cue/set/<cue-point-name>

Zum Aufrufen geben Sie den Namen direkt hinter /cue/ an:

http://localhost:12400/cue/<cue-point-name>

Der CuePoint enthält bereits den Verweis auf die zugehörige XML-Datei. Ein zusätzlicher XML-Parameter ist nicht erforderlich.

Nur für die aktuelle Sitzung: CuePoints werden nicht gespeichert. Nach einem Neustart ist die Liste leer. Verwende DMX- oder MIDI-Kennungen, wenn Sie dauerhaft zugewiesene Sprungziele benötigen.

Steuerungsmodule aktivieren und deaktivieren

true aktiviert das angegebene Modul, false deaktiviert es.

http://localhost:12400/control/hippo/true
http://localhost:12400/control/hippo/false
http://localhost:12400/control/dmx/true
http://localhost:12400/control/dmx/false
http://localhost:12400/control/midi/true
http://localhost:12400/control/midi/false

Sonderfunktionen einer Animation steuern

Steht eine Sequenz an einer über ihre Sonderfunktionen festgelegten Stop-Marke, setzt dieser Befehl die Animation fort:

http://localhost:12400/gfx/continue

Sprungmarken aus den Sonderfunktionen können auch direkt aufgerufen werden. Das gilt sowohl für Marken vor als auch hinter dem aktuellen Abspielpunkt:

http://localhost:12400/gfx/jump/<stop>

Für <stop> sind die Werte 1 bis 4 vorgesehen.

Geladene Videos austauschen

http://localhost:12400/file/dmx/1/<filename>
http://localhost:12400/file/midi/ABC/<filename>

Diese Aufrufe ändern ein geladenes Video anhand der DMX- oder MIDI-Kennung. Ersetze <filename> durch den gewünschten Dateinamen.

Diese Referenz basiert auf der bisherigen LEDVIZ-Dokumentation. Abbildungen zeigen teilweise eine ältere Programmoberfläche. Ursprüngliche Dokumentation