Ehttp api doku
Inhaltsverzeichnis
- 1 Allgemeines
- 2 API-Dokumentation
- 2.1 zap zum angegebenen Service
- 2.2 Lautstärke setzen (Bereich 0...10)
- 2.3 Ton Stumm schalten
- 2.4 aktuelles Enigma-Datum und -Uhrzeit
- 2.5 zum service zappen
- 2.6 dbox/dreambox shutdown
- 2.7 dbox/dreambox reboot
- 2.8 Enigma Neustart
- 2.9 Enigma standby
- 2.10 Enigma aufwachen aus standby
- 2.11 Lautstärke setzen (Bereich 64...1)
- 2.12 Mute an (1) - Mute aus (0)
- 2.13 gibt die PMT als XML-File zurück
- 2.14 Nachricht auf den Fernsehbildschirm
- 2.15 erweiterte Nachricht auf den Fernsehbildschirm
- 2.16 startet einen Audio-HTTP-Stream des aktuell laufenden Services
- 2.17 startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services
- 2.18 startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services
- 2.19 zeigt aktuelle Version von Enigma an
- 2.20 liefert die TV User-Bouquets inklusive Sender
- 2.21 liefert die Radio User-Bouquets inklusive Sender
- 2.22 liefert die Movies-Liste
- 2.23 liefert den EPG des aktuellen Service
- 2.24 liefert die Stream-Daten des aktuellen Service
- 2.25 liefert den Namen des aktuellen Service
- 2.26 Enigma Einstellungen neu laden
- 2.27 Liste der Recordings neu laden
- 2.28 Liste der Recordings im Flash speichern
- 2.29 Playlist neu laden
- 2.30 Playlist speichern
- 2.31 User-Bouquets neu einlesen
- 2.32 User-Bouquets speichern
- 2.33 Timer-Liste neu einlesen
- 2.34 Timer-Liste speichern
- 2.35 Plugin starten
- 2.36 screenshot nach /tmp/screenshot.bmp
- 2.37 screenshot des OSD nach /tmp/osdshot.png
- 3 einige Kompatibilitäts-Funktionen zu Neutrino
- 3.1 Nachricht auf den Fernsehbildschirm
- 3.2 liefert die VPid und APid des aktuellen Service (dezimal)
- 3.3 liefert VPid, APid's, vtxt Pid und PMT Pid des aktuellen Service (dezimal)
- 3.4 sollte zum angegebenen Channel zappen -> tut es aber nicht
- 3.5 liefert onid+sid
- 3.6 liefert die komplette Kanalliste (unsortiert)
- 4 XML-Funktionen
- 5 Timer
Allgemeines
Dies ist die Dokumentation der API des ehttp (Web-Server) von Enigma.
API-Dokumentation
zap zum angegebenen Service
Befehl: http://dbox/?path=1:0:1:6dca:44d:1:0:0:0:0
Parameter 1: ?
Parameter 2: ?
Parameter 3: tv/radio/data/... ?
Parameter 4: sid
Parameter 5: tsid
Parameter 6: onid
Parameter 7: ?
Parameter 8: ?
Parameter 9: ?
Parameter10: ?
Lautstärke setzen (Bereich 0...10)
Befehl: http://dbox/setVolume?volume=5
Ton Stumm schalten
Befehl: http://dbox/setVolume?mute=1
Beschreibung:
Mute an (1)
Mute aus (0)
aktuelles Enigma-Datum und -Uhrzeit
Befehl: http://dbox/cgi-bin/status
Beschreibung: gibt das aktuelle Enigma-Datum und -Uhrzeit zurück
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
Lautstärke setzen (Bereich 64...1)
Befehl: http://dbox/cgi-bin/audio?volume=30
Mute an (1) - Mute aus (0)
Befehl: http://dbox/cgi-bin/audio?mute=0
gibt die PMT als XML-File zurück
Befehl: http://dbox/cgi-bin/getPMT
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
startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services
Befehl: http://dbox/mplayer.mply
zeigt aktuelle Version von Enigma an
Befehl: http://dbox/version
(die Rückgabewerte sollten mal aktualisiert werden)
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 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
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
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:
liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.
Befehl: http://dbox/xml/currentservicedata
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
url = 'addTimerEvent?timer=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.
wiederholender-Timer hinzufügen
url = '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.
Timer ändern
/changeTimerEvent?<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>
Timer löschen
/deleteTimerEvent?ref=#REFERENCE#&start=#START#&type=#TIMERTYPE#&force=no/yes
Grundlagen - Installation - Debug-Mode - Hardware - CDK/Development
LCars - Neutrino - Enigma - Plugins - Spiele - Software - Tools - Howto - FAQ - Images
Hauptseite - News - Alle Artikel - Bewertungen - Gewünschte Seiten - Index - Neue Artikel - Impressum - Team
Hilfeportal - Seite bearbeiten - Bilder - Links - Tabellen - Textgestaltung