Player API

Platzhalter

Du kannst in Modulen Platzhalter im Format {{variable|default}} verwenden, um dynamische Inhalte mit Hilfe der Player-API zu befüllen. Dabei enstpricht der Wert „variable“ dem Schlüssel („key“) des API-Aufrufs, welcher durch den dort hinterlegten Wert („value“) ersetzt wird. Zusätzlich kannst du durch die optionale Verwendung von „default“ einen Standardwert für den Platzhalter definieren, der verwendet wird wenn in der Player-API kein Wert oder ein leerer Text („“) zum verwendeten Schlüssel gefunden wird.

Beispiel:
Dies ist mein Beispieltext mit einer dynamischen Zahl „{{zahl|50}}“ im Text.

Durch den Aufruf der Player-API auf den Endpunkt mit den Parametern { „key“: „zahl“, „value“: „100“ } wird die Ausgabe geändert von „{{zahl|50}}“ auf „100“.

POST „https://[IP]/api/variable“ { „key“: „zahl“, „value“: „100“ }

Dies ist mein Beispieltext mit einer dynamischen Zahl „100“ im Text.

Im initialen Zustand des Players nach dem Start oder durch das Löschen des Wertes via API wird bei diesem Beispiel der Standardwert „50“ ausgegeben.

POST „https://[IP]/api/variable“ { „key“: „zahl“, „value“: „“ }

Dies ist mein Beispieltext mit einer dynamischen Zahl „50“ im Text.

Natürlich kannst du auch mehrere Platzhalter im Modul gleichzeitig verwenden.

 

Playlist ändern

Du kannst die Wiedergabeliste deines Players extern über die Player-API ändern. Zum Wechseln der derzeit aktiven Wiedergabeliste eines Players genügt es, den Schlüssel „playlistID“ und die ID der gewünschten Wiedergabeliste über die Player-API anzugeben. Die ID der Wiedergabeliste findest du, indem du eine Wiedergabeliste öffnest und dir die URL in der Browserleiste ansiehst, z.B. https://cockpit.framr.tv/channels/schedule/1234/.

Beispiel:

POST “https://[IP]/api/variable” { “key”: “playlistID”, “value”: “[ID]” }

 

Der Zielplayer zeigt dann die angegebene Wiedergabeliste an, bis entweder die „playlistID“ wieder über die API gelöscht oder das Gerät neu gestartet wird.

Example:

POST “https://[IP]/api/variable” { “key”: “playlistID”, “value”: “” }

Cloud-API

Du kannst auch über die Server-API eine Variable setzen. Schicke dafür einen POST-Request den Endpunkt https://api.framr.tv/tv/device/actions/var/ auf und übermittle dabei folgende Parameter:

  • secret: API-Key … einen API-Key kannst du in den Gruppeneinstellungen erstellen
  • id: Player-ID … die Player-ID findest du am Ende jener Browser-URL, die im Cockpit nach dem Klick auf einen Player angezeigt wird
  • key: Variablenname
  • value: Wert

Um mehrere Variablen gleichzeitig über die Server-API zu setzen, verwende folgende Parameter:

  • secret: API-Key … einen API-Key kannst du in den Gruppeneinstellungen erstellen
  • id: Player-ID … die Player-ID findest du am Ende jener Browser-URL, die im Cockpit nach dem Klick auf einen Player angezeigt wird
  • key[]: Array der Variablennamen
  • value[]: Array der entsprechenden Werte
  • …
  • key[]: Array der Variablennamen
  • value[]: Array der entsprechenden Werte

Diese Methode erlaubt es, mehrere Schlüssel-Werte-Paare in einem einzigen Aufruf zu setzen, was besonders nützlich ist, um mehrere dynamische Inhalte im Player effizient anzupassen.

Beispiel:

Dies ist mein Beispieltext mit einer dynamischen Zahl „{{zahl|50}}“ im Text.

Durch den Aufruf der Player-API auf den Endpunkt mit den Parametern { „key“: „zahl“, „value“: „100“ } wird die Ausgabe geändert von „{{zahl|50}}“ auf „100“.

POST „https://api.framr.tv/tv/device/actions/var/“ { „secret“: [API-KEY], „id“: [PLAYER-ID], „key“: „zahl“, „value“: „100“ }

Dies ist mein Beispieltext mit einer dynamischen Zahl „100“ im Text.

Im initialen Zustand des Players nach dem Start oder durch das Löschen des Wertes via API wird bei diesem Beispiel wieder der Standardwert „50“ ausgegeben.