Media streaming server based on nginx-module-rtmp
134 — 所有核心与模块指令——语法、默认值、上下文与真实配置示例。
access_log
'access_log' 指令记录 NGINX 的 RTMP 模块中对媒体流的访问请求。
ack_window
`ack_window` 指令设置用于 RTMP 流管理的确认窗口大小。
allow
'allow' 指令控制 NGINX 中对 RTMP 流的访问权限。
application
`application` 指令为在 NGINX RTMP 模块中配置媒体流应用程序定义了一个上下文。
buffer
'buffer' 指令在 NGINX RTMP 模块中配置媒体流的缓冲区大小,用于控制流媒体传输过程中的数据处理。
buflen
The 'buflen' 指令在 NGINX 的 RTMP 模块中设置媒体流的缓冲长度,用于优化流媒体性能。
busy
nginx-module-rtmp 模块中的 'busy' 指令用于配置服务器在媒体流传输时可处理的最大同时连接数。
chunk_size
在 NGINX RTMP 模块中,'chunk_size' 指令用于配置在媒体流传输过程中发送的数据块大小。
connection_pool_size
指令 `connection_pool_size` 设置用于处理媒体流的 RTMP 服务器的连接池大小。
dash
'dash' 指令在 RTMP 应用中启用基于 HTTP 的动态自适应流式传输 (DASH)。
dash_cleanup
dash_cleanup 指令控制从服务器存储中自动清理未使用的 DASH 片段。
dash_fragment
'dash_fragment' 指令在媒体流应用中设置 DASH 分片的持续时间。
dash_nested
'dash_nested' 指令用于在 NGINX RTMP 模块中启用或禁用对嵌套 DASH 分段的支持。
dash_path
`dash_path` 指令指定用于存储 DASH (Dynamic Adaptive Streaming over HTTP) 文件的目录路径。
dash_playlist_length
设置用于媒体流的 DASH 播放列表的长度。
deny
在 NGINX RTMP 模块的配置中,`deny` 指令用于限制对指定客户端的访问。
drop_idle_publisher
`drop_idle_publisher` 指令控制在指定超时时间后对空闲 RTMP 推流者的自动断开连接。
exec
'exec' 指令允许在 NGINX RTMP 模块上下文中执行外部命令或脚本。
exec_block
`exec_block` 指令允许你指定一段代码块,在 RTMP 服务器的流媒体操作上下文中执行。
exec_kill_signal
指令 `exec_kill_signal` 指定应发送的信号,用于终止与 RTMP 或 DASH 流关联的流处理进程。
exec_options
exec_options 指令为 NGINX RTMP 模块中的 DASH 流会话配置执行选项。
exec_play
exec_play 指令允许在媒体流播放时执行命令或脚本。
exec_play_done
`exec_play_done` 指令指定在 RTMP 流播放完成时要执行的命令。
exec_publish
exec_publish 指令允许在向服务器发布流时执行指定命令。
exec_publish_done
exec_publish_done 指令指定在 NGINX RTMP 模块的发布会话结束后要执行的命令。
exec_pull
exec_pull 指令用于指定在 RTMP 应用中拉取媒体流时要执行的外部命令。
exec_push
`exec_push` 指令会在 RTMP 流媒体传输过程中触发执行外部命令。
exec_record_done
exec_record_done 指令指定在 NGINX 的 RTMP 模块中,当流的录制完成时需要执行的命令。
exec_static
`exec_static` 指令配置 RTMP 服务器以执行静态文件交付操作。
flv_live
`flv_live` 指令通过 NGINX RTMP 模块启用对 FLV 内容的实时流式传输。
location
gop_cache
`gop_cache` 指令在 NGINX 中为视频流启用 GOP(图像组)缓存。
gop_max_audio_count
'gop_max_audio_count' 指令限制了单个 GOP (Group of Pictures) 中用于媒体流的音频样本的最大数量。
gop_max_frame_count
The `gop_max_frame_count` 指令限制视频流中一组图像 (GOP) 的帧数。
gop_max_video_count
`gop_max_video_count` 指令限制自适应流媒体中一个图像组 (GOP) 内的视频段最大数量。
hls
`hls` 指令启用 NGINX 中使用 RTMP 模块的 HTTP Live Streaming (HLS) 媒体流。
hls_audio_buffer_size
`hls_audio_buffer_size` 指令设置 HLS 流中音频片段的缓冲区大小。
hls_base_url
指令 `hls_base_url` 指定了 NGINX RTMP 模块中 HLS 媒体播放列表和媒体片段资源的基础 URL。
hls_cleanup
指令 `hls_cleanup` 控制 NGINX RTMP 模块中 HLS(HTTP Live Streaming)片段的清理。
hls_continuous
'hls_continuous' 指令决定在直播结束后 HLS 流是否继续提供直播片段。
hls_fragment
'hls_fragment' 指令设置由 RTMP 服务器生成的 HLS 段的持续时间。
hls_fragment_naming
在 NGINX 的媒体流服务器中,`hls_fragment_naming` 指令决定 HLS 片段文件的命名方案。
hls_fragment_naming_granularity
指令 `hls_fragment_naming_granularity` 控制 HLS 片段文件的命名约定模式。
hls_fragment_slicing
指令 `hls_fragment_slicing` 控制用于流媒体的 HLS 片段切分。
hls_fragments_per_key
指令 `hls_fragments_per_key` 定义与单个加密密钥关联的 HLS 片段数量。
hls_key_path
指令 `hls_key_path` 指定用于媒体分段流式传输的 HLS 加密密钥的文件路径。
hls_key_url
指令 `hls_key_url` 指定用于检索 HLS 流的加密密钥的 URL。
hls_keys
'hls_keys' 指令指定 NGINX RTMP 模块所提供的 HLS 分段的加密密钥。
hls_max_audio_delay
指令 `hls_max_audio_delay` 设置 HLS 流中允许的最大音频延迟。
hls_max_fragment
'hls_max_fragment' 指令设置由 NGINX 中的 RTMP 服务器模块生成的 HLS 片段的最大持续时间。
hls_muxdelay
在使用 HLS 流媒体时,`hls_muxdelay` 指令指定片段之间允许的最大延迟。
hls_nested
指令 `hls_nested` 控制 HLS 段是否嵌套在父目录结构中。
hls_path
`hls_path` 指令指定存放 HLS 片段文件的目录。
hls_playlist_length
`hls_playlist_length` 指令指定 HLS 播放列表的持续时间(以秒为单位)。
hls_sync
'hls_sync' 指令为 RTMP 流中的 HLS 输出设置同步点。
hls_type
'hls_type' 指令定义了用于 NGINX 媒体流中的 HLS 分段类型。
hls_variant
`hls_variant` 指令允许在 NGINX 中配置多个 HLS 流变体,以实现自适应码率流媒体。
idle_streams
'idle_streams' 指令在 NGINX RTMP 模块中配置在 NGINX 自动关闭它们之前允许的空闲流数量。
interleave
'interleave' 指令可在 RTMP (Real-Time Messaging Protocol) 流中对音频和视频流进行交错。
listen
`listen` 指令指定 NGINX 用于接收传入 RTMP 连接以进行媒体流传输的地址和端口。
live
'live' 指令为 NGINX RTMP 服务器启用实时流功能。
log_format
指令 `log_format` 定义了 RTMP 模块中流媒体事件日志消息的格式。
log_interval
`log_interval` 指令指定 NGINX RTMP 模块中用于媒体流的统计日志记录间隔。
log_size
`log_size` 指令设置 NGINX RTMP 模块生成的日志文件的最大大小。
max_connections
`max_connections` 指令设置允许媒体流服务器的最大并发连接数。
max_message
指令 'max_message' 设置在 RTMP 流中发送消息的最大大小。
max_streams
The `max_streams` 指令设置 RTMP(实时消息传输协议)应用的最大并发流数量。
merge_slashes
`merge_slashes` 指令控制在 RTMP 流处理期间,URI 中的多个连续斜杠是否合并为单个斜杠。
meta
nginx-module-rtmp 模块中的 'meta' 指令为媒体流上下文指定元数据。
netcall_buffer
"netcall_buffer" 指令在 RTMP 媒体流服务器中配置用于网络调用的缓冲区大小。
netcall_timeout
netcall_timeout 指令指定在 RTMP 模块中等待网络调用完成的最大持续时间。
notify_method
'notify_method' 指令指定在 NGINX RTMP 模块中,如何为 RTMP 媒体流发送通知。
notify_no_resolve
`notify_no_resolve` 指令禁用服务器名称的 DNS 解析,允许在 RTMP 流通知期间使用原始 IP 地址。
notify_relay_redirect
指令 `notify_relay_redirect` 用于指定一个 URL,RTMP 服务器会将通知重定向到该 URL。
notify_update_strict
'notify_update_strict' 指令在 RTMP 服务器模块中配置严格的通知处理。
notify_update_timeout
指令 `notify_update_timeout` 指定在 RTMP 流中通知客户端更新的超时时长。
on_connect
指令 'on_connect' 指定了一个回调函数,当客户端连接到媒体流时执行该函数。
on_disconnect
指令 `on_disconnect` 指定一个回调函数,当客户端与 RTMP 服务器断开连接时执行。
on_done
`on_done` 指令指定在 RTMP 流会话结束时要执行的回调函数。
on_play
NGINX RTMP 模块中的 `on_play` 指令在流开始播放时触发特定操作或回调。
on_play_done
`on_play_done` 指令允许在 NGINX 的 RTMP 模块中配置在流播放完成时要执行的操作。
on_publish
NGINX 中的 `on_publish` 指令允许指定在流发布时执行的处理程序。
on_publish_done
在 RTMP 应用中,`on_publish_done` 指令指定在发布会话完成时要执行的回调函数。
on_record_done
NGINX RTMP 模块中的 `on_record_done` 指令在录制完成后触发一个操作。
on_update
The `on_update` 指令允许在流会话更新时定义并执行自定义操作。
out_cork
'out_cork' 指令控制 RTMP 环境中媒体输出的缓冲行为。
out_queue
'out_queue' 指令用于在 NGINX 中配置 RTMP 流媒体的输出队列设置。
ping
'ping' 指令用于在 NGINX 媒体流服务器中配置 RTMP 会话的 ping 行为。
ping_timeout
`ping_timeout` 指令指定服务器在将连接视为不活动并最终关闭之前,等待客户端对 ping 响应的最长时间。
play
'play' 指令在 NGINX RTMP 模块中允许客户端从服务器回放实时或已录制的流。
play_local_path
指令 `play_local_path` 指定在 RTMP 流媒体传输期间用于提供媒体文件的本地文件系统路径。
play_restart
`play_restart` 指令控制 NGINX 的 RTMP 模块中回放会话的行为,特别是允许会话在结束时重新启动。
play_temp_path
在 NGINX RTMP 应用中,指令`play_temp_path`指定用于在播放期间存放媒体碎片的临时目录。
play_time_fix
`play_time_fix` 指令用于修改 RTMP 流的回放时间调整。
publish_notify
指令 `publish_notify` 在流发布时配置通知回调。
publish_time_fix
publish_time_fix 指令可确保流媒体的发布时间被正确调整。
pull
`pull` 指令用于指定要拉入本地 RTMP 服务器的远程 RTMP 流,以便进行广播或处理。
pull_reconnect
`pull_reconnect` 指令用于配置 NGINX RTMP 模块中拉取流的重连行为。
push
NGINX RTMP 模块中的 'push' 指令用于将直播流推送到外部流媒体服务器或端点。
push_reconnect
push_reconnect 指令控制 NGINX RTMP 模块中 push client 的重连行为。
record
NGINX RTMP 模块中的 'record' 指令用于配置将直播流录制到文件。
record_append
`record_append` 指令指定将录制的 RTMP 流数据追加到哪个文件。
record_interval
`record_interval` 指令用于配置 RTMP 模块中录制媒体流的时间间隔。
record_lock
`record_lock` 指令用于启用或禁用 RTMP 流录制的锁定机制,以防止同时写入。
record_max_frames
`record_max_frames` 指令设置 NGINX RTMP 模块中每个流可记录的最大帧数限制。
record_max_size
在 RTMP 服务器上下文中,`record_max_size` 指令指定了媒体流录制分段的最大大小。
record_notify
`record_notify` 指令用于在 RTMP 模块中配置录制事件的通知。
record_path
'record_path' 指令指定在 RTMP 应用中用于录制流媒体的文件路径。
record_suffix
`record_suffix` 指令指定录制媒体流的文件扩展名。
record_unique
NGINX RTMP 模块中的 `record_unique` 指令用于根据特定参数以唯一的文件名保存 RTMP 流的录制文件。
recorder
'recorder' 指令用于在 NGINX RTMP 服务器中指定记录媒体流的设置。
relay_buffer
'relay_buffer' 指令在 NGINX RTMP 模块中配置用于流式媒体片段的缓冲区大小。
resolver
resolver 指令用于在 RTMP 流媒体场景中配置域名的 DNS 解析。
resolver_timeout
`resolver_timeout` 指令用于在 NGINX 的 RTMP (Real-Time Messaging Protocol)…
respawn
`respawn` 指令指示 NGINX RTMP 模块在流媒体会话变为不活跃或发生故障时自动重新启动该会话。
respawn_timeout
respawn_timeout 指令设置服务器在故障后尝试重启流处理进程之前应等待的时间间隔。
rtmp
'rtmp' 指令在 NGINX 中启用 RTMP 流媒体服务器,是处理 RTMP 协议操作的基础。
main
rtmp_auto_push
在 NGINX 的 RTMP 模块中,`rtmp_auto_push` 指令启用将流式媒体自动推送到已定义端点的功能。
main
rtmp_auto_push_reconnect
在 NGINX RTMP 服务器配置中,`rtmp_auto_push_reconnect` 指令启用对 RTMP(实时消息传输协议)推流的自动重连尝试。
main
rtmp_control
The `rtmp_control` 指令为 NGINX 中的媒体流应用配置 RTMP 流控制参数。
httpserverlocation
rtmp_socket_dir
指令 `rtmp_socket_dir` 设置 NGINX RTMP 模块 使用的 RTMP socket files 的目录。
main
rtmp_stat
`rtmp_stat` 指令启用流媒体应用的 RTMP 状态,提供有关流会话的实时统计信息。
httpserverlocation
rtmp_stat_format
`rtmp_stat_format` 指令指定 NGINX 中 RTMP 流的统计输出格式。
httpserverlocation
rtmp_stat_stylesheet
`rtmp_stat_stylesheet` 指令指定用于 RTMP 统计 HTML 输出的自定义样式表的路径。
httpserverlocation
send_lowat
`send_lowat` 指令限制在套接字上发送的数据量,以防止淹没网络接口。
send_timeout
`send_timeout` 指令设置向客户端传输响应的超时时间。
server
nginx-rtmp 模块中的 'server' 指令用于为媒体流配置 RTMP 服务器实例。
server_name
在 NGINX 中,'server_name' 指令指定了 server 块应该响应的主机名。
session_relay
用于在 NGINX 的 RTMP 模块中管理会话中继的 `session_relay` 指令。
so_keepalive
在 RTMP 中,`so_keepalive` 指令用于启用或禁用流套接字上的 TCP keepalive 选项。
stream_buckets
配置 NGINX RTMP 模块用于媒体流传输的内部缓冲区大小。
sync
'sync' 指令指定 nginx-module-rtmp 模块中媒体流的同步设置。
timeout
`timeout` 指令定义了在 NGINX 媒体流服务器上一个会话被视为不活动并可以关闭之前的持续时间。
wait_key
'wait_key' 指令控制流在开始播放之前是否等待关键帧。
wait_video
`wait_video` 指令配置 RTMP 流服务器在开始播放前等待视频数据。