diff xml/en/docs/http/ngx_http_mp4_module.xml @ 953:aded7086e84f

Commercial version documentation.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 01 Aug 2013 16:31:02 +0400
parents 77a3314c74a7
children 488a3f738db0
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_mp4_module.xml	Wed Jul 31 23:46:04 2013 +0400
+++ b/xml/en/docs/http/ngx_http_mp4_module.xml	Thu Aug 01 16:31:02 2013 +0400
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_mp4_module"
         link="/en/docs/http/ngx_http_mp4_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -100,8 +100,10 @@
 <example>
 location /video/ {
     mp4;
-    mp4_buffer_size     1m;
-    mp4_max_buffer_size 5m;
+    mp4_buffer_size       1m;
+    mp4_max_buffer_size   5m;
+    mp4_limit_rate        on;
+    mp4_limit_rate_after  30s;
 }
 </example>
 </para>
@@ -158,6 +160,53 @@
 
 </directive>
 
+
+<directive name="mp4_limit_rate">
+<syntax>
+    <literal>on</literal> |
+    <literal>off</literal> |
+    <value>factor</value></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+
+<para>
+Enables or disables rate limiting based on an average bitrate of the
+MP4 file served.
+To calculate the rate, bitrate is multiplied by the specified
+<value>factor</value>.
+The special value “<literal>on</literal>” corresponds to a factor of 1.1.
+</para>
+
+<para>
+<note>
+This directive is available as part of our <commercial_version/> only.
+</note>
+</para>
+
+</directive>
+
+
+<directive name="mp4_limit_rate_after">
+<syntax><value>time</value></syntax>
+<default>1m</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+
+<para>
+Limits rate after sending the specified amount of media data.
+</para>
+
+<para>
+<note>
+This directive is available as part of our <commercial_version/> only.
+</note>
+</para>
+
+</directive>
+
 </section>
 
 </module>