-
Notifications
You must be signed in to change notification settings - Fork 6
Other Functions
This section describes other functions which can be accessed via HTTP. They are not part of the HTTP API and so are not preceded by 'api'.
Unless otherwise stated no special privilege is needed to use these functions.
Downloads a previously-recorded file. Called with the UUID of the recording. Requires appropriate privilege (DVR or streaming).
http://192.168.0.1:9981/dvrfile/968ecf2073e4ec2e45c0ad534acdd4bf
Downloads an icon file. The filename is hard-coded in the source; on installation it is usually placed at /usr/share/tvheadend/src/webui/static/img/logo.png.
Outputs an image from the image cache. Requires streaming, recording or web interface privilege.
$ curl http://192.168.0.1:9981/imagecache/<image-number>
Used to download help files.
This function acts as a front-end to the dvrfile and stream functions. It is invoked using the following forms:
http://192.168.0.1:9981/play/stream/channelnumber/<channelnumber>
http://192.168.0.1:9981/play/dvrfile/968ecf2073e4ec2e45c0ad534acdd4bf
The function examines the 'User-Agent' string sent by the client. If the user-agent is on a preset list (or is not present), data transfer starts immediately; if not then a playlist is returned to the client.
The User-Agent list is "MPlayer", "curl/", "wget/", "TVHeadend", "Lavf" and any string containing "shoutcastsource".
This is a complex function which outputs lists of content available from the server, in various formats and filtered in several ways. The syntax for invoking the function depends on the required output and not all combinations of inputs are valid.
$ curl http://192.168.0.1:9981/playlist/tags
See below for sample output.
$ curl http://192.168.0.1:9981/playlist/x/channels
$ curl http://192.168.0.1:9981/playlist/recordings
The value of <x> in the URL specifies the format of the output. The options are e2, m3u or satip, with m3u the default if the item is omitted. For recordings only m3u is available.
For channels, a parameter sort can be added. This can take the value 'name' or 'numname', to sort the output by channel name or channel number respectively.
See below for sample outputs and notes.
$ curl http://192.168.0.1:9981/playlist/x/channelid/<channelid>
$ curl http://192.168.0.1:9981/playlist/x/channelnumber/<channelnumber>
$ curl http://192.168.0.1:9981/playlist/x/channelname/<channelname>
$ curl http://192.168.0.1:9981/playlist/x/channel/<channelUUID>
$ curl http://192.168.0.1:9981/playlist/x/tagid/<tagid>
$ curl http://192.168.0.1:9981/playlist/x/tagname/<tagname>
$ curl http://192.168.0.1:9981/playlist/x/tag/<tagUUID>
$ curl http://192.168.0.1:9981/playlist/dvrid/<dvr_id>
The value of <x> in the URL specifies the format of the output. The options are e2, m3u or satip, with m3u the default if the item is omitted. For recordings only m3u is available.
See below for sample outputs and notes.
The list of recordings includes all entries in the DVR logs, including failed and missed recordings and recordings to be made in the future (ie timers). Unplayable recordings have 'bandwidth=0' in the output.
Some URLs returned in channel lists include a ticket parameter. This is part of the TVHeadend authentication system; it is only valid for 5 minutes and should be removed from the URL. The server will then re-authenticate the request.
Alternatively, if Persistent Authentication is in use (TVHeadend versions > 4.3.1500), the auth code must be appended to the URL as a parameter, eg.
$ curl http://192.168.0.1:9981/playlist/tags?auth=8ef7aa08e516060ca4330730c60e00d5b5174920
$ curl http://192.168.0.1:9981/playlist/tags
#EXTM3U
#EXTINF:-1 logo="",HDTV
http://192.168.0.1:9981/playlist/tagid/1267929608?ticket=8ef7aa08e516060ca4330730c60e00d5b5174920&profile=pass
#EXTINF:-1 logo="",Radio channels
http://192.168.0.1:9981/playlist/tagid/1970563711?ticket=d5dff3b18c642fb75ae01d4d6c31702bea701b15&profile=pass
...
$ curl http://192.168.0.1:9981/playlist/channels
#EXTINF:-1 tvg-id="90a325df8d683eb014cf0abf56943e8d" tvg-chno="1005",CNN
http://192.168.0.1:9981/stream/channelid/1596302224?ticket=8849d82e41bf5ba9661a7077d70616450fce5239&profile=pass
#EXTINF:-1 tvg-id="c44d3390a7b5ecb59a074fff73a6b532" tvg-chno="2000",BBC R4 FM
http://192.168.0.1:9981/stream/channelid/271797700?ticket=1378d6c1e96c330dd0c758daf3feb906c078b099&profile=pass
...
$ curl http://192.168.0.1:9981/playlist/e2/channelname/QUEST
#NAME QUEST
#SERVICE 1:0:0:0:0:0:0:0:0:0:http://192.168.1.1:9981/stream/channelid/344789476&profile=pass:QUEST
#DESCRIPTION QUEST
$ curl http://192.168.0.1:9981/playlist/satip/channelname/QUEST
#EXTINF:-1,QUEST
http://192.168.1.1:9981/stream/channelid/344789476?profile=pass
$ curl http://192.168.1.0:9981/playlist/recordings
#EXTM3U
#EXTINF:1800,The Repair Shop
#EXT-X-TARGETDURATION:1800
#EXT-X-STREAM-INF:PROGRAM-ID=da01a7de69dfd8d09241c045d6fbaeb6,BANDWIDTH=5115
#EXT-X-PROGRAM-DATE-TIME:2018-03-23T18:30:00+0000
http://192.168.0.1:9981/dvrfile/da01a7de69dfd8d09241c045d6fbaeb6?ticket=0b9bdcdec9f7f95392bf82f34d9908a6e99697af
#EXTINF:1800,The Hitchhiker's Guide to the...
#EXT-X-TARGETDURATION:1800
#EXT-X-STREAM-INF:PROGRAM-ID=74cb4b64f55afca54725d8ab0a3d3e00,BANDWIDTH=0
#EXT-X-PROGRAM-DATE-TIME:2018-04-05T18:30:00+0100
http://192.168.0.1:9981/dvrfile/74cb4b64f55afca54725d8ab0a3d3e00?ticket=4a692cb4a1ba15881adde7fa88e7a73b7ba9b260
Used internally for theme selection?
Outputs one of two files describing the SAT>IP server and the services available from it.
$ curl http://192.168.0.1:9981/satip_server/desc.xml
$ curl http://192.168.0.1:9981/satip_server/satip.m3u
Outputs details of encrypted services. Each item contains:
- Service ID
- CA ID
- CA provider ID
- Service name
- Service type
- Service provider name
2968:0B00|TRP 1|TV||ASTRA
177B:0963,0961,0960|Crime+Inv+1|TV||ASTRA
0E1F:0963,0961,0960|Virgin Two|TV||ASTRA
13FB:0963,0961,0960|VICE|TV||ASTRA
2584:0963,0961,0960|Virgin One+1|TV||ASTRA
1789:0963,0961,0960|Real Lives+1|TV||ASTRA
15AE:0963,0961,0960|History+1|TV||ASTRA
15AF:0963,0961,0960|History2|TV||ASTRA
15AD:0963,0961,0960|History|TV||ASTRA
15B3:0963,0961,0960|Nat Geo Wild|TV||ASTRA
15B1:0963,0961,0960|Nat Geo+1|TV||ASTRA
15B0:0963,0961,0960|Nat Geo|TV||ASTRA
Outputs the TVHeadend version number and a (text) list of channels. This function requires Admin privilege.
The binary hash is only filled-in if the server runs on an x86 processor.
$ curl 'http://user:[email protected]:9981/state'
Tvheadend 4.3-1215~g5782d8c14-dirty Binary SHA1: 0000000000000000000000000000000000000000
Channels
----------------------------------------------
tru TV (13183175)
refcount = 0
number = 156
icon = <none set>
ITV3 (54665543)
refcount = 0
number = 114
icon = <none set>
...
Outputs the current status of the server, including CPU load average, recordings in progress (or minutes to the next recording) and the number of active subscriptions. Needs 'Web interface' or 'Recorder' privilege.
<?xml version="1.0"?>
<currentload>
<systemload>0.000000,0.000000,0.000000</systemload>
<recordings>
<recording>
<next>465</next>
</recording>
</recordings>
<subscriptions>0</subscriptions>
</currentload>
Starts the streaming of live data. The available forms are:
http://192.168.0.1:9981/stream/channelid/<chid>
http://192.168.0.1:9981/stream/channel/<uuid>
http://192.168.0.1:9981/stream/channelnumber/<channelnumber>
http://192.168.0.1:9981/stream/channelname/<channelname>
http://192.168.0.1:9981/stream/service/<uuid>
http://192.168.0.1:9981/stream/mux/<muxid>
Outputs the EPG in XML format, filtered in various ways.
$ curl http://192.168.0.1:9981/xmltv/channelid/<channelid>
$ curl http://192.168.0.1:9981/xmltv/channelnumber/<channelnumber>
$ curl http://192.168.0.1:9981/xmltv/channelname/<channelname>
$ curl http://192.168.0.1:9981/xmltv/channel/<channelUUID>
$ curl http://192.168.0.1:9981/xmltv/tagid/<tagid>
$ curl http://192.168.0.1:9981/xmltv/tagname/<tagname>
$ curl http://192.168.0.1:9981/xmltv/tag/<tagUUID>
The final variation lists the complete EPG together with a channel list. Example:
$ curl http://192.168.0.1:9981/xmltv/channels
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE tv SYSTEM "xmltv.dtd">
<tv generator-info-name="TVHeadend-4.3-1670~ge37c696de-dirty" source-info-name="tvh-Tvheadend">
<channel id="7e7b77801531c803f5ce8f4d5003f44c">
<display-name>Channel 5+1</display-name>
</channel>
...
<programme start="20181231151500 +0000" stop="20181231161500 +0000" channel="7e7b77801531c803f5ce8f4d5003f44c">
<title lang="eng">Dirty Dancing</title>
<desc lang="eng">Classic starring Patrick Swayze and Jennifer Grey. A spoiled 17-year-old learns a lot about life from the hotel dance instructor during a family summer holiday. (1987)[S]</desc>
<category lang="en">Movie / Drama</category>
</programme>
...
</tv>
If Persistent Authentication is in use (TVHeadend versions > 4.3.1500), the auth code must be appended to the URL as a parameter.