Project

General

Profile

Htsp » History » Version 136

Jaroslav Kysela, 2015-05-29 22:28

1 117 Jaroslav Kysela
h1. Home Tv Streaming Protocol (HTSP) - Version 21
2 1 Andreas Smas
3
h2. General
4 58 sbi -
5
HTSP is a TCP based protocol primarily intended for streaming of live TV and related meta data such as channels, group of channels (called tags in HTSP) and electronic program guide (EPG) information.
6
7 61 Adam Sutton
The transmission and reception of a channel over HTSP is referred to as a subscription. A single HTSP session can handle as many concurrent subscriptions as the bandwidth and CPU permits.
8 1 Andreas Smas
9 61 Adam Sutton
The HTSP server in tvheadend has a payload-aware scheduler for prioritizing more important packets (such as I-frames) before less important ones (such as B-frames). This makes HTSP suitable for long-distance transmissions and/or paths with non-perfect delivery.
10 1 Andreas Smas
(It has been tested with a server in Stockholm and the client in Berlin).
11
12 17 Andreas Smas
For information about the HTSP wire format please read [[htsmsgbinary|HTSMSG binary format]]
13 1 Andreas Smas
14 61 Adam Sutton
If you're looking to develop a new client, there are several existing client implementations from which you might be able to gain knowledge:
15
16
* "XBMC":https://github.com/opdenkamp/xbmc/tree/master/xbmc/pvrclients/tvheadend
17
* "Showtime":https://github.com/andoma/showtime/tree/master/src/backend/htsp
18 65 John Törnblom
* "TVHGuide":https://github.com/john-tornblom/TVHGuide
19 69 Adam Sutton
* "PyHTSP":https://github.com/adamsutton/tvheadend/tree/master/lib/py/tvh/htsp.py (This is a demo client and is WIP, it has limited functionality).
20 1 Andreas Smas
21 22 Andreas Smas
----
22 18 Andreas Smas
23 84 Jaroslav Kysela
h2. Protocol Changes
24 83 Jaroslav Kysela
25 126 Jaroslav Kysela
h3. v18..v19
26
27 131 Jaroslav Kysela
h3. v19..v20
28
29
* dvrEntry structures
30
** added subscriptionError, streamErrors, dataErrors fields
31
** added subtitle fields
32
* autorecEntry structures
33
** added dupDetect and fulltext fields
34
* errors fields to the stream deliver?
35
* satpos to the subscription start ?
36
* added subscriptionError field to subscriptionStatus server-to-client method
37
38
h3. v18..v19
39
40 126 Jaroslav Kysela
* autorec/timerec structures
41
** added directory field (forced output directory)
42 127 Jaroslav Kysela
** added enabled field
43
44 126 Jaroslav Kysela
45 119 Jaroslav Kysela
h3. v17..v18
46
47
* added addTimerecEntry, deleteTimerecEntry methods
48
* added timerecEntryAdd, timerecEntryUpdate, timerecEntryDelete server-to-client methods
49
* extended addAutorecEntry method
50
** added start/startWindow/name fields
51
** added owner/creator fields
52
** obsoleted creator field
53
* extended dvrEntryAdd, dvrEntryUpdate
54
** added timerecId field
55
** added owner/creator fields
56
* extended addAutorecEntry, deleteAutorecEntry methods
57
** added start/startWindow fields
58
** obsoleted approxTime
59
** added name/owner/creator fields
60
* extended autorecEntryAdd, autorecEntryUpdate server-to-client methods
61
** fields like for addAutorecEntry
62
* extended getTag method
63
** added tagIndex field
64
65 110 Jaroslav Kysela
h3. v16..v17
66
67
* extended subscriptionStart server-to-client method
68
** added meta field
69
* changed H264 meta data handling (codec meta data are in the meta field only in start message)
70
* VORBIS and AAC codecs have codec specific meta data in the meta field in start message
71 115 Jaroslav Kysela
* changed subscribe method
72
** the normts is always active and the parameter is ignored
73
74 110 Jaroslav Kysela
75 107 Jaroslav Kysela
h3. v15..v16
76
77
* added getProfiles, getDvrConfigs methods
78
* removed getCodecs methods
79
* extended subscribe method
80
** add profile field
81
82 105 Jaroslav Kysela
h3. v14..v15
83
84
* extended channelAdd, channelUpdate server-to-client methods
85 106 Jaroslav Kysela
** the channelIcon URL can be relative 'imagecache/%d' or '/imagecache/%d'
86 1 Andreas Smas
* extended getChannel method
87 106 Jaroslav Kysela
** the channelIcon URL can be relative 'imagecache/%d' or '/imagecache/%d'
88
89 105 Jaroslav Kysela
90 100 Jaroslav Kysela
h3. v13..v14
91
92
* added getChannel method
93
94 85 Jaroslav Kysela
h3. v12..v13
95
96
* added addAutorecEntry method
97
* added deleteAutorecEntry method
98 92 Jaroslav Kysela
* added autorecEntryAdd, autorecEntryUpdate, autorecEntryDelete server-to-client methods
99 85 Jaroslav Kysela
* extended channelAdd server-to-client method
100 87 Jaroslav Kysela
** added channelNumberMinor (for {major}.{minor} channel numbers)
101
* extended dvrEntryAdd and dvrEntryUpdate server-to-client methods
102 88 Jaroslav Kysela
** added eventId, autorecId, startExtra, stopExtra, retention, priority, contentType fields
103 97 Jaroslav Kysela
* extended addDvrEntry method
104
** added retention
105
* extended updateDvrEntry method
106
** added retention, priority
107
* extended epgQuery method
108
** added minduration, maxduration
109 85 Jaroslav Kysela
* added subscriptionGrace server-to-client method
110 97 Jaroslav Kysela
111 85 Jaroslav Kysela
112 83 Jaroslav Kysela
h3. v11..v12
113
114
* added subscriptionFilterStream method
115
* added getDvrCutpoints method
116
117
118
h3. v10..v11
119
120 86 Jaroslav Kysela
* added audio_type in the subscriptionStart server-to-client method
121 83 Jaroslav Kysela
* added getCodecs method
122
123 58 sbi -
h2. Communication
124
125
126 69 Adam Sutton
This communication is currently implemented by using htsmsg's. All strings are encoded as UTF-8.
127 1 Andreas Smas
128
There are two distinct ways for communication within HTSP.
129
130 28 Andreas Smas
Apart from this there is a number of messages that needs to be exchanged during login, see the login section below.
131
132 1 Andreas Smas
133 58 sbi -
h3. RPC communication
134
135
136 1 Andreas Smas
There is a normal RPC way of doing things. I.e. the client sends a request and the server responds with a reply. All the RPC methods are listed below as the 'Client to Server' methods. Apart from all message fields listed within each message type the client can add an additional field:
137 18 Andreas Smas
138 17 Andreas Smas
RPC request extra fields:
139 58 sbi -
<pre>
140 28 Andreas Smas
seq              int  optional   Sequence number. This field will be echoed back by the server in the reply.
141 1 Andreas Smas
username         str  optional   Username, in combination with 'digest' this can be used to raise the privileges
142
                                 for the session in combination with invocation of a method. 
143 28 Andreas Smas
digest           bin  optional   Used to raise privileges.
144 58 sbi -
</pre>
145 18 Andreas Smas
146 1 Andreas Smas
The followings field should be used by the client to match the reply with the request.
147
All replies are guaranteed to arrive in the same order as the requests.
148
Even so, probably the best way to implement the request-reply client is by taking advantage of the 'seq' field.
149
150
RPC reply extra fields:
151 58 sbi -
<pre>
152 18 Andreas Smas
seq              int  optional   Sequence number. Same as in the request.
153 19 Andreas Smas
error            str  optional   If present an error has occurred and the text describes the error.
154
noaccess         int  optional   If present and set to '1' the user is prohibited from invoking the method due to 
155 1 Andreas Smas
                                 access restrictions. 
156 58 sbi -
</pre>
157 1 Andreas Smas
158 18 Andreas Smas
159 58 sbi -
h3. Streaming communication
160
161
162 19 Andreas Smas
For streaming of live TV and various related messages the server will continuously push data to the client.
163 1 Andreas Smas
These messages are referred to as asynchronous messages and always have the 'method' field set and never have the 'seq' field set.
164
Also, the client can enable an additional asyncMetadata mode and by doing so it will be notified by the server when meta data changes. (EPG updates, creation of channels and tags, etc). 
165
166 34 Andreas Smas
167 58 sbi -
h3. Authentication
168
169
170 29 Andreas Smas
In Tvheadend, each method has an associated access restriction. Currently there is only one restriction (Streaming). However, this may change in the future.
171 1 Andreas Smas
172
Privileges for these restrictions may be granted in two ways: Username + Password and/or Source IP address.
173
Therefore it is possible to gain permissions to the system without entering a username and password.
174
While this is really useful it also complicates the authentication schema a bit.
175
Upon connect the initial privileges will be raised based on the source address.
176
177
Before any username / password based authentication has taken place the client must have
178 34 Andreas Smas
obtained a challenge (which stays fixed for the session). This is done via the 'hello' method.
179 1 Andreas Smas
180
In principle it's possible to use two different authentication idioms with HTSP.
181
Depending on how your application works one or another may be more suitable.
182
While they do not really differ from a protocol point of view it's worth mentioning a bit about them here:
183
184
185 58 sbi -
h3. Initial login authentication
186
187
188 1 Andreas Smas
The client performs all of its authentication using the 'login' method.
189
190
It may choose to send:
191 58 sbi -
* Username and password: Privileges will be raised based on these credentials.
192
* Username only: Privileges will be based on just the source address. The username will be used for various logging purposes.
193
* Nothing: Privileges will be based on just the source address.
194 1 Andreas Smas
195
If no privileges are granted after the login message has been received by the server (i.e. both network and username + password based)
196
the server will reply with 'noaccess' set to 1. A client that only employs initial login should honor this flag and ask the
197
user for a username + password and retry by using the 'authenticate' method. I.e. it should not send the 'login' method again.
198
199
200 58 sbi -
h3. On-demand authentication
201
202
203 1 Andreas Smas
The client performs all of its authentication when it needs to.
204
205
When using this method, the client will check every RPC reply for the 'noaccess' field.
206
If it set to 1 it whould ask the user for username + password and retry the request but also
207 58 sbi -
add 'username' and 'digest' to the original message. (See _RPC request extra fields_ above)
208 1 Andreas Smas
209
Typically it would not send a username or digest during login.
210 29 Andreas Smas
211
----
212 34 Andreas Smas
213 66 Adam Sutton
h2. Client to Server (RPC) methods
214 34 Andreas Smas
215
h3. hello
216 58 sbi -
217
Used to identify the client toward the server and to get the session challenge used to
218 1 Andreas Smas
hash passwords into digests. The client can request a different version of the HTSP
219 66 Adam Sutton
protocol with this method. If no 'hello' message is sent the server assumes latest version
220 1 Andreas Smas
is to be used.
221 34 Andreas Smas
222 66 Adam Sutton
Client/Server should select lowest common version, if this is not possible connection should be terminated.
223 1 Andreas Smas
224
Request message fields:
225
<pre>
226 66 Adam Sutton
htspversion        u32   required   Client preferred HTSP version.
227
clientname         str   required   Client software name.
228
clientversion      str   required   Client software version.
229 58 sbi -
</pre>
230 1 Andreas Smas
231
Reply message fields:
232 34 Andreas Smas
<pre>
233 66 Adam Sutton
htspversion        u32   required   The server supports all versions of the protocol up to and including this number.
234
servername         str   required   Server software name.
235
serverversion      str   required   Server software version.
236
servercapability   str[] required   Server capabilities (Added in version 6)
237 1 Andreas Smas
challenge          bin   required   32 bytes randomized data used to generate authentication digests
238 73 Adam Sutton
webroot            str   optional   Server HTTP webroot (Added in version 8)
239
                                    Note: any access to TVH webserver should include this at start of URL path
240 1 Andreas Smas
</pre>
241
242 70 Adam Sutton
Note: possible values for servercapability[]:
243
<pre>
244
cwc                Descrambling available
245
v4l                Analogue TV available
246
linuxdvb           Linux DVB API available
247 1 Andreas Smas
imagecache         Image caching available
248 73 Adam Sutton
timeshift          Timeshifting available (Added in version 9).
249 70 Adam Sutton
</pre>
250
251 58 sbi -
h3. authenticate
252 1 Andreas Smas
253
This can be used to issue authentication without doing anything else.
254
If no privileges are gained it will return with 'noaccess' set to 1.
255
256 33 Andreas Smas
Request message fields:
257 1 Andreas Smas
<pre>
258 66 Adam Sutton
None   
259 33 Andreas Smas
</pre>
260 58 sbi -
261
Reply message fields:
262
<pre>
263 66 Adam Sutton
noaccess           u32   optional   If set to 1, no privileges were granted.
264 33 Andreas Smas
</pre>
265 1 Andreas Smas
266
----
267
268 66 Adam Sutton
h3. getDiskSpace (Added in version 3)
269 58 sbi -
270 66 Adam Sutton
Return diskspace status from Tvheadend's PVR storage
271 1 Andreas Smas
272 66 Adam Sutton
Request message fields:
273
<pre>
274
None
275
</pre>
276 1 Andreas Smas
277 66 Adam Sutton
Reply message fields:
278
<pre>
279
freediskspace      s64   required   Bytes available.
280
totaldiskspace     s64   required   Total capacity.
281
</pre>
282 1 Andreas Smas
283 66 Adam Sutton
h3. getSysTime (Added in version 3)
284 1 Andreas Smas
285 66 Adam Sutton
Return system time on the server.
286
287 1 Andreas Smas
Request message fields:
288
<pre>
289
None
290
</pre>
291
292
Reply message fields:
293 58 sbi -
<pre>
294 66 Adam Sutton
time               s64  required   UNIX time.
295
timezone           s32  required   Minutes west of GMT.
296 1 Andreas Smas
</pre>
297 23 Andreas Smas
298 1 Andreas Smas
----
299
300 66 Adam Sutton
h3. enableAsyncMetadata
301 1 Andreas Smas
302 66 Adam Sutton
When this is enabled the client will get continuous updates from the server about added, update or deleted channels, tags, dvr and epg entries.
303 1 Andreas Smas
304 66 Adam Sutton
An interactive application that presents the user with information about these things should probably enable this and the implement the various server to client methods.
305 1 Andreas Smas
306
Request message fields:
307
<pre>
308 66 Adam Sutton
epg                u32   optional   Set to 1, to include EPG data in async, implied by epgMaxTime (Added in version 6).
309
lastUpdate         s64   optional   Only provide metadata that has changed since this time (Added in version 6).
310
epgMaxTime         s64   optional   Maximum time to return EPG data up to (Added in version 6)
311
language           str   optional   RFC 2616 compatible language list (Added in version 6)
312 1 Andreas Smas
</pre>
313
314
Reply message fields:
315
<pre>
316 66 Adam Sutton
None
317 1 Andreas Smas
</pre>
318
319 66 Adam Sutton
Once the reply as been sent the initial data set will be provided, and then updates will arrive asynchronously after that. The initial data dump is sent using the following messages:
320 1 Andreas Smas
321 66 Adam Sutton
<pre>
322
tagAdd                   optional
323
channelAdd               optional
324
tagUpdate                optional
325
dvrEntryAdd              optional
326
eventAdd                 optional   (Added in version 6)
327
initialSyncComplete      required
328
</pre>
329 1 Andreas Smas
330 66 Adam Sutton
----
331 1 Andreas Smas
332 101 Jaroslav Kysela
h3. getChannel (Added in version 14)
333
334
Request information about the given channel.
335
336
Request message fields:
337
<pre>
338
channelId          u32   required   Channel ID.
339
</pre>
340
341
Reply message fields:
342
<pre>
343
see channelAdd
344
</pre>
345
346
----
347
348 66 Adam Sutton
h3. getEvent
349 1 Andreas Smas
350 66 Adam Sutton
Request information about the given event. An event typically corresponds to a program on a channel.
351 1 Andreas Smas
352 66 Adam Sutton
The language field in the request allows preference for languages to be requested for the various string fields.
353
354 1 Andreas Smas
Request message fields:
355 45 mdd -
<pre>
356 66 Adam Sutton
eventId            u32   required   Event ID.
357
language           str   optional   RFC 2616 compatible language list (Added in version 6)
358 1 Andreas Smas
</pre>
359
360
Reply message fields:
361
<pre>
362 66 Adam Sutton
see eventAdd
363 1 Andreas Smas
</pre>
364
365 66 Adam Sutton
h3. getEvents (Added in version 4)
366 1 Andreas Smas
367 66 Adam Sutton
Request information about a set of events. If no options are specified the entire EPG database will be returned.
368 57 sbi -
369 58 sbi -
Request message fields:
370 1 Andreas Smas
<pre>
371 66 Adam Sutton
eventId            u32   optional   Event ID to begin from (Optional since version 6)
372
channelId          u32   optional   Channel ID to get data for (Added in version 6)
373
numFollowing       u32   optional   Number of events to add (Optional since version 6)
374
maxTime            u64   optional   Maximum time to return data up to (Added in version 6)
375
language           str   optional   RFC 2616 compatible language list (Added in version 6)
376 1 Andreas Smas
</pre>
377
378
Reply message fields:
379
<pre>
380 66 Adam Sutton
events             msg[] required   List of events, using response message fields from eventAdd
381 1 Andreas Smas
</pre>
382 45 mdd -
383 66 Adam Sutton
h3. epgQuery (Added in version 4)
384 1 Andreas Smas
385 66 Adam Sutton
Query the EPG (event titles) and optionally restrict to channel/tag/content type.
386 1 Andreas Smas
387 66 Adam Sutton
Request message fields:
388
<pre>
389
query              str   required  Title regular expression to search for
390
channelId          u32   optional  [[ChannelId]] to restrict search to
391
tagId              u32   optional  [[TagId]] to restrict search to
392
contentType        u32   optional  DVB content type to restrict search to
393 98 Jaroslav Kysela
minduration        u32   optional  Minimal duration in seconds (Added in version 13)
394
maxduration        u32   optional  Maximal duration in seconds (Added in version 13)
395 66 Adam Sutton
language           str   optional  RFC 2616 compatible language list for title (Added in version 6)
396
full               u32   optional  Output full event list rather than just IDs
397
</pre>
398 1 Andreas Smas
399 66 Adam Sutton
Reply message fields:
400 1 Andreas Smas
401 66 Adam Sutton
if full == 1
402
<pre>
403
events             msg[] optional   List of events, using response message fields from eventAdd
404
</pre>
405
else
406
<pre>
407
eventIds           u32[] optional  List of eventIds that match the query
408
</pre>
409 1 Andreas Smas
410 66 Adam Sutton
h3. getEpgObject
411
412
Get detailed EPG Object info.
413
414 58 sbi -
Request message fields:
415 1 Andreas Smas
<pre>
416 66 Adam Sutton
id                 u32   required  Object ID
417
type               u32   optional  Object type
418 1 Andreas Smas
</pre>
419 58 sbi -
420 1 Andreas Smas
Reply message fields:
421 66 Adam Sutton
422 1 Andreas Smas
<pre>
423 66 Adam Sutton
TODO
424 1 Andreas Smas
</pre>
425
426 58 sbi -
----
427 1 Andreas Smas
428 109 Jaroslav Kysela
h3. getDvrConfigs (Added in version 16)
429
430
Return a list of DVR configurations.
431
432
Reply message fields:
433
<pre>
434
dvrconfigs         msg[]      optional   Supported DVR configurations.
435
</pre>
436
437
Message fields:
438
<pre>
439
uuid               str        required   DVR configuration ID
440
name               str        required   DVR configuration Name
441
comment            str        required   DVR configuration Comment
442
</pre>
443
444 66 Adam Sutton
h3. addDvrEntry (Added in version 4)
445
446 1 Andreas Smas
Create a new DVR entry. Either eventId or channelId, start and stop must be specified.
447
448
Request message fields:
449 66 Adam Sutton
<pre>
450
eventId            u32   optional   Event ID (Optional since version 5).
451
channelId          u32   optional   Channel ID (Added in version 5)
452
start              s64   optional   Time to start recording (Added in version 5)
453 96 Jaroslav Kysela
stop               s64   optional   Time to stop recording (Added in version 5)
454 66 Adam Sutton
retention          u32   optional   Retention time in days (Added in version 13)
455 117 Jaroslav Kysela
creator            str   optional   Name of the event creator (Added in version 5, obsoleted in version 18 - applications are not allowed to change credential)
456 66 Adam Sutton
priority           u32   optional   Recording priority (Added in version 5)
457
startExtra         s64   optional   Pre-recording buffer in minutes (Added in version 5)
458
stopExtra          s64   optional   Post-recording buffer in minutes (Added in version 5)
459
title              str   optional   Recording title, if no eventId (Added in version 6)
460 132 Jaroslav Kysela
subtitle           str   optional   Recording subtitle, if no eventId (Added in version 20)
461 1 Andreas Smas
description        str   optional   Recording description, if no eventId (Added in version 5)
462 109 Jaroslav Kysela
configName         str   optional   DVR configuration name or UUID
463 40 Andreas Smas
</pre>
464 1 Andreas Smas
465
Reply message fields:
466
<pre>
467 66 Adam Sutton
success            u32   required   1 if entry was added, 0 otherwise
468
id                 u32   optional   ID of created DVR entry
469 1 Andreas Smas
error              str   optional   English clear text of error message
470
</pre>
471 66 Adam Sutton
472 1 Andreas Smas
h3. updateDvrEntry (Added in version 5)
473 66 Adam Sutton
474 1 Andreas Smas
Update an existing DVR entry.
475
476
Request message fields:
477 66 Adam Sutton
<pre>
478
id                 u32   required   DVR Entry ID
479
start              s64   optional   New start time
480
stop               s64   optional   New stop time
481
title              str   optional   New entry title
482
description        str   optional   New entry description (Added in version 6)
483 1 Andreas Smas
startExtra         s64   optional   New pre-record buffer (Added in version 6)
484 66 Adam Sutton
stopExtra          s64   optional   New post-record buffer (Added in version 6)
485 109 Jaroslav Kysela
configName         str   optional   New DVR configuration name or UUID
486 99 Jaroslav Kysela
retention          u32   optional   Retention in days (Added in version 13)
487
priority           u32   optional   Recording priority (Added in version 13)
488 1 Andreas Smas
</pre>
489
490
Reply message fields:
491
<pre>
492 66 Adam Sutton
success            u32   required   1 if update as successful, otherwise 0
493
error              str   optional   Error message if update failed
494 40 Andreas Smas
</pre>
495
496 66 Adam Sutton
h3. cancelDvrEntry (Added in version 5)
497 1 Andreas Smas
498 66 Adam Sutton
Cancel an existing recording, but don't remove the entry from the database.
499 1 Andreas Smas
500 66 Adam Sutton
Request message fields:
501
<pre>
502
id                 u32   required   dvrEnryId to delete
503
</pre>
504 1 Andreas Smas
505 66 Adam Sutton
Reply message fields:
506
<pre>
507
success            int   required   1 if entry was cancelled
508
error              str   optional   Error message if cancellation failed
509
</pre>
510 1 Andreas Smas
511 66 Adam Sutton
h3. deleteDvrEntry (Added in version 4)
512
513
Delete an existing DVR entry from the database.
514
515
Request message fields:
516 1 Andreas Smas
<pre>
517 66 Adam Sutton
id                 u32   required   DVR Entry ID
518 1 Andreas Smas
</pre>
519
520 11 Andreas Smas
Reply message fields:
521 1 Andreas Smas
<pre>
522 66 Adam Sutton
success            u32   required   1 if entry was removed
523
error              str   optional   Error message if the delete fails
524 1 Andreas Smas
</pre>
525
526 103 Jaroslav Kysela
h3. getDvrCutpoints (Added in version 12)
527
528
Get DVR cutpoints.
529
530
Request message fields:
531
<pre>
532
id                 u32   required   DVR Entry ID
533
</pre>
534
535
Reply message fields:
536
<pre>
537
cutpoints          msg[] optional   List of cutpoint entries, if a file is found and has some valid data.
538
</pre>
539
540
Cutpoint fields:
541
<pre>
542
start              u32   required   Cut start time in ms.
543
end                u32   required   Cut end time in ms.
544
type               u32   required   Action type: 
545
                                      0=Cut, 1=Mute, 2=Scene, 
546
                                      3=Commercial break.
547
</pre>
548
549 102 Jaroslav Kysela
---
550
551 91 Jaroslav Kysela
h3. addAutorecEntry (Added in version 13)
552
553
Create a new Autorec DVR entry. Title must be specified.
554
555
Request message fields:
556
<pre>
557 128 Jaroslav Kysela
enabled            u32   optional   Enabled flag (Added in version 19).
558 91 Jaroslav Kysela
title              str   required   Title for the recordings.
559 133 Jaroslav Kysela
fulltext           u32   optional   Full text flag (Added in version 20).
560 121 Jaroslav Kysela
directory          str   optional   Forced directory name - missing or empty = auto (Added in version 19).
561 120 Jaroslav Kysela
name               str   optional   Name of this autorec entry (Added in version 18).
562 91 Jaroslav Kysela
configName         str   optional   DVR Configuration Name / UUID.
563
channelId          u32   optional   Channel ID.
564
minDuration        u32   optional   Minimal duration in seconds (0 = Any).
565
maxDuration        u32   optional   Maximal duration in seconds (0 = Any).
566 1 Andreas Smas
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
567
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
568 117 Jaroslav Kysela
approxTime         u32   optional   Minutes from midnight (up to 24*60) (window +- 15 mintes) (Obsoleted from version 18).
569
start              s32   optional   Minutes from midnight (up to 24*60) for the start of the time window (including) (Added in version 18).
570
startWindow        s32   optional   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed) (Added in version 18).
571 91 Jaroslav Kysela
startExtra         s64   optional   Extra start minutes (pre-time).
572
stopExtra          s64   optional   Extra stop minutes (post-time).
573 134 Jaroslav Kysela
dupDetect          u32   optional   Dup Detect (0 = all, 1 = diff episode, 2 = diff subtitle, 3 = diff description, 4 = once per week, 5 = once per day) (Added in version 20).
574 91 Jaroslav Kysela
comment            str   optional   User Comment.
575
</pre>
576 83 Jaroslav Kysela
577
Reply message fields:
578
<pre>
579
success            u32   required   1 if entry was added, 0 otherwise
580
id                 str   optional   ID (string!) of created autorec DVR entry
581
error              str   optional   English clear text of error message
582
</pre>
583
584
h3. deleteAutorecEntry (Added in version 13)
585
586
Delete an existing autorec DVR entry from the database.
587
588
Request message fields:
589
<pre>
590
id                 str   required   Autorec DVR Entry ID (string!)
591
</pre>
592
593
Reply message fields:
594
<pre>
595
success            u32   required   1 if entry was removed
596
error              str   optional   Error message if the delete fails
597 1 Andreas Smas
</pre>
598 83 Jaroslav Kysela
599 117 Jaroslav Kysela
---
600 1 Andreas Smas
601 117 Jaroslav Kysela
h3. addTimerecEntry (Added in version 18)
602
603
Create a new Timerec DVR entry. Title must be specified.
604
605
Request message fields:
606
<pre>
607 129 Jaroslav Kysela
enabled            u32   optional   Enabled flag (Added in version 19).
608 117 Jaroslav Kysela
title              str   required   Title for the recordings.
609 125 Jaroslav Kysela
directory          str   optional   Forced output directory name (Added in version 19).
610 117 Jaroslav Kysela
name               str   optional   Name for this timerec entry.
611
configName         str   optional   DVR Configuration Name / UUID.
612
channelId          u32   required   Channel ID.
613
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
614
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
615
start              u32   required   Minutes from midnight (up to 24*60) for the start of the time window (including)
616
stop               u32   required   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed)
617
retention          u32   optional   Retention in days. 
618
comment            str   optional   User Comment.
619
</pre>
620
621
Reply message fields:
622
<pre>
623
success            u32   required   1 if entry was added, 0 otherwise
624
id                 str   optional   ID (string!) of created timerec DVR entry
625
error              str   optional   English clear text of error message
626
</pre>
627
628
h3. deleteTimerecEntry (Added in version 18)
629
630
Delete an existing timerec DVR entry from the database.
631
632
Request message fields:
633
<pre>
634
id                 str   required   Timerec DVR Entry ID (string!)
635
</pre>
636
637
Reply message fields:
638
<pre>
639
success            u32   required   1 if entry was removed
640
error              str   optional   Error message if the delete fails
641
</pre>
642
643
----
644
645 66 Adam Sutton
h3. getTicket (Added in version 5)
646 1 Andreas Smas
647 66 Adam Sutton
Get a ticket to allow access to a channel or recording via HTTP
648 1 Andreas Smas
649 66 Adam Sutton
Request message fields:
650 1 Andreas Smas
<pre>
651 66 Adam Sutton
channelId          u32  optional   Channel to gain access for
652
dvrId              u32  optional   DVR file to gain access for
653 1 Andreas Smas
</pre>
654
655
Reply message fields:
656
<pre>
657 66 Adam Sutton
path               str  required   The full path for access URL (no scheme, host or port)
658
ticket             str  required   The ticket to pass in the URL query string
659 1 Andreas Smas
</pre>
660
661 66 Adam Sutton
h3. subscribe
662 1 Andreas Smas
663 66 Adam Sutton
Request subscription to the given channel. 
664 1 Andreas Smas
665 66 Adam Sutton
Request message fields:
666
<pre>
667
channelId          u32   required   ID for channel. 
668
subscriptionId     u32   required   Subscription ID. Selected by client. This value is not interpreted by the server in any form. 
669
                                    The value is used from now on in all messages related to the subscription.
670 1 Andreas Smas
weight             u32   optional   Weighting of this subscription (same as recording priority).
671 73 Adam Sutton
90khz              u32   optional   Request PTS/DTS in default 90kHz timebase, default is 1MHz (Added in version 7)
672
normts             u32   optional   Request PTS/DTS normalisation (Added in version 7)
673
                                    Note: this will mean missing timestamps are added, first packet should be ~0 and will always be an i-frame.
674
                                    Note: this is implied if timeshiftPeriod is enabled
675 114 Jaroslav Kysela
                                    Note: from version 17, this is always enabled and this parameter is ignored.
676 73 Adam Sutton
queueDepth         u32   optional   Change the default packet queue lengths, default 500000 bytes (Added in version 7)
677
                                    Note: I-frame depth is 3*queueDepth, P-frame is 2*queueDepth and B-frame is queueDepth
678
timeshiftPeriod    u32   optional   The number of seconds to keep in the timeshift buffer (Added in version 9)
679
                                    Note: this may be bounded by server configuration settings
680 108 Jaroslav Kysela
profile            str   optional   Select stream profile (Added in version 16).
681 11 Andreas Smas
</pre>
682 66 Adam Sutton
683 1 Andreas Smas
Reply message fields:
684
<pre>
685 73 Adam Sutton
90khz              u32   optional   Indicates 90khz timestamps will be used
686
normts             u32   optional   Indicates timestamps will be normalised (and fixed)
687
timeshiftPeriod    u32   optional   The actual timeshiftPeriod to be used
688 66 Adam Sutton
</pre>
689 1 Andreas Smas
690 66 Adam Sutton
h3. unsubscribe
691
692
Stop a subscription.
693
694
Request message fields:
695 1 Andreas Smas
<pre>
696 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
697 58 sbi -
</pre>
698
699 11 Andreas Smas
Reply message fields:
700 1 Andreas Smas
<pre>
701 66 Adam Sutton
None
702 58 sbi -
</pre>
703 11 Andreas Smas
704 66 Adam Sutton
h3. subscriptionChangeWeight (Added in version 5)
705 1 Andreas Smas
706 66 Adam Sutton
Change the weight of an existing subscription
707 1 Andreas Smas
708 66 Adam Sutton
Request message fields:
709
<pre>
710
subscriptionId     u32   required   Subscription ID.
711
weight             u32   optional   The new subscription weight.
712 1 Andreas Smas
</pre>
713
714
Reply message fields:
715
<pre>
716 69 Adam Sutton
None
717 1 Andreas Smas
</pre>
718
719 73 Adam Sutton
h3. subscriptionSkip (Added in version 9)
720
721
Skip a timeshift enabled subscription. The response will be asynchronous subscriptionSkip().
722
723
Request message fields:
724
<pre>
725
subscriptionId     u32   required   Subscription ID.
726
absolute           u32   optional   The skip request is absolute
727
time               u64   optional   Specify skip using time (units are as for PTS)
728
size               u64   optional   Specify skip using size (Not currently used)
729
</pre>
730
731
Reply message fields:
732
<pre>
733
None
734
</pre>
735
736
h3. subscriptionSeek (Added in version 9)
737
738
Synonym for subscriptionSkip
739
740
h3. subscriptionSpeed (Added in version 9)
741
742
Set the playback speed for the subscription. The response will be asynchronous subscriptionSpeed().
743
744
Request message fields:
745
<pre>
746
subscriptionId     u32   required   Subscription ID.
747
speed              u32   required   Specify speed (0=pause, 100=1x fwd, -100=1x backward)
748
</pre>
749
750
Reply message fields:
751
<pre>
752
None
753
</pre>
754
755
h3. subscriptionLive (Added in version 9)
756
757
Return a timeshifted session to live. Reply will be asynchronous subscriptionSkip().
758
759
Request message fields:
760
<pre>
761
subscriptionId     u32   required   Subscription ID.
762
</pre>
763
764
Reply message fields:
765
<pre>
766
None
767 82 Jaroslav Kysela
</pre>
768 1 Andreas Smas
769 83 Jaroslav Kysela
h3. subscriptionFilterStream (Added in version 12)
770 1 Andreas Smas
771 83 Jaroslav Kysela
Enable or disable specified streams by index.
772
773
Request message fields:
774
<pre>
775
subscriptionId     u32        required   Subscription ID.
776
enable             list[u32]  optional   Enable stream indexes
777
disable            list[u32]  optional   Disable (filter out) stream indexes
778
</pre>
779
780
Reply message fields:
781 1 Andreas Smas
<pre>
782
None
783 109 Jaroslav Kysela
</pre>
784
785
---
786
787
h3. getProfiles (Added in version 16)
788
789
Return a list of stream profiles (configurations).
790
791
Reply message fields:
792
<pre>
793
profiles           msg[]      optional   Supported profiles
794
</pre>
795
796
Message fields:
797
<pre>
798
uuid               str        required   Profile ID
799
name               str        required   Profile Name
800
comment            str        required   Profile Comment
801 83 Jaroslav Kysela
</pre>
802
803
h3. getCodecs (Added in version 11, Removed in version 16)
804
805 82 Jaroslav Kysela
Return a list of encoders (codecs).
806
807 1 Andreas Smas
Reply message fields:
808 82 Jaroslav Kysela
<pre>
809 83 Jaroslav Kysela
encoders           list[str]  optional   Supported encoders
810 82 Jaroslav Kysela
</pre>
811
812 70 Adam Sutton
h3. fileOpen (Added in version 8)
813 69 Adam Sutton
814
Open a file within the Tvheadend file system. This is now the preferred method (in place of HTTP) for accessing recordings.
815
816
Accessing recordings via HTSP will overcome the limitations of standard HTTP streaming which cannot handle both skipping and growing files (i.e. in-progress recordings) at the same time.
817
818 1 Andreas Smas
Request message fields:
819 69 Adam Sutton
<pre>
820 70 Adam Sutton
file               str   required   File path to open
821 1 Andreas Smas
</pre>
822
823 70 Adam Sutton
Valid file paths:
824
<pre>
825
/dvrfile/ID        will open the file associated with DVR entry ID
826 74 Adam Sutton
/imagecache/ID     will open the file associated with imagecache entry ID (Note: only works for HTSPv10+)
827 70 Adam Sutton
</pre>
828
829 69 Adam Sutton
Reply message fields:
830
<pre>
831
id                 u32   required   The file handle used for further file operations
832
size               u64   optional   The size of the file in bytes
833 1 Andreas Smas
mtime              u64   optional   The last time the file was modified
834 69 Adam Sutton
</pre>
835
836 70 Adam Sutton
h3. fileRead (Added in version 8)
837 69 Adam Sutton
838 1 Andreas Smas
Read data from a file.
839
840 69 Adam Sutton
Request message fields:
841
<pre>
842
id                 u32   required   The file handle used for further file operations
843 70 Adam Sutton
size               u64   required   The amount of data to read
844
offset             u64   optional   Offset into the file to read (default is current position)
845 69 Adam Sutton
</pre>
846 1 Andreas Smas
847 69 Adam Sutton
Reply message fields:
848
<pre>
849
data               bin   required   The data read from the file (size may be less than requested)
850
</pre>
851
852 70 Adam Sutton
h3. fileClose (Added in version 8)
853 69 Adam Sutton
854
Close an opened file.
855
856
Request message fields:
857
<pre>
858 1 Andreas Smas
id                 u32   required   The file handle to be closed
859 69 Adam Sutton
</pre>
860
861
Reply message fields:
862
<pre>
863
None
864
</pre>
865 70 Adam Sutton
866 69 Adam Sutton
h3. fileStat (Added in version 8)
867
868
Get status of a file.
869
870
Request message fields:
871
<pre>
872
id                 u32   required   The file handle to be stat'd
873 1 Andreas Smas
</pre>
874
875
Reply message fields:
876
<pre>
877
size               u64   optional   The size of the file in bytes
878
mtime              u64   optional   The last time the file was modified
879
</pre>
880 70 Adam Sutton
881
h3. fileSeek (Added in version 8)
882
883
Seek to position in a file.
884
885
Request message fields:
886
<pre>
887
id                 u32   required   The file handle to be stat'd
888
offset             u64   required   The position to seek in the file
889
whence             str   required   Where to seek relative to (default=SEEK_SET)
890
</pre>
891
892
Note: valid values for whence
893
<pre>
894
SEEK_SET           Seek relative to start of file
895
SEEK_CUR           Seek relative to current position in file
896 72 Adam Sutton
SEEK_END           Seek relative (backwards) to end of file
897 70 Adam Sutton
</pre>
898
899
Reply message fields:
900
<pre>
901
offset             u64   optional   The new absolute position within the file
902
</pre>
903 66 Adam Sutton
904 1 Andreas Smas
h1. Server to Client methods
905
906
----
907
908
h3. channelAdd
909
910
A new channel has been created on the server.
911
912
Message fields:
913
<pre>
914
channelId          u32   required   ID of channel.
915 66 Adam Sutton
channelNumber      u32   required   Channel number, 0 means unconfigured.
916 90 Jaroslav Kysela
channelNumberMinor u32   optional   Minor channel number (Added in version 13).
917 1 Andreas Smas
channelName        str   required   Name of channel.
918 70 Adam Sutton
channelIcon        str   optional   URL to an icon representative for the channel
919
                                    (For v8+ clients this could be a relative /imagecache/ID URL
920 73 Adam Sutton
                                     intended to be fed to fileOpen() or HTTP server)
921 104 Jaroslav Kysela
                                    (For v15+ clients this could be a relative imagecache/ID URL
922
                                     intended to be fed to fileOpen() or HTTP server)
923 66 Adam Sutton
eventId            u32   optional   ID of the current event on this channel.
924
nextEventId        u32   optional   ID of the next event on the channel.
925
tags               u32[] optional   Tags this channel is mapped to.
926
services           msg[] optional   List of available services (Added in version 5)
927 13 Andreas Smas
</pre>
928 1 Andreas Smas
929 66 Adam Sutton
Service fields:
930 1 Andreas Smas
<pre>
931 66 Adam Sutton
name               str   required   Service name
932
type               str   required   Service type
933
caid               u32   optional   Encryption CA ID
934
caname             str   optional   Encryption CA name
935 11 Andreas Smas
</pre>
936 1 Andreas Smas
937 66 Adam Sutton
h3. channelUpdate
938 11 Andreas Smas
939 66 Adam Sutton
Same as channelAdd, but all fields (except channelId) are optional.
940
941 58 sbi -
h3. channelDelete
942 1 Andreas Smas
943
A channel has been deleted on the server.
944 58 sbi -
945
Message fields:
946 1 Andreas Smas
<pre>
947
channelId          u32   required   ID of channel.
948
</pre>
949
950
----
951
952 11 Andreas Smas
h3. tagAdd
953 1 Andreas Smas
954
A new tag has been created on the server.
955
956
Message fields:
957
<pre>
958 66 Adam Sutton
tagId              u32   required   ID of tag.
959
tagName            str   required   Name of tag.
960 117 Jaroslav Kysela
tagIndex           u32   optional   Index value for sorting (default by from min to max) (Added in version 18).
961 66 Adam Sutton
tagIcon            str   optional   URL to an icon representative for the channel.
962
tagTitledIcon      u32   optional   Icon includes a title
963 1 Andreas Smas
members            u32[] optional   Channel IDs of those that belong to the tag
964 11 Andreas Smas
</pre>
965 39 elupus -
966 58 sbi -
h3. tagUpdate
967 66 Adam Sutton
968 11 Andreas Smas
Same as tagAdd, but all fields (except tagId) are optional.
969
970 1 Andreas Smas
h3. tagDelete
971 58 sbi -
972 1 Andreas Smas
A tag has been deleted from the server.
973
974
Message fields:
975 66 Adam Sutton
<pre>
976 58 sbi -
tagId              u32   required   ID of tag.
977
</pre>
978 12 Andreas Smas
979 1 Andreas Smas
----
980 66 Adam Sutton
981 58 sbi -
h3. dvrEntryAdd (Added in version 4)
982 1 Andreas Smas
983 58 sbi -
A new recording has been created on the server.
984 1 Andreas Smas
985 2 Andreas Smas
Message fields:
986 66 Adam Sutton
<pre>
987
id                 u32   required   ID of dvrEntry.
988
channel            u32   required   Channel of dvrEntry.
989
start              s64   required   Time of when this entry was scheduled to start recording.
990 89 Jaroslav Kysela
stop               s64   required   Time of when this entry was scheduled to stop recording.
991
startExtra         s64   required   Extra start time (pre-time) in minutes (Added in version 13).
992 1 Andreas Smas
stopExtra          s64   required   Extra stop time (post-time) in minutes (Added in version 13).
993
retention          s64   required   DVR Entry retention time in days.
994 89 Jaroslav Kysela
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set) (Added in version 13).
995
eventId            u32   optional   Associated EPG Event ID (Added in version 13).
996 117 Jaroslav Kysela
autorecId          str   optional   Associated Autorec UUID (Added in version 13).
997
timerecId          str   optional   Associated Timerec UUID (Added in version 18).
998 89 Jaroslav Kysela
contentType        u32   optional   Content Type (like in the DVB standard) (Added in version 13).
999 66 Adam Sutton
title              str   optional   Title of recording
1000 1 Andreas Smas
summary            str   optional   Short description of the recording (Added in version 6).
1001
description        str   optional   Long description of the recording.
1002 66 Adam Sutton
state              str   required   Recording state
1003
error              str   optional   Plain english error description (e.g. "Aborted by user").
1004 117 Jaroslav Kysela
owner              str   optional   Name of the entry owner (Added in version 18).
1005
creator            str   optional   Name of the entry creator (Added in version 18).
1006 135 Jaroslav Kysela
subscriptionError  str   optional   Subscription error string (Added in version 20).
1007
streamErrors       str   optional   Number of recording errors (Added in version 20).
1008
dataErrors         str   optional   Number of stream data errors (Added in version 20).
1009 1 Andreas Smas
</pre>
1010 66 Adam Sutton
1011 48 mdd -
TODO: recording states
1012
1013
h3. dvrEntryUpdate
1014 66 Adam Sutton
1015
Message fields:
1016
<pre>
1017
Same as dvrEntryAdd, but all fields (except id) are optional.
1018 51 elupus -
</pre>
1019 66 Adam Sutton
1020 58 sbi -
h3. dvrEntryDelete (Added in version 4)
1021 66 Adam Sutton
1022 58 sbi -
A recording has been deleted from the server.
1023 48 mdd -
1024
Message fields:
1025 66 Adam Sutton
<pre>
1026 1 Andreas Smas
id                 u32   required   ID of recording to delete.
1027 48 mdd -
</pre>
1028 58 sbi -
1029 48 mdd -
----
1030 95 Jaroslav Kysela
1031
h3. autorecEntryAdd (Added in version 13)
1032
1033
A new autorec recording has been created on the server.
1034
1035 1 Andreas Smas
Message fields:
1036 95 Jaroslav Kysela
<pre>
1037
id                 str   required   ID (string!) of dvrAutorecEntry.
1038
enabled            u32   required   If autorec entry is enabled (activated).
1039 117 Jaroslav Kysela
name               str   required   Name of the autorec entry (Added in version 18).
1040 95 Jaroslav Kysela
minDuration        u32   required   Minimal duration in seconds (0 = Any).
1041
maxDuration        u32   required   Maximal duration in seconds (0 = Any).
1042
retention          u32   required   Retention time (in days).
1043
daysOfWeek         u32   required   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
1044
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
1045
approxTime         u32   required   Minutes from midnight (up to 24*60).
1046 1 Andreas Smas
startExtra         s64   required   Extra start minutes (pre-time).
1047
stopExtra          s64   required   Extra stop minutes (post-time).
1048 95 Jaroslav Kysela
title              str   optional   Title.
1049 136 Jaroslav Kysela
fulltext           u32   optional   Fulltext flag (Added in version 20).
1050 122 Jaroslav Kysela
directory          str   optional   Forced directory name (Added in version 19).
1051 95 Jaroslav Kysela
channel            u32   optional   Channel ID.
1052 117 Jaroslav Kysela
owner              str   optional   Owner of this autorec entry (Added in version 18).
1053
creator            str   optional   Creator of this autorec entry (Added in version 18).
1054 136 Jaroslav Kysela
dupDetect          u32   optional   Duplicate detection (see addAutorecEntry) (Added in version 20).
1055 95 Jaroslav Kysela
</pre>
1056 1 Andreas Smas
1057 95 Jaroslav Kysela
h3. autorecEntryUpdate (Added in version 13)
1058
1059
Message fields:
1060
<pre>
1061 117 Jaroslav Kysela
Same as autorecEntryAdd but all fields (except id) are optional.
1062 95 Jaroslav Kysela
</pre>
1063
1064 1 Andreas Smas
h3. autorecEntryDelete (Added in version 13)
1065
1066
Message fields:
1067
<pre>
1068
id                 str   required   Autorec Entry ID (string!)
1069 117 Jaroslav Kysela
</pre>
1070
1071
----
1072
1073 118 Jaroslav Kysela
h3. timerecEntryAdd (Added in version 18)
1074 117 Jaroslav Kysela
1075
A new autorec recording has been created on the server.
1076
1077
Message fields:
1078
<pre>
1079
title              str   required   Title for the recordings.
1080 123 Jaroslav Kysela
directory          str   optional   Forced directory name (Added in version 19).
1081 117 Jaroslav Kysela
enabled            u32   required   Title for the recordings.
1082
name               str   required   Name for this timerec entry.
1083
configName         str   required   DVR Configuration Name / UUID.
1084
channelId          u32   required   Channel ID.
1085
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
1086
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
1087
start              u32   required   Minutes from midnight (up to 24*60) for the start of the time window (including)
1088
stop               u32   required   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed)
1089
retention          u32   optional   Retention in days. 
1090
comment            str   optional   User Comment.
1091
owner              str   optional   Owner of this timerec entry.
1092
creator            str   optional   Creator of this timerec entry.
1093
</pre>
1094
1095
h3. timerecEntryUpdate (Added in version 18)
1096
1097
Message fields:
1098
<pre>
1099
Same as timerecEntryAdd but all fields (except id) are optional.
1100
</pre>
1101
1102
h3. timerecEntryDelete (Added in version 18)
1103
1104
Message fields:
1105
<pre>
1106
id                 str   required   Timerec Entry ID (string!)
1107 95 Jaroslav Kysela
</pre>
1108
1109
----
1110
1111 66 Adam Sutton
h3. eventAdd (Added in version 6)
1112 48 mdd -
1113 66 Adam Sutton
Message fields:
1114
<pre>
1115
eventId            u32   required   Event ID
1116
channelId          u32   required   The channel this event is related to.
1117
start              u64   required   Start time of event, UNIX time.
1118
stop               u64   required   Ending time of event, UNIX time.
1119
title              str   optional   Title of event.
1120
summary            str   optional   Short description of the event (Added in version 6).
1121
description        str   optional   Long description of the event.
1122
serieslinkId       u32   optional   Series Link ID (Added in version 6).
1123
episodeId          u32   optional   Episode ID (Added in version 6).
1124
seasonId           u32   optional   Season ID (Added in version 6).
1125
brandId            u32   optional   Brand ID (Added in version 6).
1126
contentType        u32   optional   DVB content code (Added in version 4, Modified in version 6*).
1127
ageRating          u32   optional   Minimum age rating (Added in version 6).
1128
starRating         u32   optional   Star rating (1-5) (Added in version 6).
1129
firstAired         s64   optional   Original broadcast time, UNIX time (Added in version 6).
1130
seasonNumber       u32   optional   Season number (Added in version 6).
1131
seasonCount        u32   optional   Show season count (Added in version 6).
1132
episodeNumber      u32   optional   Episode number (Added in version 6).
1133
episodeCount       u32   optional   Season episode count (Added in version 6).
1134
partNumber         u32   optional   Multi-part episode part number (Added in version 6).
1135
partCount          u32   optional   Multi-part episode part count (Added in version 6).
1136
episodeOnscreen    str   optional   Textual representation of episode number (Added in version 6).
1137
image              str   optional   URL to a still capture from the episode (Added in version 6).
1138
dvrId              u32   optional   ID of a recording (Added in version 5).
1139
nextEventId        u32   optional   ID of next event on the same channel.
1140
</pre>
1141 48 mdd -
1142 66 Adam Sutton
* *contentType previously had the major DVB category in the bottom 4 bits, 
1143
  however in v6 this has been changed to properly match DVB, so top 4 bits
1144
  as major category and bottom 4 bits has sub-category. Clients requesting
1145
  v5 or lower will get the old output.
1146 48 mdd -
1147 66 Adam Sutton
h3. eventUpdate (Added in version 6)
1148 35 Andreas Smas
1149 58 sbi -
Message fields:
1150
<pre>
1151 66 Adam Sutton
Same as eventAdd but all fields (except eventId) are optional.
1152 35 Andreas Smas
</pre>
1153 58 sbi -
1154 77 John Törnblom
h3. eventDelete (Added in version 6)
1155 35 Andreas Smas
1156 66 Adam Sutton
Message fields:
1157
<pre>
1158
eventId            u32   required   Event ID
1159
</pre>
1160 14 Andreas Smas
1161 66 Adam Sutton
---
1162 14 Andreas Smas
1163 66 Adam Sutton
h3. initialSyncCompleted (Added in version 2)
1164 14 Andreas Smas
1165 66 Adam Sutton
Sent after all the initial metadata has been sent when session has been set to async mode.
1166 38 Andreas Smas
1167
Message fields:
1168 14 Andreas Smas
<pre>
1169
</pre>
1170
1171
----
1172
1173
h3. subscriptionStart
1174 53 Andreas Smas
1175 66 Adam Sutton
Asynchronous message output when a new subscription is successfully started.
1176 14 Andreas Smas
1177
Message fields:
1178 1 Andreas Smas
<pre>
1179 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1180
streams            msg[] required   Array of messages with stream information
1181
sourceinfo         msg   optional   Source information.
1182
</pre>
1183 37 Andreas Smas
1184 66 Adam Sutton
Stream message fields:
1185
<pre>
1186
index              u32   required   Index for this stream
1187
type               str   required   Type of stream
1188 113 Jaroslav Kysela
meta               bin   optional   Codec metadata (private data, libav - extradata) (Added in version 17)
1189 66 Adam Sutton
language           str   optional   Language for stream
1190
Video components only:
1191
width              u32   optional   Width of video in pixels
1192
height             u32   optional   Height of video in pixels
1193 68 Andreas Smas
aspect_num         u32   optional   Aspect ratio numerator (Added in version 5) *Can be incorrect and should not be relied upon*
1194
aspect_den         u32   optional   Aspect ratio denonminator (Added in version 5) *Can be incorrect and should not be relied upon*
1195 66 Adam Sutton
Audio components only:
1196 76 Dave Chapman
audio_type         u32   optional   Audio type - 0=Normal; 1=Clean effects; 2=Hearing impaired; 3=Visually impaired commentary; 4-255=Reserved (Added in version 11)
1197 66 Adam Sutton
channels           u32   optional   Number of audio channels (Added in version 5)
1198
rate               u32   optional   Audio bitrate (Added in version 5)
1199
Subtitle components only:
1200
composition_id     u32   optional   ??? (Added in version 5)
1201
ancillary_id       u32   optional   ??? (Added in version 5)
1202
</pre>
1203 2 Andreas Smas
1204 66 Adam Sutton
Sourceinfo message fields:
1205
<pre>
1206
adapter            str   optional   Adapter name
1207
mux                str   optional   Transponder name
1208
network            str   optional   Network name
1209
provider           str   optional   ???
1210
service            str   optional   Service name
1211
</pre>
1212 15 Andreas Smas
1213 66 Adam Sutton
Video Stream types:
1214 1 Andreas Smas
<pre>
1215 79 Jaroslav Kysela
MPEG2VIDEO                    MPEG2 video, meta field is present (configuration blocks)
1216
H264                          H264 video, meta field is present (configuration blocks)
1217
HEVC                          HEVC video, meta field is present (configuration blocks)
1218 66 Adam Sutton
</pre>
1219 15 Andreas Smas
1220 1 Andreas Smas
Audio Stream types:
1221
<pre>
1222 66 Adam Sutton
MPEG2AUDIO                    MPEG2 audio (MP2)
1223
AC3                           AC3 audio
1224 79 Jaroslav Kysela
AAC                           ADTS framed AAC (one AAC packet per ADTS frame), meta field is present (MPEG4 config)
1225 66 Adam Sutton
EAC3                          Enhanced AC3 audio
1226 79 Jaroslav Kysela
VORBIS                        Vorbis audio, meta field is present with the main vorbis header
1227 16 Andreas Smas
</pre>
1228
1229 66 Adam Sutton
Subtitle Stream types:
1230
<pre>
1231
TELETEXT                      ???
1232
DVBSUB                        ???
1233
</pre>
1234 55 Lars Op den Kamp -
1235 112 Jaroslav Kysela
h3. subscriptionGrace
1236
1237
Notifies client about the grace timeout (timeout for stream activation). It can be issues multiple times.
1238
For example a configuration with satellite rotors requires more than 120 seconds to tune, so users
1239
should be notified..
1240
1241
Message fields:
1242
<pre>
1243
subscriptionId     u32   required   Subscription ID.
1244
graceTimeout       u32   required   Grace timeout in seconds.
1245
</pre>
1246
1247 55 Lars Op den Kamp -
h3. subscriptionStop
1248
1249 66 Adam Sutton
A subscription has been stopped.
1250 55 Lars Op den Kamp -
1251
Message fields:
1252
<pre>
1253 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1254 1 Andreas Smas
status             str   optional   Error message if subscription stopped unexpectedly.
1255
</pre>
1256
1257 73 Adam Sutton
h3. subscriptionSkip (Added version 9)
1258
1259
A subscription has been skipped.
1260
1261
Message fields:
1262
<pre>
1263
subscriptionId     u32   required   Subscription ID.
1264
error              u32   optional   The last skip command caused an error.
1265
absolute           u32   optional   Indicates the output is absolute (Note: should always be 1 at the moment)
1266
time               u64   optional   The time the subscription has skipped to.
1267
size               u64   optional   The position in the file we've skipped to (Note: not currently used).
1268
</pre>
1269
1270
h3. subscriptionSpeed (Added version 9)
1271
1272
A subscription's playback speed has changed.
1273
1274
This can happen even without a speed request, should playback reach either end of the buffer.
1275
1276
Message fields:
1277
<pre>
1278
subscriptionId     u32   required   Subscription ID.
1279
speed              u32   required   The new speed of the subscription
1280
</pre>
1281
1282 55 Lars Op den Kamp -
h3. subscriptionStatus
1283
1284 66 Adam Sutton
Subscription status update.
1285 58 sbi -
1286
Message fields:
1287
<pre>
1288 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1289
status             str   optional   English clear text of error status. Absence of this field means that the status is OK. 
1290 16 Andreas Smas
</pre>
1291 58 sbi -
1292 16 Andreas Smas
h3. queueStatus
1293
1294 1 Andreas Smas
The queueStatus message is sent every second during normal data delivery.
1295 60 John Törnblom
1296
The transmit scheduler have different drop thresholds for different frame types.
1297 66 Adam Sutton
1298 1 Andreas Smas
If congestion occurs it will favor dropping B-frames before P-frames before I-frames.
1299
All audio is recognized as I-frames. 
1300 58 sbi -
1301 1 Andreas Smas
Message fields:
1302
<pre>
1303 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1304
packets            u32   required   Number of data packets in queue.
1305
bytes              u32   required   Number of bytes in queue.
1306
delay              u32   optional   Estimated delay of queue (in µs).
1307 1 Andreas Smas
Bdrops             u32   required   Number of B-frames dropped
1308 66 Adam Sutton
Pdrops             u32   required   Number of P-frames dropped
1309
Idrops             u32   required   Number of I-frames dropped
1310 73 Adam Sutton
delay              s64   required   Delta between first and last DTS (Added in version 9)
1311 1 Andreas Smas
</pre>
1312
1313
h3. signalStatus
1314
1315
The signalStatus message is sent every second during normal data delivery.
1316
1317
The optional fields may not have been implemented or may not be supported by the active adapter.
1318
1319
Message fields:
1320
<pre>
1321 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1322
feStatus           str   required   Frontend status.
1323
feSNR              u32   optional   Signal to noise ratio.
1324 1 Andreas Smas
feSignal           u32   optional   Signal status percentage.
1325
feBER              u32   optional   Bit error rate.
1326
feUNC              u32   optional   Uncorrected blocks.
1327 73 Adam Sutton
</pre>
1328
1329
h3. timeshiftStatus
1330
1331
Provide status every second about the timeshift buffer.
1332
1333
Message fields:
1334
<pre>
1335
subscriptionId     u32   required   Subscription ID.
1336
full               u32   required   Indicates whether the buffer is full
1337
shift              s64   required   Current position relative to live
1338
start              s64   optional   PTS of the first frame in the buffer
1339
end                s64   optional   PTS of the last frame in the buffer
1340 1 Andreas Smas
</pre>
1341
1342
h3. muxpkt
1343
1344
Streaming data.
1345
1346
Message fields:
1347
<pre>
1348 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1349
frametype          u32   required   Type of frame as ASCII value: 'I', 'P', 'B'
1350
stream             u32   required   Stream index. Corresponds to the streams reported in the subscriptionStart message.
1351
dts                s64   optional   Decode Time Stamp in µs.
1352
pts                s64   optional   Presentation Time Stamp in µs.
1353
duration           u32   required   Duration of frame in µs.
1354
payload            bin   required   Actual frame data.
1355 1 Andreas Smas
</pre>