Project

General

Profile

Htsp » History » Version 107

Jaroslav Kysela, 2014-10-19 21:24

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