API Dokumentation

1 Allgemeine Informationen

1.1 TCP API

Die TCP API (application programming interface) von veoovibes ermöglichteinen automatisierten, maschinengeeigneten Zugriff zur Steuerung von veoovibes. Der Zugriff erfolgt via TCP, die Antworten werden als PlainTextzurück geliefert.

1.2 API-Key

Jede veoovibes Installation verfügt über einen eigenen einzigartigen API-Key. Dieser wird benötigt um die jeweilige veoovibes Installation zu steuern. Der API-Key muss bei allen Abfragen im Parameter api_key übermittelt werden. Geschieht dieses nicht oder wird ein ungültiger API-Key verwendet, wird der Befehl nicht ausgeführt und die API meldet den Fehlercode 20 (siehe API Antwort Codes).

1.3 Ausgabeformat

Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle als Plain-Text.

1.4 Systemmanager

Der Systemmanager von veoovibes ist ein eigener Service, welcher auf jeder veoovibes Installation vorhanden ist. Darüber können Wartungsaufgaben und Systemdiagnosen durchgeführt werden. Auch werden über den Systemmanager die API Einstellungen festgelegt.

Den Systemmanager können Sie über die veoovibes Oberfläche über: „veoovibes Einstellungen -> System -> Systemmanager öffnen“ aufrufen.
systemmanger

1.5 Wiedergabelisten vs. Warteschlangen

In veoovibes werden die Begriffe Wiedergabelisten und Warteschlangen verwendet. Wiedergabelisten sind vom Endbenutzer erstelle Listen, welche eine beliebige Anzahl von Musiktiteln enthalten. Warteschlangen gibt es pro Zone, diese stellen die abzuspielenden Titel der Zone dar.

1.6 Unterstützung

Sie benötigen Hilfe? Unser Support-Team steht Ihnen mit Rat und Tat zur Seite. Bitte senden Sie Ihre Anfragen per E-Mail an: support@veoovibes.com oder besuchen Sie http://support.veoovibes.com

2 API Steuerungsdefinitionen

2.1 Protokoll Definitionen

Befehle werden unabhängig der Groß- und Kleinschreibung interpretiert. Alle Befehle und Antworten werden mit einem abschließenden Zeilenumbruch (CRLF - carriage return / linefeed pair) gesendet.

2.2 Verbindungsinformationen

Die Verbindung erfolgt auf die IP-Adresse von veoovibes sowie auf den Port 5004.

Name	Beschreibung
IP-Adresse	Die IP-Adresse welche veoovibes zugewiesen wurde. Verwenden Sie hierbei eine statische IP-Adresse für veoovibes.
Port	5004

Verbindung Aufbauen

Der TCP/IP Client baut eine Verbindung zu veoovibes durch das Öffnen eines Sockets auf den vordefinierten Port 5004 auf.
Wenn die Verbindung erfolgreich hergestellt wurde, Antwortet veoovibes mit folgendem Text:

Welcome to the veoovibes TCP/IP Control Server

2.3 Antwort Format

Wurde ein Befehl erfolgreich ausgeführt, so beginnt die Antwort mit dem Text "OK – " und enthält im Anschluss nochmals den angeforderten Befehl. Schlägt der Befehl fehl, so beginnt die Antwort mit "FAILED – " und enthält im Anschluss nochmals den angeforderten Befehl, sowie eine (wenn vorhanden) Fehlermeldung. Sollte der abgesetzte Befehl nicht erkannt worden sein, erhält man "unknown command:" als Antwort

Beispiele

Befehl wurde erfolgreich ausgeführt:

Befehl:
 room_vol_set room=39 vol=15 api_key=ABCDEFG12345
Antwort:
 OK - room_vol_set room=39 vol=15

Befehl wurde erfolgreich ausgeführt UND liefert Daten zurück (Daten verkürzt):

Befehl:
 listrooms api_key=ABCDEFG12345
Antwort:
 DATA – listrooms
   Begin Room 47
    id_room 47
     name  Badezimmer
   End Room 47
 OK - listrooms

Befehl wurde nicht ausgeführt:

Befehl:
 room_vol_set room=39 vol=155 api_key=ABCDEFG12345
Antwort:
 FAILED - room_vol_set - parameter -vol- out of range

Befehl nicht bekannt:

Befehl:
 rooooom_set room=39 vol=50 api_key=ABCDEFG12345
Antwort:
 unknown command: rooooom_set

3 Räume steuern

3.1 Wiedergabe starten (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_play api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_play api_key=<API-Key> room=<Room-ID>

3.2 Wiedergabe stoppen (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_stop api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_stop api_key=<API-Key> room=<Room-ID>

3.3 Nächste Titel (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_next api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_next api_key=<API-Key> room=<Room-ID>

3.4 Vorheriger Titel (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_prev api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_prev api_key=<API-Key> room=<Room-ID>

3.5 Lautstärke erhöhen (Raum)

Lautstärke des angegebenen Raumes schrittweise erhöhen. Hinweis: Ist der Raum als einziger Raum mit der Zone verbunden, so wird die Zonenlautstärke mit der neuen Lautstärke des Raums gleichgesetzt.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_vol_up api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_vol_up api_key=<API-Key> room=<Room-ID>

3.6 Lautstärke verringern (Raum)

Lautstärke des angegebenen Raumes schrittweise verringern. Hinweis: Ist der Raum als einziger Raum mit der Zone verbunden, so wird die Zonenlautstärke mit der neuen Lautstärke des Raums gleichgesetzt.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_vol_down api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_vol_down api_key=<API-Key> room=<Room-ID>

3.7 Lautstärke einstellen (Raum)

Lautstärke des angegebenen Raumes auf einen Wert zwischen 0 – 100% einstellen.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes
vol	Ein Wert zwischen 0 und 100 als Ganzzahl. Es ist auch möglich eine relative Änderung mit +XX oder -XX anzugeben (Achtung: '+' muss URL-Codiert sein!).

Aufruf

room_vol_set api_key=<API-Key> room=<Room-ID> vol=<Volume>

Antwort

OK - room_vol_set api_key=<API-Key> room=<Room-ID> vol=<Volume>

3.8 Musik abspielen (Raum)

Für das Abspielen von einem Speicherplatz in einem Raum. Dabei gilt folgende Logik: Ist der Raum der einzige in der Zone, so wird der angegebene Speicherplatz in die Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) aufgenommen und abgespielt. Befinden sich in der Zone des angegebenen Raumes mehrere Räume, so wird der Raum aus der Zone entfernt und der angegebene Speicherplatz wiedergegeben.

Für die Musikwiedergabe müssen im Systemmanager die „Programme“ festgelegt werden, welche hier über den Befehl „Musik Wiedergeben“ abgespielt werden können. Dabei gilt es zu beachten, dass max. 12 Programmgruppen angelegt werden können. Jede Programmgruppe kann bis zu 12 „Speicherplätze“ enthalten. Pro Speicherplatz kann jeweils ein „Radiosender“ oder ein „pers. Radiosender“ oder eine „Wiedergabeliste“ (siehe Wiedergabelisten vs. Warteschlangen) hinterlegt werden.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes
group	Die ID der zur verwendenden Programmgruppe
prog	Die ID des Speicherplatzes innerhalb der Programmgruppe

Aufruf

music_room api_key=<API-Key> room=<Room-ID> group=<Group-ID> prog=<Prog-ID>

Antwort

OK - music_room api_key=<API-Key> room=<Room-ID> group=<Group-ID> prog=<Prog-ID>

3.9 Zufallswiedergabe (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_random api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_random api_key=<API-Key> room=<Room-ID>

3.10 Endloswiedergabe (Raum)

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_repeat api_key=<API-Key> room=<Room-ID>

Antwort

OK - room_repeat api_key=<API-Key> room=<Room-ID>

3.11 Player Status Abfragen (Raum)

ab Version 1.1.780 verfügbar

Gibt eine Auflistung aller Informationen über den Wiedergabestatus inkl. Metadaten für den Raum aus.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

room_player_status api_key=<API-Key> room=<Room-ID>

Antwort

DATA - room_player_status room=kizi1
        Begin Zone 3
                time_total
                time_now
                progress        100
                is_playing      1
                zone_volume     13
                random          0
                repeat          1
                status_code     playing
                status          Wiedergabe
                album
                artist
                title           Commodores - Brick House
                cover           http://api.veoovibes.com/radiostations/c4fa856e631d52fce97c4eb37d17bb19.png
                is_radio        1
                radio_name      Lounge FM Digital
                type
        End Zone 3
OK - room_player_status room=kizi1

3.12 Räume Abfragen

Gibt eine Liste mit allen im System konfigurierten Räumen zurück.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

listrooms api_key=<API-Key>

Antwort

DATA - listrooms
        Begin Room 95
                id_room 95
                name    Küche
                type    Soundkarte
                vol     13
        End Room 95
        Begin Room 91
                id_room 91
                name    Wohnzimmer
                type    Soundkarte
                vol     13
        End Room 91
OK - listrooms

3.13 Raum stoppen

Da die Zone die Musik steuert, ist es im Normalfall erforderlich, die mit dem Raum verbundene Zone zu stoppen. Diese Funktion ermöglicht Ihnen die Zone aufgrund des angegebenen Raums zu stoppen ohne vorher die dazugehörige Zone abzufragen. Dabei kann entschieden werden, ob die gesamte Zone gestoppt werden soll oder ob der angegebene Raum aus der Zone entfernt werden soll.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes
action	1 = (Standard) Den Raum aus der aktuellen Zone entfernen – somit wird der Raum gestoppt und verliert gleichzeitig jedoch die Warteschlange aufgrund der neuen Zone. 2 = Die für den Raum zuständige Zone stoppen, somit werden ev. weitere verbunden Räume ebenfalls nichts mehr Wiedergeben.

Aufruf

stop_room api_key=<API-Key> room=<Room-ID> action=<Action-ID>

Antwort

OK - stop_room api_key=<API-Key> room=<Room-ID> action=<Action-ID>

4 Zone steuern

4.1 Wiedergabe starten (Zone)

Setzt die Wiedergabe an der letzten Position der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) fort.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

play api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - play api_key=<API-Key> zone=<Zone-ID>

4.2 Wiedergabe stoppen (Zone)

Stoppt die Wiedergabe der angegeben Zone.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

stop api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - stop api_key=<API-Key> zone=<Zone-ID>

4.3 Nächster Titel (Zone)

Den nächsten Titel der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) abspielen.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

next api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - next api_key=<API-Key> zone=<Zone-ID>

4.4 Vorheriger Titel (Zone)

Den vorherigen Titel der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) abspielen.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

prev api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - prev api_key=<API-Key> zone=<Zone-ID>

4.5 Lautstärke erhöhen (Zone)

Lautstärke aller mit der Zone verbundenen Räumen schrittweise erhöhen.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

vol_up api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - vol_up api_key=<API-Key> zone=<Zone-ID>

4.6 Lautstärke verringern (Zone)

Lautstärke aller mit der Zone verbundenen Räumen schrittweise verringern.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

vol_down api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - vol_down api_key=<API-Key> zone=<Zone-ID>

4.7 Lautstärke einstellen (Zone)

Setzt die Lautstärke aller mit der Zone verbundenen Räume auf einen Wert zwischen 0 – 100%.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
vol	Ein Wert zwischen 0 und 100 als Ganzzahl. Es ist auch möglich eine relative Änderung mit +XX oder -XX anzugeben (Achtung: '+' muss URL-Codiert sein!).
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

vol_set api_key=<API-Key> zone=<Zone-ID> vol=<Volume>

Antwort

OK - vol_set api_key=<API-Key> zone=<Zone-ID> vol=<Volume>

4.8 Musik abspielen (Zone)

Für das Abspielen von einem Speicherplatz in einer Zone. Alle mit der Zone verbunden Räume geben diesen Speicherplatz wieder.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
group	Die ID der zur verwendenden Programmgruppe
prog	Die ID des Speicherplatzes innerhalb der Programmgruppe
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

music_zone api_key=<API-Key> zone=<Zone-ID> group=<Group-ID> prog=<Prog-ID>

Antwort

OK - music_zone api_key=<API-Key> zone=<Zone-ID> group=<Group-ID> prog=<Prog-ID>

4.9 Zufallswiedergabe (Zone)

Die Zufallswiedergabe der Zone für die aktuelle Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) aktivieren / deaktivieren.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

random api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - random api_key=<API-Key> zone=<Zone-ID>

4.10 Endloswiedergabe (Zone)

Die Einträge der Warteschlange (siehe Wiedergabelisten vs. Warteschlangen) wiederholen aktivieren / deaktivieren.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

repeat api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - repeat api_key=<API-Key> zone=<Zone-ID>

4.11 Player Status Abfragen (Zone)

in Version 1.1.780 geändert

Gibt eine Auflistung aller Informationen über den Wiedergabestatus inkl. Metadaten für alle Zonen oder einen bestimmten Zone aus.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone	wird im Beispiel nicht angezeigt
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

player_status api_key=<API-Key>

Antwort

DATA - player_status
        Begin Zone 1
                time_total
                time_now
                progress        100
                is_playing      1
                zone_volume     13
                random          0
                repeat          1
                status_code     playing
                status          Wiedergabe
                album
                artist
                title           Pepe Deluxe - The Beat Experience
                cover           http://api.veoovibes.com/radiostations/c4fa856e631d52fce97c4eb37d17bb19.png
                is_radio        1
                radio_name      Lounge FM Digital
                type
        End Zone 1
        Begin Zone 2
                time_total
                time_now
                progress        100
                is_playing      0
                zone_volume     24
                random          0
                repeat          1
                status_code     stopped
                status
                album
                artist
                title
                cover
                is_radio
                radio_name
                type
        End Zone 2
OK - player_status

4.12 Zonen Abfragen

Gibt eine Liste mit der aktuellen Zonenkonfiguration zurück. Die Rückgabe enthält die API Antwort Codes und das Element result, welche alle Zonen auflistet.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

listzones api_key=<API-Key>

Antwort

DATA - listzones
		Begin Zone 2
				rooms   22,23
		Begin Room 22
				id_room 22
						name    Wohnzimmer
						type    Soundkarte
						vol     20
				End Room 22
				Begin Room 23
						id_room 23
						name    Schlafzimmer
						type    Soundkarte
						vol     16
				End Room 23
		End Zone 3
		Begin Zone 2
				rooms   24
				Begin Room 24
						id_room 24
						name    Küche
						type    Soundkarte
						vol     16
				End Room 24
		End Zone 3
OK – listzones

4.13 Zonen & Player Status kombiniert

Gibt eine kombinierte Antwort aus den beiden Einzelabfragen "Zonen Abfragen" und "Player Status Abfragen" zurück.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

listzones_player_status api_key=<API-Key>

Antwort

DATA - listzones_player_status
        Begin 3
                id_zone 3
                rooms   91,90
                Begin room_detail
                        Begin 91
                                id_room 91
                                api_room_id     91
                                api_room_name   allgemein
                                type    Soundkarte
                                name    Allgemein
                                current_volume  13
                                eq_bands
                                is_hidden       0
                                is_available    1
                        End 91
                        Begin 90
                                id_room 90
                                api_room_id     90
                                api_room_name   kueche
                                type    Soundkarte
                                name    Kükche
                                current_volume  13
                                eq_bands
                                is_hidden       0
                                is_available    1
                        End 90
                End room_detail
                Begin player
                        mediatime_total
                        mediatime_now
                        mediatime_progress      100
                        is_playing      1
                        zone_volume     13
                        random  0
                        repeat  1
                        status_code     playing
                        status  Wiedergabe
                        album
                        artist
                        title   Miguel Migs - Think It Over
                        cover   http://api.veoovibes.com/radiostations/c4fa856e631d52fce97c4eb37d17bb19.png
                        is_radio        1
                        radio_name      Lounge FM Digital
                        type
                End player
        End 3
        Begin 2
                id_zone 2
                rooms   126
                Begin room_detail
                        Begin 126
                                id_room 126
                                api_room_id     126
                                api_room_name   terrasse
                                type    Soundkarte
                                name    Dachterrasse
                                current_volume  17.3496
                                eq_bands        -8,-5.2,-2.8,0,0,0,0,0,0,0
                                is_hidden       0
                                is_available    1
                        End 126
                End room_detail
                Begin player
                        mediatime_total
                        mediatime_now
                        mediatime_progress      100
                        is_playing      0
                        zone_volume     19
                        random  0
                        repeat  1
                        status_code     stopped
                        status
                        album
                        artist
                        title
                        cover
                        is_radio
                        radio_name
                        type
                End player
        End 2
OK - listzones_player_status

4.14 Warteschlange einer Zone anzeigen

ab Version 1.0.860 verfügbar

Gibt die komplette Warteschlange der angegebenen Zone aus.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone

Aufruf

list_queue api_key=<API-Key> zone=<Zone-ID>

Antwort

DATA - list_queue z
        Begin 0
                id      66
                title   Lounge FM Digital
                artist
                duration        0
        End 0 OK - list_queue z

4.15 Wiedergabe eines Eintrags der Warteschlange

ab Version 1.0.860 verfügbar

Spielt den angegebenen Eintrag der Warteschlange ab. Hinweis: Dieser Befehl startet ggf. die Wiedergabe!

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
item	Die ID des Eintrags der Warteschlange

Aufruf

play_queue_item api_key=<API-Key> zone=<Zone-ID> item=<Item-ID>

Antwort

OK - play_queue_item api_key=<API-Key> zone=<Zone-ID> item=<Item-ID>

4.16 Warteschlange einer Zone leeren

ab Version 1.0.854 verfügbar

Leert / Löscht die komplette Warteschlange der angegebenen Zone.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
zone	Die ID der zu steuernden Zone
zoneroom	Parameter ab Version 1.0.865 verfügbar Alternativ zu <Zone-ID>, wenn die Zone-ID nicht bekannt ist, kann auch die Raum-ID oder der Kurzname des zu steuernden Raumes angegeben werden. Hinweis: Wird <ZoneRoom-ID> verwendet, wird der Wert von <Zone-ID> ignoriert (insofern angegeben).	wird im Beispiel nicht angezeigt

Aufruf

empty_queue api_key=<API-Key> zone=<Zone-ID>

Antwort

OK - empty_queue api_key=<API-Key> zone=<Zone-ID>

4.17 Alle Zonen stoppen

Stoppt die Wiedergabe in allen Zonen.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

stop_all api_key=<API-Key>

Antwort

OK - stop_all api_key=<API-Key>

5 veoovibes Steuerung

5.1 Haussperre aktivieren

Aktiviert die Haussperre. Mehr Informationen zur Haussperre unter "Grundfunktionalität".

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

lock_system api_key=<API-Key>

Antwort

OK - lock_system api_key=<API-Key>

5.2 Haussperre deaktivieren

Deaktiviert die Haussperre. Mehr Informationen zur Haussperre unter "Grundfunktionalität".

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

unlock_system api_key=<API-Key>

Antwort

OK - unlock_system api_key=<API-Key>

5.3 Türgong abspielen

ab Version 1.2.217 verfügbar

Spielt einen Türgong in den im Admin-Bereich hinterlegten Räumen (und eingestellten Lautstärke) ab.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden

Aufruf

chime api_key=<API-Key>

Antwort

OK - chime api_key=<API-Key>

6 Raum / Zonen Zuordnung

6.1 Raum zu einer Zone hinzufügen

Fügt einen Raum einer Zone hinzu.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes
zone	Die ID der zu steuernden Zone

Aufruf

add_room_to_zone api_key=<API-Key> room=<Room-ID> zone=<Zone-ID>

Antwort

OK - add_room_to_zone api_key=<API-Key> room=<Room-ID> zone=<Zone-ID>

6.2 Raum aus einer Zone entfernen

Entfernt einen Raum aus einer Zone.

Parameter

Name	Beschreibung	Werte angeben
api_key	API-Key, dieser kann aus den Einstellungen von veoovibes ausgelesen werden
room	Die Raum-ID oder der Kurzname des zu steuernden Raumes

Aufruf

remove_room_from_zone api_key=<API-Key> room=<Room-ID>

Antwort

OK - remove_room_from_zone api_key=<API-Key> room=<Room-ID>