Ehttp api doku: Unterschied zwischen den Versionen

Aus TuxBoxWIKI
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 98: Zeile 98:




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




*http://dbox/video.pls
==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




*http://dbox/mplayer.mply
==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




*http://dbox/version
==zeigt aktuelle Version von Enigma an==
zeigt aktuelle Version von Enigma an (die Rückgabewerte sollten aber mal aktualisiert werden)
'''Befehl:''' http://dbox/version


(die Rückgabewerte sollten mal aktualisiert werden)


*http://dbox/cgi-bin/getcurrentepg
liefert den EPG des aktuellen Service


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


*http://dbox/cgi-bin/streaminfo
liefert die Stream-Daten des aktuellen Service


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


*http://dbox/channels/getcurrent
liefert den Namen des aktuellen Service


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


*http://dbox/cgi-bin/reloadSettings
Enigma Einstellungen neu laden


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


*http://dbox/cgi-bin/reloadRecordings
Liste der Recordings neu laden


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


*http://dbox/cgi-bin/saveRecordings
Liste der Recordings im Flash speichern


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


*http://dbox/cgi-bin/reloadPlaylist
Playlist neu laden


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


*http://dbox/cgi-bin/savePlaylist
Playlist speichern


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


*http://dbox/cgi-bin/reloadUserBouquets
User-Bouquets neu einlesen


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


*http://dbox/cgi-bin/saveUserBouquets
User-Bouquets speichern


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


*http://dbox/cgi-bin/reloadTimerList
Timer-Liste neu einlesen


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


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




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




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




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




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


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




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


Beispiel-Ausgabe:
Beispiel-Ausgabe:
Zeile 191: Zeile 193:
256 ist die Audio Pid
256 ist die Audio Pid


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




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




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




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


Beispiel-Ausgabe:
Beispiel-Ausgabe:
Zeile 234: Zeile 234:




*http://dbox/xml/timers  
==liefert die Timerliste==
liefert die Timerliste
'''Befehl:''' http://dbox/xml/timers  


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




*http://dbox/xml/serviceepg?ref={service reference} (ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)
'''Befehl:''' <nowiki>http://dbox/xml/serviceepg?ref={service reference}</nowiki> (ref ist optional, falls nicht angegeben wird der eingestellte Service genommen)


Gibt den [[EPG]] eines Services mit der Servicereferenz 'ref' zurueck:
Gibt den [[EPG]] eines Services mit der Servicereferenz 'ref' zurueck:
Zeile 247: Zeile 247:




*http://dbox/xml/currentservicedata
==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


[[Bild:Currentservice.jpg|800px]]
[[Bild:Currentservice.jpg|800px]]




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


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





Version vom 24. Juli 2005, 01:35 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>

<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 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.