huangxiyun
/
ZLKMedia
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
21MB
Tree: 339c93e477
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '339c93e477'
${ noResults }
ZLKMedia/conf/config.ini

370 lines
17KB
Raw Blame History 

  1. #!!!!此配置文件为范例配置文件，意在告诉读者，各个配置项的具体含义和作用，

  2. #!!!!该配置文件在执行cmake时，会拷贝至release/${操作系统类型}/${编译类型}(例如release/linux/Debug) 文件夹。

  3. #!!!!该文件夹(release/${操作系统类型}/${编译类型})同时也是可执行程序生成目标路径，在执行MediaServer进程时，它会默认加载同目录下的config.ini文件作为配置文件，

  4. #!!!!你如果修改此范例配置文件(conf/config.ini)，并不会被MediaServer进程加载，因为MediaServer进程默认加载的是release/${操作系统类型}/${编译类型}/config.ini。

  5. #!!!!当然，你每次执行cmake，该文件确实会被拷贝至release/${操作系统类型}/${编译类型}/config.ini，

  6. #!!!!但是一般建议你直接修改release/${操作系统类型}/${编译类型}/config.ini文件，修改此文件一般不起作用,除非你运行MediaServer时使用-c参数指定到此文件。

  7. 

  8. [api]

  9. #是否调试http api,启用调试后，会打印每次http请求的内容和回复

  10. apiDebug=1

  11. #一些比较敏感的http api在访问时需要提供secret，否则无权限调用

  12. #如果是通过127.0.0.1访问,那么可以不提供secret

  13. secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc

  14. #截图保存路径根目录，截图通过http api(/index/api/getSnap)生成和获取

  15. snapRoot=./www/snap/

  16. #默认截图图片，在启动FFmpeg截图后但是截图还未生成时，可以返回默认的预设图片

  17. defaultSnap=./www/logo.png

  18. 

  19. [ffmpeg]

  20. #FFmpeg可执行程序路径,支持相对路径/绝对路径

  21. bin=/usr/bin/ffmpeg

  22. #FFmpeg拉流再推流的命令模板，通过该模板可以设置再编码的一些参数

  23. cmd=%s -re -i %s -c:a aac -strict -2 -ar 44100 -ab 48k -c:v libx264 -f flv %s

  24. #FFmpeg生成截图的命令，可以通过修改该配置改变截图分辨率或质量

  25. snap=%s -i %s -y -f mjpeg -t 0.001 %s

  26. #FFmpeg日志的路径，如果置空则不生成FFmpeg日志

  27. #可以为相对(相对于本可执行程序目录)或绝对路径

  28. log=./ffmpeg/ffmpeg.log

  29. # 自动重启的时间(秒), 默认为0, 也就是不自动重启. 主要是为了避免长时间ffmpeg拉流导致的不同步现象

  30. restart_sec=0

  31. 

  32. #转协议相关开关；如果addStreamProxy api和on_publish hook回复未指定转协议参数，则采用这些配置项

  33. [protocol]

  34. #转协议时，是否开启帧级时间戳覆盖

  35. modify_stamp=0

  36. #转协议是否开启音频

  37. enable_audio=1

  38. #添加acc静音音频，在关闭音频时，此开关无效

  39. add_mute_audio=1

  40. #推流断开后可以在超时时间内重新连接上继续推流，这样播放器会接着播放。

  41. #置0关闭此特性(推流断开会导致立即断开播放器)

  42. #此参数不应大于播放器超时时间;单位毫秒

  43. continue_push_ms=15000

  44. 

  45. #是否开启转换为hls

  46. enable_hls=1

  47. #是否开启MP4录制

  48. enable_mp4=0

  49. #是否开启转换为rtsp/webrtc

  50. enable_rtsp=1

  51. #是否开启转换为rtmp/flv

  52. enable_rtmp=1

  53. #是否开启转换为http-ts/ws-ts

  54. enable_ts=1

  55. #是否开启转换为http-fmp4/ws-fmp4

  56. enable_fmp4=1

  57. 

  58. #是否将mp4录制当做观看者

  59. mp4_as_player=0

  60. #mp4切片大小，单位秒

  61. mp4_max_second=3600

  62. #mp4录制保存路径

  63. mp4_save_path=./www

  64. 

  65. #hls录制保存路径

  66. hls_save_path=./www

  67. 

  68. ###### 以下是按需转协议的开关，在测试ZLMediaKit的接收推流性能时，请把下面开关置1

  69. ###### 如果某种协议你用不到，你可以把以下开关置1以便节省资源(但是还是可以播放，只是第一个播放者体验稍微差点)，

  70. ###### 如果某种协议你想获取最好的用户体验，请置0(第一个播放者可以秒开，且不花屏)

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

  72. hls_demand=0

  73. #rtsp[s]协议是否按需生成

  74. rtsp_demand=0

  75. #rtmp[s]、http[s]-flv、ws[s]-flv协议是否按需生成

  76. rtmp_demand=0

  77. #http[s]-ts协议是否按需生成

  78. ts_demand=0

  79. #http[s]-fmp4、ws[s]-fmp4协议是否按需生成

  80. fmp4_demand=0

  81. 

  82. [general]

  83. #是否启用虚拟主机

  84. enableVhost=0

  85. #播放器或推流器在断开后会触发hook.on_flow_report事件(使用多少流量事件)，

  86. #flowThreshold参数控制触发hook.on_flow_report事件阈值，使用流量超过该阈值后才触发，单位KB

  87. flowThreshold=1024

  88. #播放最多等待时间，单位毫秒

  89. #播放在播放某个流时，如果该流不存在，

  90. #ZLMediaKit会最多让播放器等待maxStreamWaitMS毫秒

  91. #如果在这个时间内，该流注册成功，那么会立即返回播放器播放成功

  92. #否则返回播放器未找到该流，该机制的目的是可以先播放再推流

  93. maxStreamWaitMS=15000

  94. #某个流无人观看时，触发hook.on_stream_none_reader事件的最大等待时间，单位毫秒

  95. #在配合hook.on_stream_none_reader事件时，可以做到无人观看自动停止拉流或停止接收推流

  96. streamNoneReaderDelayMS=20000

  97. #拉流代理时如果断流再重连成功是否删除前一次的媒体流数据，如果删除将重新开始，

  98. #如果不删除将会接着上一次的数据继续写(录制hls/mp4时会继续在前一个文件后面写)

  99. resetWhenRePlay=1

  100. #合并写缓存大小(单位毫秒)，合并写指服务器缓存一定的数据后才会一次性写入socket，这样能提高性能，但是会提高延时

  101. #开启后会同时关闭TCP_NODELAY并开启MSG_MORE

  102. mergeWriteMS=0

  103. #服务器唯一id，用于触发hook时区别是哪台服务器

  104. mediaServerId=your_server_id

  105. 

  106. #最多等待未初始化的Track时间，单位毫秒，超时之后会忽略未初始化的Track

  107. wait_track_ready_ms=10000

  108. #如果流只有单Track，最多等待若干毫秒，超时后未收到其他Track的数据，则认为是单Track

  109. #如果协议元数据有声明特定track数，那么无此等待时间

  110. wait_add_track_ms=3000

  111. #如果track未就绪，我们先缓存帧数据，但是有最大个数限制，防止内存溢出

  112. unready_frame_cache=100

  113. 

  114. [hls]

  115. #hls写文件的buf大小，调整参数可以提高文件io性能

  116. fileBufSize=65536

  117. #hls最大切片时间

  118. segDur=2

  119. #m3u8索引中,hls保留切片个数(实际保留切片个数大2~3个)

  120. #如果设置为0，则不删除切片，而是保存为点播

  121. segNum=3

  122. #HLS切片从m3u8文件中移除后，继续保留在磁盘上的个数

  123. segRetain=5

  124. #是否广播 ts 切片完成通知

  125. broadcastRecordTs=0

  126. #直播hls文件删除延时，单位秒，issue: #913

  127. deleteDelaySec=10

  128. #是否保留hls文件，此功能部分等效于segNum=0的情况

  129. #不同的是这个保留不会在m3u8文件中体现

  130. #0为不保留，不起作用

  131. #1为保留，则不删除hls文件，如果开启此功能，注意磁盘大小，或者定期手动清理hls文件

  132. segKeep=0

  133. 

  134. [hook]

  135. #在推流时，如果url参数匹对admin_params，那么可以不经过hook鉴权直接推流成功，播放时亦然

  136. #该配置项的目的是为了开发者自己调试测试，该参数暴露后会有泄露隐私的安全隐患

  137. admin_params=secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc

  138. #是否启用hook事件，启用后，推拉流都将进行鉴权

  139. enable=0

  140. #播放器或推流器使用流量事件，置空则关闭

  141. on_flow_report=https://127.0.0.1/index/hook/on_flow_report

  142. #访问http文件鉴权事件，置空则关闭鉴权

  143. on_http_access=https://127.0.0.1/index/hook/on_http_access

  144. #播放鉴权事件，置空则关闭鉴权

  145. on_play=https://127.0.0.1/index/hook/on_play

  146. #推流鉴权事件，置空则关闭鉴权

  147. on_publish=https://127.0.0.1/index/hook/on_publish

  148. #录制mp4切片完成事件

  149. on_record_mp4=https://127.0.0.1/index/hook/on_record_mp4

  150. # 录制 hls ts 切片完成事件

  151. on_record_ts=https://127.0.0.1/index/hook/on_record_ts

  152. #rtsp播放鉴权事件，此事件中比对rtsp的用户名密码

  153. on_rtsp_auth=https://127.0.0.1/index/hook/on_rtsp_auth

  154. #rtsp播放是否开启专属鉴权事件，置空则关闭rtsp鉴权。rtsp播放鉴权还支持url方式鉴权

  155. #建议开发者统一采用url参数方式鉴权，rtsp用户名密码鉴权一般在设备上用的比较多

  156. #开启rtsp专属鉴权后，将不再触发on_play鉴权事件

  157. on_rtsp_realm=https://127.0.0.1/index/hook/on_rtsp_realm

  158. #远程telnet调试鉴权事件

  159. on_shell_login=https://127.0.0.1/index/hook/on_shell_login

  160. #直播流注册或注销事件

  161. on_stream_changed=https://127.0.0.1/index/hook/on_stream_changed

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

  163. on_stream_none_reader=https://127.0.0.1/index/hook/on_stream_none_reader

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

  165. on_stream_not_found=https://127.0.0.1/index/hook/on_stream_not_found

  166. #服务器启动报告，可以用于服务器的崩溃重启事件监听

  167. on_server_started=https://127.0.0.1/index/hook/on_server_started

  168. #server保活上报

  169. on_server_keepalive=https://127.0.0.1/index/hook/on_server_keepalive

  170. #发送rtp(startSendRtp)被动关闭时回调

  171. on_send_rtp_stopped=https://127.0.0.1/index/hook/on_send_rtp_stopped

  172. #rtp server 超时未收到数据

  173. on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout

  174. 

  175. #hook api最大等待回复时间，单位秒

  176. timeoutSec=10

  177. #keepalive hook触发间隔,单位秒，float类型

  178. alive_interval=10.0

  179. #hook通知失败重试次数,正整数。为0不重试，1时重试一次，以此类推

  180. retry=1

  181. #hook通知失败重试延时，单位秒，float型

  182. retry_delay=3.0

  183. 

  184. [cluster]

  185. #设置源站拉流url模板, 格式跟printf类似，第一个%s指定app,第二个%s指定stream_id,

  186. #开启集群模式后，on_stream_not_found和on_stream_none_reader hook将无效.

  187. #溯源模式支持以下类型:

  188. #rtmp方式: rtmp://127.0.0.1:1935/%s/%s

  189. #rtsp方式: rtsp://127.0.0.1:554/%s/%s

  190. #hls方式: http://127.0.0.1:80/%s/%s/hls.m3u8

  191. #http-ts方式: http://127.0.0.1:80/%s/%s.live.ts

  192. #支持多个源站，不同源站通过分号(;)分隔

  193. origin_url=

  194. #溯源总超时时长，单位秒，float型；假如源站有3个，那么单次溯源超时时间为timeout_sec除以3

  195. #单次溯源超时时间不要超过general.maxStreamWaitMS配置

  196. timeout_sec=15

  197. #溯源失败尝试次数，-1时永久尝试

  198. retry_count=3

  199. 

  200. [http]

  201. #http服务器字符编码，windows上默认gb2312

  202. charSet=utf-8

  203. #http链接超时时间

  204. keepAliveSecond=30

  205. #http请求体最大字节数，如果post的body太大，则不适合缓存body在内存

  206. maxReqSize=40960

  207. #404网页内容，用户可以自定义404网页

  208. #notFound=<html><head><title>404 Not Found</title></head><body bgcolor="white"><center><h1>您访问的资源不存在！</h1></center><hr><center>ZLMediaKit-4.0</center></body></html>

  209. #http服务器监听端口

  210. port=80

  211. #http文件服务器根目录

  212. #可以为相对(相对于本可执行程序目录)或绝对路径

  213. rootPath=./www

  214. #http文件服务器读文件缓存大小，单位BYTE，调整该参数可以优化文件io性能

  215. sendBufSize=65536

  216. #https服务器监听端口

  217. sslport=443

  218. #是否显示文件夹菜单，开启后可以浏览文件夹

  219. dirMenu=1

  220. #虚拟目录, 虚拟目录名和文件路径使用","隔开，多个配置路径间用";"隔开

  221. #例如赋值为 app_a,/path/to/a;app_b,/path/to/b 那么

  222. #访问 http://127.0.0.1/app_a/file_a 对应的文件路径为 /path/to/a/file_a

  223. #访问 http://127.0.0.1/app_b/file_b 对应的文件路径为 /path/to/b/file_b

  224. #访问其他http路径,对应的文件路径还是在rootPath内

  225. virtualPath=

  226. #禁止后缀的文件使用mmap缓存，使用“,”隔开

  227. #例如赋值为 .mp4,.flv

  228. #那么访问后缀为.mp4与.flv 的文件不缓存

  229. forbidCacheSuffix=

  230. #可以把http代理前真实客户端ip放在http头中：https://github.com/ZLMediaKit/ZLMediaKit/issues/1388

  231. #切勿暴露此key，否则可能导致伪造客户端ip

  232. forwarded_ip_header=

  233. 

  234. [multicast]

  235. #rtp组播截止组播ip地址

  236. addrMax=239.255.255.255

  237. #rtp组播起始组播ip地址

  238. addrMin=239.0.0.0

  239. #组播udp ttl

  240. udpTTL=64

  241. 

  242. [record]

  243. #mp4录制或mp4点播的应用名，通过限制应用名，可以防止随意点播

  244. #点播的文件必须放置在此文件夹下

  245. appName=record

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

  247. fileBufSize=65536

  248. #mp4点播每次流化数据量，单位毫秒，

  249. #减少该值可以让点播数据发送量更平滑，增大该值则更节省cpu资源

  250. sampleMS=500

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

  252. fastStart=0

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

  254. fileRepeat=0

  255. 

  256. [rtmp]

  257. #rtmp必须在此时间内完成握手，否则服务器会断开链接，单位秒

  258. handshakeSecond=15

  259. #rtmp超时时间，如果该时间内未收到客户端的数据，

  260. #或者tcp发送缓存超过这个时间，则会断开连接，单位秒

  261. keepAliveSecond=15

  262. #在接收rtmp推流时，是否重新生成时间戳(很多推流器的时间戳着实很烂)

  263. modifyStamp=0

  264. #rtmp服务器监听端口

  265. port=1935

  266. #rtmps服务器监听地址

  267. sslport=0

  268. 

  269. [rtp]

  270. #音频mtu大小，该参数限制rtp最大字节数，推荐不要超过1400

  271. #加大该值会明显增加直播延时

  272. audioMtuSize=600

  273. #视频mtu大小，该参数限制rtp最大字节数，推荐不要超过1400

  274. videoMtuSize=1400

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

  276. rtpMaxSize=10

  277. # rtp 打包时，低延迟开关，默认关闭（为0），h264存在一帧多个slice（NAL）的情况，在这种情况下，如果开启可能会导致画面花屏

  278. lowLatency=0

  279. 

  280. [rtp_proxy]

  281. #导出调试数据(包括rtp/ps/h264)至该目录,置空则关闭数据导出

  282. dumpDir=

  283. #udp和tcp代理服务器，支持rtp(必须是ts或ps类型)代理

  284. port=10000

  285. #rtp超时时间，单位秒

  286. timeoutSec=15

  287. #随机端口范围，最少确保36个端口

  288. #该范围同时限制rtsp服务器udp端口范围

  289. port_range=30000-35000

  290. #rtp h264 负载的pt

  291. h264_pt=98

  292. #rtp h265 负载的pt

  293. h265_pt=99

  294. #rtp ps 负载的pt

  295. ps_pt=96

  296. #rtp ts 负载的pt

  297. ts_pt=33

  298. #rtp opus 负载的pt

  299. opus_pt=100

  300. #rtp g711u 负载的pt

  301. g711u_pt=0

  302. #rtp g711a 负载的pt

  303. g711a_pt=8

  304. 

  305. 

  306. [rtc]

  307. #rtc播放推流、播放超时时间

  308. timeoutSec=15

  309. #本机对rtc客户端的可见ip，作为服务器时一般为公网ip，可有多个，用','分开，当置空时，会自动获取网卡ip

  310. #同时支持环境变量，以$开头，如"$EXTERN_IP"; 请参考：https://github.com/ZLMediaKit/ZLMediaKit/pull/1786

  311. externIP=

  312. #rtc udp服务器监听端口号，所有rtc客户端将通过该端口传输stun/dtls/srtp/srtcp数据，

  313. #该端口是多线程的，同时支持客户端网络切换导致的连接迁移

  314. #需要注意的是，如果服务器在nat内，需要做端口映射时，必须确保外网映射端口跟该端口一致

  315. port=8000

  316. #rtc tcp服务器监听端口号，在udp 不通的情况下，会使用tcp传输数据

  317. #该端口是多线程的，同时支持客户端网络切换导致的连接迁移

  318. #需要注意的是，如果服务器在nat内，需要做端口映射时，必须确保外网映射端口跟该端口一致

  319. tcpPort = 8000

  320. #设置remb比特率，非0时关闭twcc并开启remb。该设置在rtc推流时有效，可以控制推流画质

  321. #目前已经实现twcc自动调整码率，关闭remb根据真实网络状况调整码率

  322. rembBitRate=0

  323. #rtc支持的音频codec类型,在前面的优先级更高

  324. #以下范例为所有支持的音频codec

  325. preferredCodecA=PCMU,PCMA,opus,mpeg4-generic

  326. #rtc支持的视频codec类型,在前面的优先级更高

  327. #以下范例为所有支持的视频codec

  328. preferredCodecV=H264,H265,AV1,VP9,VP8

  329. 

  330. [srt]

  331. #srt播放推流、播放超时时间,单位秒

  332. timeoutSec=5

  333. #srt udp服务器监听端口号，所有srt客户端将通过该端口传输srt数据，

  334. #该端口是多线程的，同时支持客户端网络切换导致的连接迁移

  335. port=9000

  336. #srt 协议中延迟缓存的估算参数，在握手阶段估算rtt ,然后latencyMul*rtt 为最大缓存时长，此参数越大，表示等待重传的时长就越大

  337. latencyMul=4

  338. #包缓存的大小

  339. pktBufSize=8192

  340. 

  341. 

  342. [rtsp]

  343. #rtsp专有鉴权方式是采用base64还是md5方式

  344. authBasic=0

  345. #rtsp拉流、推流代理是否是直接代理模式

  346. #直接代理后支持任意编码格式，但是会导致GOP缓存无法定位到I帧，可能会导致开播花屏

  347. #并且如果是tcp方式拉流，如果rtp大于mtu会导致无法使用udp方式代理

  348. #假定您的拉流源地址不是264或265或AAC，那么你可以使用直接代理的方式来支持rtsp代理

  349. #如果你是rtsp推拉流，但是webrtc播放，也建议关闭直接代理模式，

  350. #因为直接代理时，rtp中可能没有sps pps,会导致webrtc无法播放; 另外webrtc也不支持Single NAL Unit Packets类型rtp

  351. #默认开启rtsp直接代理，rtmp由于没有这些问题，是强制开启直接代理的

  352. directProxy=1

  353. #rtsp必须在此时间内完成握手，否则服务器会断开链接，单位秒

  354. handshakeSecond=15

  355. #rtsp超时时间，如果该时间内未收到客户端的数据，

  356. #或者tcp发送缓存超过这个时间，则会断开连接，单位秒

  357. keepAliveSecond=15

  358. #rtsp服务器监听地址

  359. port=554

  360. #rtsps服务器监听地址

  361. sslport=0

  362. #rtsp 转发是否使用低延迟模式，当开启时，不会缓存rtp包，来提高并发，可以降低一帧的延迟

  363. lowLatency=0

  364. [shell]

  365. #调试telnet服务器接受最大bufffer大小

  366. maxReqSize=1024

  367. #调试telnet服务器监听端口

  368. port=0