Skip to content

Z
ZLMediaKit
Switch branch/tag
Find file
Normal viewHistoryPermalink
config.ini 9.41 KB
Newer Older
添加配置文件说明
8dfe2d15
 
xiongziliang committed
1 2 3 4 5 6 
[api]
#是否调试http api,启用调试后，会打印每次http请求的内容和回复
apiDebug=1
#一些比较敏感的http api在访问时需要提供secret，否则无权限调用
#如果是通过127.0.0.1访问,那么可以不提供secret
secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc
修复配置文件错误注释
eddb5adc
 
xiongziliang committed
7 
#截图保存路径根目录，截图通过http api(/index/api/getSnap)生成和获取
实现实时生成和获取截图的http api
76bece02
 
xiongziliang committed
8 
snapRoot=./www/snap/
截图api支持默认图片
cecfe7ba
 
xiongziliang committed
9 10 
#默认截图图片，在启动FFmpeg截图后但是截图还未生成时，可以返回默认的预设图片
defaultSnap=./www/logo.png
添加配置文件说明
8dfe2d15
 
xiongziliang committed
11 12 

[ffmpeg]
支持相对路径
a4dab876
 
xiongziliang committed
13 
#FFmpeg可执行程序绝对路径
修改默认配置文件
69d53990
 
xiongziliang committed
14 
bin=/usr/bin/ffmpeg
添加配置文件说明
8dfe2d15
 
xiongziliang committed
15 
#FFmpeg拉流再推流的命令模板，通过该模板可以设置再编码的一些参数
修复FFmpeg拉流代理卡顿的问题
a993132a
 
xiongziliang committed
16 
cmd=%s -re -i %s -c:a aac -strict -2 -ar 44100 -ab 48k -c:v libx264 -f flv %s
实现实时生成和获取截图的http api
76bece02
 
xiongziliang committed
17 18 
#FFmpeg生成截图的命令，可以通过修改该配置改变截图分辨率或质量
snap=%s -i %s -y -f mjpeg -t 0.001 %s
添加配置文件说明
8dfe2d15
 
xiongziliang committed
19 
#FFmpeg日志的路径，如果置空则不生成FFmpeg日志
支持相对路径
a4dab876
 
xiongziliang committed
20 21 
#可以为相对(相对于本可执行程序目录)或绝对路径
log=./ffmpeg/ffmpeg.log
添加配置文件说明
8dfe2d15
 
xiongziliang committed
22 23 24 

[general]
#是否启用虚拟主机
文件根目录httpRoot改成www，并且自动复制到相应目录
aaab52c9
 
xiongziliang committed
25 
enableVhost=0
添加配置文件说明
8dfe2d15
 
xiongziliang committed
26 27 28 29 30 31 32 33 
#播放器或推流器在断开后会触发hook.on_flow_report事件(使用多少流量事件)，
#flowThreshold参数控制触发hook.on_flow_report事件阈值，使用流量超过该阈值后才触发，单位KB
flowThreshold=1024
#播放最多等待时间，单位毫秒
#播放在播放某个流时，如果该流不存在，
#ZLMediaKit会最多让播放器等待maxStreamWaitMS毫秒
#如果在这个时间内，该流注册成功，那么会立即返回播放器播放成功
#否则返回播放器未找到该流，该机制的目的是可以先播放再推流
实现hls按需拉流
4b4c4e0c
 
xiongziliang committed
34 
maxStreamWaitMS=15000
添加配置文件说明
8dfe2d15
 
xiongziliang committed
35 36 
#某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒
#在配合hook.on_stream_none_reader事件时，可以做到无人观看自动停止拉流或停止接收推流
实现hls按需拉流
4b4c4e0c
 
xiongziliang committed
37 
streamNoneReaderDelayMS=20000
完善配置文件说明
119d8d82
 
xiongziliang committed
38 39 
#拉流代理是否添加静音音频(直接拉流模式本协议无效)
addMuteAudio=1
添加断流重连是否接着前一次继续写;修复断流重连成功后hls时间戳错误问题
d6e60e09
 
Weiwei.Zhou committed
40 41 42 
#拉流代理时如果断流再重连成功是否删除前一次的媒体流数据，如果删除将重新开始，
#如果不删除将会接着上一次的数据继续写(录制hls/mp4时会继续在前一个文件后面写)
resetWhenRePlay=1
完善注释
5a150300
 
xiongziliang committed
43 
#是否默认推流时转换成hls，hook接口(on_publish)中可以覆盖该设置
添加配置项，控制在关闭hook时，推流是否转协议或录制
a8a4f267
 
xiongziliang committed
44 
publishToHls=1
完善注释
5a150300
 
xiongziliang committed
45 
#是否默认推流时mp4录像，hook接口(on_publish)中可以覆盖该设置
添加配置项，控制在关闭hook时，推流是否转协议或录制
a8a4f267
 
xiongziliang committed
46 
publishToMP4=0
添加合并写功能
99a55dda
 
xiongziliang committed
47 
#合并写缓存大小(单位毫秒)，合并写指服务器缓存一定的数据后才会一次性写入socket，这样能提高性能，但是会提高延时
去除ultraLowDelay配置项
f9df7f52
 
xiongziliang committed
48 49 
#开启后会同时关闭TCP_NODELAY并开启MSG_MORE
mergeWriteMS=0
添加全局时间戳覆盖逻辑
06d61cf1
 
xiongziliang committed
50 51 52 53 54 
#全局的时间戳覆盖开关，在转协议时，对frame进行时间戳覆盖
#该开关对rtsp/rtmp/rtp推流、rtsp/rtmp/hls拉流代理转协议时生效
#会直接影响rtsp/rtmp/hls/mp4/flv等协议的时间戳
#同协议情况下不影响(例如rtsp/rtmp推流，那么播放rtsp/rtmp时不会影响时间戳)
modifyStamp=0
添加配置项 mediaServerId
6a8268f3
 
xiongziliang committed
55 56 
#服务器唯一id，用于触发hook时区别是哪台服务器
mediaServerId=your_server_id
添加配置文件说明
8dfe2d15
 
xiongziliang committed
57 58 59 60 61 

[hls]
#hls写文件的buf大小，调整参数可以提高文件io性能
fileBufSize=65536
#hls保存文件路径
支持相对路径
a4dab876
 
xiongziliang committed
62 
#可以为相对(相对于本可执行程序目录)或绝对路径
文件根目录httpRoot改成www，并且自动复制到相应目录
aaab52c9
 
xiongziliang committed
63 
filePath=./www
添加配置文件说明
8dfe2d15
 
xiongziliang committed
64 
#hls最大切片时间
添加hls.segRetain配置项，修复hls切片等于segNum+1的问题
ccbd1d4a
 
xiongziliang committed
65 
segDur=2
添加配置文件说明
8dfe2d15
 
xiongziliang committed
66 
#m3u8索引中,hls保留切片个数(实际保留切片个数大2~3个)
支持hls点播录制
4bc355b0
 
xiongziliang committed
67 
#如果设置为0，则不删除切片，而是保存为点播
添加配置文件说明
8dfe2d15
 
xiongziliang committed
68 
segNum=3
添加hls.segRetain配置项，修复hls切片等于segNum+1的问题
ccbd1d4a
 
xiongziliang committed
69 70 
#HLS切片从m3u8文件中移除后，继续保留在磁盘上的个数
segRetain=5
添加 ts 切片是否通知选项, 默认为不通知
b22a6e3d
 
wxf committed
71 72 
# 是否广播 ts 切片完成通知
broadcastRecordTs=0
添加配置文件说明
8dfe2d15
 
xiongziliang committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 

[hook]
#在推流时，如果url参数匹对admin_params，那么可以不经过hook鉴权直接推流成功，播放时亦然
#该配置项的目的是为了开发者自己调试测试，该参数暴露后会有泄露隐私的安全隐患
admin_params=secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc
#是否启用hook事件，启用后，推拉流都将进行鉴权
enable=0
#播放器或推流器使用流量事件，置空则关闭
on_flow_report=https://127.0.0.1/index/hook/on_flow_report
#访问http文件鉴权事件，置空则关闭鉴权
on_http_access=https://127.0.0.1/index/hook/on_http_access
#播放鉴权事件，置空则关闭鉴权
on_play=https://127.0.0.1/index/hook/on_play
#推流鉴权事件，置空则关闭鉴权
on_publish=https://127.0.0.1/index/hook/on_publish
#录制mp4切片完成事件
on_record_mp4=https://127.0.0.1/index/hook/on_record_mp4
添加 ts 切片是否通知选项, 默认为不通知
b22a6e3d
 
wxf committed
90 91 
# 录制 hls ts 切片完成事件
on_record_ts=https://127.0.0.1/index/hook/on_record_ts
添加配置文件说明
8dfe2d15
 
xiongziliang committed
92 93 
#rtsp播放鉴权事件，此事件中比对rtsp的用户名密码
on_rtsp_auth=https://127.0.0.1/index/hook/on_rtsp_auth
优化rtsp鉴权事件
8d180133
 
xiongziliang committed
94 
#rtsp播放是否开启专属鉴权事件，置空则关闭rtsp鉴权。rtsp播放鉴权还支持url方式鉴权
添加配置文件说明
8dfe2d15
 
xiongziliang committed
95 
#建议开发者统一采用url参数方式鉴权，rtsp用户名密码鉴权一般在设备上用的比较多
优化rtsp鉴权事件
8d180133
 
xiongziliang committed
96 
#开启rtsp专属鉴权后，将不再触发on_play鉴权事件
添加配置文件说明
8dfe2d15
 
xiongziliang committed
97 98 99 100 101 102 103 104 105 
on_rtsp_realm=https://127.0.0.1/index/hook/on_rtsp_realm
#远程telnet调试鉴权事件
on_shell_login=https://127.0.0.1/index/hook/on_shell_login
#直播流注册或注销事件
on_stream_changed=https://127.0.0.1/index/hook/on_stream_changed
#无人观看流事件，通过该事件，可以选择是否关闭无人观看的流。配合general.streamNoneReaderDelayMS选项一起使用
on_stream_none_reader=https://127.0.0.1/index/hook/on_stream_none_reader
#播放时，未找到流事件，通过配合hook.on_stream_none_reader事件可以完成按需拉流
on_stream_not_found=https://127.0.0.1/index/hook/on_stream_not_found
完善范例配置文件
22c01d0a
 
xiongziliang committed
106 107 
#服务器启动报告，可以用于服务器的崩溃重启事件监听
on_server_started=https://127.0.0.1/index/hook/on_server_started
添加配置文件说明
8dfe2d15
 
xiongziliang committed
108 109 110 111 112 113 114 
#hook api最大等待回复时间，单位秒
timeoutSec=10

[http]
#http服务器字符编码，windows上默认gb2312
charSet=utf-8
#http链接超时时间
修改默认配置文件
bedf088e
 
xiongziliang committed
115 
keepAliveSecond=30
添加配置文件说明
8dfe2d15
 
xiongziliang committed
116 117 118 119 120 121 122 
#http请求体最大字节数，如果post的body太大，则不适合缓存body在内存
maxReqSize=4096
#404网页内容，用户可以自定义404网页
notFound=<html><head><title>404 Not Found</title></head><body bgcolor="white"><center><h1>您访问的资源不存在！</h1></center><hr><center>ZLMediaKit-4.0</center></body></html>
#http服务器监听端口
port=80
#http文件服务器根目录
支持相对路径
a4dab876
 
xiongziliang committed
123 
#可以为相对(相对于本可执行程序目录)或绝对路径
文件根目录httpRoot改成www，并且自动复制到相应目录
aaab52c9
 
xiongziliang committed
124 
rootPath=./www
添加配置文件说明
8dfe2d15
 
xiongziliang committed
125 126 127 128 
#http文件服务器读文件缓存大小，单位BYTE，调整该参数可以优化文件io性能
sendBufSize=65536
#https服务器监听端口
sslport=443
新增是否开启浏览http目录的配置选项:#367
41c75fb6
 
xiongziliang committed
129 130 
#是否显示文件夹菜单，开启后可以浏览文件夹
dirMenu=1
添加配置文件说明
8dfe2d15
 
xiongziliang committed
131 132 133 134 135 136 137 138 139 140 141 

[multicast]
#rtp组播截止组播ip地址
addrMax=239.255.255.255
#rtp组播起始组播ip地址
addrMin=239.0.0.0
#组播udp ttl
udpTTL=64

[record]
#mp4录制或mp4点播的应用名，通过限制应用名，可以防止随意点播
完善配置注释
dd188f08
 
xiongziliang committed
142 
#点播的文件必须放置在此文件夹下
添加配置文件说明
8dfe2d15
 
xiongziliang committed
143 144 145 
appName=record
#mp4录制写文件缓存，单位BYTE,调整参数可以提高文件io性能
fileBufSize=65536
完善配置注释
dd188f08
 
xiongziliang committed
146 
#mp4录制保存、mp4点播根路径
支持相对路径
a4dab876
 
xiongziliang committed
147 
#可以为相对(相对于本可执行程序目录)或绝对路径
文件根目录httpRoot改成www，并且自动复制到相应目录
aaab52c9
 
xiongziliang committed
148 
filePath=./www
添加配置文件说明
8dfe2d15
 
xiongziliang committed
149 150 151 152 
#mp4录制切片时间，单位秒
fileSecond=3600
#mp4点播每次流化数据量，单位毫秒，
#减少该值可以让点播数据发送量更平滑，增大该值则更节省cpu资源
mp4点播每次流化时间改成500毫秒，优化文件io性能
a604d8c6
 
xiongziliang committed
153 
sampleMS=500
mp4录制完成后是否进行二次关键帧索引写入头部
f0deafd7
 
Weiwei.Zhou committed
154 155 
#mp4录制完成后是否进行二次关键帧索引写入头部
fastStart=0
完善配置文件说明
119d8d82
 
xiongziliang committed
156 157 
#MP4点播(rtsp/rtmp/http-flv/ws-flv)是否循环播放文件
fileRepeat=0
添加配置文件说明
8dfe2d15
 
xiongziliang committed
158 159 160 161 162 163 164 165 

[rtmp]
#rtmp必须在此时间内完成握手，否则服务器会断开链接，单位秒
handshakeSecond=15
#rtmp超时时间，如果该时间内未收到客户端的数据，
#或者tcp发送缓存超过这个时间，则会断开连接，单位秒
keepAliveSecond=15
#在接收rtmp推流时，是否重新生成时间戳(很多推流器的时间戳着实很烂)
默认关闭rtmp时间戳覆盖
97ad062d
 
xiongziliang committed
166 
modifyStamp=0
添加配置文件说明
8dfe2d15
 
xiongziliang committed
167 168 
#rtmp服务器监听端口
port=1935
新增rtmps默认端口
02700579
 
xiongziliang committed
169 170 
#rtmps服务器监听地址
sslport=19350
添加配置文件说明
8dfe2d15
 
xiongziliang committed
171 172 173 174 175 176 177 178 179 180 

[rtp]
#音频mtu大小，该参数限制rtp最大字节数，推荐不要超过1400
#加大该值会明显增加直播延时
audioMtuSize=600
#rtp时间戳回环时间，单位毫秒
cycleMS=46800000
#视频mtu大小，该参数限制rtp最大字节数，推荐不要超过1400
videoMtuSize=1400
支持rtp代理服务器
0d9bdec1
 
xiongziliang committed
181 182 183 184 185 186 187 188 189 190 
[rtp_proxy]
#udp类型的代理服务器是否检查rtp源地址，地址不配备将丢弃数据
checkSource=1
#导出调试数据(包括rtp/ps/h264)至该目录,置空则关闭数据导出
dumpDir=
#udp和tcp代理服务器，支持rtp(必须是ts或ps类型)代理
port=10000
#rtp超时时间，单位秒
timeoutSec=15
添加配置文件说明
8dfe2d15
 
xiongziliang committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 
[rtsp]
#rtsp专有鉴权方式是采用base64还是md5方式
authBasic=0
#rtsp拉流代理是否是直接代理模式
#直接代理后支持任意编码格式，但是会导致GOP缓存无法定位到I帧，可能会导致开播花屏
#并且如果是tcp方式拉流，如果rtp大于mtu会导致无法使用udp方式代理
#假定您的拉流源地址不是264或265或AAC，那么你可以使用直接代理的方式来支持rtsp代理
#默认开启rtsp直接代理，rtmp由于没有这些问题，是强制开启直接代理的
directProxy=1
#rtsp必须在此时间内完成握手，否则服务器会断开链接，单位秒
handshakeSecond=15
#rtsp超时时间，如果该时间内未收到客户端的数据，
#或者tcp发送缓存超过这个时间，则会断开连接，单位秒
keepAliveSecond=15
#rtsp服务器监听地址
port=554
#rtsps服务器监听地址
sslport=322

[shell]
#调试telnet服务器接受最大bufffer大小
maxReqSize=1024
#调试telnet服务器监听端口
port=9000