comparison xml/en/docs/http/ngx_http_hls_module.xml @ 1476:c20c2b945f8c

Added new URI arguments, corrected file formats in hls.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 15 May 2015 16:11:59 +0300
parents 0ffd5caf0766
children ad8a1fae0b72
comparison
equal deleted inserted replaced
1475:1179ca80e110 1476:c20c2b945f8c
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_hls_module" 9 <module name="Module ngx_http_hls_module"
10 link="/en/docs/http/ngx_http_hls_module.html" 10 link="/en/docs/http/ngx_http_hls_module.html"
11 lang="en" 11 lang="en"
12 rev="4"> 12 rev="5">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_hls_module</literal> module provides HTTP Live Streaming 17 The <literal>ngx_http_hls_module</literal> module provides HTTP Live Streaming
18 (HLS) server-side support for H.264/AAC files. 18 (HLS) server-side support for MP4 and MOV media files.
19 Such files typically have the <path>.mp4</path>, <path>.m4v</path>, 19 Such files typically have the <path>.mp4</path>, <path>.m4v</path>,
20 or <path>.m4a</path> filename extensions. 20 <path>.m4a</path>, <path>.mov</path> or <path>.qt</path> file extensions.
21 </para> 21 The module supports H.264 video codec, AAC and MP3 audio codecs.
22 22 </para>
23 <para> 23
24 nginx supports two URIs for each MP4 file: 24 <para>
25 For each media file, two types of URI are supported:
25 <list type="bullet"> 26 <list type="bullet">
26 27
27 <listitem> 28 <listitem>
28 The playlist URI that ends with “<literal>.m3u8</literal>” and accepts 29 a playlist URI with the “<literal>.m3u8</literal>” file extension.
29 the optional “<literal>len</literal>” argument that defines the fragment length 30 The URI can accept optional arguments:
30 in seconds; 31 <list type="bullet">
31 </listitem> 32
32 33 <listitem>
33 <listitem> 34 “<literal>start</literal>” and “<literal>end</literal>”
34 The fragment URI that ends with “<literal>.ts</literal>” and accepts 35 define playlist boundaries in seconds (1.9.0);
36 </listitem>
37
38 <listitem>
39 “<literal>offset</literal>” shifts an initial playback position
40 to the time offset in seconds (1.9.0).
41 A positive value sets a time offset from the beginning of the playlist.
42 A negative value sets a time offset
43 from the end of the last fragment in the playlist;
44 </listitem>
45
46 <listitem>
47 “<literal>len</literal>” defines the fragment length in seconds,
48 </listitem>
49 </list>
50
51 </listitem>
52
53 <listitem>
54 a fragment URI with the “<literal>.ts</literal>” file extension.
55 The URI can accept optional
35 “<literal>start</literal>” and “<literal>end</literal>” arguments that 56 “<literal>start</literal>” and “<literal>end</literal>” arguments that
36 define fragment boundaries in seconds. 57 define fragment boundaries in seconds.
37 </listitem> 58 </listitem>
38 59
39 </list> 60 </list>
63 } 84 }
64 </example> 85 </example>
65 With this configuration, the following URIs are supported for 86 With this configuration, the following URIs are supported for
66 the “<path>/var/video/test.mp4</path>” file: 87 the “<path>/var/video/test.mp4</path>” file:
67 <example> 88 <example>
89 http://hls.example.com/video/test.mp4.m3u8?offset=1.000&amp;start=1.000&amp;end=2.200
68 http://hls.example.com/video/test.mp4.m3u8?len=8.000 90 http://hls.example.com/video/test.mp4.m3u8?len=8.000
69 http://hls.example.com/video/test.mp4.ts?start=1.000&amp;end=2.200 91 http://hls.example.com/video/test.mp4.ts?start=1.000&amp;end=2.200
70 </example> 92 </example>
71 </para> 93 </para>
72 94
216 <context>server</context> 238 <context>server</context>
217 <context>location</context> 239 <context>location</context>
218 240
219 <para> 241 <para>
220 Sets the initial <value>size</value> of the buffer used for 242 Sets the initial <value>size</value> of the buffer used for
221 processing MP4 files. 243 processing MP4 and MOV files.
222 </para> 244 </para>
223 245
224 </directive> 246 </directive>
225 247
226 248