Skip to content

OpenWebif API documentation

Jump to bottom Edit New page
Jörg Bleyel edited this page Feb 24, 2018 · 1 revision

#Table of Contents

Preface

Calling API methods

General Information

about
currenttime
deviceinfo
getipv6
statusinfo
tunersignal

Services and EPG

bouquets
epgbouquet
epgmulti
epgmultigz
epgnext
epgnow
epgnownext
epgsearch
epgsearchrss
epgservice
epgservicelistnownext
epgservicenext
epgservicenow
epgsimilar
event
getallservices
getcurrent
getpid
getsatellites
getservices
getsubtitles
loadepg
parentcontrollist
servicelistplayable
saveepg
servicelistreload
serviceplayable
servicesm3u
subservices

Volume

vol

Audiotracks

getaudiotracks
selectaudiotrack

Control

powerstate
remotecontrol
set_powerup_without_waking_tv
supports_powerup_without_waking_tv
zap

Locations

addlocation
getcurrlocation
getlocations
removelocation

Timers

powertimer
recordnow
sleeptimer
timeradd
timeraddbyeventid
timerchange
timercleanup
timerdelete
timerlist
timerlistwrite
timertogglestatus
tvbrowser
vpschannels

Messages

message
messageanswer

Movies

fullmovielist
gettags
moviedelete
movielist
movielisthtml
movielistm3u
movielistrss
moviemove
movierename
movietags

Config

collapsemenu
expandmenu
remotegrabscreenshot
saveconfig
set
settings
zapstream
epgsearchtype

Streams

streamcurrentm3u
streamm3u
streamsubservices
tsm3u
videom3u

Mediaplayer

mediaplayeradd
mediaplayercmd
mediaplayercurrent
mediaplayerfindfile
mediaplayerlist
mediaplayerload
mediaplayerplay
mediaplayerremove
mediaplayerwrite

Misc

external
pluginlistread
restarttwisted

Calling API methods

The OpenWebif API in general either creates XML or JSON results, depending on which prefix you use to call the API. Using /web/<method> creates XML answers whereas /api/<method> returns JSON objects. XML and JSON answers do not necessarily return the same information.

API methods

about

Gives information about hardware, software and running service.

<?xml version="1.0" encoding="UTF-8"?>
<e2abouts>
    <e2about>
        <e2oeversion>openvuplus 3.0</e2oeversion>
        <e2enigmaversion>2016-07-28-vti-master (d75da0c)</e2enigmaversion>
        <e2distroversion>VTi</e2distroversion>
        <e2imageversion>9.0.3.</e2imageversion>
        <e2driverdate>3.14.28-20160808.r0</e2driverdate>
        <e2webifversion>OWIF 0.4.8</e2webifversion>
        <e2fpversion>0</e2fpversion>
        <e2model>Solo4K</e2model>
        <e2lanmac>00:1d:ec:0a:be:ae</e2lanmac>
        <e2landhcp>True</e2landhcp>
        <e2lanip>192.168.0.8</e2lanip>
        <e2lanmask>255.255.255.0</e2lanmask>
        <e2langw>192.168.0.1</e2langw>
        <e2hddinfo>
            <model>ATA(ST2000LM003 HN-M)</model>
            <capacity>1.82 TB</capacity>
            <free>1405.121 GB</free>
        </e2hddinfo>
        <e2tunerinfo>
            <e2nim>
                <name>Tuner A</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner B</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner C</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner D</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner E</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner F</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner G</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner H</name>
                <type>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner I</name>
                <type>Vuplus DVB-T NIM(TT3L10) (DVB-T2)</type>
            </e2nim>
            <e2nim>
                <name>Tuner J</name>
                <type>Vuplus DVB-T NIM(TT3L10) (DVB-T2)</type>
            </e2nim>
        </e2tunerinfo>
        <e2servicename>tagesschau24 HD</e2servicename>
        <e2servicenamespace>12582912</e2servicenamespace>
        <e2serviceaspect>3</e2serviceaspect>
        <e2serviceprovider>ARD</e2serviceprovider>
        <e2videowidth>1280</e2videowidth>
        <e2videoheight>720</e2videoheight>
        <e2servicevideosize>1280x720</e2servicevideosize>
        <e2apid>5406</e2apid>
        <e2vpid>5401</e2vpid>
        <e2pcrpid>5401</e2pcrpid>
        <e2pmtpid>5400</e2pmtpid>
        <e2txtpid>5404</e2txtpid>
        <e2tsid>1039</e2tsid>
        <e2onid>1</e2onid>
        <e2sid>10375</e2sid>
    </e2about>
</e2abouts>

or as JSON object:

{
    "info": {
        "fp_version": 0,
        "tuners": [
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner A"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner B"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner C"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner D"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner E"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner F"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner G"
            },
            {
                "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
                "name": "Tuner H"
            },
            {
                "type": "Vuplus DVB-T NIM(TT3L10) (DVB-T2)",
                "name": "Tuner I"
            },
            {
                "type": "Vuplus DVB-T NIM(TT3L10) (DVB-T2)",
                "name": "Tuner J"
            }
        ],
        "uptime": "1:20",
        "enigmaver": "2016-07-28-vti-master (d75da0c)",
        "driverdate": "3.14.28-20160808.r0",
        "imagever": "9.0.3.",
        "ifaces": [
            {
                "gw": "192.168.0.1",
                "mac": "00:1d:ec:0a:be:ae",
                "name": "eth0",
                "firstpublic": null,
                "ip": "192.168.0.8",
                "dhcp": true,
                "v4prefix": 24,
                "ipv6": "keine\/reines IPv4-Netzwerk",
                "mask": "255.255.255.0"
            }
        ],
        "brand": "Vu+",
        "boxtype": "solo4k",
        "machinebuild": "solo4k",
        "kinopoisk": false,
        "imagedistro": "VTi",
        "oever": "openvuplus 3.0",
        "hdd": [
            {
                "model": "ATA(ST2000LM003 HN-M)",
                "capacity": "1.82 TB",
                "labelled_capacity": "2 TB",
                "free": "1405.121 GB"
            },
            {
                "model": "WD(Elements 10B8)",
                "capacity": "1.82 TB",
                "labelled_capacity": "2 TB",
                "free": "573.270 GB"
            }
        ],
        "mem1": "2067980 kB",
        "mem2": "776176 kB",
        "chipset": "7376",
        "model": "Solo4K",
        "transcoding": true,
        "webifver": "OWIF 0.4.8",
        "kernelver": "3.14.28"
    },
    "service": {
        "onid": 1,
        "txtpid": 5404,
        "pmtpid": 5400,
        "name": "tagesschau24 HD",
        "tsid": 1039,
        "pcrpid": 5401,
        "sid": 10375,
        "namespace": 12582912,
        "height": 720,
        "apid": 5406,
        "width": 1280,
        "result": true,
        "aspect": 3,
        "provider": "ARD",
        "ref": "1:0:19:2887:40F:1:C00000:0:0:0:",
        "vpid": 5401,
        "iswidescreen": true
    }
}

statusinfo

Returns information about running service. Does not return a XML answer.

{
    "inStandby": "false",
    "currservice_begin": "10:00",
    "muted": false,
    "isRecording": "false",
    "currservice_station": "tagesschau24 HD",
    "currservice_serviceref": "1:0:19:2887:40F:1:C00000:0:0:0:",
    "volume": 90,
    "currservice_fulldescription": "Tagesschau-Nachrichten\n10:00 - 10:30\n\nDas Wichtigste aus Politik, Wirtschaft, Kultur, Sport und Wissenschaft. Korrespondenten der ARD sorgen f\u00fcr schnelle und pr\u00e4zise News.\nProduziert in HD",
    "currservice_name": "Tagesschau-Nachrichten",
    "currservice_filename": "",
    "transcoding": true,
    "currservice_end": "10:30",
    "currservice_description": ""
}

tunersignal

Return tuner signal strength.

<e2frontendstatus>
	<e2snrdb>84 dB</e2snrdb>
	<e2snr>84 %</e2snr>
	<e2ber>0</e2ber>
	<e2acg>66 %</e2acg>
</e2frontendstatus>
{
    "agc": 66,
    "tunernumber": 0,
    "snr": 84,
    "ber": 0,
    "snr_db": 84,
    "tunertype": "DVB-S"
}

vol

Changes volume level.

Parameters:

  • set - on of state, up, down, mute, setNN

With set=state or without Parameter the current volume level is returned:

<e2volume>
	<e2result>True</e2result>
	<e2resulttext>Status</e2resulttext>
	<e2current>90</e2current>
	<e2ismuted>False</e2ismuted>	
</e2volume>
{
    "current": 90,
    "message": "Status",
    "result": true,
    "ismute": false
}

Parameters set=up, set=down, set=mute, set=set90 change volume level and return message.
Parameters set=up and set=down change level with steps of 5, set=mute toggles mute.

getaudiotracks

Returns audio tracks for currently running service; e.g.:

<e2audiotracklist>
		<e2audiotrack>
			<e2audiotrackdescription>MPEG (stereo)</e2audiotrackdescription>
			<e2audiotrackid>0</e2audiotrackid>
			<e2audiotrackpid>5402</e2audiotrackpid>
			<e2audiotrackactive>False</e2audiotrackactive>
		</e2audiotrack>
		<e2audiotrack>
			<e2audiotrackdescription>Dolby Digital (Dolby Digital 2.0)</e2audiotrackdescription>
			<e2audiotrackid>1</e2audiotrackid>
			<e2audiotrackpid>5406</e2audiotrackpid>
			<e2audiotrackactive>True</e2audiotrackactive>
		</e2audiotrack>
</e2audiotracklist>
{
    "tracklist": [
        {
            "active": false,
            "index": 0,
            "pid": 5402,
            "description": "MPEG (stereo)"
        },
        {
            "active": true,
            "index": 1,
            "pid": 5406,
            "description": "Dolby Digital (Dolby Digital 2.0)"
        }
    ],
    "result": true
}

selectaudiotrack

Select audio track; parameter id=N corresponds to the values e2audiotrackid and index returned from the method getaudiotracks.

Parameters:

  • id - index of new audio track.
<e2result>
	Success
</e2result>

Returns "Error" in case of an error.

{
    "result": true
}

Returns "result": false in case of an error.

zap

Changes service.

Parameter:

  • sRef - url encoded service reference of new service; eg 1%3A0%3A1%3A6F47%3A445%3A1%3AC00000%3A0%3A0%3A0%3A
  • title - (optional) title returned in e2statetext and message. Defaults to sRef.
<e2simplexmlresult>
	<e2state>True</e2state>
	<e2statetext>Active service is now '1:0:1:6F47:445:1:C00000:0:0:0:'</e2statetext>	
</e2simplexmlresult>
{
    "message": "Active service is now '1:0:1:6F47:445:1:C00000:0:0:0:'",
    "result": true
}

remotecontrol

Simulate remote control key press.

Parameter:

  • command - number; code of key
  • rcu - (optional) one of standard, advanced, keyboard
  • type - (optional) one of long, ascii

For a list of valid commands inspect the files under /public/static/remotes/

<e2remotecontrol>
	<e2result>True</e2result>
	<e2resulttext>RC command '11' has been issued</e2resulttext>
</e2remotecontrol>
{
    "message": "RC command '11' has been issued",
    "result": true
}

powerstate

Returns current power state of receiver. Can change to a new power state.

Parameters:

  • newstate - (optional) number; one of
    0: Toggle StandBy
    1: DeepStandBy
    2: Reboot
    3: Restart Enigma
    4: Wakeup
    5: Standby
<e2powerstate>
	<e2instandby>
		false
	</e2instandby>
</e2powerstate>
{
    "instandby": false,
    "result": true
}

supports_powerup_without_waking_tv

Does not return a XML answer.

Returns "true" if the image supports the function "Power on without TV", "false" otherwise.

set_powerup_without_waking_tv

Does not return a XML answer.

The box will power on once skipping the HDMI-CEC communication when called.

getlocations

Returns a list of known movie locations.

<e2locations>
	<e2location>/media/hdd/movie/</e2location>
	<e2location>/media/hdd1/</e2location>
</e2locations>
{
    "result": true,
    "locations": [
        "/media/hdd/movie/",
        "/media/hdd1/"
    ]
}

getcurrlocation

Returns current or default movie list location.

<e2locations>
	<e2location>/media/hdd/movie/</e2location>
</e2locations>
{
    "result": true,
    "location": "/media/hdd/movie/"
}

getallservices

Returns a list of all services in all user bouquets.

Parameter:

  • type - (optional) on of tv, radio; defaults to tv.
  • renameserviceforxmbc -
<e2servicelistrecursive>
    <e2bouquet>
        <e2servicereference>1:7:1:0:0:0:0:0:0:0:FROM BOUQUET "userbouquet.favourites.tv" ORDER BY bouquet</e2servicereference>
        <e2servicename>Hauptsender</e2servicename>
        <e2servicelist>
            <e2service>
                <e2servicereference>1:0:19:283D:3FB:1:C00000:0:0:0:</e2servicereference>
                <e2servicename>Das Erste HD</e2servicename>
            </e2service>
            <!-- ... -->
        </e2servicelist>
    </e2bouquet>
    <!-- ... -->
</e2servicelistrecursive>
{
    "services": [
        {
            "servicereference": "1:7:1:0:0:0:0:0:0:0:FROM BOUQUET \"userbouquet.favourites.tv\" ORDER BY bouquet",
            "subservices": [
                {
                    "servicereference": "1:0:19:283D:3FB:1:C00000:0:0:0:",
                    "servicename": "Das Erste HD"
                },
                /* ... */
            ],
            "servicename": "Favourites"
        },
        /* ... */
    ],
    "result": true
}

getservices

Return list of user bouquets or list of services for given service reference query.

Parameter:

  • sRef - (optional) service reference
  • hidden - (optional) 1
<e2servicelist>
    <e2service>
        <e2servicereference>1:7:1:0:0:0:0:0:0:0:FROM BOUQUET "userbouquet.favourites.tv" ORDER BY bouquet</e2servicereference>
        <e2servicename>Favourites</e2servicename>
    </e2service>
    <!-- ... -->
</e2servicelist>

with sRef parameter:

<e2servicelist>
	<e2service>
		<e2servicereference>1:0:19:2B8E:3F2:1:C00000:0:0:0:</e2servicereference>
		<e2servicename>3sat HD</e2servicename>
	</e2service>
	<!-- ... -->
</e2servicelist>

JSOn replies:

{
    "services": [
        {
            "servicereference": "1:7:1:0:0:0:0:0:0:0:FROM BOUQUET \"userbouquet.favourites.tv\" ORDER BY bouquet",
            "servicename": "Favourites"
        },
        /* ... */
    ]
}

with sRef parameter:

{
    "services": [
        {
            "servicereference": "1:0:19:283D:3FB:1:C00000:0:0:0:",
            "servicename": "Das Erste HD"
        },
        /* ... */
        {
            "servicereference": "1:0:19:2B7A:3F3:1:C00000:0:0:0:",
            "servicename": "zdf_neo HD"
        }
    ]
}

servicesm3u

Returns a m3u list as in getservices when in XML context. In JSON context the output is the same as in getservices.

Parameter:

  • bRef - service reference

subservices

Returns subservices of current service.

<e2servicelist>
	<e2service>
		<e2servicereference>1:0:16:12:4:85:C00000:0:0:0:</e2servicereference>
		<e2servicename>�Sky� �Sel�ect</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:12:4:85:C00000:0:0:0::Sky Select</e2servicereference>
		<e2servicename>Sky Select</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:FB:3:85:C00000:12:4:0::389 - 10%3a15</e2servicereference>
		<e2servicename>389 - 10:15</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:14B:2:85:C00000:12:4:0::389 - 11%3a15</e2servicereference>
		<e2servicename>389 - 11:15</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:105:3:85:C00000:12:4:0::389 - 12%3a00</e2servicereference>
		<e2servicename>389 - 12:00</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:141:2:85:C00000:12:4:0::382 - 11%3a15</e2servicereference>
		<e2servicename>382 - 11:15</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:12D:3:85:C00000:12:4:0::385 - 12%3a30</e2servicereference>
		<e2servicename>385 - 12:30</e2servicename>
	</e2service>
	<e2service>
		<e2servicereference>1:0:1:137:2:85:C00000:12:4:0::379 - 10%3a30</e2servicereference>
		<e2servicename>379 - 10:30</e2servicename>
	</e2service>
</e2servicelist>
{
    "services": [
        {
            "servicereference": "1:0:16:12:4:85:C00000:0:0:0:",
            "servicename": "\u0086Sky\u0087 \u0086Sel\u0087ect"
        },
        {
            "servicereference": "1:0:1:12:4:85:C00000:0:0:0::Sky Select",
            "servicename": "Sky Select"
        },
        {
            "servicereference": "1:0:1:FB:3:85:C00000:12:4:0::389 - 10%3a15",
            "servicename": "389 - 10:15"
        },
        {
            "servicereference": "1:0:1:14B:2:85:C00000:12:4:0::389 - 11%3a15",
            "servicename": "389 - 11:15"
        },
        {
            "servicereference": "1:0:1:105:3:85:C00000:12:4:0::389 - 12%3a00",
            "servicename": "389 - 12:00"
        },
        {
            "servicereference": "1:0:1:141:2:85:C00000:12:4:0::382 - 11%3a15",
            "servicename": "382 - 11:15"
        },
        {
            "servicereference": "1:0:1:12D:3:85:C00000:12:4:0::385 - 12%3a30",
            "servicename": "385 - 12:30"
        },
        {
            "servicereference": "1:0:1:137:2:85:C00000:12:4:0::379 - 10%3a30",
            "servicename": "379 - 10:30"
        }
    ]
}

parentcontrollist

Return the parental control list

<e2servicelist>
</e2servicelist>
{
    "services": [],
    "type": "blacklist",
    "result": true
}

servicelistplayable

Returns list of playable services from a service reference query (bouquet).

Parameters:

  • sRef - (optional) service reference
  • sRefPlaying - (optional) service reference playing
<e2servicelistplayable>
    <e2serviceplayable>
        <e2servicereference>1:0:19:283D:3FB:1:C00000:0:0:0:</e2servicereference>
        <e2isplayable>True</e2isplayable>
    </e2serviceplayable>
    ...
</e2servicelistplayable>
{
    "services": [
        {
            "servicereference": "1:0:19:283D:3FB:1:C00000:0:0:0:",
            "isplayable": true
        },
        /* ... */
    ],
    "result": true
}

serviceplayable

Returns if service is playable.

Parameters:

  • sRef - (optional) service reference
  • sRefPlaying - (optional) service reference of running service
<e2serviceplayable>
	<e2servicereference>1:0:19:283D:3FB:1:C00000:0:0:0:</e2servicereference>
	<e2isplayable>True</e2isplayable>
</e2serviceplayable>
{
    "result": true,
    "service": {
        "servicereference": "1:0:19:283D:3FB:1:C00000:0:0:0:",
        "isplayable": true
    }
}

addlocation

Parameters:

  • dirname - dirname of new location
  • createFolder - (optional) if 1, create folder

Possible answers:

<e2simplexmlresult>
    <e2state>False</e2state>
    <e2statetext>Path '/media/hdd/newdir' does not exist</e2statetext>
</e2simplexmlresult>
<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>Location '/media/hdd/newdir' added succesfully</e2statetext>
</e2simplexmlresult>
<e2simplexmlresult>
    <e2state>False</e2state>
    <e2statetext>Location '/media/hdd/newdir' is already existing</e2statetext>
</e2simplexmlresult>
{
    "message": "Path '/media/hdd/newdir' does not exist", 
    "result": false
}
{
    "message": "Location '/media/hdd/newdir' added succesfully", 
    "result": false
}
{
    "message": "Location '/media/hdd/newdir' is already existing", 
    "result": false
}

removelocation

Remove movie location.

Parameter:

  • dirname - location to remove
<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>Location '/media/hdd/newdir' removed succesfully</e2statetext>
</e2simplexmlresult>
<e2simplexmlresult>
    <e2state>False</e2state>
    <e2statetext>Location '/media/hdd/newdir' does not exist</e2statetext>
</e2simplexmlresult>
{
    "message": "Location '/media/hdd/newdir' removed succesfully", 
    "result": true
}
{
    "message": "Location '/media/hdd/newdir' does not exist",
    "result": false
}

message

Sends message to tv.

Parameters:

  • text - message to send
  • type - (number) 0: YESNO, 1: INFO, 2: WARNING, 3: ERROR
  • timeout - (optional, number) seconds to display message; defaults to -1: infinitly
<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>Nachricht erfolgreich verschickt!</e2statetext>
</e2simplexmlresult>
{
    "message": "Nachricht erfolgreich verschickt!", 
    "result": true
}

messageanswer

Returns the response of the message; if the dialog was not answered, the default answer is returned.

<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>Antwort lautet JA!</e2statetext>
</e2simplexmlresult>```

```javascript
{
    "message": "Antwort lautet JA!", 
    "result": true
}

movielist

Returns the list of movies.

Parameters:

  • tag - (optional)
  • dirname - (optional) full path to directory to scan for movies.
<e2movielist>
	<e2movie>
		<e2servicereference>1:0:0:0:0:0:0:0:0:0:/media/hdd/movie/20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts</e2servicereference>
		<e2title>ran Football: 5. Spieltag NFL - Cincinnati Bengals at Dallas Cowboys</e2title>
		<e2description>Sport, D 2016</e2description>
		<e2descriptionextended>Am fünften Spieltag der National Football League sind die Cincinnati Bengals bei den Dallas Cowboys in Texas zu Gast. Kommentiert wird die Begegnung von Florian Schmidt-Sommerfeld, der Experte im Studio ist Roman Motzkus.</e2descriptionextended>
		<e2servicename>Pro7 MAXX HD</e2servicename>
		<e2time>1476044100</e2time>
		<e2length>224:57</e2length>
		<e2tags></e2tags>
		<e2filename>/media/hdd/movie/20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts</e2filename>
		<e2filesize>17298616396</e2filesize>
	</e2movie>
	<e2movie>
		<e2servicereference>1:0:0:0:0:0:0:0:0:0:/media/hdd/movie/20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts</e2servicereference>
		<e2title>Auf Schottlands Whisky-Routen</e2title>
		<e2description>Aus der Reihe "Länder - Menschen - Abenteuer"</e2description>
		<e2descriptionextended>Seit 1.000 Jahren brennt man überall in Europa geistige Getränke, Spirituosen, volkstümlich Schnaps genannt. Ob Wodka, Whisky, Obstbrand oder Absinth, Europas Essenzen und Destillate sind ein hochprozentiges Kulturerbe. In ihnen spiegeln sich Landschaft, Geschichte und Lebensart einer Region. - Whisky ist mehr als gebranntes Gerstenmalz, er ist der Stolz der Schotten. Wie die meisten Spirituosen wurde schottischer Whisky zunächst als Medizin verwendet. Heute ist er das hochprozentige Genussmittel mit dem besten Ruf weltweit und beschert den Schotten einen Exportumsatz von jährlich sechs Milliarden Euro.�Produziert in HD</e2descriptionextended>
		<e2servicename>SWR RP HD</e2servicename>
		<e2time>1468242600</e2time>
		<e2length>54:59</e2length>
		<e2tags></e2tags>
		<e2filename>/media/hdd/movie/20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts</e2filename>
		<e2filesize>5856274072</e2filesize>
	</e2movie>
	<!-- ... -->
</e2movielist>
{
    "directory": "\/media\/hdd\/movie\/",
    "movies": [
        {
            "filename_stripped": "20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts",
            "description": "Sport, D 2016",
            "tags": "",
            "serviceref": "1:0:0:0:0:0:0:0:0:0:\/media\/hdd\/movie\/20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts",
            "filename": "\/media\/hdd\/movie\/20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts",
            "eventname": "ran Football: 5. Spieltag NFL - Cincinnati Bengals at Dallas Cowboys",
            "length": "224:57",
            "servicename": "Pro7 MAXX HD",
            "begintime": "9.10., 22:15",
            "lastseen": 0,
            "fullname": "1:0:0:0:0:0:0:0:0:0:\/media\/hdd\/movie\/20161009 2215 - Pro7 MAXX HD - ran Football_ 5_ Spieltag NFL - Cincinnati Bengals at Dallas Cowboys.ts",
            "recordingtime": 1476044100,
            "descriptionExtended": "Am f\u00fcnften Spieltag der National Football League sind die Cincinnati Bengals bei den Dallas Cowboys in Texas zu Gast. Kommentiert wird die Begegnung von Florian Schmidt-Sommerfeld, der Experte im Studio ist Roman Motzkus.",
            "filesize": 17298616396
        },
        {
            "filename_stripped": "20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts",
            "description": "Aus der Reihe \"L\u00e4nder - Menschen - Abenteuer\"",
            "tags": "",
            "serviceref": "1:0:0:0:0:0:0:0:0:0:\/media\/hdd\/movie\/20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts",
            "filename": "\/media\/hdd\/movie\/20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts",
            "eventname": "Auf Schottlands Whisky-Routen",
            "length": "54:59",
            "servicename": "SWR RP HD",
            "begintime": "11.7., 15:10",
            "lastseen": 0,
            "fullname": "1:0:0:0:0:0:0:0:0:0:\/media\/hdd\/movie\/20160711 1510 - SWR RP HD - Auf Schottlands Whisky-Routen.ts",
            "recordingtime": 1468242600,
            "descriptionExtended": "Seit 1.000 Jahren brennt man \u00fcberall in Europa geistige Getr\u00e4nke, Spirituosen, volkst\u00fcmlich Schnaps genannt. Ob Wodka, Whisky, Obstbrand oder Absinth, Europas Essenzen und Destillate sind ein hochprozentiges Kulturerbe. In ihnen spiegeln sich Landschaft, Geschichte und Lebensart einer Region. - Whisky ist mehr als gebranntes Gerstenmalz, er ist der Stolz der Schotten. Wie die meisten Spirituosen wurde schottischer Whisky zun\u00e4chst als Medizin verwendet. Heute ist er das hochprozentige Genussmittel mit dem besten Ruf weltweit und beschert den Schotten einen Exportumsatz von j\u00e4hrlich sechs Milliarden Euro.\u008aProduziert in HD",
            "filesize": 5856274072
        }
    ],
    "bookmarks": [
        "Diverse",
        "Dokumentationen",
        "Filme",
        "Musik",
        "Serien",
        "Sport"
    ]
}

fullmovielist

Returns all movies from all locations in getlocations. Does not return XML.
Returns a "locations" array instead of a "bookmarks" array, output is otherwise identical to movielist.

movielisthtml

Returns a HTML formatted list of movies as in movielist when in XML context. JSON output is the same as in movielist.

movielistm3u

Returns a m3u list of movies as in movielist when in XML context. JSON output is the same as in movielist.

movielistrss

Returns a RSS formatted list of movies as in movielist when in XML context. JSON output is the same as in movielist.

moviedelete

Parameters:

  • sRef
  • force - (optional)

moviemove

Parameters:

  • sRef
  • dirname

movierename

Parameters:

  • sRef
  • newname

movietags

Parameters:

  • sref - (optional)
  • add - (optional)
  • del - (optional)

gettags

The same as movietags without parameters.

timerlist

Returns a list of existing timers.

<e2timerlist>
	<e2timer>
		<e2servicereference>1:0:19:EF74:3F9:1:C00000:0:0:0:</e2servicereference>
		<e2servicename>SAT.1 HD</e2servicename>
		<e2eit>39350</e2eit>
		<e2name>Navy CIS: L.A.</e2name>
		<e2description>Kein Rauch ohne Feuer, Crime-Serie, USA 2016</e2description>
		<e2descriptionextended>Ein Feuerwehrmann stirbt bei einem Brand in einer Fabrik. Seine Leiche wird in einem Spezial-Container gefunden, den das Verteidigungsministerium für die Aufbewahrung brisanter Dokumente nutzt. Da ein Überwachungsvideo Fragen zum Einsatz der Retter aufwirft, schleusen sich Sam und Callen undercover bei der Feuerwehr ein. Schon bald stoßen sie auf einige Ungereimtheiten in der Truppe und haben mit Brandermittler Hackett einen ersten Verdächtigen im Visier.

Regie: James Hanlon
Drehbuch: Andrew Bartels
Komponist: Jay Ferguson
Kamera: Victor Hammer

Darsteller:
Chris O'Donnell (Special Agent G. Callen)
 LL Cool J (Special Agent Sam Hanna)
Daniela Ruah (Special Agent Kensi Blye)
Linda Hunt (Henrietta "Hetty" Lange)
Eric Christian Olsen (Marty Deeks)
Barrett Foa (Eric Beale)
Renée Felice Smith (Nell Jones)
Miguel Ferrer (Owen Granger)
Steven Flynn (Arson Investigator Peter Hackett)</e2descriptionextended>
		<e2disabled>0</e2disabled>
		<e2timebegin>1476644933</e2timebegin>
		<e2timeend>1476649083</e2timeend>
		<e2duration>4150</e2duration>
		<e2startprepare>1476644913</e2startprepare>
		<e2justplay>0</e2justplay>
		<e2afterevent>3</e2afterevent>
		<e2location>None</e2location>
		<e2tags></e2tags>
		<e2logentries>[(1476254301, 15, 'record time changed, start prepare is now: Sun Oct 16 21:08:33 2016'), (1476254484, 501, '[AutoTimer] Warning, AutoTimer NCIS LA messed with a timer which might not belong to it.'), (1476254484, 501, '[AutoTimer] AutoTimer modified timer: Navy CIS: L.A. .'), (1476265663, 501, '[AutoTimer] Warning, AutoTimer NCIS LA messed with a timer which might not belong to it.'), (1476265663, 501, '[AutoTimer] AutoTimer modified timer: Navy CIS: L.A. .')]</e2logentries>
		<e2filename></e2filename>
		<e2backoff>0</e2backoff>
		<e2nextactivation></e2nextactivation>
		<e2firsttryprepare>True</e2firsttryprepare>
		<e2state>0</e2state>
		<e2repeated>0</e2repeated>
		<e2dontsave>0</e2dontsave>
		<e2cancled>False</e2cancled>
		<e2toggledisabled>1</e2toggledisabled>
		<e2toggledisabledimg>off</e2toggledisabledimg>
		<e2alwayszap>-1</e2alwayszap>
	</e2timer>
</e2timerlist>
{
    "timers": [
        {
            "begin": 1476644933,
            "description": "Kein Rauch ohne Feuer, Crime-Serie, USA 2016",
            "tags": "",
            "firsttryprepare": true,
            "always_zap": -1,
            "toggledisabled": 1,
            "dontsave": 0,
            "backoff": 0,
            "disabled": 0,
            "asrefs": "",
            "repeated": 0,
            "servicename": "SAT.1 HD",
            "duration": 4150,
            "dirname": "None",
            "realend": "16.10.2016 22:18",
            "descriptionextended": "Ein Feuerwehrmann stirbt bei einem Brand in einer Fabrik. Seine Leiche wird in einem Spezial-Container gefunden, den das Verteidigungsministerium f\u00fcr die Aufbewahrung brisanter Dokumente nutzt. Da ein \u00dcberwachungsvideo Fragen zum Einsatz der Retter aufwirft, schleusen sich Sam und Callen undercover bei der Feuerwehr ein. Schon bald sto\u00dfen sie auf einige Ungereimtheiten in der Truppe und haben mit Brandermittler Hackett einen ersten Verd\u00e4chtigen im Visier.\n\nRegie: James Hanlon\nDrehbuch: Andrew Bartels\nKomponist: Jay Ferguson\nKamera: Victor Hammer\n\nDarsteller:\nChris O'Donnell (Special Agent G. Callen)\n LL Cool J (Special Agent Sam Hanna)\nDaniela Ruah (Special Agent Kensi Blye)\nLinda Hunt (Henrietta \"Hetty\" Lange)\nEric Christian Olsen (Marty Deeks)\nBarrett Foa (Eric Beale)\nRen\u00e9e Felice Smith (Nell Jones)\nMiguel Ferrer (Owen Granger)\nSteven Flynn (Arson Investigator Peter Hackett)",
            "name": "Navy CIS: L.A.",
            "startprepare": 1476644913,
            "realbegin": "16.10.2016 21:08",
            "end": 1476649083,
            "eit": 39350,
            "vpsplugin_overwrite": false,
            "afterevent": 3,
            "justplay": 0,
            "serviceref": "1:0:19:EF74:3F9:1:C00000:0:0:0:",
            "filename": null,
            "toggledisabledimg": "off",
            "state": 0,
            "logentries": [
                [
                    1476254301,
                    15,
                    "record time changed, start prepare is now: Sun Oct 16 21:08:33 2016"
                ],
                [
                    1476254484,
                    501,
                    "[AutoTimer] Warning, AutoTimer NCIS LA messed with a timer which might not belong to it."
                ],
                [
                    1476254484,
                    501,
                    "[AutoTimer] AutoTimer modified timer: Navy CIS: L.A. ."
                ],
                [
                    1476265663,
                    501,
                    "[AutoTimer] Warning, AutoTimer NCIS LA messed with a timer which might not belong to it."
                ],
                [
                    1476265663,
                    501,
                    "[AutoTimer] AutoTimer modified timer: Navy CIS: L.A. ."
                ]
            ],
            "nextactivation": null,
            "vpsplugin_time": -1,
            "cancelled": false,
            "vpsplugin_enabled": false
        }
    ],
    "result": true,
    "locations": [
        "\/media\/hdd\/movie\/",
        "\/media\/hdd1\/"
    ]
}

timeradd

Add a new timer entry.

Parameters:

  • sRef - service reference
  • begin - unix timestamp of begin
  • end - unix timestamp of end
  • name - name of the timer entry
  • disabled - (optional) if 1, disable entry
  • justplay - (optional) if 1, just play
  • afterevent - (optional, number) 1: Standby, 2: Deep Standby, 3: Auto; defaults to 3
  • dirname - (optional) full path of a movie location
  • tags - (optional) space separated list of movie tags
  • repeated - (optional) if 1, create a repeat timer (?)
  • description - (optional) description
  • eit - (optional) event id; if empty OpenWebif tries to find a corresponding event id from EPG cache
  • always_zap - (optional) if 1, create a zap timer

timeraddbyeventid

Add a new timer entry from existing event id.

Parameters:

  • sRef - service reference
  • eventid - event id
  • justplay - (optional) if 1, just play
  • dirname - (optional) full path of a movie location
  • tags - (optional) space separated list of movie tags
  • always_zap - (optional) if 1, create a zap timer

timerchange

Change timer entry parameters.

Parameters:

  • sRef - service reference
  • begin - unix timestamp of begin
  • end - unix timestamp of end
  • name - name of the timer entry
  • channelOld - old service reference
  • beginOld - old unix timestamp of begin
  • endOld - old unix timestamp of end
  • disabled - (optional) if 1, disable entry
  • justplay - (optional) if 1, just play
  • afterevent - (optional, number) 1: Standby, 2: Deep Standby, 3: Auto; defaults to 3
  • dirname - (optional) full path of a movie location
  • tags - (optional) space separated list of movie tags
  • repeated - (optional) if 1, create a repeat timer (?)
  • eit - (optional) event id; if empty OpenWebif tries to find a corresponding event id from EPG cache
  • always_zap - (optional) if 1, create a zap timer
  • description - (optional)

timertogglestatus

Disable or enable existing timer.

Parameters:

  • sRef
  • begin
  • end

timerdelete

Delete timer.

Parameters:

  • sRef
  • begin
  • end

timercleanup

Delete expired timers.

timerlistwrite

Save in memory timer list to disk.

vpschannels

No XML output; for VPS plugin.

recordnow

Record current program.

Parameters:

  • infinite - (optional) record until stopped by user.

currenttime

Current time of receiver.

<e2currenttime>
    14:36:13
</e2currenttime>
{
    "status": true, 
    "time": "14:36:13"
}

deviceinfo

Device info - similar to about

<e2deviceinfo>
	<e2oeversion>openvuplus 3.0</e2oeversion>
	<e2enigmaversion>2016-07-28-vti-master (d75da0c)</e2enigmaversion>
	<e2distroversion>VTi</e2distroversion>
	<e2imageversion>9.0.3.</e2imageversion>
	<e2driverdate>3.14.28-20160808.r0</e2driverdate>
	<e2webifversion>OWIF 0.4.8</e2webifversion>
	<e2fpversion>0</e2fpversion>
	<e2devicename>Solo4K</e2devicename>
	<e2frontends>
		<e2frontend>
			<e2name>Tuner A</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner B</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner C</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner D</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner E</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner F</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner G</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner H</e2name>
			<e2model>Vuplus DVB-S NIM(7376 FBC) (DVB-S2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner I</e2name>
			<e2model>Vuplus DVB-T NIM(TT3L10) (DVB-T2)</e2model>
		</e2frontend>
		<e2frontend>
			<e2name>Tuner J</e2name>
			<e2model>Vuplus DVB-T NIM(TT3L10) (DVB-T2)</e2model>
		</e2frontend>
	</e2frontends>
	<e2network>
		<e2interface>
			<e2name>eth0</e2name>
			<e2mac>00:1d:ec:0a:be:ae</e2mac>
			<e2dhcp>True</e2dhcp>
			<e2ip>192.168.0.8</e2ip>
			<e2gateway>192.168.0.1</e2gateway>
			<e2netmask>255.255.255.0</e2netmask>
		</e2interface>
	</e2network>
	<e2hdds>
		<e2hdd>
			<e2model>ATA(ST2000LM003 HN-M)</e2model>
			<e2capacity>1.82 TB</e2capacity>
			<e2free>1405.121 GB</e2free>
		</e2hdd>
		<e2hdd>
			<e2model>WD(Elements 10B8)</e2model>
			<e2capacity>1.82 TB</e2capacity>
			<e2free>573.270 GB</e2free>
		</e2hdd>
	</e2hdds>
</e2deviceinfo>
{
    "fp_version": 0,
    "tuners": [
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner A"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner B"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner C"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner D"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner E"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner F"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner G"
        },
        {
            "type": "Vuplus DVB-S NIM(7376 FBC) (DVB-S2)",
            "name": "Tuner H"
        },
        {
            "type": "Vuplus DVB-T NIM(TT3L10) (DVB-T2)",
            "name": "Tuner I"
        },
        {
            "type": "Vuplus DVB-T NIM(TT3L10) (DVB-T2)",
            "name": "Tuner J"
        }
    ],
    "uptime": "6:01",
    "enigmaver": "2016-07-28-vti-master (d75da0c)",
    "driverdate": "3.14.28-20160808.r0",
    "imagever": "9.0.3.",
    "ifaces": [
        {
            "gw": "192.168.0.1",
            "mac": "00:1d:ec:0a:be:ae",
            "name": "eth0",
            "firstpublic": null,
            "ip": "192.168.0.8",
            "dhcp": true,
            "v4prefix": 24,
            "ipv6": "keine\/reines IPv4-Netzwerk",
            "mask": "255.255.255.0"
        }
    ],
    "brand": "Vu+",
    "boxtype": "solo4k",
    "machinebuild": "solo4k",
    "kinopoisk": false,
    "imagedistro": "VTi",
    "oever": "openvuplus 3.0",
    "hdd": [
        {
            "model": "ATA(ST2000LM003 HN-M)",
            "capacity": "1.82 TB",
            "labelled_capacity": "2 TB",
            "free": "1405.121 GB"
        },
        {
            "model": "WD(Elements 10B8)",
            "capacity": "1.82 TB",
            "labelled_capacity": "2 TB",
            "free": "573.270 GB"
        }
    ],
    "mem1": "2067980 kB",
    "mem2": "773604 kB",
    "chipset": "7376",
    "model": "Solo4K",
    "transcoding": true,
    "webifver": "OWIF 0.4.8",
    "kernelver": "3.14.28"
}

getipv6

In XML context returns text: My IP address is:

{
    "firstpublic": ""
}

epgbouquet

"Now" EPG for bouquet given by parameter bRef

Parameters:

  • bRef - service reference for bouquet
  • time - (optional) begin time
<e2eventlist>
	<e2event>
		<e2eventid>54307</e2eventid>
		<e2eventstart>1476281700</e2eventstart>
		<e2eventduration>2700</e2eventduration>
		<e2eventcurrenttime>1476282186</e2eventcurrenttime>
		<e2eventtitle>Lecker aufs Land - Eine kulinarische Reise (4/6)</e2eventtitle>
		<e2eventdescription>nach Hohenlohe zu Carmen Mack</e2eventdescription>
		<e2eventdescriptionextended>Carmen Mack ist auf dem elterlichen Hof groß geworden. Doch die Landwirtschaft im hohenlohischen Weikersholz zu übernehmen, kam ihr zunächst nicht in den Sinn. Sie machte eine Ausbildung zur pharmazeutisch-technischen Assistentin und wollte ihren eigenen Weg gehen. Doch mit ihrem Mann Michael, der als Speditionskaufmann arbeitete,  fasste sie sich ein Herz und führte den Betrieb, den Carmens Großvater gegründet hat, weiter. Diesen Schritt haben beide nicht bereut. Michael schulte zum Landwirtschaftsmeister um und die beiden bekamen vier Kinder.�Produziert in HD</e2eventdescriptionextended>
		<e2eventservicereference>1:0:19:283D:3FB:1:C00000:0:0:0:</e2eventservicereference>
		<e2eventservicename>Das Erste HD</e2eventservicename>
	</e2event>
	<e2event>
		<e2eventid>16443</e2eventid>
		<e2eventstart>1476281400</e2eventstart>
		<e2eventduration>3000</e2eventduration>
		<e2eventcurrenttime>1476282186</e2eventcurrenttime>
		<e2eventtitle>SOKO Kitzbühel</e2eventtitle>
		<e2eventdescription>Die letzte Seilbahn</e2eventdescription>
		<e2eventdescriptionextended>Krimiserie, Österreich 2002�Während einer Party wird eine Frau ermordet. Andreas ist vor Ort, hat in der Band seines besten Freundes Charly als Gitarrist ausgeholfen. Ausgerechnet Charly gerät unter Tatverdacht.�Dazu kommt, dass die Mordwaffe als Andreas' Dienstpistole identifiziert wird. Für den jungen Kitzbüheler Kriminalisten und seine Kollegin Karin eine überaus heikle und sehr emotionsgeladene Situation.�Darsteller:�Karin Kofler - Kristina Sprenger�Andreas Blitz - Hans Sigl�Gräfin Schönberg - Andrea L'Arronge�Hannes Kofler - Heinz Marecek�Eva - Eva Maria Marold�Kroisleitner - Ferry Öllinger�Dr. Silvia Pfaundler - Anja Stöhr�Wolfgang Zykan - Martin Gruber�Ute Beck - Edita Malovic�Charly Heinrich - Matthias Kahler�Judith Gruber - Katharina Quast�Irene Thaler - Pia Baresch�Anselm Müller - Gunther Gillian�und andere�Regie: Stefan Klisch�Buch/Autor: Martin Ambrosch�Kamera: Christoph Chassée�Musik: Gerd Schuller�HD-Produktion�Altersfreigabe: 6</e2eventdescriptionextended>
		<e2eventservicereference>1:0:19:2B66:3F3:1:C00000:0:0:0:</e2eventservicereference>
		<e2eventservicename>ZDF HD</e2eventservicename>
	</e2event>
	<!-- ... -->
</e2eventlist>
{
    "events": [
        {
            "sname": "Das Erste HD",
            "title": "Lecker aufs Land - Eine kulinarische Reise (4\/6)",
            "begin_timestamp": 1476281700,
            "now_timestamp": 1476282301,
            "sref": "1:0:19:283D:3FB:1:C00000:0:0:0:",
            "id": 54307,
            "duration_sec": 2700,
            "shortdesc": "nach Hohenlohe zu Carmen Mack",
            "longdesc": "Carmen Mack ist auf dem elterlichen Hof gro\u00df geworden. Doch die Landwirtschaft im hohenlohischen Weikersholz zu \u00fcbernehmen, kam ihr zun\u00e4chst nicht in den Sinn. Sie machte eine Ausbildung zur pharmazeutisch-technischen Assistentin und wollte ihren eigenen Weg gehen. Doch mit ihrem Mann Michael, der als Speditionskaufmann arbeitete,  fasste sie sich ein Herz und f\u00fchrte den Betrieb, den Carmens Gro\u00dfvater gegr\u00fcndet hat, weiter. Diesen Schritt haben beide nicht bereut. Michael schulte zum Landwirtschaftsmeister um und die beiden bekamen vier Kinder.\u008aProduziert in HD"
        },
        {
            "sname": "ZDF HD",
            "title": "SOKO Kitzb\u00fchel",
            "begin_timestamp": 1476281400,
            "now_timestamp": 1476282301,
            "sref": "1:0:19:2B66:3F3:1:C00000:0:0:0:",
            "id": 16443,
            "duration_sec": 3000,
            "shortdesc": "Die letzte Seilbahn",
            "longdesc": "Krimiserie, \u00d6sterreich 2002\u008aW\u00e4hrend einer Party wird eine Frau ermordet. Andreas ist vor Ort, hat in der Band seines besten Freundes Charly als Gitarrist ausgeholfen. Ausgerechnet Charly ger\u00e4t unter Tatverdacht.\u008aDazu kommt, dass die Mordwaffe als Andreas' Dienstpistole identifiziert wird. F\u00fcr den jungen Kitzb\u00fcheler Kriminalisten und seine Kollegin Karin eine \u00fcberaus heikle und sehr emotionsgeladene Situation.\u008aDarsteller:\u008aKarin Kofler - Kristina Sprenger\u008aAndreas Blitz - Hans Sigl\u008aGr\u00e4fin Sch\u00f6nberg - Andrea L'Arronge\u008aHannes Kofler - Heinz Marecek\u008aEva - Eva Maria Marold\u008aKroisleitner - Ferry \u00d6llinger\u008aDr. Silvia Pfaundler - Anja St\u00f6hr\u008aWolfgang Zykan - Martin Gruber\u008aUte Beck - Edita Malovic\u008aCharly Heinrich - Matthias Kahler\u008aJudith Gruber - Katharina Quast\u008aIrene Thaler - Pia Baresch\u008aAnselm M\u00fcller - Gunther Gillian\u008aund andere\u008aRegie: Stefan Klisch\u008aBuch\/Autor: Martin Ambrosch\u008aKamera: Christoph Chass\u00e9e\u008aMusik: Gerd Schuller\u008aHD-Produktion\u008aAltersfreigabe: 6"
        },
        /* ... */
    ],
    "result": true
}

epgmulti

Like epgbouquet, but produces entries for more than just the now running programs.

Parameters:

  • bRef - service reference for bouquet
  • time - (optional) unix timestamp for first events
  • endTime - (optional) end time, defined as minutes in the future (1440 = one day)

epgnow

Like epgbouquet with time parameter not set.

Parameters:

  • bRef - service reference for bouquet

epgnext

Like epgbouquet but with upcoming events

Parameters:

  • bRef - service reference for bouquet

epgnownext

Like epgbouquet but with current and upcoming events

Parameters:

  • bRef - service reference for bouquet

Return value for JSON produces additionally information about running service:

    "info": {
        "onid": 133,
        "txtpid": 32,
        "pmtpid": 97,
        "name": "NatGeo HD",
        "tsid": 13,
        "pcrpid": 511,
        "sid": 112,
        "namespace": 12582912,
        "height": 1080,
        "apid": 515,
        "width": 1920,
        "result": true,
        "aspect": 3,
        "provider": "SKY",
        "ref": "1:0:19:70:D:85:C00000:0:0:0:",
        "vpid": 511,
        "iswidescreen": true
    },
    "events": [
    /* ... like before */
    ],
    "return": true
}

epgservicelistnownext

Not working?

epgsearch

Search EPG for search phrase.

Parameters:

  • search - search phrase
  • endtime - (optional)

epgsearchrss

Search EPG for search phrase. Output RSS, no difference in JSON context

Parameters:

  • search - search phrase
  • endtime - (optional)

epgservice

Get EPG for a channel.

Parameters:

  • sRef - service reference
  • time - (optional) begin time
  • endTime - (optional) end time

epgservicenow

Get Now-EPG for a channel.

Parameters:

  • sRef - service reference

epgservicenext

Get Next-EPG for a channel.

Parameters:

  • sRef - service reference

epgsimilar

Get EPG suggestions for similar events like given

Parameters:

  • sRef - service reference
  • eventid - event id

event

Get event data for event specified by service reference and event id.

Parameters:

  • sref - service reference
  • idev - event id
{
    "event": {
        "begin": 1477605300,
        "recording_margin_after": 5,
        "end": "00:35",
        "title": "ZDFzeit",
        "begin_str": "23:55",
        "sref": "1:0:19:2BA2:3F2:1:C00000:0:0:0:",
        "longdesc": "Dokumentation, Deutschland 2016\u008aMcDonald's ist der unangefochtene Marktf\u00fchrer auf dem deutschen Fastfood-Markt. Doch es kriselt: In welchen Bereichen ist der Platzhirsch noch super, und wo leistet er sich Schw\u00e4chen?\u008aNordsee verspricht frischen Fisch, KFC puren H\u00fchnchengeschmack, die meisten Filialen hat seit Kurzem Subway - und dann ist da noch Burger King, der angeschlagene Mitbewerber, der sich neu positionieren will. Wer schl\u00e4gt McDonald's? Das Fastfood-Duell.\u008aBuch\/Autor: Kathrin Dapper\u008aKamera: Andr\u00e9 G\u00f6tzmann, Bj\u00f6rn Schneider, Arun H\u00fcttemann\u008aHD-Produktion\u008aAltersfreigabe: 6",
        "shortdesc": "Wer schl\u00e4gt McDonald's? - Das gro\u00dfe Fastfood-Duell mit Nelson M\u00fcller",
        "recording_margin_before": 5,
        "duration": 2400,
        "id": 22658,
        "channel": "ZDFinfo HD"
    }
}

getcurrent

Now-Next-EPG for currently running service or movie.

getpid

{
    "apid": "203", 
    "host": "vusolo4k", 
    "ppid": "61", 
    "vpid": "1ff"
}

collapsemenu

Used internally for config.

Parameters:

  • name

expandmenu

Used internally for config.

Parameters:

  • name

remotegrabscreenshot

Used internally for config.

Parameters:

  • checked - one of true, false
{
    "result": true
}

zapstream

Used internally for config.

Parameters:

  • checked - one of true, false
{
    "result": true
}

epgsearchtype

Used internally for config.

Parameters:

  • checked - one of true, false
{
    "result": true
}

streamm3u

Create a "stream.m3u" file for given service reference; use given name in m3u.

Parameters:

  • ref - (optional)
  • name - (optional)
  • device - (optional) if phone, default to transcoding port
  • port - (optional) streaming port

tsm3u

Create a m3u file for streaming a file

Parameters:

  • file - file to stream
  • device - (optional) if phone, default to transcoding port
  • port - (optional) streaming port

videom3u

Create a "video.m3u" file for given service reference; use given name in m3u.

Parameters:

  • ref - (optional)
  • name - (optional)
  • device - (optional) if phone, default to transcoding port
  • port - (optional) streaming port

streamcurrentm3u

Create a "streamcurrent.m3u" file for current service; use given name in m3u.

Parameters:

  • name - (optional)
  • device - (optional) if phone, default to transcoding port
  • port - (optional) streaming port

streamsubservices

Get subservices?

Parameters:

  • sRef - (optional)

servicelistreload

Reload service lists

Parameters:

  • mode - (optional),
    0: reload lamedb and bouquets,
    1: reload lamedb,
    2: reload bouquets,
    3: reload transponders,
    4: reloaded parentalcontrol white-/blacklist
<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>reloaded both</e2statetext>
</e2simplexmlresult>
{
    "message": "reloaded both", 
    "result": true
}

tvbrowser

Another interface for adding, removing, changing timers.

Parameters:

  • name - (optional)
  • description - (optional)
  • disabled - (optional) if 1
  • justplay - (optional) if 1
  • afterevent - (optional) defaults to 3
  • dirname - (optional) location, defaults to preferred timer path
  • syear -
  • smonth -
  • sday -
  • shour -
  • smin -
  • ehour -
  • emin -
  • repeated -
  • mo, tu, we, th, fr, sa, su, ms, mf - (optional)
  • sRef - service reference
  • tags - (optional)
  • command - one of add, del, change

saveconfig

Used internally to change config.

Parameters:

  • key
  • value

mediaplayeradd

Add file to MediaPlayer.

Parameters:

  • file - filename

mediaplayerplay

Add file to Playlist or load a playlist and start playing.

Parameters:

  • file - filename
  • root - (optional) "playlist"

mediaplayercmd

Issue a MediaPlayer command

Parameters:

  • command - one of play, pause, stop, next, previous, shuffle, clear, exit
<e2simplexmlresult>
    <e2state>True</e2state>
    <e2statetext>Command 'play' executed</e2statetext>
</e2simplexmlresult>
{
    "message": "Command 'play' executed", 
    "result": true
}

mediaplayercurrent

Show information about current title.

If not active - XML: exception.

{
    "message": "Mediaplayer not active", 
    "result": false
}

If active:

mediaplayerfindfile

mediaplayerlist

Show files of type "types" in "path".

Parameters:

  • path - (optional)
  • types - (optional)

mediaplayerremove

mediaplayerload

Load Playlist.

Parameters:

  • filename

mediaplayerwrite

pluginlistread

Reads list of plugins.

<?xml version="1.0" encoding="UTF-8"?>
<e2simplexmlresult>
	<e2state>True</e2state>
	<e2statetext>List of Plugins has been read</e2statetext>	
</e2simplexmlresult>
{
    "message": "List of Plugins has been read",
    "result": true
}

restarttwisted

Restarts twisted; doesn't generate an answer.

powertimer

Purpose?

Parameters:

  • start
  • end
  • timertype
  • repeated
  • afterevent
  • disabled

If any parameter is present, all listed parameters are mandatory.

sleeptimer

Get sleep timer configuration or configure sleep timer.

Parameters:

  • cmd - one of get, set
  • enabled - (mandatory for cmd=set), False: deactivates sleep timer, True activates sleep timer
  • time - (number, mandatory for enabled=True) - time in minutes between 0 and 999
  • action - (optional) defaults to "standby", one of standby, shutdown
<e2sleeptimer>
	<e2enabled>False</e2enabled>
	<e2minutes>30</e2minutes>
	<e2action>shutdown</e2action>
	<e2text>SleepTimer deaktiviert</e2text>
</e2sleeptimer>
{
    "action": "shutdown",
    "minutes": 30,
    "message": "SleepTimer deaktiviert",
    "enabled": false
}

external

List of plugins with "original web interface" support.

<e2webifexternals>
	<e2webifexternal>
		<e2path>webradiofs</e2path>
		<e2name>webradioFS</e2name>
		<e2externalversion>14.53</e2externalversion>
	</e2webifexternal>
</e2webifexternals>

Doesn't currently work for JSON output.

settings

Read Enigma2 settings.

<e2settings>
	<e2setting>
		<e2settingname>config.keyboard.keymap</e2settingname>
		<e2settingvalue>dream-de.kmap</e2settingvalue>
	</e2setting>
	<e2setting>
		<e2settingname>config.misc.rcused</e2settingname>
		<e2settingvalue>0</e2settingvalue>
	</e2setting>
    <!-- ... -->
</e2settings>
{
    "result": true,
    "settings": [
        [
            "config.keyboard.keymap",
            "dream-de.kmap"
        ],
        [
            "config.misc.rcused",
            "0"
        ],
        /* ... */
    ]
}

bouquets

List of user bouquets.

Parameters:

  • stype - (optional) one of tv, radio; defaults to tv.
<e2servicelist>
	<e2service>
		<e2servicereference>1:7:1:0:0:0:0:0:0:0:FROM BOUQUET "userbouquet.favourites.tv" ORDER BY bouquet</e2servicereference>
		<e2servicename>Hauptsender</e2servicename>
	</e2service>
    <!-- ... -->
</e2servicelist>
{
    "bouquets": [
        [
            "1:7:1:0:0:0:0:0:0:0:FROM BOUQUET \"userbouquet.favourites.tv\" ORDER BY bouquet",
            "Hauptsender"
        ],
        /* ... */
    ]
}

epgmultigz

Like epgmulti; result is returned compressed.

getsatellites

Get service references of known satellites.

Parameters:

  • stype - (optional) one of tv, radio; defaults to tv.
{
    "satellites": [
        {
            "name": "Terrestrisch - Kan\u00e4le",
            "service": "1:7:0:0:0:0:EEEE0000:0:0:0:(satellitePosition == 61166) && (type == 1) || (type == 17) || (type == 22) || (type == 25) || (type == 31) || (type == 134) || (type == 195) ORDER BY name:Terrestrisch - Kan\u00e4le"
        },
        {
            "name": "Terrestrisch - Neu",
            "service": "1:7:0:0:0:0:EEEE0000:0:0:0:(satellitePosition == 61166) && (flags == 64) && (type == 1) || (type == 17) || (type == 22) || (type == 25) || (type == 31) || (type == 134) || (type == 195) ORDER BY name:Terrestrisch - Neu"
        },
        {
            "name": "Astra 1KR\/1L\/1M\/1N (19.2E) - Kan\u00e4le",
            "service": "1:7:0:0:0:0:C00000:0:0:0:(satellitePosition == 192) && (type == 1) || (type == 17) || (type == 22) || (type == 25) || (type == 31) || (type == 134) || (type == 195) ORDER BY name:Astra 1KR\/1L\/1M\/1N (19.2E) - Kan\u00e4le"
        },
        {
            "name": "Astra 1KR\/1L\/1M\/1N (19.2E) - Neu",
            "service": "1:7:0:0:0:0:C00000:0:0:0:(satellitePosition == 192) && (flags == 64) && (type == 1) || (type == 17) || (type == 22) || (type == 25) || (type == 31) || (type == 134) || (type == 195) ORDER BY name:Astra 1KR\/1L\/1M\/1N (19.2E) - Neu"
        }
    ]
}

saveepg

Save EPG cache (epg.dat) to disk

loadepg

Read EPG cache (epg.dat) from disk

getsubtitles

List of available subtitles for current service

{
    "subtitlelist": [],
    "result": false
}
{
    "subtitlelist": [
        {
            "lang": "deu",
            "pid": 5105,
            "page_nr": 1,
            "type": 0,
            "mag_nr": 1
        },
        {
            "lang": "und",
            "pid": 5104,
            "page_nr": 80,
            "type": 1,
            "mag_nr": 1
        },
        {
            "lang": "und",
            "pid": 5104,
            "page_nr": 153,
            "type": 1,
            "mag_nr": 7
        }
    ],
    "result": true
}
Add a custom footer
Add a custom sidebar
Clone this wiki locally