Remote Control API

Click to Display Table of Contents

Navigation:  Funktionen >

Remote Control API

Sie können RadioBOSS über die Remote Control API fernbedienen.

 

Aktivieren und konfigurieren Sie diese Funktion über das Fenster Einstellungen: Konfigurieren der Fernsteuerungs-API

 

HTTP-Fernbedienung API-Referenz

 

Hinweis: Verwenden Sie beim Erzeugen einer Anforderungszeichenfolgen eine der Funktionen zur URL-Kodierung von Parametern.

Verwenden Sie beispielsweise urlencode (http://www.php.net/manual/en/function.urlencode.php) für PHP.

Anfragen sollten in UTF8-Kodierung gesendet werden.

 

I. Ausführen eines Befehls.

Sie können die gleichen Befehle wie im Planer verwenden. Hier finden Sie eine Liste der verfügbaren Befehle: Planer-Befehle

Befehle, die nicht aus der API verwendet werden können: getrandomplaylist, getfile, playrequestsong

 

Syntax:

http://IP:Port/?pass=PASSWORT&cmd=COMMAND

(ersetzen Sie "COMMAND" und "PASSWORD" entsprechend)

 

Beispiel 1: Wiedergabe des nächsten Titels (Befehl: next)

http://127.0.0.1:9000/?pass=WxPe2JXh&cmd=next

 

Beispiel 2: Wiedergabe des ersten Titels in der Wiedergabeliste (Befehl: "play 1")

http://127.0.0.1:9000/?pass=WxPe2JXh&cmd=play%201

 

II. Ausführen einer Aktion

 

Syntax:

http://IP:Port/?pass=PASSWORT&action=ACTION=ACTION

(ersetzen Sie "AKTION" und "PASSWORT" entsprechend)

 

Mögliche Aktionswerte:

 

playbackinfo

Wiedergabeinformationen abrufen

Liefert ein XML mit den aktuellen und nächsten Titel-Informationen, der Wiedergabeposition, dem Status und einige andere Informationen.

 

Beispiel

http://127.0.0.1:9000/?pass=WxPe2JXh&action=playbackinfo

 

Ein Beispiel für die Rückgabe von Daten: show

<?xml version="1.0" encoding="utf-8"?>

<Info>

  <PrevTrack>

      <TRACK ARTIST="Metallica" TITLE="Battery" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\01 Battery.m4a" DURATION="05:12" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:30" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" CASTTITLE="Metallica - Battery" />

  </PrevTrack>

  <CurrentTrack>

      <TRACK ARTIST="Metallica" TITLE="Master Of Puppets" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\02 Master Of Puppets.m4a" DURATION="08:29" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:38" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" CASTTITLE="Metallica - Master Of Puppets" LISTENERS="0" />

  </CurrentTrack>

  <NextTrack>

      <TRACK ARTIST="Metallica" TITLE="The Thing That Should Not Be" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\03 The Thing That Should Not Be.m4a" DURATION="06:36" PLAYCOUNT="0" LASTPLAYED="" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" CASTTITLE="Metallica - The Thing That Should Not Be" />

  </NextTrack>

  <Playback pos="8543" len="509416" state="play" playlistpos="4" />

  <Options repeat_list="0" shuffle="0" />

  <Features scheduler="0" />

</Info>

inserttrack

einen Titel in die Wiedergabeliste einfügen

Parameter

" filename" - lokaler Dateiname

"pos" - eine Position in der Playlist, an der der Titel eingefügt werden soll (1 .... N).

Andere mögliche Werte:

 -1: in das Ende der Wiedergabeliste einfügen

 -2: Einfügen nach der Wiedergabe des Titels

-3: Einfügen nach geplanten Spuren

" streamingtitle" - Setzt den Sendetitel für das eingefügte Element.

 

Beispiel

Einfügen der Spur “D:\music\track.mp3”

http://127.0.0.1:9001/?pass=WxPe2JXh&action=inserttrack&filename=D%3A%5Cmusic%5Ctrack.mp3&pos=-2

 

Liefert OK, wenn erfolgreich

library

eine Musikbibliothek herunterladen (xml)

Parameter

"filename" — Dateiname der Musikbibliothek

 

Liefert: Inhalt der Musikbibliothek Dateiinhalte

 

Beispiel

http://127.0.0.1:9000/?pass=WxPe2JXh&action=library&filename=Base

trackartwork

download des Covers vom aktuellen Titel

Liefert: Cover für den aktuell wiedergegebenen Titel (oder nichts, wenn es kein Cover gibt)

nexttrackartwork

Cover für den nächsten Titel herunterladen

Liefert: Cover für den nächsten Titel (oder nichts, wenn es kein Cover gibt)

setnexttrack

setzt den nächsten Titel

Parameter

"pos" — die Position eines Titels in der Wiedergabeliste, der als nächster Titel (1 .... N) ausgewählt wird.

 

Beispiel

Legen Sie den ersten Titel in der Wiedergabeliste fest, der als nächstes wiedergegeben werden soll.

http://127.0.0.1:9000/?pass=WxPe2JXh&action=setnexttrack&pos=1

 

Liefert OK wenn erfolgreich

delete

Löschen eines Titels aus der Wiedergabeliste

Parameter

"pos" — die Position eines Titels in der Wiedergabeliste, der gelöscht wird (1 .... N)

 

Beispiel

Löschen des zweiten Titels in der Wiedergabeliste

http://127.0.0.1:9000/?pass=WxPe2JXh&action=delete&pos=2

 

Liefert OK wenn erfolgreich

move

einen Titel an eine andere Position in der Wiedergabeliste verschieben

Parameter

"pos1" — Ausgangsspurposition

"pos2" — Neue Position

 

Liefert OK wenn erfolgreich

mic

Mikrofon ein- und ausschalten oder Mikrofonstatus abfragen

Parameter

"on" - 0, um das Mikrofon auszuschalten, 1, um es einzuschalten. Wenn der Parameter weggelassen wird, wird der Mikrofonstatus zurückgegeben, wenn der Parameter vorhanden ist, wird bei Erfolg OK zurückgegeben.

0 - aus

1 - an

 

Beispiel (Mikrofon einschalten):

http://127.0.0.1:9000/?pass=WxPe2JXh&action=mic&on=1

 

Beispiel (Abfragestatus):

http://127.0.0.1:9000/?pass=WxPe2JXh&action=mic

getplaylist

Wiedergabelisteninhalte abrufen

Gibt zurück: ein XML, das den Inhalt der Wiedergabeliste enthält. Diese Funktion liest Tag-Informationen und kann bei großen Wiedergabelisten langsam sein.

 

Parameter:

(optional) "from", "to" - wenn gesetzt, holen Sie Titel von (from) Position zu (to) Position zu (inklusive), anstatt die gesamte Wiedergabeliste zu erhalten.

 

 

Ein Beispiel für die Rückgabe von Daten: Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<Playlist>

  <TRACK ARTIST="Metallica" TITLE="Battery" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\01 Battery.m4a" DURATION="05:12" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:30" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" />

  <TRACK ARTIST="Metallica" TITLE="Master Of Puppets" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\02 Master Of Puppets.m4a" DURATION="08:35" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:38" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" />

  <TRACK ARTIST="Metallica" TITLE="The Thing That Should Not Be" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\03 The Thing That Should Not Be.m4a" DURATION="06:36" PLAYCOUNT="0" LASTPLAYED="" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" />

</Playlist>

getplaylist2

Wiedergabeliste-Inhalte abrufen (schnell)

Gibt zurück: ein XML, das den Inhalt der Wiedergabeliste enthält. Diese Funktion ist schneller als getplaylist.

 

Parameter

(optional) "cnt" - maximale Anzahl der zurückzugebenden Spuren, 0 = alle Spuren zurückgeben

 

 

Ein Beispiel für die Rückgabe von Daten: Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<Playlist COUNT="18">

  <TRACK STARTTIME="8:20:30 PM" CASTTITLE="Metallica - Battery" DURATION="05:12" FILENAME="D:\Metallica\Master of Puppets\01 Battery.m4a" RATING="0" PLAYCOUNT="1" INTRO="" OUTRO="" BPM="" PLAYLISTINDEX="0" INDEX="1" />

  <TRACK STARTTIME="8:20:38 PM" CASTTITLE="Metallica - Master Of Puppets" DURATION="08:35" FILENAME="D:\Metallica\Master of Puppets\02 Master Of Puppets.m4a" RATING="0" PLAYCOUNT="1" INTRO="" OUTRO="" BPM="" PLAYLISTINDEX="1" INDEX="2" />

  <TRACK STARTTIME="8:29:10 PM" CASTTITLE="Metallica - The Thing That Should Not Be" DURATION="06:36" FILENAME="D:\Metallica\Master of Puppets\03 The Thing That Should Not Be.m4a" RATING="0" PLAYCOUNT="0" INTRO="" OUTRO="" BPM="" PLAYLISTINDEX="2" INDEX="3" />

</Playlist>

trackinfo

Titelinformationen abrufen

Parameter

"pos" — die Position eines Titels in der Wiedergabeliste

 

Beispiel

http://127.0.0.1:9000/?pass=WxPe2JXh&action=trackinfo&pos=2

 

Ein Beispiel für die Rückgabe von Daten: Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<Info>

  <Track>

      <TRACK ARTIST="Metallica" TITLE="Master Of Puppets" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\02 Master Of Puppets.m4a" DURATION="08:35" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:38" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" />

  </Track>

</Info>

songrequest

Songanforderung hinzufügen

Parameter

"filename" - Titelname eines gewünschten Songs (voller Pfad)

"message" - optional, Nachricht von einem Benutzer, der einen Song angefordert hat

 

Um die Liste der angeforderten Songs manuell anzuzeigen, klicken Sie im Menü auf Werkzeuge ->Titelwünsche

Um die angeforderten Songs automatisch abzuspielen, verwenden Sie den Planer Befehl playrequestedsong

 

 

Liefert OK wenn erfolgreich

songrequestclear

Löschen der angeforderten Titelliste

Löscht die Liste der gewünschten Songs.

 

Liefert OK wenn erfolgreich

songrequestlist

angeforderte Titelliste erhalten

Ein Beispiel für die Rückgabe von Daten: Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<SongRequest>

  <Request filename="C:\Music\Track01.mp3" message="The message" />

  <Request filename="C:\Music\Track08.mp3" message="Another message" />

</SongRequest>

encoderstatus

Status des Broadcast-Encoder abfragen

Gibt ein XML aus, welches den Encoder Status enthält Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<Encoders>

  <Encoder index="0" status="idle" />

  <Encoder index="1" status="off" />

  <Encoder index="2" status="active" />

</Encoders>

streamarchivestatus

Stream-Archivstatus erhalten

Liefert den Status des Stream-Archivs

0 - aus

1 - an

schedule

Kontrolle der geplanten Ereignisse

Parameter

o"type" - der Anfragetyp, von einer:

olist - Ereignis auflisten (gibt alle Events im XML-Format zurück)

odelete - ein Ereignis löschen

orun - Ereignis starten

oadd - neues Ereignis hinzufügen

oupdate - Ereignis bearbeiten

ostate - schaltet den Planer ein oder aus oder ruft den Status des Planers ab.

o"event" - XML-Ereignisdaten (wenn der type "update" oder "add" ist)

"id" - Ereignis-ID, Sie erhalten die Ereignis-ID, wenn Sie die Abfrage "list" durchführen (verwendet, wenn der type "delete", "run" oder "update" ist).

"set" - ein oder aus (wenn der type "state" ist), wenn der Parameter weggelassen wird - gibt den aktuellen Status des Planers zurück.

"skipnext" - auf 1 setzen, um den Start des geplanten Ereignisses zu überspringen (wenn der type "run" ist).

 

Liefert

für delete-, run-, add- und update: OK bei Erfolg

für state Abfragen: on - Planer aktiviert, off - Planer deaktiviert

 

Beispiel einer Ereignis Liste in XML

<?xml version="1.0" encoding="utf-8"?>

<Events>

<item EnabledEvent="True" UseDate="False" EveryYear="False" Imm="False" Above="False" FileName="generate [pro] 1h" MuteLev="50" DelPrev="True" DoNotRunIfStopped="False" bRepeat="True" nRepeatPer="60" DoNotMarkAsScheduled="False" nRepeat="1" RepeatLimit="False" TimeToStart="" Shuffle="False" PausePlaylist="False" UseWeeks="False" Enqueue="False" DelTaskAction="0" DelTaskUseDate="False" TaskName="Playlist" ClearMainPlaylist="False" UseDaysOfWeek="True" Hours="000000000000000000000000" Minutes="0" Seconds="0" TimeType="0" TaskNameAsTitle="False" IntTimeToStart="2147483647" ItemImageIndex="63" FontColor="-16777208" BackColor="-16777211" GroupName="" DTMFOn="False" DTMFString="" DTMFOnly="False" DTMFExitOn="False" DTMFExitString="" MaxTimeWaitOn="False" MaxTimeWaitSec="0" MaxTimeWaitAction="0" UseFillers="False" FillersSource="" FillersRecurse="True" FillerMaxAmount="120" Id="DKCODACFWSIKHULWXDUL" Days="1111111" Weeks="00000" Time="2018-02-17 00:00:00" DelTaskTime="2018-02-17 00:00:00" />

<item EnabledEvent="True" UseDate="False" EveryYear="False" Imm="False" Above="True" FileName="http://127.0.0.1:8092/live" MuteLev="50" DelPrev="True" DoNotRunIfStopped="False" bRepeat="False" nRepeatPer="10" DoNotMarkAsScheduled="False" nRepeat="1" RepeatLimit="False" TimeToStart="" Shuffle="False" PausePlaylist="False" UseWeeks="False" Enqueue="False" DelTaskAction="0" DelTaskUseDate="False" TaskName="" ClearMainPlaylist="False" UseDaysOfWeek="True" Hours="000000000000000000000000" Minutes="0" Seconds="0" TimeType="0" TaskNameAsTitle="False" IntTimeToStart="2147483647" ItemImageIndex="56" FontColor="-16777208" BackColor="-16777211" GroupName="" DTMFOn="False" DTMFString="" DTMFOnly="False" DTMFExitOn="False" DTMFExitString="" MaxTimeWaitOn="False" MaxTimeWaitSec="0" MaxTimeWaitAction="0" UseFillers="False" FillersSource="" FillersRecurse="True" FillerMaxAmount="120" Id="BBTHCRXFCOENENGPGOFG" Days="1111111" Weeks="00000" Time="2018-03-13 00:00:00" DelTaskTime="2018-03-13 00:00:00" />

</Events>

getlastplayed

Liste der zuletzt gespielten Titel abrufen

Parameter

"filter" = 1 - (optional) Titel ausschließen, deren Titel nicht an den Server gesendet wurden.

 

Gibt zurück: ein XML mit Informationen über zuletzt gespielte Titel. Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<LastPlayed>

  <TRACK ARTIST="Metallica" TITLE="Master Of Puppets" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\02 Master Of Puppets.m4a" DURATION="08:35" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:38" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" STARTTIME="2018-01-16 20:20:38" />

  <TRACK ARTIST="Metallica" TITLE="Battery" ALBUM="Master Of Puppets" YEAR="1986" GENRE="Metal" COMMENT="" FILENAME="D:\Metallica\Master of Puppets\01 Battery.m4a" DURATION="05:12" PLAYCOUNT="1" LASTPLAYED="2018-01-16 20:20:30" INTRO="0.00" OUTRO="0.00" LANGUAGE="" F1="" F2="" F3="" F4="" F5="" STARTTIME="2018-01-16 20:20:30" />

</LastPlayed>

readtag

Titel-Tag-Informationen lesen

Parameter

"fn" - Dateiname

 

Beispiel

http://127.0.0.1:9000/?pass=WxPe2JXh&action=readtag&fn=D:\Metallica\Metallica%20-%20Darkness.mp3

 

Ein Beispiel für die Rückgabe von Daten: Zeige Beispiel

<?xml version="1.0" encoding="utf-8"?>

<TagInfo>

  <File FN="D:\Metallica\Metallica - Darkness.mp3" Duration="446028" Artist="Metallica" Title="Darkness" Album="" Year="" Genre="" Comment="" BPM="" Rating="0" Playcount="0" LastPlayed="2018-01-16 20:20:30" UserField1="" UserField2="" UserField3="" UserField4="" UserField5="" />

</TagInfo>

writetag

Titel-Tag-Informationen schreiben

Parameter

"fn" - Dateiname

"data" - Neuer Tag im XML Format (wie zurückgegeben von readtag)

 

Rückgabewert

OK bei Erfolg

Error mit Fehlermeldungstext bei Fehler

setcasttitle

neuen Titel auf Streaming-Server setzen

Parameter

"title" - neuer Musiktitel

 

Rückgabewert

OK wenn erfolgreich

status

Rückgabe: ein XML mit der RadioBOSS-Version und der Betriebszeit in Sekunden