Ehttp api doku

Aus TuxBoxWIKI
Wechseln zu: Navigation, Suche

Inhaltsverzeichnis


Allgemeines

Dies ist die Dokumentation der API des ehttp (Web-Server) von Enigma.


API-Dokumentation

Lautstärke setzen (Bereich 0...63)

Befehl: http://dbox/setVolume?volume=5

0 ist quasi mute, sprich Ton aus.

63 entspricht der vollen Lautstärke.

Diese Funktion liefert keine Rückgabewerte. (wird für das webif benötigt)


Lautstärke setzen (Bereich 63...0)

Befehl: http://dbox/cgi-bin/audio?volume=30

0 entspricht der vollen Lautstärke.

Rückgabe: 

Volume set.
volume: 0
mute: 0

63 ist quasi mute, sprich Ton aus.

Rückgabe: 

Volume set.
volume: 63
mute: 1


Ton Stumm schalten

Befehl: http://dbox/setVolume?mute=0

Diese Funktion liefert keine Rückgabewerte. (wird für das webif benötigt)


Ton Stumm schalten (2)

Befehl: http://dbox/cgi-bin/audio?mute=0

Rückgabe: 

mute set
volume: 0
mute: 0


liefert die TV User-Bouquets inklusive Sender

Befehl: http://dbox/cgi-bin/getServices?ref=4097:7:0:6:0:0:0:0:0:0:&listContent=true

Beispiel Ausgabe: 

4097:7:0:d2fca:0:0:0:0:0:0:/var/tuxbox/config/enigma/userbouquet.d2fca.tv;Basis
1:0:1:6dca:44d:1:c00000:0:0:0:;Das Erste;ARD;192
1:0:1:6d66:437:1:c00000:0:0:0:;ZDF;ZDFvision;192
1:0:1:2e:21:85:c00000:0:0:0:;SAT.1;ProSiebenSat.1;192
1:0:1:2ee3:441:1:c00000:0:0:0:;RTL Television;RTL World;192
1:0:1:382:21:85:c00000:0:0:0:;ProSieben;ProSiebenSat.1;192


liefert die Radio User-Bouquets inklusive Sender

Befehl: http://dbox/cgi-bin/getServices?ref=4097:7:0:4:0:0:0:0:0:0:&listContent=true

Beispiel Ausgabe: 

4097:7:0:281ed:0:0:0:0:0:0:/etc/enigma/userbouquet.281ed.radio;Basis
1:0:2:aa:7:85:c00000:0:0:0:;ANTENNE BAYERN;BetaDigital;192
1:0:2:a9:7:85:c00000:0:0:0:;sunshine live;BetaDigital;192


liefert die Movies-Liste

Befehl: http://dbox/cgi-bin/getServices?ref=4097:7:0:1:0:0:0:0:0:0:&listContent=true

Beispiel Ausgabe: 

1:0:1:382:21:85:c00000:0:0:0:/hdd/movie/ProSieben - Die Simpsons - 19_07_05.ts;Die Simpsons;192


liefert die Services (Sender) des aktuellen Transponders

Befehl: http://dbox/cgi-bin/currentTransponderServices

Beispiel Ausgabe: 

1:0:1:2ee3:441:1:c00000:0:0:0:;RTL Television;0000a3;010068;020069;0300a3
1:0:1:2ef4:441:1:c00000:0:0:0:;RTL2;0000a6;010080;020044;0300a6
1:0:1:2f08:441:1:c00000:0:0:0:;Super RTL;0000a5;010078;020041;0300a5
1:0:1:2f1c:441:1:c00000:0:0:0:;VOX;0000a7;010088;020047;0300a7
1:0:1:2f30:441:1:c00000:0:0:0:;RTL Shop
1:0:1:2f3a:441:1:c00000:0:0:0:;n-tv;0000a9;010049;020050;0300a9
1:0:1:2f3f:441:1:c00000:0:0:0:;Traumpartner TV


liefert die subchannels (Unterkanäle) eines Services (Senders)

Befehl: http://dbox/cgi-bin/videoChannels

Beispiel Ausgabe auf dem Premiere Sport Portal: 

<option value="1:0:7:11:3:85:c00000:0:0:0:">Portal</option>
<option value="1:0:7:dd:11:85:c00000:0:0:0:">Bundesliga</option>
<option value="1:0:7:de:3:85:c00000:0:0:0:">Golf</option>
<option value="1:0:7:dc:3:85:c00000:0:0:0:">News</option>


liefert die Audio-Optionen eines Services (Senders)

Befehl: http://dbox/cgi-bin/audioChannels

Beispiel Ausgabe auf Pro7: 

<option selected value="0x0100">deutsch</option>
<option value="0x0101">dolby digital (AC3)</option>


zap zum angegebenen Service

Beispiel-Befehl: http://dbox/cgi-bin/zapTo?path=1:0:1:2ee3:441:1:c00000:0:0:0

Parameter 1: FavoritenTyp: 1=DBV-Service, 2=File

Parameter 2: Flags

Parameter 3: SType = Service Type; Dezimalwert: 1=TV, 2=Radio, 4=NVod, andere=Daten

Parameter 4: 2ee3 ist die SID, wird in hex angegeben

Parameter 5: 441 ist die TSID, wird in hex angegeben

Parameter 6: 1 ist die ONID, wird in hex angegeben

Parameter 7: Namespace in hex

Parameter 8: ?

Parameter 9: ?

Parameter10: ?


zum service zappen

Befehl: http://dbox/cgi-bin/switchService


dbox/dreambox shutdown

Befehl: http://dbox/cgi-bin/admin?command=shutdown


dbox/dreambox reboot

Befehl: http://dbox/cgi-bin/admin?command=reboot


Enigma Neustart

Befehl: http://dbox/cgi-bin/admin?command=restart


Enigma standby

Befehl: http://dbox/cgi-bin/admin?command=standby


Enigma aufwachen aus standby

Befehl: http://dbox/cgi-bin/admin?command=wakeup


Nachricht auf den Fernsehbildschirm

Befehl: http://dbox/cgi-bin/message?Hallo


erweiterte Nachricht auf den Fernsehbildschirm

Befehl: http://dbox/cgi-bin/xmessage?timeout=3&caption=Nachricht&body=Hallo


startet einen Audio-HTTP-Stream des aktuell laufenden Services

Befehl: http://dbox/audio.m3u


startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services

Befehl: http://dbox/video.pls

Bei neueren Images (YADI 2.1.0.6) lautet der Befehl http://dbox/video.m3u


startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services

Befehl: http://dbox/mplayer.mply


aktuelles Enigma-Datum und -Uhrzeit

Befehl: http://dbox/cgi-bin/status

Beschreibung: gibt das aktuelle Enigma-Datum und -Uhrzeit zurück


zeigt aktuelle Version von Enigma an

Befehl: http://dbox/version

(die Rückgabewerte sollten mal aktualisiert werden)


liefert den EPG des aktuellen Service

Befehl: http://dbox/cgi-bin/getcurrentepg


liefert die Stream-Daten des aktuellen Service

Befehl: http://dbox/cgi-bin/streaminfo


liefert den Namen des aktuellen Service

Befehl: http://dbox/channels/getcurrent


gibt die PMT als XML-File zurück

Befehl: http://dbox/cgi-bin/getPMT


Enigma Einstellungen neu laden

Befehl: http://dbox/cgi-bin/reloadSettings


Liste der Recordings neu laden

Befehl: http://dbox/cgi-bin/reloadRecordings


Liste der Recordings im Flash speichern

Befehl: http://dbox/cgi-bin/saveRecordings


Playlist neu laden

Befehl: http://dbox/cgi-bin/reloadPlaylist


Playlist speichern

Befehl: http://dbox/cgi-bin/savePlaylist


User-Bouquets neu einlesen

Befehl: http://dbox/cgi-bin/reloadUserBouquets


User-Bouquets speichern

Befehl: http://dbox/cgi-bin/saveUserBouquets


Timer-Liste neu einlesen

Befehl: http://dbox/cgi-bin/reloadTimerList


Timer-Liste speichern

Befehl: http://dbox/cgi-bin/saveTimerList


Plugin starten

Befehl: http://dbox/cgi-bin/startPlugin?name=pluginname


screenshot nach /tmp/screenshot.bmp

Befehl: http://dbox/cgi-bin/screenshot


screenshot des OSD nach /tmp/osdshot.png

Befehl: http://dbox/cgi-bin/osdshot


einige Kompatibilitäts-Funktionen zu Neutrino

Nachricht auf den Fernsehbildschirm

Befehl: http://dbox/control/message?Hallo


liefert die VPid und APid des aktuellen Service (dezimal)

Befehl: http://dbox/control/zapto?getpids

Beispiel-Ausgabe: 

255
256

255 ist die Video Pid

256 ist die Audio Pid


liefert VPid, APid's, vtxt Pid und PMT Pid des aktuellen Service (dezimal)

Befehl: http://dbox/control/zapto?getallpids

Beispiel-Ausgabe: 

00255
00256 deutsch
00257 dolby digital (AC3)
00032 vtxt
00100 pmt

00255 ist die Video Pid

00256 ist die Audio Pid

00257 ist die 2te Audio Pid

00032 ist die vtxt (Teletext) Pid

00100 ist die PMT Pid


sollte zum angegebenen Channel zappen -> tut es aber nicht

Befehl: http://dbox/control/zapto?69531


liefert onid+sid

Befehl: http://dbox/control/getonidsid


liefert die komplette Kanalliste (unsortiert)

Befehl: http://dbox/control/channellist


XML-Funktionen

liefert Statusinformationen der Box wie z.B. Standby, Recording, etc.

Befehl: http://dbox/xml/boxstatus

Beispiel-Ausgabe: 

<status>
 <current_time>Sat Jul 23 23:03:17 2005
 </current_time>
 <standby>OFF</standby>
 <recording>OFF</recording>
 <mode>0</mode>
 <ip>192.168.0.10</ip>
</status>


Erläuterungen:

<current_time>Sat Jul 23 23:03:17 2005</current_time> liefert das Datum und die aktuelle Uhrzeit

<standby>OFF</standby> die Box ist nicht im standby, ON bedeutet sie befindet sich im Standby

<recording>OFF</recording> Enigma nimmt gerade nicht auf, ON bedeutet Enigma nimmt gerade auf

<mode>0</mode> Enigma befindet sich im TV-Modus

<mode>1</mode> Enigma befindet sich im Radio-Modus

<mode>2</mode> Enigma befindet sich im Datei-Modus

<ip>192.168.0.10</ip> gibt die aktuelle IP-Adresse der Box zurück, in diesem Fall wäre das die 192.168.0.10


liefert die Timerliste

Befehl: http://dbox/xml/timers

Timer.jpg


liefert den EPG eines Services mit der Servicereferenz

Befehl: http://dbox/xml/serviceepg?ref={service reference}

(ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)

Gibt den EPG eines Services mit der Servicereferenz 'ref' zurueck:

600px


liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.

Befehl: http://dbox/xml/currentservicedata

600px


Box-Info

Befehl: http://dbox/xml/boxinfo


liefert die Stream-Daten des aktuellen Service

Befehl: http://dbox/xml/streaminfo


Alle Services

Befehl: http://dbox/xml/services


Timer

einmal-Timer hinzufügen

http://dbox/addTimerEvent?type=regular&ref=' + channel + '&sday=' + sday + '&smonth=' + smonth + '&syear=' +

 syear + '&shour=' + shour + '&smin=' + smin + '&eday=' + eday + '&emonth=' + emonth + '&eyear=' + eyear + '&ehour=' +

 ehour + '&emin=' + emin + '&descr=' + descr + '&after_event=' + after_event + '&action=' + action;

Bei action gibt man dvr, ngrab oder zap an.

Bei 'after_event' gibt man 67108864 (shutdown) oder 134217728 (standby) an. Keine Angabe entspricht keiner Aktion.


wiederholender-Timer hinzufügen

http://dbox/addTimerEvent?timer=repeating&ref=' + channel + '&shour=' + shour + '&smin=' + smin + '&ehour=' + 

ehour + '&emin=' + emin + '&mo=' + mo + '&tu=' + tu + '&we=' + we + '&th=' + th + '&fr=' + fr + '&sa=' + sa + '&su=' + 

su + '&descr=' + descr + '&after_event=' + after_event + '&action=' + action;

Bei action gibt man dvr, ngrab oder zap an.

Bei 'after_event' gibt man 67108864 (shutdown) oder 134217728 (standby) an. Keine Angabe entspricht keiner Aktion.

Bei den Tagen gibt man 'on' an den Tagen an, an denen der Timer ausgeführt werden soll (z.B. &tu=on&fr=on). Nicht verwendete Tage kann man weglassen.

Achtung:

Gegenüber dem Hinzfügen eines einmal-Timers muss hier nach addTimerEvent? timer=repeating kommen.


einmal-Timer ändern

http://dbox/changeTimerEvent?type=regular<dieselben parameter wie addtimerevent> plus old_type=...&old_stime=...

zur Identifikation des Timers. Bei old_data muss der Parameter <typedata> aus der Timerliste übernommen werden und old_stime ist die alte Startzeit <start>


wiederholender-Timer ändern

http://dbox/changeTimerEvent?type=repeating<dieselben parameter wie addtimerevent> plus old_type=...&old_stime=...

zur Identifikation des Timers. Bei old_data muss der Parameter <typedata> aus der Timerliste übernommen werden und old_stime ist die alte Startzeit <start>


einmal-Timer löschen

http://dbox/deleteTimerEvent?ref=#REFERENCE#&start=#START#&type=#TIMERTYPE#&force=no/yes

Hier ist type=dvr oder type=ngrab.


wiederholender-Timer löschen

http://dbox/deleteTimerEvent?ref=#REFERENCE#&start=#START#&type=#TIMERID#&force=no/yes

Achtung:

Hier muss bei type die timer-id angegeben werden, dies ist nur für wiederholende-Timer notwendig.




Review-KandidatDieser Artikel befindet sich derzeit im Reviewprozess. Hilf mit, ihn zu verbessern! Falls du bei weiteren Artikeln helfen willst, findest du hier eine Auswahl offener Artikel.


Abgerufen von „https://wiki.tuxbox-neutrino.org/w/index.php?title=Ehttp_api_doku&oldid=6009“