博主个人微信:xituxiaoshutong100

ZLMediaKit教程(二)主程序和配置文件

ZLMediaKit 迷途小书童 0评论

环境

主服务程序

ZLMediaKit 源码编译完成后,会生成主服务程序 MediaServer ,其路径是 release/linux

MediaServer 的启动参数如下

(base) xugaoxiang@1070Ti:~/workshop/github/ZLMediaKit/release/linux$ ./MediaServer -h
  -h  --help     无参  默认:null                                                                   选填  打印此信息
  -d  --daemon   无参  默认:null                                                                   选填  是否以Daemon方式启动
  -l  --level    有参  默认:0                                                                      选填  日志等级,LTrace~LError(0~4)
  -m  --max_day  有参  默认:7                                                                      选填  日志最多保存天数
  -c  --config   有参  默认:/home/xugaoxiang/workshop/github/ZLMediaKit/release/linux/config.ini   选填  配置文件路径
  -s  --ssl      有参  默认:/home/xugaoxiang/workshop/github/ZLMediaKit/release/linux/default.pem  选填  ssl证书文件或文件夹,支持p12/pem类型
  -t  --threads  有参  默认:4                                                                      选填  启动事件触发线程数
  -v  --version  无参  默认:null                                                                   选填  显示版本号

参数的含义,原作者非常用心,在帮助信息里写的很清楚,点个赞

配置文件详解

当主程序 MediaServer 启动时,默认使用的配置文件是其同目录下的 config.inirelease/linux/config.ini,当然也可以通过 -c 参数来指定其它路径下的配置文件

./MediaServer -c test.ini

下面我们来看看配置文件中的各个配置项及其含义

; auto-generated by mINI class {

[api]
# http api debug开关,启用调试后,会打印每次http请求的内容和回复
apiDebug=1

# 默认截图图片,在启动ffmpeg截图后
defaultSnap=./www/logo.png

# 添加secret来提高访问的安全性
secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc

# 截图的保存路径,截图通过 http api(/index/api/getSnap)生成和获取
snapRoot=./www/snap/

[ffmpeg]
# ffmpeg可执行程序路径
bin=/usr/bin/ffmpeg

# ffmpeg拉流再推流的命令行模板
cmd=%s -re -i %s -c:a aac -strict -2 -ar 44100 -ab 48k -c:v libx264 -f flv %s

# ffmpeg日志的路径
log=./ffmpeg/ffmpeg.log

# ffmpeg截图的命令参数
snap=%s -i %s -y -f mjpeg -t 0.001 %s

[general]
# 是否添加静音音频
addMuteAudio=1

# 是否启用虚拟机
enableVhost=0

# 转协议是否全局开启或关闭音频
enable_audio=1

# 播放器或推流器在断开后会触发hook.on_flow_report事件(使用多少流量事件),flowThreshold参数控制触发hook.on_flow_report事件阈值,使用流量超过该阈值后才触发,单位KB
flowThreshold=1024

# http[s]-fmp4、ws[s]-fmp4协议是否按需生成
fmp4_demand=0

# hls协议是否按需生成,如果hls.segNum配置为0(意味着hls录制),那么hls将一直生成(不管此开关)
hls_demand=0

# 播放最多等待时间,单位毫秒。播放在播放某个流时,如果该流不存在,ZLMediaKit会最多让播放器等待maxStreamWaitMS毫秒,如果在这个时间内,该流注册成功,那么会立即返回播放器播放成功,否则返回播放器未找到该流,该机制的目的是可以先播放再推流
maxStreamWaitMS=15000

# 服务器唯一id,用于触发hook时区别是哪台服务器
mediaServerId=NGQg5lh0WnNf8P64

# 合并写缓存大小(单位毫秒),合并写指服务器缓存一定的数据后才会一次性写入socket,这样能提高性能,但是会提高延时,开启后会同时关闭TCP_NODELAY并开启MSG_MORE
mergeWriteMS=0

# 全局的时间戳覆盖开关,在转协议时,对frame进行时间戳覆盖,该开关对rtsp/rtmp/rtp推流、rtsp/rtmp/hls拉流代理转协议时生效会直接影响rtsp/rtmp/hls/mp4/flv等协议的时间戳,同协议情况下不影响(例如rtsp/rtmp推流,那么播放rtsp/rtmp时不会影响时间戳)
modifyStamp=0

# 是否默认推流时转换成hls,hook接口(on_publish)中可以覆盖该设置
publishToHls=1

# 是否默认推流时mp4录像,hook接口(on_publish)中可以覆盖该设置
publishToMP4=0

# 拉流代理时如果断流再重连成功是否删除前一次的媒体流数据,如果删除将重新开始,如果不删除将会接着上一次的数据继续写(录制hls/mp4时会继续在前一个文件后面写)
resetWhenRePlay=1

# rtmp[s]、http[s]-flv、ws[s]-flv协议是否按需生成
rtmp_demand=0

# rtsp[s]协议是否按需生成
rtsp_demand=0

# 某个流无人观看时,触发hook.on_stream_none_reader事件的最大等待时间,单位毫秒,在配合hook.on_stream_none_reader事件时,可以做到无人观看自动停止拉流或停止接收推流
streamNoneReaderDelayMS=20000

# http[s]-ts协议是否按需生成
ts_demand=0

[hls]
# 是否广播 ts 切片完成通知
broadcastRecordTs=0

# 直播hls文件删除延时,单位秒
deleteDelaySec=0

# hls写文件的buf大小,调整参数可以提高文件io性能
fileBufSize=65536

# hls保存文件路径,可以为相对(相对于本可执行程序目录)或绝对路径
filePath=./www

# hls最大切片时间,单位秒
segDur=2

# m3u8索引中,hls保留切片个数(实际保留切片个数大2~3个),如果设置为0,则不删除切片,而是保存为点播
segNum=3

# hls切片从m3u8文件中移除后,继续保留在磁盘上的个数
segRetain=5

[hook]
# 在推流时,如果url参数匹对admin_params,那么可以不经过hook鉴权直接推流成功,播放时亦然。该配置项的目的是为了开发者自己调试测试,该参数暴露后会有泄露隐私的安全隐患
admin_params=secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc

# keepalive hook触发间隔,单位秒,float类型
alive_interval=30.000000

# 是否启用hook事件,启用后,推拉流都将进行鉴权
enable=0

# 播放器或推流器使用流量事件,置空则关闭,如 on_flow_report=https://127.0.0.1/index/hook/on_flow_report
on_flow_report=

# 访问http文件鉴权事件,置空则关闭鉴权
on_http_access=

# 播放鉴权事件,置空则关闭鉴权
on_play=

# 推流鉴权事件,置空则关闭鉴权
on_publish=

# 录制mp4切片完成事件
on_record_mp4=

# 录制 hls ts 切片完成事件
on_record_ts=

# rtsp播放鉴权事件,此事件中比对rtsp的用户名密码
on_rtsp_auth=

# rtsp播放是否开启专属鉴权事件,置空则关闭rtsp鉴权。rtsp播放鉴权还支持url方式鉴权。建议开发者统一采用url参数方式鉴权,rtsp用户名密码鉴权一般在设备上用的比较多。开启rtsp专属鉴权后,将不再触发on_play鉴权事件
on_rtsp_realm=

# server保活上报
on_server_keepalive=

# 服务器启动报告,可以用于服务器的崩溃重启事件监听
on_server_started=

# 远程telnet调试鉴权事件
on_shell_login=

# 直播流注册或注销事件
on_stream_changed=

# 无人观看流事件,通过该事件,可以选择是否关闭无人观看的流。配合general.streamNoneReaderDelayMS选项一起使用
on_stream_none_reader=

# 播放时,未找到流事件,通过配合hook.on_stream_none_reader事件可以完成按需拉流
on_stream_not_found=

# hook api最大等待回复时间,单位秒
timeoutSec=10

[http]
# http服务器字符编码,windows上默认gb2312
charSet=utf-8

# 是否显示文件夹菜单,开启后可以浏览文件夹
dirMenu=1

# http链接超时时间
keepAliveSecond=15

# http请求体最大字节数,如果post的body太大,则不适合缓存body在内存
maxReqSize=40960

# 404网页内容,用户可以自定义404网页
notFound=<html><head><title>404 Not Found</title></head><body bgcolor="white"><center><h1>您访问的资源不存在!</h1></center><hr><center>ZLMediaKit(git hash:07b0536f,branch:master,build time:Sep 24 2021 14:06:12)</center></body></html>

# http服务器监听端口
port=80

# http文件服务器根目录
rootPath=./www

# http文件服务器读文件缓存大小,单位BYTE,调整该参数可以优化文件io性能
sendBufSize=65536

# https服务器监听端口
sslport=443

# 虚拟目录, 虚拟目录名和文件路径使用","隔开,多个配置路径间用";"隔开,例如赋值为 app_a,/path/to/a;app_b,/path/to/b 那么访问 http://127.0.0.1/app_a/file_a 对应的文件路径为 /path/to/a/file_a,访问 http://127.0.0.1/app_b/file_b 对应的文件路径为 /path/to/b/file_b,访问其他http路径,对应的文件路径还是在rootPath内
virtualPath=

[multicast]
# rtp组播截止组播ip地址
addrMax=239.255.255.255

# rtp组播起始组播ip地址
addrMin=239.0.0.0

# 组播udp ttl
udpTTL=64

[record]
# mp4录制或mp4点播的应用名,通过限制应用名,可以防止随意点播,点播的文件必须放置在此文件夹下
appName=record

# mp4录制完成后是否进行二次关键帧索引写入头部
fastStart=0

# mp4录制写文件缓存,单位BYTE,调整参数可以提高文件io性能
fileBufSize=65536

# mp4录制保存、mp4点播根路径,可以为相对(相对于本可执行程序目录)或绝对路径
filePath=./www

# MP4点播(rtsp/rtmp/http-flv/ws-flv)是否循环播放文件
fileRepeat=0

# mp4录制切片时间,单位秒
fileSecond=3600

# mp4点播每次流化数据量,单位毫秒,减少该值可以让点播数据发送量更平滑,增大该值则更节省cpu资源
sampleMS=500

[rtmp]
# rtmp必须在此时间内完成握手,否则服务器会断开链接,单位秒
handshakeSecond=15

# rtmp超时时间,如果该时间内未收到客户端的数据,或者tcp发送缓存超过这个时间,则会断开连接,单位秒
keepAliveSecond=15

# 在接收rtmp推流时,是否重新生成时间戳
modifyStamp=0

# rtmp服务器监听端口
port=1935

# rtmps服务器监听地址
sslport=19350

[rtp]
# 音频mtu大小,该参数限制rtp最大字节数,推荐不要超过1400,加大该值会明显增加直播延时
audioMtuSize=600

# rtp包最大长度限制,单位KB,主要用于识别TCP上下文破坏时,获取到错误的rtp
rtpMaxSize=10

# 视频mtu大小,该参数限制rtp最大字节数,推荐不要超过1400
videoMtuSize=1400

[rtp_proxy]
# 导出调试数据(包括rtp/ps/h264)至该目录,置空则关闭数据导出
dumpDir=

# udp和tcp代理服务器,支持rtp(必须是ts或ps类型)代理
port=10000

# rtp超时时间,单位秒
timeoutSec=15

[rtsp]
# rtsp专有鉴权方式是采用base64还是md5方式
authBasic=0

# rtsp拉流、推流代理是否是直接代理模式。直接代理后支持任意编码格式,但是会导致GOP缓存无法定位到I帧,可能会导致开播花屏,并且如果是tcp方式拉流,如果rtp大于mtu会导致无法使用udp方式代理。假定您的拉流源地址不是264或265或AAC,那么你可以使用直接代理的方式来支持rtsp代理。如果你是rtsp推拉流,但是rtc播放,也建议关闭直接代理模式,因为直接代理时,rtp中可能没有sps pps,会导致rtc无法播放。默认开启rtsp直接代理,rtmp由于没有这些问题,是强制开启直接代理的
directProxy=1

# rtsp必须在此时间内完成握手,否则服务器会断开链接,单位秒
handshakeSecond=15

# rtsp超时时间,如果该时间内未收到客户端的数据,或者tcp发送缓存超过这个时间,则会断开连接,单位秒
keepAliveSecond=15

# rtsp服务器监听地址
port=554

# rtsps服务器监听地址
sslport=332

[shell]
# 调试telnet服务器接受最大bufffer大小
maxReqSize=1024

# 调试telnet服务器监听端口
port=9000

; } ---

修改并保存配置文件后,在 shell 里面输入 killall -1 MediaServer 就能使 ZLMediaKit 热加载配置文件,而不必先关闭服务然后再开启

关联阅读

  1. ZLMediaKit教程(一)编译安装
喜欢 (0)
发表我的评论
取消评论

表情