Project

General

Profile

Htsp » History » Version 120

Jaroslav Kysela, 2015-05-29 22:04

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