Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

ZLMediaKit.postman_collection.json 45KB

8 månader sedan
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853
  1. {
  2. "info": {
  3. "_postman_id": "4626d766-16b5-4255-89ba-f7614de2398c",
  4. "name": "ZLMediaKit",
  5. "description": "媒体服务器",
  6. "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  7. },
  8. "item": [
  9. {
  10. "name": "获取服务器api列表(getApiList)",
  11. "request": {
  12. "method": "GET",
  13. "header": [],
  14. "url": {
  15. "raw": "{{ZLMediaKit_URL}}/index/api/getApiList?secret={{ZLMediaKit_secret}}",
  16. "host": [
  17. "{{ZLMediaKit_URL}}"
  18. ],
  19. "path": [
  20. "index",
  21. "api",
  22. "getApiList"
  23. ],
  24. "query": [
  25. {
  26. "key": "secret",
  27. "value": "{{ZLMediaKit_secret}}",
  28. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  29. }
  30. ]
  31. }
  32. },
  33. "response": []
  34. },
  35. {
  36. "name": "获取网络线程负载(getThreadsLoad)",
  37. "request": {
  38. "method": "GET",
  39. "header": [],
  40. "url": {
  41. "raw": "{{ZLMediaKit_URL}}/index/api/getThreadsLoad?secret={{ZLMediaKit_secret}}",
  42. "host": [
  43. "{{ZLMediaKit_URL}}"
  44. ],
  45. "path": [
  46. "index",
  47. "api",
  48. "getThreadsLoad"
  49. ],
  50. "query": [
  51. {
  52. "key": "secret",
  53. "value": "{{ZLMediaKit_secret}}",
  54. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  55. }
  56. ]
  57. }
  58. },
  59. "response": []
  60. },
  61. {
  62. "name": "获取主要对象个数(getStatistic)",
  63. "request": {
  64. "method": "GET",
  65. "header": [],
  66. "url": {
  67. "raw": "{{ZLMediaKit_URL}}/index/api/getStatistic?secret={{ZLMediaKit_secret}}",
  68. "host": [
  69. "{{ZLMediaKit_URL}}"
  70. ],
  71. "path": [
  72. "index",
  73. "api",
  74. "getStatistic"
  75. ],
  76. "query": [
  77. {
  78. "key": "secret",
  79. "value": "{{ZLMediaKit_secret}}",
  80. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  81. }
  82. ]
  83. }
  84. },
  85. "response": []
  86. },
  87. {
  88. "name": "获取后台线程负载(getWorkThreadsLoad)",
  89. "request": {
  90. "method": "GET",
  91. "header": [],
  92. "url": {
  93. "raw": "{{ZLMediaKit_URL}}/index/api/getWorkThreadsLoad?secret={{ZLMediaKit_secret}}",
  94. "host": [
  95. "{{ZLMediaKit_URL}}"
  96. ],
  97. "path": [
  98. "index",
  99. "api",
  100. "getWorkThreadsLoad"
  101. ],
  102. "query": [
  103. {
  104. "key": "secret",
  105. "value": "{{ZLMediaKit_secret}}",
  106. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  107. }
  108. ]
  109. }
  110. },
  111. "response": []
  112. },
  113. {
  114. "name": "获取服务器配置(getServerConfig)",
  115. "request": {
  116. "method": "GET",
  117. "header": [],
  118. "url": {
  119. "raw": "{{ZLMediaKit_URL}}/index/api/getServerConfig?secret={{ZLMediaKit_secret}}",
  120. "host": [
  121. "{{ZLMediaKit_URL}}"
  122. ],
  123. "path": [
  124. "index",
  125. "api",
  126. "getServerConfig"
  127. ],
  128. "query": [
  129. {
  130. "key": "secret",
  131. "value": "{{ZLMediaKit_secret}}",
  132. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  133. }
  134. ]
  135. }
  136. },
  137. "response": []
  138. },
  139. {
  140. "name": "设置服务器配置(setServerConfig)",
  141. "request": {
  142. "method": "GET",
  143. "header": [],
  144. "url": {
  145. "raw": "{{ZLMediaKit_URL}}/index/api/setServerConfig?secret={{ZLMediaKit_secret}}&api.apiDebug=0",
  146. "host": [
  147. "{{ZLMediaKit_URL}}"
  148. ],
  149. "path": [
  150. "index",
  151. "api",
  152. "setServerConfig"
  153. ],
  154. "query": [
  155. {
  156. "key": "secret",
  157. "value": "{{ZLMediaKit_secret}}",
  158. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  159. },
  160. {
  161. "key": "api.apiDebug",
  162. "value": "0",
  163. "description": "配置键与配置项值"
  164. }
  165. ]
  166. }
  167. },
  168. "response": []
  169. },
  170. {
  171. "name": "重启服务器(restartServer)",
  172. "request": {
  173. "method": "GET",
  174. "header": [],
  175. "url": {
  176. "raw": "{{ZLMediaKit_URL}}/index/api/restartServer?secret={{ZLMediaKit_secret}}",
  177. "host": [
  178. "{{ZLMediaKit_URL}}"
  179. ],
  180. "path": [
  181. "index",
  182. "api",
  183. "restartServer"
  184. ],
  185. "query": [
  186. {
  187. "key": "secret",
  188. "value": "{{ZLMediaKit_secret}}",
  189. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  190. }
  191. ]
  192. }
  193. },
  194. "response": []
  195. },
  196. {
  197. "name": "获取流列表(getMediaList)",
  198. "request": {
  199. "method": "GET",
  200. "header": [],
  201. "url": {
  202. "raw": "{{ZLMediaKit_URL}}/index/api/getMediaList?secret={{ZLMediaKit_secret}}",
  203. "host": [
  204. "{{ZLMediaKit_URL}}"
  205. ],
  206. "path": [
  207. "index",
  208. "api",
  209. "getMediaList"
  210. ],
  211. "query": [
  212. {
  213. "key": "secret",
  214. "value": "{{ZLMediaKit_secret}}",
  215. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  216. },
  217. {
  218. "key": "schema",
  219. "value": "rtmp",
  220. "description": "筛选协议,例如 rtsp或rtmp",
  221. "disabled": true
  222. },
  223. {
  224. "key": "vhost",
  225. "value": "{{defaultVhost}}",
  226. "description": "筛选虚拟主机,例如__defaultVhost__",
  227. "disabled": true
  228. },
  229. {
  230. "key": "app",
  231. "value": null,
  232. "description": "筛选应用名,例如 live",
  233. "disabled": true
  234. },
  235. {
  236. "key": "stream",
  237. "value": null,
  238. "description": "筛选流id,例如 test",
  239. "disabled": true
  240. }
  241. ]
  242. }
  243. },
  244. "response": []
  245. },
  246. {
  247. "name": "关断单个流(close_stream)",
  248. "request": {
  249. "method": "GET",
  250. "header": [],
  251. "url": {
  252. "raw": "{{ZLMediaKit_URL}}/index/api/close_stream?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=test",
  253. "host": [
  254. "{{ZLMediaKit_URL}}"
  255. ],
  256. "path": [
  257. "index",
  258. "api",
  259. "close_stream"
  260. ],
  261. "query": [
  262. {
  263. "key": "secret",
  264. "value": "{{ZLMediaKit_secret}}",
  265. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  266. },
  267. {
  268. "key": "schema",
  269. "value": "rtsp",
  270. "description": "协议,例如 rtsp或rtmp"
  271. },
  272. {
  273. "key": "vhost",
  274. "value": "{{defaultVhost}}",
  275. "description": "虚拟主机,例如__defaultVhost__"
  276. },
  277. {
  278. "key": "app",
  279. "value": "live",
  280. "description": "应用名,例如 live"
  281. },
  282. {
  283. "key": "stream",
  284. "value": "test",
  285. "description": "流id,例如 test"
  286. },
  287. {
  288. "key": "force",
  289. "value": "1",
  290. "description": "是否强制关闭(有人在观看是否还关闭)",
  291. "disabled": true
  292. }
  293. ]
  294. }
  295. },
  296. "response": []
  297. },
  298. {
  299. "name": "批量关断流(close_streams)",
  300. "request": {
  301. "method": "GET",
  302. "header": [],
  303. "url": {
  304. "raw": "{{ZLMediaKit_URL}}/index/api/close_streams?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=test",
  305. "host": [
  306. "{{ZLMediaKit_URL}}"
  307. ],
  308. "path": [
  309. "index",
  310. "api",
  311. "close_streams"
  312. ],
  313. "query": [
  314. {
  315. "key": "secret",
  316. "value": "{{ZLMediaKit_secret}}",
  317. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  318. },
  319. {
  320. "key": "schema",
  321. "value": "rtsp",
  322. "description": "协议,例如 rtsp或rtmp"
  323. },
  324. {
  325. "key": "vhost",
  326. "value": "{{defaultVhost}}",
  327. "description": "虚拟主机,例如__defaultVhost__"
  328. },
  329. {
  330. "key": "app",
  331. "value": "live",
  332. "description": "应用名,例如 live"
  333. },
  334. {
  335. "key": "stream",
  336. "value": "test",
  337. "description": "流id,例如 test"
  338. },
  339. {
  340. "key": "force",
  341. "value": "1",
  342. "description": "是否强制关闭(有人在观看是否还关闭)",
  343. "disabled": true
  344. }
  345. ]
  346. }
  347. },
  348. "response": []
  349. },
  350. {
  351. "name": "获取Session列表(getAllSession)",
  352. "request": {
  353. "method": "GET",
  354. "header": [],
  355. "url": {
  356. "raw": "{{ZLMediaKit_URL}}/index/api/getAllSession?secret={{ZLMediaKit_secret}}",
  357. "host": [
  358. "{{ZLMediaKit_URL}}"
  359. ],
  360. "path": [
  361. "index",
  362. "api",
  363. "getAllSession"
  364. ],
  365. "query": [
  366. {
  367. "key": "secret",
  368. "value": "{{ZLMediaKit_secret}}",
  369. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  370. },
  371. {
  372. "key": "local_port",
  373. "value": "",
  374. "description": "筛选本机端口,例如筛选rtsp链接:554",
  375. "disabled": true
  376. },
  377. {
  378. "key": "peer_ip",
  379. "value": null,
  380. "description": "筛选客户端ip",
  381. "disabled": true
  382. }
  383. ]
  384. }
  385. },
  386. "response": []
  387. },
  388. {
  389. "name": "断开tcp连接(kick_session)",
  390. "request": {
  391. "method": "GET",
  392. "header": [],
  393. "url": {
  394. "raw": "{{ZLMediaKit_URL}}/index/api/kick_session?secret={{ZLMediaKit_secret}}&id=123456",
  395. "host": [
  396. "{{ZLMediaKit_URL}}"
  397. ],
  398. "path": [
  399. "index",
  400. "api",
  401. "kick_session"
  402. ],
  403. "query": [
  404. {
  405. "key": "secret",
  406. "value": "{{ZLMediaKit_secret}}",
  407. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  408. },
  409. {
  410. "key": "id",
  411. "value": "123456",
  412. "description": "客户端唯一id,可以通过getAllSession接口获取"
  413. }
  414. ]
  415. }
  416. },
  417. "response": []
  418. },
  419. {
  420. "name": "批量断开tcp连接(kick_sessions)",
  421. "request": {
  422. "method": "GET",
  423. "header": [],
  424. "url": {
  425. "raw": "{{ZLMediaKit_URL}}/index/api/kick_sessions?secret={{ZLMediaKit_secret}}",
  426. "host": [
  427. "{{ZLMediaKit_URL}}"
  428. ],
  429. "path": [
  430. "index",
  431. "api",
  432. "kick_sessions"
  433. ],
  434. "query": [
  435. {
  436. "key": "secret",
  437. "value": "{{ZLMediaKit_secret}}",
  438. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  439. },
  440. {
  441. "key": "local_port",
  442. "value": "",
  443. "description": "筛选本机端口,例如筛选rtsp链接:554",
  444. "disabled": true
  445. },
  446. {
  447. "key": "peer_ip",
  448. "value": null,
  449. "description": "筛选客户端ip",
  450. "disabled": true
  451. }
  452. ]
  453. }
  454. },
  455. "response": []
  456. },
  457. {
  458. "name": "添加rtsp/rtmp/hls拉流代理(addStreamProxy)",
  459. "request": {
  460. "method": "GET",
  461. "header": [],
  462. "url": {
  463. "raw": "{{ZLMediaKit_URL}}/index/api/addStreamProxy?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=test&url=rtmp://live.hkstv.hk.lxdns.com/live/hks2",
  464. "host": [
  465. "{{ZLMediaKit_URL}}"
  466. ],
  467. "path": [
  468. "index",
  469. "api",
  470. "addStreamProxy"
  471. ],
  472. "query": [
  473. {
  474. "key": "secret",
  475. "value": "{{ZLMediaKit_secret}}",
  476. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  477. },
  478. {
  479. "key": "vhost",
  480. "value": "{{defaultVhost}}",
  481. "description": "添加的流的虚拟主机,例如__defaultVhost__"
  482. },
  483. {
  484. "key": "app",
  485. "value": "live",
  486. "description": "添加的流的应用名,例如live"
  487. },
  488. {
  489. "key": "stream",
  490. "value": "test",
  491. "description": "添加的流的id名,例如test"
  492. },
  493. {
  494. "key": "url",
  495. "value": "rtmp://live.hkstv.hk.lxdns.com/live/hks2",
  496. "description": "拉流地址,例如rtmp://live.hkstv.hk.lxdns.com/live/hks2"
  497. },
  498. {
  499. "key": "rtp_type",
  500. "value": null,
  501. "description": "rtsp拉流时,拉流方式,0:tcp,1:udp,2:组播",
  502. "disabled": true
  503. },
  504. {
  505. "key": "timeout_sec",
  506. "value": "10",
  507. "description": "拉流超时时间,单位秒,float类型",
  508. "disabled": true
  509. },
  510. {
  511. "key": "retry_count",
  512. "value": "",
  513. "description": "拉流重试次数,不传此参数或传值<=0时,则无限重试",
  514. "disabled": true
  515. },
  516. {
  517. "key": "enable_hls",
  518. "value": null,
  519. "description": "是否转hls",
  520. "disabled": true
  521. },
  522. {
  523. "key": "enable_mp4",
  524. "value": null,
  525. "description": "是否mp4录制",
  526. "disabled": true
  527. },
  528. {
  529. "key": "enable_rtsp",
  530. "value": "1",
  531. "description": "是否转协议为rtsp/webrtc",
  532. "disabled": true
  533. },
  534. {
  535. "key": "enable_rtmp",
  536. "value": "1",
  537. "description": "是否转协议为rtmp/flv",
  538. "disabled": true
  539. },
  540. {
  541. "key": "enable_ts",
  542. "value": "1",
  543. "description": "是否转协议为http-ts/ws-ts",
  544. "disabled": true
  545. },
  546. {
  547. "key": "enable_fmp4",
  548. "value": "1",
  549. "description": "是否转协议为http-fmp4/ws-fmp4",
  550. "disabled": true
  551. },
  552. {
  553. "key": "enable_audio",
  554. "value": "1",
  555. "description": "转协议是否开启音频",
  556. "disabled": true
  557. },
  558. {
  559. "key": "add_mute_audio",
  560. "value": "1",
  561. "description": "转协议无音频时,是否添加静音aac音频",
  562. "disabled": true
  563. },
  564. {
  565. "key": "mp4_save_path",
  566. "value": null,
  567. "description": "mp4录制保存根目录,置空使用默认目录",
  568. "disabled": true
  569. },
  570. {
  571. "key": "mp4_max_second",
  572. "value": "1800",
  573. "description": "mp4录制切片大小,单位秒",
  574. "disabled": true
  575. },
  576. {
  577. "key": "hls_save_path",
  578. "value": null,
  579. "description": "hls保存根目录,置空使用默认目录",
  580. "disabled": true
  581. },
  582. {
  583. "key": "modify_stamp",
  584. "value": null,
  585. "description": "是否重新计算时间戳",
  586. "disabled": true
  587. }
  588. ]
  589. }
  590. },
  591. "response": []
  592. },
  593. {
  594. "name": "关闭拉流代理(delStreamProxy)",
  595. "request": {
  596. "method": "GET",
  597. "header": [],
  598. "url": {
  599. "raw": "{{ZLMediaKit_URL}}/index/api/delStreamProxy?secret={{ZLMediaKit_secret}}&key=__defaultVhost__/live/1",
  600. "host": [
  601. "{{ZLMediaKit_URL}}"
  602. ],
  603. "path": [
  604. "index",
  605. "api",
  606. "delStreamProxy"
  607. ],
  608. "query": [
  609. {
  610. "key": "secret",
  611. "value": "{{ZLMediaKit_secret}}",
  612. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  613. },
  614. {
  615. "key": "key",
  616. "value": "__defaultVhost__/live/1",
  617. "description": "addStreamProxy接口返回的key"
  618. }
  619. ]
  620. }
  621. },
  622. "response": []
  623. },
  624. {
  625. "name": "添加rtsp/rtmp推流(addStreamPusherProxy)",
  626. "request": {
  627. "method": "GET",
  628. "header": [],
  629. "url": {
  630. "raw": "{{ZLMediaKit_URL}}/index/api/addStreamPusherProxy?secret={{ZLMediaKit_secret}}&schema=rtmp&vhost={{defaultVhost}}&app=live&stream=test&dst_url=rtmp://127.0.0.1/live/push",
  631. "host": [
  632. "{{ZLMediaKit_URL}}"
  633. ],
  634. "path": [
  635. "index",
  636. "api",
  637. "addStreamPusherProxy"
  638. ],
  639. "query": [
  640. {
  641. "key": "secret",
  642. "value": "{{ZLMediaKit_secret}}",
  643. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  644. },
  645. {
  646. "key": "schema",
  647. "value": "rtmp",
  648. "description": "推流协议,支持rtsp、rtmp,大小写敏感"
  649. },
  650. {
  651. "key": "vhost",
  652. "value": "{{defaultVhost}}",
  653. "description": "已注册流的虚拟主机,一般为__defaultVhost__"
  654. },
  655. {
  656. "key": "app",
  657. "value": "live",
  658. "description": "已注册流的应用名,例如live"
  659. },
  660. {
  661. "key": "stream",
  662. "value": "test",
  663. "description": "已注册流的id名,例如test"
  664. },
  665. {
  666. "key": "dst_url",
  667. "value": "rtmp://127.0.0.1/live/push",
  668. "description": "推流地址,需要与schema字段协议一致"
  669. },
  670. {
  671. "key": "rtp_type",
  672. "value": "0",
  673. "description": "rtsp推流时,推流方式,0:tcp,1:udp",
  674. "disabled": true
  675. },
  676. {
  677. "key": "timeout_sec",
  678. "value": "10",
  679. "description": "推流超时时间,单位秒,float类型",
  680. "disabled": true
  681. },
  682. {
  683. "key": "retry_count",
  684. "value": null,
  685. "description": "推流重试次数,不传此参数或传值<=0时,则无限重试",
  686. "disabled": true
  687. }
  688. ]
  689. }
  690. },
  691. "response": []
  692. },
  693. {
  694. "name": "关闭推流(delStreamPusherProxy)",
  695. "request": {
  696. "method": "GET",
  697. "header": [],
  698. "url": {
  699. "raw": "{{ZLMediaKit_URL}}/index/api/delStreamPusherProxy?secret={{ZLMediaKit_secret}}&key=__defaultVhost__/live/test",
  700. "host": [
  701. "{{ZLMediaKit_URL}}"
  702. ],
  703. "path": [
  704. "index",
  705. "api",
  706. "delStreamPusherProxy"
  707. ],
  708. "query": [
  709. {
  710. "key": "secret",
  711. "value": "{{ZLMediaKit_secret}}",
  712. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  713. },
  714. {
  715. "key": "key",
  716. "value": "__defaultVhost__/live/test",
  717. "description": "addStreamPusherProxy接口返回的key"
  718. }
  719. ]
  720. }
  721. },
  722. "response": []
  723. },
  724. {
  725. "name": "添加FFmpeg拉流代理(addFFmpegSource)",
  726. "request": {
  727. "method": "GET",
  728. "header": [],
  729. "url": {
  730. "raw": "{{ZLMediaKit_URL}}/index/api/addFFmpegSource?secret={{ZLMediaKit_secret}}&src_url=http://hefeng.live.tempsource.cjyun.org/videotmp/s10100-hftv.m3u8&dst_url=rtmp://127.0.0.1/live/hks2&timeout_ms=10000&enable_hls=0&enable_mp4=0",
  731. "host": [
  732. "{{ZLMediaKit_URL}}"
  733. ],
  734. "path": [
  735. "index",
  736. "api",
  737. "addFFmpegSource"
  738. ],
  739. "query": [
  740. {
  741. "key": "secret",
  742. "value": "{{ZLMediaKit_secret}}",
  743. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  744. },
  745. {
  746. "key": "src_url",
  747. "value": "http://hefeng.live.tempsource.cjyun.org/videotmp/s10100-hftv.m3u8",
  748. "description": "FFmpeg拉流地址,支持任意协议或格式(只要FFmpeg支持即可)"
  749. },
  750. {
  751. "key": "dst_url",
  752. "value": "rtmp://127.0.0.1/live/hks2",
  753. "description": "FFmpeg rtmp推流地址,一般都是推给自己,例如rtmp://127.0.0.1/live/stream_form_ffmpeg"
  754. },
  755. {
  756. "key": "timeout_ms",
  757. "value": "10000",
  758. "description": "FFmpeg推流成功超时时间,单位毫秒"
  759. },
  760. {
  761. "key": "enable_hls",
  762. "value": "0",
  763. "description": "是否开启hls录制"
  764. },
  765. {
  766. "key": "enable_mp4",
  767. "value": "0",
  768. "description": "是否开启mp4录制"
  769. },
  770. {
  771. "key": "ffmpeg_cmd_key",
  772. "value": "ffmpeg.cmd_hd",
  773. "description": "FFmpeg命名参数模板,置空则采用配置项:ffmpeg.cmd",
  774. "disabled": true
  775. }
  776. ]
  777. }
  778. },
  779. "response": []
  780. },
  781. {
  782. "name": "关闭FFmpeg拉流代理(delFFmpegSource)",
  783. "request": {
  784. "method": "GET",
  785. "header": [],
  786. "url": {
  787. "raw": "{{ZLMediaKit_URL}}/index/api/delFFmpegSource?secret={{ZLMediaKit_secret}}&key=5f748d2ef9712e4b2f6f970c1d44d93a",
  788. "host": [
  789. "{{ZLMediaKit_URL}}"
  790. ],
  791. "path": [
  792. "index",
  793. "api",
  794. "delFFmpegSource"
  795. ],
  796. "query": [
  797. {
  798. "key": "secret",
  799. "value": "{{ZLMediaKit_secret}}",
  800. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  801. },
  802. {
  803. "key": "key",
  804. "value": "5f748d2ef9712e4b2f6f970c1d44d93a"
  805. }
  806. ]
  807. }
  808. },
  809. "response": []
  810. },
  811. {
  812. "name": "流是否在线(isMediaOnline)",
  813. "request": {
  814. "method": "GET",
  815. "header": [],
  816. "url": {
  817. "raw": "{{ZLMediaKit_URL}}/index/api/isMediaOnline?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=proxy&stream=1",
  818. "host": [
  819. "{{ZLMediaKit_URL}}"
  820. ],
  821. "path": [
  822. "index",
  823. "api",
  824. "isMediaOnline"
  825. ],
  826. "query": [
  827. {
  828. "key": "secret",
  829. "value": "{{ZLMediaKit_secret}}",
  830. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  831. },
  832. {
  833. "key": "schema",
  834. "value": "rtsp",
  835. "description": "协议,例如 rtsp或rtmp"
  836. },
  837. {
  838. "key": "vhost",
  839. "value": "{{defaultVhost}}",
  840. "description": "虚拟主机,例如__defaultVhost__"
  841. },
  842. {
  843. "key": "app",
  844. "value": "proxy",
  845. "description": "应用名,例如 live"
  846. },
  847. {
  848. "key": "stream",
  849. "value": "1",
  850. "description": "流id,例如 test"
  851. }
  852. ]
  853. }
  854. },
  855. "response": []
  856. },
  857. {
  858. "name": "获取媒体流播放器列表(getMediaPlayerList)",
  859. "request": {
  860. "method": "GET",
  861. "header": [],
  862. "url": {
  863. "raw": "{{ZLMediaKit_URL}}/index/api/getMediaPlayerList?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=proxy&stream=1",
  864. "host": [
  865. "{{ZLMediaKit_URL}}"
  866. ],
  867. "path": [
  868. "index",
  869. "api",
  870. "getMediaPlayerList"
  871. ],
  872. "query": [
  873. {
  874. "key": "secret",
  875. "value": "{{ZLMediaKit_secret}}",
  876. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  877. },
  878. {
  879. "key": "schema",
  880. "value": "rtsp",
  881. "description": "协议,例如 rtsp或rtmp"
  882. },
  883. {
  884. "key": "vhost",
  885. "value": "{{defaultVhost}}",
  886. "description": "虚拟主机,例如__defaultVhost__"
  887. },
  888. {
  889. "key": "app",
  890. "value": "proxy",
  891. "description": "应用名,例如 live"
  892. },
  893. {
  894. "key": "stream",
  895. "value": "1",
  896. "description": "流id,例如 test"
  897. }
  898. ]
  899. }
  900. },
  901. "response": []
  902. },
  903. {
  904. "name": "获取流信息(getMediaInfo)",
  905. "request": {
  906. "method": "GET",
  907. "header": [],
  908. "url": {
  909. "raw": "{{ZLMediaKit_URL}}/index/api/getMediaInfo?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=mym9",
  910. "host": [
  911. "{{ZLMediaKit_URL}}"
  912. ],
  913. "path": [
  914. "index",
  915. "api",
  916. "getMediaInfo"
  917. ],
  918. "query": [
  919. {
  920. "key": "secret",
  921. "value": "{{ZLMediaKit_secret}}",
  922. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  923. },
  924. {
  925. "key": "schema",
  926. "value": "rtsp",
  927. "description": "协议,例如 rtsp或rtmp"
  928. },
  929. {
  930. "key": "vhost",
  931. "value": "{{defaultVhost}}",
  932. "description": "虚拟主机,例如__defaultVhost__"
  933. },
  934. {
  935. "key": "app",
  936. "value": "live",
  937. "description": "应用名,例如 live"
  938. },
  939. {
  940. "key": "stream",
  941. "value": "mym9",
  942. "description": "流id,例如 test"
  943. }
  944. ]
  945. }
  946. },
  947. "response": []
  948. },
  949. {
  950. "name": "获取流信息(getMp4RecordFile)",
  951. "request": {
  952. "method": "GET",
  953. "header": [],
  954. "url": {
  955. "raw": "{{ZLMediaKit_URL}}/index/api/getMp4RecordFile?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=proxy&stream=2&customized_path=/www&period=2020-05-26",
  956. "host": [
  957. "{{ZLMediaKit_URL}}"
  958. ],
  959. "path": [
  960. "index",
  961. "api",
  962. "getMp4RecordFile"
  963. ],
  964. "query": [
  965. {
  966. "key": "secret",
  967. "value": "{{ZLMediaKit_secret}}",
  968. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  969. },
  970. {
  971. "key": "vhost",
  972. "value": "{{defaultVhost}}",
  973. "description": "虚拟主机,例如__defaultVhost__"
  974. },
  975. {
  976. "key": "app",
  977. "value": "proxy",
  978. "description": "应用名,例如 live"
  979. },
  980. {
  981. "key": "stream",
  982. "value": "2",
  983. "description": "流id,例如 test"
  984. },
  985. {
  986. "key": "customized_path",
  987. "value": "/www",
  988. "description": "录像文件保存自定义根目录,为空则采用配置文件设置"
  989. },
  990. {
  991. "key": "period",
  992. "value": "2020-05-26",
  993. "description": "流的录像日期,格式为2020-02-01,如果不是完整的日期,那么是搜索录像文件夹列表,否则搜索对应日期下的mp4文件列表"
  994. }
  995. ]
  996. }
  997. },
  998. "response": []
  999. },
  1000. {
  1001. "name": "删除录像文件夹(deleteRecordDirectory)",
  1002. "request": {
  1003. "method": "GET",
  1004. "header": [],
  1005. "url": {
  1006. "raw": "{{ZLMediaKit_URL}}/index/api/deleteRecordDirectory?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=proxy&stream=2&period=2020-01-01",
  1007. "host": [
  1008. "{{ZLMediaKit_URL}}"
  1009. ],
  1010. "path": [
  1011. "index",
  1012. "api",
  1013. "deleteRecordDirectory"
  1014. ],
  1015. "query": [
  1016. {
  1017. "key": "secret",
  1018. "value": "{{ZLMediaKit_secret}}",
  1019. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1020. },
  1021. {
  1022. "key": "vhost",
  1023. "value": "{{defaultVhost}}",
  1024. "description": "虚拟主机,例如__defaultVhost__"
  1025. },
  1026. {
  1027. "key": "app",
  1028. "value": "proxy",
  1029. "description": "应用名,例如 live"
  1030. },
  1031. {
  1032. "key": "stream",
  1033. "value": "2",
  1034. "description": "流id,例如 test"
  1035. },
  1036. {
  1037. "key": "period",
  1038. "value": "2020-01-01",
  1039. "description": "流的录像日期,格式为2020-01-01,如果不是完整的日期,那么会删除失败"
  1040. }
  1041. ]
  1042. }
  1043. },
  1044. "response": []
  1045. },
  1046. {
  1047. "name": "开始录制(startRecord)",
  1048. "request": {
  1049. "method": "GET",
  1050. "header": [],
  1051. "url": {
  1052. "raw": "{{ZLMediaKit_URL}}/index/api/startRecord?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
  1053. "host": [
  1054. "{{ZLMediaKit_URL}}"
  1055. ],
  1056. "path": [
  1057. "index",
  1058. "api",
  1059. "startRecord"
  1060. ],
  1061. "query": [
  1062. {
  1063. "key": "secret",
  1064. "value": "{{ZLMediaKit_secret}}",
  1065. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1066. },
  1067. {
  1068. "key": "type",
  1069. "value": "1",
  1070. "description": "0为hls,1为mp4"
  1071. },
  1072. {
  1073. "key": "vhost",
  1074. "value": "{{defaultVhost}}",
  1075. "description": "虚拟主机,例如__defaultVhost__"
  1076. },
  1077. {
  1078. "key": "app",
  1079. "value": "live",
  1080. "description": "应用名,例如 live"
  1081. },
  1082. {
  1083. "key": "stream",
  1084. "value": "obs",
  1085. "description": "流id,例如 obs"
  1086. },
  1087. {
  1088. "key": "customized_path",
  1089. "value": null,
  1090. "description": "录像文件保存自定义根目录,为空则采用配置文件设置",
  1091. "disabled": true
  1092. },
  1093. {
  1094. "key": "max_second",
  1095. "value": "1000",
  1096. "description": "MP4录制的切片时间大小,单位秒",
  1097. "disabled": true
  1098. }
  1099. ]
  1100. }
  1101. },
  1102. "response": []
  1103. },
  1104. {
  1105. "name": "设置录像速度(setRecordSpeed)",
  1106. "request": {
  1107. "method": "GET",
  1108. "header": [],
  1109. "url": {
  1110. "raw": "{{ZLMediaKit_URL}}/index/api/setRecordSpeed?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&speed=2.0",
  1111. "host": [
  1112. "{{ZLMediaKit_URL}}"
  1113. ],
  1114. "path": [
  1115. "index",
  1116. "api",
  1117. "setRecordSpeed"
  1118. ],
  1119. "query": [
  1120. {
  1121. "key": "secret",
  1122. "value": "{{ZLMediaKit_secret}}",
  1123. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1124. },
  1125. {
  1126. "key": "vhost",
  1127. "value": "{{defaultVhost}}",
  1128. "description": "虚拟主机,例如__defaultVhost__"
  1129. },
  1130. {
  1131. "key": "app",
  1132. "value": "live",
  1133. "description": "应用名,例如 live"
  1134. },
  1135. {
  1136. "key": "stream",
  1137. "value": "obs",
  1138. "description": "流id,例如 obs"
  1139. },
  1140. {
  1141. "key": "speed",
  1142. "value": "2.0",
  1143. "description": "要设置的录像倍速"
  1144. }
  1145. ]
  1146. }
  1147. },
  1148. "response": []
  1149. },
  1150. {
  1151. "name": "设置录像流播放位置(seekRecordStamp)",
  1152. "request": {
  1153. "method": "GET",
  1154. "header": [],
  1155. "url": {
  1156. "raw": "{{ZLMediaKit_URL}}/index/api/seekRecordStamp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&stamp",
  1157. "host": [
  1158. "{{ZLMediaKit_URL}}"
  1159. ],
  1160. "path": [
  1161. "index",
  1162. "api",
  1163. "seekRecordStamp"
  1164. ],
  1165. "query": [
  1166. {
  1167. "key": "secret",
  1168. "value": "{{ZLMediaKit_secret}}",
  1169. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1170. },
  1171. {
  1172. "key": "vhost",
  1173. "value": "{{defaultVhost}}",
  1174. "description": "虚拟主机,例如__defaultVhost__"
  1175. },
  1176. {
  1177. "key": "app",
  1178. "value": "live",
  1179. "description": "应用名,例如 live"
  1180. },
  1181. {
  1182. "key": "stream",
  1183. "value": "obs",
  1184. "description": "流id,例如 obs"
  1185. },
  1186. {
  1187. "key": "stamp",
  1188. "value": 1000,
  1189. "description": "要设置的录像播放位置"
  1190. }
  1191. ]
  1192. }
  1193. },
  1194. "response": []
  1195. },
  1196. {
  1197. "name": "停止录制(stopRecord)",
  1198. "request": {
  1199. "method": "GET",
  1200. "header": [],
  1201. "url": {
  1202. "raw": "{{ZLMediaKit_URL}}/index/api/stopRecord?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
  1203. "host": [
  1204. "{{ZLMediaKit_URL}}"
  1205. ],
  1206. "path": [
  1207. "index",
  1208. "api",
  1209. "stopRecord"
  1210. ],
  1211. "query": [
  1212. {
  1213. "key": "secret",
  1214. "value": "{{ZLMediaKit_secret}}",
  1215. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1216. },
  1217. {
  1218. "key": "type",
  1219. "value": "1",
  1220. "description": "0为hls,1为mp4"
  1221. },
  1222. {
  1223. "key": "vhost",
  1224. "value": "{{defaultVhost}}",
  1225. "description": "虚拟主机,例如__defaultVhost__"
  1226. },
  1227. {
  1228. "key": "app",
  1229. "value": "live",
  1230. "description": "应用名,例如 live"
  1231. },
  1232. {
  1233. "key": "stream",
  1234. "value": "obs",
  1235. "description": "流id,例如 obs"
  1236. }
  1237. ]
  1238. }
  1239. },
  1240. "response": []
  1241. },
  1242. {
  1243. "name": "是否正在录制(isRecording)",
  1244. "request": {
  1245. "method": "GET",
  1246. "header": [],
  1247. "url": {
  1248. "raw": "{{ZLMediaKit_URL}}/index/api/isRecording?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
  1249. "host": [
  1250. "{{ZLMediaKit_URL}}"
  1251. ],
  1252. "path": [
  1253. "index",
  1254. "api",
  1255. "isRecording"
  1256. ],
  1257. "query": [
  1258. {
  1259. "key": "secret",
  1260. "value": "{{ZLMediaKit_secret}}",
  1261. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1262. },
  1263. {
  1264. "key": "type",
  1265. "value": "1",
  1266. "description": "0为hls,1为mp4"
  1267. },
  1268. {
  1269. "key": "vhost",
  1270. "value": "{{defaultVhost}}",
  1271. "description": "虚拟主机,例如__defaultVhost__"
  1272. },
  1273. {
  1274. "key": "app",
  1275. "value": "live",
  1276. "description": "应用名,例如 live"
  1277. },
  1278. {
  1279. "key": "stream",
  1280. "value": "obs",
  1281. "description": "流id,例如 obs"
  1282. }
  1283. ]
  1284. }
  1285. },
  1286. "response": []
  1287. },
  1288. {
  1289. "name": "获取截图(getSnap)",
  1290. "request": {
  1291. "method": "GET",
  1292. "header": [],
  1293. "url": {
  1294. "raw": "{{ZLMediaKit_URL}}/index/api/getSnap?secret={{ZLMediaKit_secret}}&url=rtsp://www.mym9.com/101065?from=2019-06-28/01:12:13&timeout_sec=10&expire_sec=1",
  1295. "host": [
  1296. "{{ZLMediaKit_URL}}"
  1297. ],
  1298. "path": [
  1299. "index",
  1300. "api",
  1301. "getSnap"
  1302. ],
  1303. "query": [
  1304. {
  1305. "key": "secret",
  1306. "value": "{{ZLMediaKit_secret}}",
  1307. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1308. },
  1309. {
  1310. "key": "url",
  1311. "value": "rtsp://www.mym9.com/101065?from=2019-06-28/01:12:13",
  1312. "description": "需要截图的url,可以是本机的,也可以是远程主机的"
  1313. },
  1314. {
  1315. "key": "timeout_sec",
  1316. "value": "10",
  1317. "description": "截图失败超时时间,防止FFmpeg一直等待截图"
  1318. },
  1319. {
  1320. "key": "expire_sec",
  1321. "value": "1",
  1322. "description": "截图的过期时间,该时间内产生的截图都会作为缓存返回"
  1323. }
  1324. ]
  1325. }
  1326. },
  1327. "response": []
  1328. },
  1329. {
  1330. "name": "获取rtp推流信息(getRtpInfo)",
  1331. "request": {
  1332. "method": "GET",
  1333. "header": [],
  1334. "url": {
  1335. "raw": "{{ZLMediaKit_URL}}/index/api/getRtpInfo?secret={{ZLMediaKit_secret}}&stream_id=test",
  1336. "host": [
  1337. "{{ZLMediaKit_URL}}"
  1338. ],
  1339. "path": [
  1340. "index",
  1341. "api",
  1342. "getRtpInfo"
  1343. ],
  1344. "query": [
  1345. {
  1346. "key": "secret",
  1347. "value": "{{ZLMediaKit_secret}}",
  1348. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1349. },
  1350. {
  1351. "key": "stream_id",
  1352. "value": "test",
  1353. "description": "流id"
  1354. }
  1355. ]
  1356. }
  1357. },
  1358. "response": []
  1359. },
  1360. {
  1361. "name": "创建RTP服务器(openRtpServer)",
  1362. "request": {
  1363. "method": "GET",
  1364. "header": [],
  1365. "url": {
  1366. "raw": "{{ZLMediaKit_URL}}/index/api/openRtpServer?secret={{ZLMediaKit_secret}}&port=0&enable_tcp=1&stream_id=test",
  1367. "host": [
  1368. "{{ZLMediaKit_URL}}"
  1369. ],
  1370. "path": [
  1371. "index",
  1372. "api",
  1373. "openRtpServer"
  1374. ],
  1375. "query": [
  1376. {
  1377. "key": "secret",
  1378. "value": "{{ZLMediaKit_secret}}",
  1379. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1380. },
  1381. {
  1382. "key": "port",
  1383. "value": "0",
  1384. "description": "绑定的端口,0时为随机端口"
  1385. },
  1386. {
  1387. "key": "tcp_mode",
  1388. "value": "1",
  1389. "description": "tcp模式,0时为不启用tcp监听,1时为启用tcp监听,2时为tcp主动连接模式"
  1390. },
  1391. {
  1392. "key": "stream_id",
  1393. "value": "test",
  1394. "description": "该端口绑定的流id\n"
  1395. },
  1396. {
  1397. "key": "re_use_port",
  1398. "value": "0",
  1399. "description": "是否重用端口,默认为0,非必选参数",
  1400. "disabled": true
  1401. },
  1402. {
  1403. "key": "ssrc",
  1404. "value": "0",
  1405. "description": "是否指定收流的rtp ssrc, 十进制数字,不指定或指定0时则不过滤rtp,非必选参数",
  1406. "disabled": true
  1407. }
  1408. ]
  1409. }
  1410. },
  1411. "response": []
  1412. },
  1413. {
  1414. "name": "连接RTP服务器(connectRtpServer)",
  1415. "request": {
  1416. "method": "GET",
  1417. "header": [],
  1418. "url": {
  1419. "raw": "{{ZLMediaKit_URL}}/index/api/connectRtpServer?secret={{ZLMediaKit_secret}}&dst_url=127.0.0.1&dst_port=10000&stream_id=test",
  1420. "host": [
  1421. "{{ZLMediaKit_URL}}"
  1422. ],
  1423. "path": [
  1424. "index",
  1425. "api",
  1426. "connectRtpServer"
  1427. ],
  1428. "query": [
  1429. {
  1430. "key": "secret",
  1431. "value": "{{ZLMediaKit_secret}}",
  1432. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1433. },
  1434. {
  1435. "key": "dst_url",
  1436. "value": "0",
  1437. "description": "tcp主动模式时服务端地址"
  1438. },
  1439. {
  1440. "key": "dst_port",
  1441. "value": "1",
  1442. "description": "tcp主动模式时服务端端口"
  1443. },
  1444. {
  1445. "key": "stream_id",
  1446. "value": "test",
  1447. "description": "OpenRtpServer时绑定的流id\n"
  1448. }
  1449. ]
  1450. }
  1451. },
  1452. "response": []
  1453. },
  1454. {
  1455. "name": "关闭RTP服务器(closeRtpServer)",
  1456. "request": {
  1457. "method": "GET",
  1458. "header": [],
  1459. "url": {
  1460. "raw": "{{ZLMediaKit_URL}}/index/api/closeRtpServer?secret={{ZLMediaKit_secret}}&stream_id=test",
  1461. "host": [
  1462. "{{ZLMediaKit_URL}}"
  1463. ],
  1464. "path": [
  1465. "index",
  1466. "api",
  1467. "closeRtpServer"
  1468. ],
  1469. "query": [
  1470. {
  1471. "key": "secret",
  1472. "value": "{{ZLMediaKit_secret}}",
  1473. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1474. },
  1475. {
  1476. "key": "stream_id",
  1477. "value": "test",
  1478. "description": "该端口绑定的流id"
  1479. }
  1480. ]
  1481. }
  1482. },
  1483. "response": []
  1484. },
  1485. {
  1486. "name": "暂停RTP超时检查(pauseRtpCheck)",
  1487. "request": {
  1488. "method": "GET",
  1489. "header": [],
  1490. "url": {
  1491. "raw": "{{ZLMediaKit_URL}}/index/api/pauseRtpCheck?secret={{ZLMediaKit_secret}}&stream_id=test",
  1492. "host": [
  1493. "{{ZLMediaKit_URL}}"
  1494. ],
  1495. "path": [
  1496. "index",
  1497. "api",
  1498. "pauseRtpCheck"
  1499. ],
  1500. "query": [
  1501. {
  1502. "key": "secret",
  1503. "value": "{{ZLMediaKit_secret}}",
  1504. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1505. },
  1506. {
  1507. "key": "stream_id",
  1508. "value": "test",
  1509. "description": "该端口绑定的流id"
  1510. }
  1511. ]
  1512. }
  1513. },
  1514. "response": []
  1515. },
  1516. {
  1517. "name": "恢复RTP超时检查(resumeRtpCheck)",
  1518. "request": {
  1519. "method": "GET",
  1520. "header": [],
  1521. "url": {
  1522. "raw": "{{ZLMediaKit_URL}}/index/api/resumeRtpCheck?secret={{ZLMediaKit_secret}}&stream_id=test",
  1523. "host": [
  1524. "{{ZLMediaKit_URL}}"
  1525. ],
  1526. "path": [
  1527. "index",
  1528. "api",
  1529. "resumeRtpCheck"
  1530. ],
  1531. "query": [
  1532. {
  1533. "key": "secret",
  1534. "value": "{{ZLMediaKit_secret}}",
  1535. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1536. },
  1537. {
  1538. "key": "stream_id",
  1539. "value": "test",
  1540. "description": "该端口绑定的流id"
  1541. }
  1542. ]
  1543. }
  1544. },
  1545. "response": []
  1546. },
  1547. {
  1548. "name": "获取RTP服务器列表(listRtpServer)",
  1549. "request": {
  1550. "method": "GET",
  1551. "header": [],
  1552. "url": {
  1553. "raw": "{{ZLMediaKit_URL}}/index/api/listRtpServer?secret={{ZLMediaKit_secret}}",
  1554. "host": [
  1555. "{{ZLMediaKit_URL}}"
  1556. ],
  1557. "path": [
  1558. "index",
  1559. "api",
  1560. "listRtpServer"
  1561. ],
  1562. "query": [
  1563. {
  1564. "key": "secret",
  1565. "value": "{{ZLMediaKit_secret}}",
  1566. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1567. }
  1568. ]
  1569. }
  1570. },
  1571. "response": []
  1572. },
  1573. {
  1574. "name": "开始发送rtp(startSendRtp)",
  1575. "request": {
  1576. "method": "GET",
  1577. "header": [],
  1578. "url": {
  1579. "raw": "{{ZLMediaKit_URL}}/index/api/startSendRtp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&ssrc=1&dst_url=127.0.0.1&dst_port=10000&is_udp=0",
  1580. "host": [
  1581. "{{ZLMediaKit_URL}}"
  1582. ],
  1583. "path": [
  1584. "index",
  1585. "api",
  1586. "startSendRtp"
  1587. ],
  1588. "query": [
  1589. {
  1590. "key": "secret",
  1591. "value": "{{ZLMediaKit_secret}}",
  1592. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1593. },
  1594. {
  1595. "key": "vhost",
  1596. "value": "{{defaultVhost}}",
  1597. "description": "虚拟主机,例如__defaultVhost__"
  1598. },
  1599. {
  1600. "key": "app",
  1601. "value": "live",
  1602. "description": "应用名,例如 live"
  1603. },
  1604. {
  1605. "key": "stream",
  1606. "value": "obs",
  1607. "description": "流id,例如 obs"
  1608. },
  1609. {
  1610. "key": "ssrc",
  1611. "value": "1",
  1612. "description": "rtp推流的ssrc,ssrc不同时,可以推流到多个上级服务器"
  1613. },
  1614. {
  1615. "key": "dst_url",
  1616. "value": "127.0.0.1",
  1617. "description": "目标ip或域名"
  1618. },
  1619. {
  1620. "key": "dst_port",
  1621. "value": "10000",
  1622. "description": "目标端口"
  1623. },
  1624. {
  1625. "key": "is_udp",
  1626. "value": "0",
  1627. "description": "是否为udp模式,否则为tcp模式"
  1628. },
  1629. {
  1630. "key": "src_port",
  1631. "value": "0",
  1632. "description": "指定tcp/udp客户端使用的本地端口,0时为随机端口,该参数非必选参数,不传时为随机端口。",
  1633. "disabled": true
  1634. },
  1635. {
  1636. "key": "from_mp4",
  1637. "value": "0",
  1638. "description": "是否推送本地MP4录像,该参数非必选参数",
  1639. "disabled": true
  1640. },
  1641. {
  1642. "key": "use_ps",
  1643. "value": "1",
  1644. "description": "rtp打包采用ps还是es模式,默认采用ps模式,该参数非必选参数",
  1645. "disabled": true
  1646. },
  1647. {
  1648. "key": "pt",
  1649. "value": "96",
  1650. "description": "rtp payload type,默认96,该参数非必选参数",
  1651. "disabled": true
  1652. },
  1653. {
  1654. "key": "only_audio",
  1655. "value": "1",
  1656. "description": "rtp es方式打包时,是否只打包音频,该参数非必选参数",
  1657. "disabled": true
  1658. },
  1659. {
  1660. "key": "udp_rtcp_timeout",
  1661. "value": "0",
  1662. "description": "udp方式推流时,是否开启rtcp发送和rtcp接收超时判断,开启后(默认关闭),如果接收rr rtcp超时,将导致主动停止rtp发送",
  1663. "disabled": true
  1664. }
  1665. ]
  1666. }
  1667. },
  1668. "response": []
  1669. },
  1670. {
  1671. "name": "开始tcp passive被动发送rtp(startSendRtpPassive)",
  1672. "request": {
  1673. "method": "GET",
  1674. "header": [],
  1675. "url": {
  1676. "raw": "{{ZLMediaKit_URL}}/index/api/startSendRtpPassive?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=test&ssrc=1",
  1677. "host": [
  1678. "{{ZLMediaKit_URL}}"
  1679. ],
  1680. "path": [
  1681. "index",
  1682. "api",
  1683. "startSendRtpPassive"
  1684. ],
  1685. "query": [
  1686. {
  1687. "key": "secret",
  1688. "value": "{{ZLMediaKit_secret}}",
  1689. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1690. },
  1691. {
  1692. "key": "vhost",
  1693. "value": "{{defaultVhost}}",
  1694. "description": "虚拟主机,例如__defaultVhost__"
  1695. },
  1696. {
  1697. "key": "app",
  1698. "value": "live",
  1699. "description": "应用名,例如 live"
  1700. },
  1701. {
  1702. "key": "stream",
  1703. "value": "test",
  1704. "description": "流id,例如 obs"
  1705. },
  1706. {
  1707. "key": "ssrc",
  1708. "value": "1",
  1709. "description": "rtp推流的ssrc,ssrc不同时,可以推流到多个上级服务器"
  1710. },
  1711. {
  1712. "key": "src_port",
  1713. "value": "0",
  1714. "description": "指定tcp/udp客户端使用的本地端口,0时为随机端口,该参数非必选参数,不传时为随机端口。",
  1715. "disabled": true
  1716. },
  1717. {
  1718. "key": "from_mp4",
  1719. "value": "0",
  1720. "description": "是否推送本地MP4录像,该参数非必选参数",
  1721. "disabled": true
  1722. },
  1723. {
  1724. "key": "use_ps",
  1725. "value": "1",
  1726. "description": "rtp打包采用ps还是es模式,默认采用ps模式,该参数非必选参数",
  1727. "disabled": true
  1728. },
  1729. {
  1730. "key": "pt",
  1731. "value": "96",
  1732. "description": "rtp payload type,默认96,该参数非必选参数",
  1733. "disabled": true
  1734. },
  1735. {
  1736. "key": "only_audio",
  1737. "value": "1",
  1738. "description": "rtp es方式打包时,是否只打包音频,该参数非必选参数",
  1739. "disabled": true
  1740. }
  1741. ]
  1742. }
  1743. },
  1744. "response": []
  1745. },
  1746. {
  1747. "name": "停止 发送rtp(stopSendRtp)",
  1748. "request": {
  1749. "method": "GET",
  1750. "header": [],
  1751. "url": {
  1752. "raw": "{{ZLMediaKit_URL}}/index/api/stopSendRtp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs",
  1753. "host": [
  1754. "{{ZLMediaKit_URL}}"
  1755. ],
  1756. "path": [
  1757. "index",
  1758. "api",
  1759. "stopSendRtp"
  1760. ],
  1761. "query": [
  1762. {
  1763. "key": "secret",
  1764. "value": "{{ZLMediaKit_secret}}",
  1765. "description": "api操作密钥(配置文件配置),如果操作ip是127.0.0.1,则不需要此参数"
  1766. },
  1767. {
  1768. "key": "vhost",
  1769. "value": "{{defaultVhost}}",
  1770. "description": "虚拟主机,例如__defaultVhost__"
  1771. },
  1772. {
  1773. "key": "app",
  1774. "value": "live",
  1775. "description": "应用名,例如 live"
  1776. },
  1777. {
  1778. "key": "stream",
  1779. "value": "obs",
  1780. "description": "流id,例如 obs"
  1781. },
  1782. {
  1783. "key": "ssrc",
  1784. "value": "",
  1785. "description": "根据ssrc关停某路rtp推流,不传时关闭所有推流",
  1786. "disabled": true
  1787. }
  1788. ]
  1789. }
  1790. },
  1791. "response": []
  1792. },
  1793. {
  1794. "name": "获取版本信息(version)",
  1795. "request": {
  1796. "method": "GET",
  1797. "header": [],
  1798. "url": {
  1799. "raw": "{{ZLMediaKit_URL}}/index/api/version?secret={{ZLMediaKit_secret}}",
  1800. "host": [
  1801. "{{ZLMediaKit_URL}}"
  1802. ],
  1803. "path": [
  1804. "index",
  1805. "api",
  1806. "version"
  1807. ],
  1808. "query": [
  1809. {
  1810. "key": "secret",
  1811. "value": "{{ZLMediaKit_secret}}"
  1812. }
  1813. ]
  1814. }
  1815. },
  1816. "response": []
  1817. }
  1818. ],
  1819. "event": [
  1820. {
  1821. "listen": "prerequest",
  1822. "script": {
  1823. "type": "text/javascript",
  1824. "exec": [
  1825. ""
  1826. ]
  1827. }
  1828. },
  1829. {
  1830. "listen": "test",
  1831. "script": {
  1832. "type": "text/javascript",
  1833. "exec": [
  1834. ""
  1835. ]
  1836. }
  1837. }
  1838. ],
  1839. "variable": [
  1840. {
  1841. "key": "ZLMediaKit_URL",
  1842. "value": "zlmediakit.com:8880"
  1843. },
  1844. {
  1845. "key": "ZLMediaKit_secret",
  1846. "value": "035c73f7-bb6b-4889-a715-d9eb2d1925cc"
  1847. },
  1848. {
  1849. "key": "defaultVhost",
  1850. "value": "__defaultVhost__"
  1851. }
  1852. ]
  1853. }