Ehttp api doku: Unterschied zwischen den Versionen

Aus TuxBoxWIKI
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 10: Zeile 10:
=API-Dokumentation=
=API-Dokumentation=


<nowiki>http://dbox/?path=1:0:1:6dca:44d:1:0:0:0:0:</nowiki> ; zap zum angegebenen Service
*http://dbox/?path=1:0:1:6dca:44d:1:0:0:0:0
Parameter 1: ?
zap zum angegebenen Service
Parameter 2: ?
Parameter 3: tv/radio/data/... ?
Parameter 4: sid
Parameter 5: tsid
Parameter 6: onid
Parameter 7: ?
Parameter 8: ?
Parameter 9: ?
Parameter10: ?


<nowiki>http://dbox/setVolume?volume=5</nowiki> ; Lautstärke setzen (Bereich 0...10)
Parameter 1: ?
<nowiki>http://dbox/setVolume?mute=1</nowiki> ; Mute an (1) - Mute aus (0)
 
<nowiki>http://dbox/cgi-bin/status</nowiki> ; aktuelles Enigma-Datum und -Uhrzeit
Parameter 2: ?
<nowiki>http://dbox/cgi-bin/switchService</nowiki> ; zap to service
 
<nowiki>http://dbox/cgi-bin/admin?command=shutdown</nowiki> ; dbox/dreambox shutdown
Parameter 3: tv/radio/data/... ?
<nowiki>http://dbox/cgi-bin/admin?command=reboot</nowiki> ; dbox/dreambox reboot
 
<nowiki>http://dbox/cgi-bin/admin?command=restart</nowiki> ; Enigma restart
Parameter 4: sid
<nowiki>http://dbox/cgi-bin/admin?command=standby</nowiki> ; Enigma standby
 
<nowiki>http://dbox/cgi-bin/admin?command=wakeup</nowiki> ; Enigma aufwachen aus standby
Parameter 5: tsid
<nowiki>http://dbox/cgi-bin/audio?volume=30</nowiki> ; Lautstärke setzen (Bereich 64...1)
 
<nowiki>http://dbox/cgi-bin/audio?mute=0</nowiki> ; Mute an (1) - Mute aus (0)
Parameter 6: onid
<nowiki>http://dbox/cgi-bin/getPMT</nowiki> ; gibt die PMT als XML-File zurück
 
<nowiki>http://dbox/cgi-bin/message?Hallo</nowiki> ; Nachricht auf den Fernsehbildschirm
Parameter 7: ?
<nowiki>http://dbox/cgi-bin/xmessage?timeout=3&caption=Nachricht&body=Hallo</nowiki> ; erweitere Nachricht auf den Fernsehbildschirm
 
http://dbox/audio.m3u ; startet einen Audio-HTTP-Stream des aktuell laufenden Services
Parameter 8: ?
http://dbox/video.pls ; startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services
 
http://dbox/mplayer.mply ; startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services
Parameter 9: ?
http://dbox/version ; zeigt aktuelle Version von Enigma an (die Rückgabewerte sollten aber mal aktualisiert werden)
 
http://dbox/cgi-bin/getcurrentepg ; liefert den EPG des aktuellen Service
Parameter10: ?
http://dbox/cgi-bin/streaminfo ; liefert die Stream-Daten des aktuellen Service
 
http://dbox/channels/getcurrent ; liefert den Namen des aktuellen Service
 
http://dbox/cgi-bin/reloadSettings ; Enigma Einstellungen neu laden
*http://dbox/setVolume?volume=5  
http://dbox/cgi-bin/reloadRecordings ; Liste der Recordings neu laden
Lautstärke setzen (Bereich 0...10)
http://dbox/cgi-bin/saveRecordings ; Liste der Recordings im Flash speichern
 
http://dbox/cgi-bin/reloadPlaylist ; Playlist neu laden
 
http://dbox/cgi-bin/savePlaylist ; Playlist speichern
*http://dbox/setVolume?mute=1
http://dbox/cgi-bin/reloadUserBouquets ; User-Bouquets neu einlesen
Mute an (1) - Mute aus (0)
http://dbox/cgi-bin/saveUserBouquets ; User-Bouquets speichern
 
http://dbox/cgi-bin/reloadTimerList ; Timer-Liste neu einlesen  
 
http://dbox/cgi-bin/saveTimerList ; Timer-Liste speichern
*http://dbox/cgi-bin/status
http://dbox/cgi-bin/startPlugin?name=pluginname ; Plugin starten
aktuelles Enigma-Datum und -Uhrzeit
http://dbox/cgi-bin/screenshot ; screenshot nach /tmp/screenshot.bmp
 
http://dbox/cgi-bin/osdshot ; screenshot des osds nach /tmp/osdshot.png
 
*http://dbox/cgi-bin/switchService
zap to service
 
 
*http://dbox/cgi-bin/admin?command=shutdown
dbox/dreambox shutdown
 
 
*http://dbox/cgi-bin/admin?command=reboot
dbox/dreambox reboot
 
 
*http://dbox/cgi-bin/admin?command=restart
Enigma restart
 
 
*http://dbox/cgi-bin/admin?command=standby
Enigma standby
 
 
*http://dbox/cgi-bin/admin?command=wakeup
Enigma aufwachen aus standby
 
 
*http://dbox/cgi-bin/audio?volume=30
Lautstärke setzen (Bereich 64...1)
 
 
*http://dbox/cgi-bin/audio?mute=0
Mute an (1) - Mute aus (0)
 
 
*http://dbox/cgi-bin/getPMT
gibt die PMT als XML-File zurück
 
 
*http://dbox/cgi-bin/message?Hallo
Nachricht auf den Fernsehbildschirm
 
 
*http://dbox/cgi-bin/xmessage?timeout=3&caption=Nachricht&body=Hallo
erweiterte Nachricht auf den Fernsehbildschirm
 
 
*http://dbox/audio.m3u
startet einen Audio-HTTP-Stream des aktuell laufenden Services
 
 
*http://dbox/video.pls
startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services
 
 
*http://dbox/mplayer.mply
startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services
 
 
*http://dbox/version
zeigt aktuelle Version von Enigma an (die Rückgabewerte sollten aber mal aktualisiert werden)
 
 
*http://dbox/cgi-bin/getcurrentepg
liefert den EPG des aktuellen Service
 
 
*http://dbox/cgi-bin/streaminfo
liefert die Stream-Daten des aktuellen Service
 
 
*http://dbox/channels/getcurrent
liefert den Namen des aktuellen Service
 
 
*http://dbox/cgi-bin/reloadSettings
Enigma Einstellungen neu laden
 
 
*http://dbox/cgi-bin/reloadRecordings
Liste der Recordings neu laden
 
 
*http://dbox/cgi-bin/saveRecordings
Liste der Recordings im Flash speichern
 
 
*http://dbox/cgi-bin/reloadPlaylist
Playlist neu laden
 
 
*http://dbox/cgi-bin/savePlaylist
Playlist speichern
 
 
*http://dbox/cgi-bin/reloadUserBouquets
User-Bouquets neu einlesen
 
 
*http://dbox/cgi-bin/saveUserBouquets
User-Bouquets speichern
 
 
*http://dbox/cgi-bin/reloadTimerList
Timer-Liste neu einlesen  
 
 
*http://dbox/cgi-bin/saveTimerList
Timer-Liste speichern
 
 
*http://dbox/cgi-bin/startPlugin?name=pluginname
Plugin starten
 
 
*http://dbox/cgi-bin/screenshot
screenshot nach /tmp/screenshot.bmp
 
 
*http://dbox/cgi-bin/osdshot
screenshot des [[OSD]]'s nach /tmp/osdshot.png




===einige Kompatibilitäts-Funktionen zu Neutrino===
===einige Kompatibilitäts-Funktionen zu Neutrino===


*http://dbox/control/message?Hallo ; Nachricht auf den Fernsehbildschirm
*http://dbox/control/message?Hallo  
Nachricht auf den Fernsehbildschirm




*http://dbox/control/zapto?getpids ; liefert die VPid und APid des aktuellen Service (dezimal)
*http://dbox/control/zapto?getpids  
liefert die VPid und APid des aktuellen Service (dezimal)


Beispiel-Ausgabe:
Beispiel-Ausgabe:
Zeile 73: Zeile 184:




*http://dbox/control/zapto?69531 ; sollte zum angegebenen Channel zappen -> tut es aber nicht
*http://dbox/control/zapto?69531  
sollte zum angegebenen Channel zappen -> tut es aber nicht




*http://dbox/control/getonidsid ; liefert onid+sid
*http://dbox/control/getonidsid
liefert onid+sid




*http://dbox/control/channellist ; liefert komplette Kanalliste (unsortiert)
*http://dbox/control/channellist
liefert die komplette Kanalliste (unsortiert)




===XML-Funktionen===
===XML-Funktionen===


*http://dbox/xml/boxstatus ; liefert den Status der Box wie Standby, Recording, etc.
*http://dbox/xml/boxstatus
liefert den Status der Box wie Standby, Recording, etc.


Beispiel-Ausgabe:
Beispiel-Ausgabe:
Zeile 108: Zeile 223:




*http://dbox/xml/timers ; liefert Timerliste
*http://dbox/xml/timers  
[[Bild:Timer.jpg|800px]]
liefert die Timerliste
 
[[Bild:Timer.jpg|800px]]
 


*http://dbox/xml/serviceepg?ref={service reference} (ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)
*http://dbox/xml/serviceepg?ref={service reference} (ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)
Gibt das EPG eines Services mit der Servicereferenz 'ref' zurueck:
[[Bild:Epg.jpg|800px]]


*http://dbox/xml/currentservicedata ; liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.
Gibt den [[EPG]] eines Services mit der Servicereferenz 'ref' zurueck:
[[Bild:Currentservice.jpg|800px]]
 
[[Bild:Epg.jpg|800px]]
 
 
*http://dbox/xml/currentservicedata
liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.
 
[[Bild:Currentservice.jpg|800px]]
 


*http://dbox/xml/imageinfo
*http://dbox/xml/imageinfo
*http://dbox/xml/services
*http://dbox/xml/services



Version vom 24. Juli 2005, 01:04 Uhr


Allgemeines

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


API-Dokumentation

zap zum angegebenen Service

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)


Mute an (1) - Mute aus (0)


aktuelles Enigma-Datum und -Uhrzeit


zap to service


dbox/dreambox shutdown


dbox/dreambox reboot


Enigma restart


Enigma standby


Enigma aufwachen aus standby


Lautstärke setzen (Bereich 64...1)


Mute an (1) - Mute aus (0)


gibt die PMT als XML-File zurück


Nachricht auf den Fernsehbildschirm


erweiterte Nachricht auf den Fernsehbildschirm


startet einen Audio-HTTP-Stream des aktuell laufenden Services


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


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


zeigt aktuelle Version von Enigma an (die Rückgabewerte sollten aber mal aktualisiert werden)


liefert den EPG des aktuellen Service


liefert die Stream-Daten des aktuellen Service


liefert den Namen des aktuellen Service


Enigma Einstellungen neu laden


Liste der Recordings neu laden


Liste der Recordings im Flash speichern


Playlist neu laden


Playlist speichern


User-Bouquets neu einlesen


User-Bouquets speichern


Timer-Liste neu einlesen


Timer-Liste speichern


Plugin starten


screenshot nach /tmp/screenshot.bmp


screenshot des OSD's nach /tmp/osdshot.png


einige Kompatibilitäts-Funktionen zu Neutrino

Nachricht auf den Fernsehbildschirm


liefert die VPid und APid des aktuellen Service (dezimal)

Beispiel-Ausgabe:

255
256

255 ist die Video Pid

256 ist die Audio Pid


sollte zum angegebenen Channel zappen -> tut es aber nicht


liefert onid+sid


liefert die komplette Kanalliste (unsortiert)


XML-Funktionen

liefert den Status der Box wie Standby, Recording, etc.

Beispiel-Ausgabe:

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

<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


liefert die Timerliste

Timer.jpg


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

Datei:Epg.jpg


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

Datei:Currentservice.jpg




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.