Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_f4f_module.xml @ 3039:e6b785b7e308

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Minor fixes in njs documentation.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 06 Feb 2024 08:52:52 +0000
parents 4e20e4f8f49b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 -->
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 <module name="Module ngx_http_f4f_module"
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 link="/en/docs/http/ngx_http_f4f_module.html"
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 lang="en"
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 rev="1">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
956
488a3f738db0 Text revision of commercial modules.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 953
diff changeset
17 The <literal>ngx_http_f4f_module</literal> module provides
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 server-side support for Adobe HTTP Dynamic Streaming (HDS).
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 <para>
956
488a3f738db0 Text revision of commercial modules.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 953
diff changeset
22 This module implements handling of HTTP Dynamic Streaming requests in the
488a3f738db0 Text revision of commercial modules.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 953
diff changeset
23 “<literal>/videoSeg1-Frag1</literal>” form — extracting the needed fragment
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 from the <path>videoSeg1.f4f</path> file using the <path>videoSeg1.f4x</path>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 index file.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 This module is an alternative to the Adobe’s f4f module (HTTP Origin Module)
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 for Apache.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 Usual pre-processing with Adobe’s f4fpackager is required, see relevant
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 documentation for details.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <note>
1128
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1088
diff changeset
37 This module is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1088
diff changeset
38 <commercial_version>commercial subscription</commercial_version>.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 </note>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <section id="example" name="Example Configuration">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <example>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 location /video/ {
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 f4f;
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 ...
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 }
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 </example>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <section id="directives" name="Directives">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <directive name="f4f">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <syntax/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <default/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <para>
956
488a3f738db0 Text revision of commercial modules.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 953
diff changeset
67 Turns on module processing in the surrounding location.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 <directive name="f4f_buffer_size">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <syntax><value>size</value></syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <default>512k</default>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <context>http</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 <context>server</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <para>
1153
4e20e4f8f49b Finished truncation of "memory buffers" to just "buffers".
Ruslan Ermilov <ru@nginx.com>
parents: 1128
diff changeset
81 Sets the <value>size</value> of the buffer used for
4e20e4f8f49b Finished truncation of "memory buffers" to just "buffers".
Ruslan Ermilov <ru@nginx.com>
parents: 1128
diff changeset
82 reading the <path>.f4x</path> index file.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 </module>