模块 ngx_http_hls_module


示例Directives
hls
hls_buffers hls_forward_args

hls_fragment
hls_mp4_buffer_size
hls_mp4_max_buffer_size

ngx_http_hls_module模块提供 HTTP Live Streaming (HLS) 对 MP4 和 MOV 媒体文件的服务器端支持。 此类文件通常具有.mp4,.m4v,.m4a,.mov.qt文件扩展名。 该模块支持 H.264 视频编解码器、AAC 和 MP3 音频编解码器。

对于每个媒体文件,支持两个 URI:

  • 带有 ”.m3u8“ 文件扩展名。 URI 可以接受可选参数:
    • start“ 和 ”end” 以秒为单位定义播放列表边界 (1.9.0)。
    • offset“ 移动初始播放位置 设置为以秒为单位的时间偏移量 (1.9.0)。 正值设置与播放列表开头的时间偏移量。 负值设置时间偏移量 从播放列表中最后一个片段的末尾开始。
    • len“ 定义片段长度(以秒为单位)。
  • 带有 ”.ts“ 文件扩展名。 URI 可以接受可选参数:
    • start“ 和 ”end” 定义 Fragment 边界(以秒为单位)。

此模块作为我们商业订阅的一部分提供。

示例配置

location / {
    hls;
    hls_fragment            5s;
    hls_buffers             10 10m;
    hls_mp4_buffer_size     1m;
    hls_mp4_max_buffer_size 5m;
    root /var/video/;
}

使用此配置,支持以下 URI “/var/video/test.mp4“ 文件:

http://hls.example.com/test.mp4.m3u8?offset=1.000&start=1.000&end=2.200
http://hls.example.com/test.mp4.m3u8?len=8.000
http://hls.example.com/test.mp4.ts?start=1.000&end=2.200

Directives

语法: hls;
默认值:
上下文: location

在周围位置打开 HLS 流式传输。

语法: hls_buffers number size;
默认值:
hls_buffers 8 2m;
上下文: http,server,location

设置最大值numbersize缓冲区 用于读取和写入数据帧。

语法: hls_forward_args on | off;
默认值:
hls_forward_args off;
上下文: http,server,location

该Directives出现在版本 1.5.12 中。

将播放列表请求中的参数添加到片段的 URI。 这对于在 请求片段,或者在使用 ngx_http_secure_link_module 模块保护 HLS 流时。

例如,如果客户端请求播放列表http://example.com/hls/test.mp4.m3u8?a=1&b=2, 参数a=1b=2将添加到 fragment 的 URI 中的参数startend:

#EXTM3U
#EXT-X-VERSION:3
#EXT-X-TARGETDURATION:15
#EXT-X-PLAYLIST-TYPE:VOD

#EXTINF:9.333,
test.mp4.ts?start=0.000&end=9.333&a=1&b=2
#EXTINF:7.167,
test.mp4.ts?start=9.333&end=16.500&a=1&b=2
#EXTINF:5.416,
test.mp4.ts?start=16.500&end=21.916&a=1&b=2
#EXTINF:5.500,
test.mp4.ts?start=21.916&end=27.416&a=1&b=2
#EXTINF:15.167,
test.mp4.ts?start=27.416&end=42.583&a=1&b=2
#EXTINF:9.626,
test.mp4.ts?start=42.583&end=52.209&a=1&b=2

#EXT-X-ENDLIST

如果 HLS 流使用 ngx_http_secure_link_module 模块进行保护,$uri不应在 secure_link_md5 表达式中使用,因为这会在请求片段时导致错误。应使用基本 URI 而不是$uri ($hls_uri在示例中):

http {
    ...

    map $uri $hls_uri {
        ~^(?<base_uri>.*).m3u8$ $base_uri;
        ~^(?<base_uri>.*).ts$   $base_uri;
        default                 $uri;
    }

    server {
        ...

        location /hls/ {
            hls;
            hls_forward_args on;

            alias /var/videos/;

            secure_link $arg_md5,$arg_expires;
            secure_link_md5 "$secure_link_expires$hls_uri$remote_addr secret";

            if ($secure_link = "") {
                return 403;
            }

            if ($secure_link = "0") {
                return 410;
            }
        }
    }
}

语法: hls_fragment time;
默认值:
hls_fragment 5s;
上下文: http,server,location

定义请求的播放列表 URI 的默认片段长度,而不使用 “len“ 参数。

语法: hls_mp4_buffer_size size;
默认值:
hls_mp4_buffer_size 512k;
上下文: http,server,location

设置初始size缓冲区的 处理 MP4 和 MOV 文件。

语法: hls_mp4_max_buffer_size size;
默认值:
hls_mp4_max_buffer_size 10m;
上下文: http,server,location

在元数据处理期间,可能需要更大的缓冲区。 其大小不能超过指定的size, 否则 nginx 将返回服务器错误 500(internal服务器错误)、 并记录以下消息:

"/some/movie/file.mp4" mp4 moov atom is too large:
12583268, you may want to increase hls_mp4_max_buffer_size