Ehttp api doku: Unterschied zwischen den Versionen

Aus TuxBoxWIKI
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
(Kosmetik)
Zeile 35: Zeile 35:


==Lautstärke setzen (Bereich 0...10)==
==Lautstärke setzen (Bereich 0...10)==
'''Befehl:''' http://dbox/setVolume?volume=5  
Befehl: http://dbox/setVolume?volume=5  




==Ton Stumm schalten==
==Ton Stumm schalten==
'''Befehl:''' http://dbox/setVolume?mute=1
Befehl: http://dbox/setVolume?mute=1


'''Beschreibung:'''
Beschreibung:


Mute an (1)  
Mute an (1)  
Zeile 49: Zeile 49:


==aktuelles Enigma-Datum und -Uhrzeit==
==aktuelles Enigma-Datum und -Uhrzeit==
'''Befehl:''' http://dbox/cgi-bin/status
Befehl: http://dbox/cgi-bin/status


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




==Zum service zappen==
==Zum service zappen==
'''Befehl:''' http://dbox/cgi-bin/switchService
Befehl: http://dbox/cgi-bin/switchService




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




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




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




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




==Enigma aufwachen aus standby==
==Enigma aufwachen aus standby==
'''Befehl:''' http://dbox/cgi-bin/admin?command=wakeup
Befehl: http://dbox/cgi-bin/admin?command=wakeup




==Lautstärke setzen (Bereich 64...1)==
==Lautstärke setzen (Bereich 64...1)==
'''Befehl:''' http://dbox/cgi-bin/audio?volume=30
Befehl: http://dbox/cgi-bin/audio?volume=30




==Mute an (1) - Mute aus (0)==
==Mute an (1) - Mute aus (0)==
'''Befehl:''' http://dbox/cgi-bin/audio?mute=0
Befehl: http://dbox/cgi-bin/audio?mute=0




==gibt die PMT als XML-File zurück==
==gibt die PMT als XML-File zurück==
'''Befehl:''' http://dbox/cgi-bin/getPMT
Befehl: http://dbox/cgi-bin/getPMT




==Nachricht auf den Fernsehbildschirm==
==Nachricht auf den Fernsehbildschirm==
'''Befehl:''' http://dbox/cgi-bin/message?Hallo
Befehl: http://dbox/cgi-bin/message?Hallo




==erweiterte Nachricht auf den Fernsehbildschirm==
==erweiterte Nachricht auf den Fernsehbildschirm==
'''Befehl:''' http://dbox/cgi-bin/xmessage?timeout=3&caption=Nachricht&body=Hallo
Befehl: http://dbox/cgi-bin/xmessage?timeout=3&caption=Nachricht&body=Hallo




==startet einen Audio-HTTP-Stream des aktuell laufenden Services==
==startet einen Audio-HTTP-Stream des aktuell laufenden Services==
'''Befehl:''' http://dbox/audio.m3u
Befehl: http://dbox/audio.m3u




==startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services==
==startet einen Video-HTTP-Stream (VLC kompatibel) des aktuell laufenden Services==
'''Befehl:''' http://dbox/video.pls
Befehl: http://dbox/video.pls




==startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services==
==startet einen Video-HTTP-Stream (MPlayer kompatibel) des aktuell laufenden Services==
'''Befehl:''' http://dbox/mplayer.mply
Befehl: http://dbox/mplayer.mply




==zeigt aktuelle Version von Enigma an==
==zeigt aktuelle Version von Enigma an==
'''Befehl:''' http://dbox/version
Befehl: http://dbox/version


(die Rückgabewerte sollten mal aktualisiert werden)
(die Rückgabewerte sollten mal aktualisiert werden)
Zeile 117: Zeile 117:


==liefert den EPG des aktuellen Service==
==liefert den EPG des aktuellen Service==
'''Befehl:''' http://dbox/cgi-bin/getcurrentepg
Befehl: http://dbox/cgi-bin/getcurrentepg




==liefert die Stream-Daten des aktuellen Service==
==liefert die Stream-Daten des aktuellen Service==
'''Befehl:''' http://dbox/cgi-bin/streaminfo
Befehl: http://dbox/cgi-bin/streaminfo




==liefert den Namen des aktuellen Service==
==liefert den Namen des aktuellen Service==
'''Befehl:''' http://dbox/channels/getcurrent
Befehl: http://dbox/channels/getcurrent




==Enigma Einstellungen neu laden==
==Enigma Einstellungen neu laden==
'''Befehl:''' http://dbox/cgi-bin/reloadSettings
Befehl: http://dbox/cgi-bin/reloadSettings




==Liste der Recordings neu laden==
==Liste der Recordings neu laden==
'''Befehl:''' http://dbox/cgi-bin/reloadRecordings
Befehl: http://dbox/cgi-bin/reloadRecordings




==Liste der Recordings im Flash speichern==
==Liste der Recordings im Flash speichern==
'''Befehl:''' http://dbox/cgi-bin/saveRecordings
Befehl: http://dbox/cgi-bin/saveRecordings




==Playlist neu laden==
==Playlist neu laden==
'''Befehl:''' http://dbox/cgi-bin/reloadPlaylist
Befehl: http://dbox/cgi-bin/reloadPlaylist




==Playlist speichern==
==Playlist speichern==
'''Befehl:''' http://dbox/cgi-bin/savePlaylist
Befehl: http://dbox/cgi-bin/savePlaylist




==User-Bouquets neu einlesen==
==User-Bouquets neu einlesen==
'''Befehl:''' http://dbox/cgi-bin/reloadUserBouquets
Befehl: http://dbox/cgi-bin/reloadUserBouquets




==User-Bouquets speichern==
==User-Bouquets speichern==
'''Befehl:''' http://dbox/cgi-bin/saveUserBouquets
Befehl: http://dbox/cgi-bin/saveUserBouquets




==Timer-Liste neu einlesen==
==Timer-Liste neu einlesen==
'''Befehl:''' http://dbox/cgi-bin/reloadTimerList
Befehl: http://dbox/cgi-bin/reloadTimerList
   
   


==Timer-Liste speichern==
==Timer-Liste speichern==
'''Befehl:''' http://dbox/cgi-bin/saveTimerList
Befehl: http://dbox/cgi-bin/saveTimerList




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




==screenshot nach /tmp/screenshot.bmp==
==screenshot nach /tmp/screenshot.bmp==
'''Befehl:''' http://dbox/cgi-bin/screenshot
Befehl: http://dbox/cgi-bin/screenshot




==screenshot des [[OSD]]'s nach /tmp/osdshot.png==
==screenshot des [[OSD]]'s nach /tmp/osdshot.png==
'''Befehl:''' http://dbox/cgi-bin/osdshot
Befehl: http://dbox/cgi-bin/osdshot




Zeile 179: Zeile 179:


==Nachricht auf den Fernsehbildschirm==
==Nachricht auf den Fernsehbildschirm==
'''Befehl:''' http://dbox/control/message?Hallo  
Befehl: http://dbox/control/message?Hallo  




==liefert die VPid und APid des aktuellen Service (dezimal)==
==liefert die VPid und APid des aktuellen Service (dezimal)==
'''Befehl:''' http://dbox/control/zapto?getpids  
Befehl: http://dbox/control/zapto?getpids  


Beispiel-Ausgabe:
Beispiel-Ausgabe:
Zeile 192: Zeile 192:


256 ist die Audio Pid
256 ist die Audio Pid


==sollte zum angegebenen Channel zappen -> tut es aber nicht==
==sollte zum angegebenen Channel zappen -> tut es aber nicht==
'''Befehl:''' http://dbox/control/zapto?69531  
Befehl: http://dbox/control/zapto?69531  




==liefert onid+sid==
==liefert onid+sid==
'''Befehl:''' http://dbox/control/getonidsid
Befehl: http://dbox/control/getonidsid




==liefert die komplette Kanalliste (unsortiert)==
==liefert die komplette Kanalliste (unsortiert)==
'''Befehl:''' http://dbox/control/channellist
Befehl: http://dbox/control/channellist




=XML-Funktionen=
=XML-Funktionen=
==liefert den Status der Box wie Standby, Recording, etc.==
==liefert den Status der Box wie Standby, Recording, etc.==
'''Befehl:''' http://dbox/xml/boxstatus
Befehl: http://dbox/xml/boxstatus


'''Beispiel-Ausgabe:'''
'''Beispiel-Ausgabe:'''
Zeile 222: Zeile 223:
'''Erläuterungen:'''  
'''Erläuterungen:'''  


'''<current_time>Sat Jul 23 23:03:17 2005</current_time>''' liefert das Datum und die aktuelle Uhrzeit
<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
<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
<recording>OFF</recording> Enigma nimmt gerade nicht auf, ON bedeutet Enigma nimmt gerade auf


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


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


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


'''<ip>192.168.0.10</ip>''' gibt die aktuelle IP der Box zurück, in diesem Fall wäre das die 192.168.0.10
<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==
==liefert die Timerliste==
'''Befehl:''' http://dbox/xml/timers  
Befehl: http://dbox/xml/timers  


[[Bild:Timer.jpg|600px]]
[[Bild:Timer.jpg|600px]]




'''Befehl:''' <nowiki>http://dbox/xml/serviceepg?ref={service reference}</nowiki>  
Befehl: <nowiki>http://dbox/xml/serviceepg?ref={service reference}</nowiki>  


(ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)
(ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)
Zeile 253: Zeile 254:


==liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.==
==liefert Daten des momentanen Services wie EPG, Audio- und Video-Channels, etc.==
'''Befehl:''' http://dbox/xml/currentservicedata
Befehl: http://dbox/xml/currentservicedata


[[Bild:Currentservice.jpg|600px]]
[[Bild:Currentservice.jpg|600px]]
Zeile 259: Zeile 260:


==Image-Info==
==Image-Info==
'''Befehl:''' http://dbox/xml/imageinfo
Befehl: http://dbox/xml/imageinfo




==Alle Services==
==Alle Services==
'''Befehl:''' http://dbox/xml/services
Befehl: http://dbox/xml/services





Version vom 24. Juli 2005, 01:46 Uhr


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 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's 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


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 den Status der Box wie 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


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:

Datei:Epg.jpg


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

Befehl: http://dbox/xml/currentservicedata

Datei:Currentservice.jpg


Image-Info

Befehl: http://dbox/xml/imageinfo


Alle Services

Befehl: http://dbox/xml/services



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.