Mirror/ZLMediaKit
1
0
Fork 0
mirror of https://github.com/ZLMediaKit/ZLMediaKit.git synced 2026-07-09 07:20:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated MediaServer支持的HTTP HOOK API (markdown)

xiongguangjie
2025-02-14 18:28:21 +08:00
parent 2e8c207ebc
commit f0d3487182
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
MediaServer支持的HTTP-HOOK-API.md

@@ -75,6 +75,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"params" : "token=1677193e-1244-49f2-8868-13b3fcc31b17", "params" : "token=1677193e-1244-49f2-8868-13b3fcc31b17",
"player" : false, "player" : false,
"schema" : "rtmp", "schema" : "rtmp",
"protocol" : "rtmp",
"stream" : "obs", "stream" : "obs",
"totalBytes" : 1508161, "totalBytes" : 1508161,
"vhost" : "__defaultVhost__", "vhost" : "__defaultVhost__",
@@ -91,7 +92,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `duration` | `int` | tcp链接维持时间，单位秒 | | `duration` | `int` | tcp链接维持时间，单位秒 |
| `params` | `string` | 推流或播放url参数 | | `params` | `string` | 推流或播放url参数 |
| `player` | `bool` | true为播放器，false为推流器 | | `player` | `bool` | true为播放器，false为推流器 |
| `schema` | `string` | 播放或推流的协议，可能是rtsp、rtmp、http | | `schema` | `string` | 播放或推流的媒体源类型，可能是rtsp、rtmp、fmp4、ts、hls |
| `protocol` | `string` | 传输的协议，可能是/http/https/ws/wss/rtsp/rtmp/rtsps/rtmps/rtc/srt/rtp/tcp/udp |
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `totalBytes` | `int` | 耗费上下行流量总和，单位字节 | | `totalBytes` | `int` | 耗费上下行流量总和，单位字节 |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
@@ -236,6 +238,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"params" : "", "params" : "",
"port" : 65217, "port" : 65217,
"schema" : "rtmp", "schema" : "rtmp",
"protocol" : "rtmp",
"stream" : "obs", "stream" : "obs",
"vhost" : "__defaultVhost__" "vhost" : "__defaultVhost__"
} }
@@ -251,7 +254,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `ip` | `string` | 播放器ip | | `ip` | `string` | 播放器ip |
| `params` | `string` | 播放url参数 | | `params` | `string` | 播放url参数 |
| `port` | `unsigned short` | 播放器端口号 | | `port` | `unsigned short` | 播放器端口号 |
| `schema` | `string` | 播放的协议，可能是rtsp、rtmp、http | | `schema` | `string` | 播放的媒体源类型，可能是rtsp、rtmp、fmp4、ts、hls |
| `protocol` | `string` | 播放的传输协议，可能是rtsp/rtmp/rtsps/rtmps/rtc/srt/rtp/tcp/udp |
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
| `mediaServerId` | `string` | 服务器id,通过配置文件设置 | | `mediaServerId` | `string` | 服务器id,通过配置文件设置 |
@@ -310,6 +314,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"params" : "token=1677193e-1244-49f2-8868-13b3fcc31b17", "params" : "token=1677193e-1244-49f2-8868-13b3fcc31b17",
"port" : 65284, "port" : 65284,
"schema" : "rtmp", "schema" : "rtmp",
"protocol" : "rtmp",
"stream" : "obs", "stream" : "obs",
"vhost" : "__defaultVhost__" "vhost" : "__defaultVhost__"
} }
@@ -325,7 +330,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `ip` | `string` | 推流器ip | | `ip` | `string` | 推流器ip |
| `params` | `string` | 推流url参数 | | `params` | `string` | 推流url参数 |
| `port` | `unsigned short` | 推流器端口号 | | `port` | `unsigned short` | 推流器端口号 |
| `schema` | `string` | 推流的协议，可能是rtsp、rtmp | | `schema` | `string` | 推流的媒体源类型，可能是rtsp、rtmp、srt |
| `protocol` | `string` | 推流的传输协议，可能是rtsp/rtmp/rtsps/rtmps/rtc/srt/rtp/tcp/udp |
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
| `mediaServerId` | `string` | 服务器id,通过配置文件设置 | | `mediaServerId` | `string` | 服务器id,通过配置文件设置 |
@@ -492,6 +498,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"params" : "", "params" : "",
"port" : 65473, "port" : 65473,
"schema" : "rtsp", "schema" : "rtsp",
"protocol" : "rtsp",
"stream" : "obs", "stream" : "obs",
"vhost" : "__defaultVhost__" "vhost" : "__defaultVhost__"
} }
@@ -506,7 +513,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `ip` | `string` | rtsp播放器ip | | `ip` | `string` | rtsp播放器ip |
| `params` | `string` | 播放rtsp url参数 | | `params` | `string` | 播放rtsp url参数 |
| `port` | `unsigned short` | rtsp播放器端口号 | | `port` | `unsigned short` | rtsp播放器端口号 |
| `schema` | `string` | rtsp或rtsps | | `schema` | `string` | rtsp |
| `protocol` | `string` | 传输协议|
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
| `mediaServerId` | `string` | 服务器id,通过配置文件设置 | | `mediaServerId` | `string` | 服务器id,通过配置文件设置 |
@@ -568,6 +576,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"port" : 65473, "port" : 65473,
"realm" : "zlmediakit_reaml", "realm" : "zlmediakit_reaml",
"schema" : "rtsp", "schema" : "rtsp",
"protocol" : "rtsps",
"stream" : "obs", "stream" : "obs",
"user_name" : "test", "user_name" : "test",
"vhost" : "__defaultVhost__" "vhost" : "__defaultVhost__"
@@ -586,7 +595,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `params` | `string` | rtsp url参数 | | `params` | `string` | rtsp url参数 |
| `port` | `unsigned short` | rtsp播放器端口号 | | `port` | `unsigned short` | rtsp播放器端口号 |
| `realm` | `string` | rtsp播放鉴权加密realm | | `realm` | `string` | rtsp播放鉴权加密realm |
| `schema` | `string` | rtsp或rtsps | | `schema` | `string` | rtsp |
| `protocol` | `string` | rtsp或rtsps |
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `user_name` | `string` | 播放用户名 | | `user_name` | `string` | 播放用户名 |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
@@ -900,6 +910,7 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
"params" : "", "params" : "",
"port" : 49614, "port" : 49614,
"schema" : "rtsp", "schema" : "rtsp",
"protocol" : "rtsp",
"stream" : "obs", "stream" : "obs",
"vhost" : "__defaultVhost__" "vhost" : "__defaultVhost__"
} }
@@ -914,7 +925,8 @@ on_rtp_server_timeout=https://127.0.0.1/index/hook/on_rtp_server_timeout
| `ip` | `string` | 播放器ip | | `ip` | `string` | 播放器ip |
| `params` | `string` | 播放url参数 | | `params` | `string` | 播放url参数 |
| `port` | `unsigned short` | 播放器端口号 | | `port` | `unsigned short` | 播放器端口号 |
| `schema` | `string` | 播放的协议，可能是rtsp、rtmp | | `schema` | `string` | 播放媒体源类型，可能是rtsp、rtmp |
| `protocol` | `string` | 传输协议|
| `stream` | `string` | 流ID | | `stream` | `string` | 流ID |
| `vhost` | `string` | 流虚拟主机 | | `vhost` | `string` | 流虚拟主机 |
| `mediaServerId` | `string` | 服务器id,通过配置文件设置 | | `mediaServerId` | `string` | 服务器id,通过配置文件设置 |