3 ZLMediaKit API接口

ZLMediaKit API详解

MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些接口全部支持GET/POST方式，

"/index/api/addStreamProxy",
"/index/api/close_stream",
"/index/api/close_streams",
"/index/api/delFFmpegSource",
"/index/api/delStreamProxy",
"/index/api/getAllSession",
"/index/api/getApiList",
"/index/api/getMediaList",
"/index/api/getServerConfig",
"/index/api/getThreadsLoad",
"/index/api/getWorkThreadsLoad",
"/index/api/kick_session",
"/index/api/kick_sessions",
"/index/api/restartServer",
"/index/api/setServerConfig",
"/index/api/isMediaOnline",
"/index/api/getMediaInfo",
"/index/api/getRtpInfo",
"/index/api/getMp4RecordFile",
"/index/api/startRecord",
"/index/api/stopRecord",
"/index/api/getRecordStatus",
"/index/api/getSnap",
"/index/api/openRtpServer",
"/index/api/closeRtpServer",
"/index/api/listRtpServer",
"/index/api/startSendRtp",
"/index/api/stopSendRtp",
"/index/api/getStatistic",
"/index/api/addStreamPusherProxy",
"/index/api/delStreamPusherProxy"

其中POST方式，参数既可以使用urlencoded方式也可以使用json方式。操作这些api一般需要提供secret参数以便鉴权，如果操作ip是127.0.0.1，那么可以无需鉴权。
API返回结果约定

HTTP层面统一返回200状态码，body统一为json。
body一般为以下样式：

{
    "code" : -1,
    "msg" : "失败提示"
}

code值代表执行结果，目前包含以下类型：

typedef enum {
    Exception = -400,//代码抛异常
    InvalidArgs = -300,//参数不合法
    SqlFailed = -200,//sql执行失败
    AuthFailed = -100,//鉴权失败
    OtherFailed = -1,//业务代码执行失败，
    Success = 0//执行成功
} ApiErr;

如果执行成功，那么code == 0,并且一般无msg字段。
code == -1时代表业务代码执行不成功，更细的原因一般提供result字段，例如以下：

{
    "code" : -1, # 代表业务代码执行失败
    "msg" : "can not find the stream", # 失败提示
    "result" : -2 # 业务代码执行失败具体原因
}

开发者一般只要关注code字段和msg字段，如果code != 0时，打印显示msg字段即可。
code == 0时代表完全成功，如果有数据返回，一般提供data字段返回数据。

API详解
1. /index/api/getApiList

功能：获取API列表
范例：http://127.0.0.1/index/api/getApiList
参数：无
响应：

{
    "code": 0,
    "data": [
        "/index/",
        "/index/api/addFFmpegSource",
        "/index/api/addStreamProxy",
        "/index/api/addStreamPusherProxy",
        "/index/api/closeRtpServer",
        "/index/api/close_stream",
        "/index/api/delFFmpegSource",
        "/index/api/delStreamProxy",
        "/index/api/delStreamPusherProxy",
        "/index/api/downloadBin",
        "/index/api/getAllSession",
        "/index/api/getApiList",
        "/index/api/getMediaInfo",
        "/index/api/getMediaList",
        "/index/api/getMp4RecordFile",
        "/index/api/getRtpInfo",
        "/index/api/getServerConfig",
        "/index/api/getSnap",
        "/index/api/getStatistic",
        "/index/api/getThreadsLoad",
        "/index/api/getWorkThreadsLoad",
        "/index/api/isMediaOnline",
        "/index/api/isRecording",
        "/index/api/kick_session",
        "/index/api/kick_sessions",
        "/index/api/listRtpServer",
        "/index/api/openRtpServer",
        "/index/api/pauseRtpCheck",
        "/index/api/restartServer",
        "/index/api/resumeRtpCheck",
        "/index/api/setServerConfig",
        "/index/api/startRecord",
        "/index/api/startSendRtp",
        "/index/api/stopRecord",
        "/index/api/stopSendRtp",
        "/index/api/webrtc",
        "/index/hook/on_flow_report",
        "/index/hook/on_http_access",
        "/index/hook/on_play",
        "/index/hook/on_publish",
        "/index/hook/on_record_hls",
        "/index/hook/on_record_mp4",
        "/index/hook/on_rtsp_auth",
        "/index/hook/on_rtsp_realm",
        "/index/hook/on_server_started",
        "/index/hook/on_shell_login",
        "/index/hook/on_stream_changed",
        "/index/hook/on_stream_none_reader",
        "/index/hook/on_stream_not_found",
        "/index/hook/on_stream_not_found_ffmpeg"
    ]
}

2. /index/api/getThreadsLoad

功能：获取各epoll(或select)线程负载以及延时
范例：http://127.0.0.1/index/api/getThreadsLoad
参数：无
响应:

{
   "code" : 0,
   "data" : [
      {
         "delay" : 0, # 该线程延时
         "load" : 0 # 该线程负载，0 ~ 100
      },
      {
         "delay" : 0,
         "load" : 0
      }
   ]
}

3. /index/api/getWorkThreadsLoad

功能：获取各后台epoll(或select)线程负载以及延时
范例：http://127.0.0.1/index/api/getWorkThreadsLoad
参数：无
响应:

{
   "code" : 0,
   "data" : [
      {
         "delay" : 0, # 该线程延时
         "load" : 0 # 该线程负载，0 ~ 100
      },
      {
         "delay" : 0,
         "load" : 0
      }
   ]
}

4. /index/api/getServerConfig

功能：获取服务器配置
范例：http://127.0.0.1/index/api/getServerConfig
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
响应：

{
   "code" : 0,
   "data" : [
      {
         "api.apiDebug" : "1",
         "api.secret" : "035c73f7-bb6b-4889-a715-d9eb2d1925cc",
         "ffmpeg.bin" : "/usr/local/bin/ffmpeg",
         "ffmpeg.cmd" : "%s -i %s -c:a aac -strict -2 -ar 44100 -ab 48k -c:v libx264 -f flv %s",
         "ffmpeg.log" : "/Users/xzl/git/ZLMediaKit/cmake-build-debug/bin/ffmpeg/ffmpeg.log",
         "general.enableVhost" : "1",
         "general.flowThreshold" : "1024",
         "general.maxStreamWaitMS" : "5000",
         "general.streamNoneReaderDelayMS" : "5000",
         "hls.fileBufSize" : "65536",
         "hls.filePath" : "/Users/xzl/git/ZLMediaKit/cmake-build-debug/bin/httpRoot",
         "hls.segDur" : "3",
         "hls.segNum" : "3",
         "hook.access_file_except_hls" : "1",
         "hook.admin_params" : "secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc",
         "hook.enable" : "1",
         "hook.on_flow_report" : "https://127.0.0.1/index/hook/on_flow_report",
         "hook.on_http_access" : "https://127.0.0.1/index/hook/on_http_access",
         "hook.on_play" : "https://127.0.0.1/index/hook/on_play",
         "hook.on_publish" : "https://127.0.0.1/index/hook/on_publish",
         "hook.on_record_mp4" : "https://127.0.0.1/index/hook/on_record_mp4",
         "hook.on_rtsp_auth" : "https://127.0.0.1/index/hook/on_rtsp_auth",
         "hook.on_rtsp_realm" : "https://127.0.0.1/index/hook/on_rtsp_realm",
         "hook.on_shell_login" : "https://127.0.0.1/index/hook/on_shell_login",
         "hook.on_stream_changed" : "https://127.0.0.1/index/hook/on_stream_changed",
         "hook.on_stream_none_reader" : "https://127.0.0.1/index/hook/on_stream_none_reader",
         "hook.on_stream_not_found" : "https://127.0.0.1/index/hook/on_stream_not_found",
         "hook.timeoutSec" : "10",
         "http.charSet" : "utf-8",
         "http.keepAliveSecond" : "100",
         "http.maxReqCount" : "100",
         "http.maxReqSize" : "4096",
         "http.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.rootPath" : "/Users/xzl/git/ZLMediaKit/cmake-build-debug/bin/httpRoot",
         "http.sendBufSize" : "65536",
         "http.sslport" : "443",
         "multicast.addrMax" : "239.255.255.255",
         "multicast.addrMin" : "239.0.0.0",
         "multicast.udpTTL" : "64",
         "record.appName" : "record",
         "record.filePath" : "/Users/xzl/git/ZLMediaKit/cmake-build-debug/bin/httpRoot",
         "record.fileSecond" : "3600",
         "record.sampleMS" : "100",
         "rtmp.handshakeSecond" : "15",
         "rtmp.keepAliveSecond" : "15",
         "rtmp.modifyStamp" : "1",
         "rtmp.port" : "1935",
         "rtp.audioMtuSize" : "600",
         "rtp.clearCount" : "10",
         "rtp.cycleMS" : "46800000",
         "rtp.maxRtpCount" : "50",
         "rtp.videoMtuSize" : "1400",
         "rtsp.authBasic" : "0",
         "rtsp.handshakeSecond" : "15",
         "rtsp.keepAliveSecond" : "15",
         "rtsp.port" : "554",
         "rtsp.sslport" : "322",
         "shell.maxReqSize" : "1024",
         "shell.port" : "9000"
      }
   ]
}

5. /index/api/setServerConfig

功能：设置服务器配置
范例：http://127.0.0.1/index/api/setServerConfig?api.apiDebug=0(例如关闭http api调试)
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

响应：

{
   "changed" : 0, # 配置项变更个数
   "code" : 0     # 0代表成功
}

6. /index/api/restartServer

功能：重启服务器,只有Daemon方式才能重启，否则是直接关闭！
范例：http://127.0.0.1/index/api/restartServer
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

响应：

{
   "code" : 0,
   "msg" : "服务器将在一秒后自动重启"
}

7. /index/api/getMediaList

功能：获取流列表，可选筛选参数
范例：http://127.0.0.1/index/api/getMediaList

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
schema	N	筛选协议，例如 rtsp或rtmp
vhost	N	筛选虚拟主机，例如`__defaultVhost__`
app	N	筛选应用名，例如 live
stream	N	筛选流id，例如 test

响应：

{
  "code" : 0,
  "data" : [
   {
     "app" : "live",  # 应用名
     "readerCount" : 0, # 本协议观看人数
     "totalReaderCount" : 0, # 观看总人数，包括hls/rtsp/rtmp/http-flv/ws-flv
     "schema" : "rtsp", # 协议
     "stream" : "obs", # 流id
     "originSock": {  # 客户端和服务器网络信息，可能为null类型
            "identifier": "140241931428384",
            "local_ip": "127.0.0.1",
            "local_port": 1935,
            "peer_ip": "127.0.0.1",
            "peer_port": 50097
        },
     "originType": 1, # 产生源类型，包括 unknown = 0,rtmp_push=1,rtsp_push=2,rtp_push=3,pull=4,ffmpeg_pull=5,mp4_vod=6,device_chn=7
     "originTypeStr": "MediaOriginType::rtmp_push",
     "originUrl": "rtmp://127.0.0.1:1935/live/hks2", #产生源的url
     "createStamp": 1602205811, #GMT unix系统时间戳，单位秒
     "aliveSecond": 100, #存活时间，单位秒
     "bytesSpeed": 12345, #数据产生速度，单位byte/s
     "tracks" : [    # 音视频轨道
        {
           "channels" : 1, # 音频通道数
           "codec_id" : 2, # H264 = 0, H265 = 1, AAC = 2, G711A = 3, G711U = 4
           "codec_id_name" : "CodecAAC", # 编码类型名称 
           "codec_type" : 1, # Video = 0, Audio = 1
           "ready" : true, # 轨道是否准备就绪
           "sample_bit" : 16, # 音频采样位数
           "sample_rate" : 8000 # 音频采样率
        },
        {
           "codec_id" : 0, # H264 = 0, H265 = 1, AAC = 2, G711A = 3, G711U = 4
           "codec_id_name" : "CodecH264", # 编码类型名称  
           "codec_type" : 0, # Video = 0, Audio = 1
           "fps" : 59,  # 视频fps
           "height" : 720, # 视频高
           "ready" : true,  # 轨道是否准备就绪
           "width" : 1280 # 视频宽
        }
     ],
     "vhost" : "__defaultVhost__" # 虚拟主机名
   }
  ]
}

8. /index/api/close_streams

功能：关闭流(目前所有类型的流都支持关闭)
范例：http://127.0.0.1/index/api/close_streams?schema=rtmp&vhost=__defaultVhost__&app=live&stream=0&force=1

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
schema	N	协议，例如 rtsp或rtmp
vhost	N	虚拟主机，例如`__defaultVhost__`
app	N	应用名，例如 live
stream	N	流id，例如 test
force	N	是否强制关闭(有人在观看是否还关闭)

响应：

{
   "code" : 0,
   "count_hit" : 1,  # 筛选命中的流个数
   "count_closed" : 1 # 被关闭的流个数，可能小于count_hit
}

9. /index/api/getAllSession

功能：获取所有TcpSession列表(获取所有tcp客户端相关信息)
范例：http://127.0.0.1/index/api/getAllSession

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
local_port	N	筛选本机端口，例如筛选rtsp链接：554
peer_ip	N	筛选客户端ip

响应：

{
   "code" : 0,
   "data" : [
      {
         "id" : "140614477848784",
         "local_ip" : "127.0.0.1",
         "local_port" : 80,
         "peer_ip" : "127.0.0.1",
         "peer_port" : 51136,
         "typeid" : "16WebSocketSessionI11EchoSessionN8mediakit11HttpSessionEE"
      },
      {
         "id" : "140614443300192",
         "local_ip" : "127.0.0.1",
         "local_port" : 80,
         "peer_ip" : "127.0.0.1",
         "peer_port" : 51135,
         "typeid" : "16WebSocketSessionI11EchoSessionN8mediakit11HttpSessionEE"
      },
      {
         "id" : "140614440178720",  # 该tcp链接唯一id
         "local_ip" : "127.0.0.1",  # 本机网卡ip
         "local_port" : 1935,           # 本机端口号 (这是个rtmp播放器或推流器)
         "peer_ip" : "127.0.0.1",   # 客户端ip 
         "peer_port" : 51130,               # 客户端端口号
         "typeid" : "N8mediakit11RtmpSessionE"  # 客户端TCPSession typeid
      }
   ]
}

10. /index/api/kick_session

功能：断开tcp连接，比如说可以断开rtsp、rtmp播放器等
范例：http://127.0.0.1/index/api/kick_session?id=140614440178720
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

Id Y 客户端唯一id，可以通过getAllSession接口获取

响应：

{
   "code" : 0,
   "msg" : "success"
}

11. /index/api/kick_sessions

功能：断开tcp连接，比如说可以断开rtsp、rtmp播放器等
范例：http://127.0.0.1/index/api/kick_sessions?local_port=554

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
local_port	N	筛选本机端口，例如筛选rtsp链接：554
peer_ip	N	筛选客户端ip

响应：

{
   "code" : 0,
   "count_hit" : 1,# 筛选命中客户端个数
   "msg" : "success"
}

12. /index/api/addStreamProxy

功能：动态添加rtsp/rtmp/hls拉流代理(只支持H264/H265/aac/G711负载)
范例：http://127.0.0.1/index/api/addStreamProxy?vhost=__defaultVhost__&app=proxy&stream=0&url=rtmp://live.hkstv.hk.lxdns.com/live/hks2
参数：

参数	参数类型	释意	是否必选
secret	`string`	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数	Y
vhost	`string`	添加的流的虚拟主机，例如`__defaultVhost__`	Y
app	`string`	添加的流的应用名，例如live	Y
stream	`string`	添加的流的id名，例如test	Y
url	`string`	拉流地址，例如rtmp://live.hkstv.hk.lxdns.com/live/hks2	Y
retry_count	`int`	拉流重试次数，默认为-1无限重试	N
rtp_type	`int`	rtsp拉流时，拉流方式，0：tcp，1：udp，2：组播	N
timeout_sec	`int`	拉流超时时间，单位秒，float类型	N
`enable_hls`	`0/1`	是否转换成hls协议	N
`enable_mp4`	`0/1`	是否允许mp4录制	N
`enable_rtsp`	`0/1`	是否转rtsp协议	N
`enable_rtmp`	`0/1`	是否转rtmp/flv协议	N
`enable_ts`	`0/1`	是否转http-ts/ws-ts协议	N
`enable_fmp4`	`0/1`	是否转http-fmp4/ws-fmp4协议	N
`enable_audio`	`0/1`	转协议时是否开启音频	N
`add_mute_audio`	`0/1`	转协议时，无音频是否添加静音aac音频	N
`mp4_save_path`	`string`	mp4录制文件保存根目录，置空使用默认	N
`mp4_max_second`	`int`	mp4录制切片大小，单位秒	N
`hls_save_path`	`string`	hls文件保存保存根目录，置空使用默认	N

响应：

{
   "code" : 0,
   "data" : {
      "key" : "__defaultVhost__/proxy/0"  # 流的唯一标识
   }
}

13. /index/api/delStreamProxy(流注册成功后，也可以使用close_streams接口替代)

功能：关闭拉流代理
范例：http://127.0.0.1/index/api/delStreamProxy?key=__defaultVhost__/proxy/0
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

key Y addStreamProxy接口返回的key

响应：

{
   "code" : 0,
   "data" : {
      "flag" : true # 成功与否
   }
}

14. /index/api/addFFmpegSource

功能：通过fork FFmpeg进程的方式拉流代理，支持任意协议
范例：http://127.0.0.1/index/api/addFFmpegSource?src_url=http://live.hkstv.hk.lxdns.com/live/hks2/playlist.m3u8&dst_url=rtmp://127.0.0.1/live/hks2&timeout_ms=10000&ffmpeg_cmd_key=ffmpeg.cmd

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
src_url	Y	FFmpeg拉流地址,支持任意协议或格式(只要FFmpeg支持即可)
dst_url	Y	FFmpeg rtmp推流地址，一般都是推给自己，例如rtmp://127.0.0.1/live/stream_form_ffmpeg
timeout_ms	Y	FFmpeg推流成功超时时间
enable_hls	Y	是否开启hls录制
enable_mp4	Y	是否开启mp4录制
ffmpeg_cmd_key	N	配置文件中FFmpeg命令参数模板key(非内容)，置空则采用默认模板:`ffmpeg.cmd`

响应：

{
   "code" : 0,
   "data" : {
      "key" : "5f748d2ef9712e4b2f6f970c1d44d93a"  # 唯一key
   }
}

15. /index/api/delFFmpegSource(流注册成功后，也可以使用close_streams接口替代)

功能：关闭ffmpeg拉流代理
范例：http://127.0.0.1/index/api/delFFmpegSource?key=5f748d2ef9712e4b2f6f970c1d44d93a
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

key Y addFFmpegSource接口返回的key

响应：

{
   "code" : 0,
   "data" : {
      "flag" : true # 成功与否
   }
}

16. /index/api/getRtpInfo

功能：获取rtp代理时的某路ssrc rtp信息
范例：http://127.0.0.1/index/api/getRtpInfo?stream_id=1A2B3C4D

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
stream_id	Y	RTP的ssrc，16进制字符串或者是流的id(openRtpServer接口指定)

响应：

{
   "code" : 0,
   "exist" : true, # 是否存在
   "peer_ip" : "192.168.0.23", # 推流客户端ip
   "peer_port" : 54000 # 客户端端口号
   "local_ip" : "0.0.0.0", #本地监听的网卡ip
   "local_port" : 10000
}

17. /index/api/getMp4RecordFile

功能：搜索文件系统，获取流对应的录像文件列表或日期文件夹列表
范例：http://127.0.0.1/index/api/getMp4RecordFile?vhost=__defaultVhost__&app=live&stream=ss&period=2020-01

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
vhost	Y	流的虚拟主机名
app	Y	流的应用名
stream	Y	流的ID
period	Y	流的录像日期，格式为2020-02-01,如果不是完整的日期，那么是搜索录像文件夹列表，否则搜索对应日期下的mp4文件列表
customized_path	N	自定义搜索路径，与startRecord方法中的customized_path一样，默认为配置文件的路径

响应：

# 搜索文件夹列表(按照前缀匹配规则)：period = 2020-01
{
   "code" : 0,
   "data" : {
      "paths" : [ "2020-01-25", "2020-01-24" ],
      "rootPath" : "/www/record/live/ss/"
   }
}

# 搜索mp4文件列表：period = 2020-01-24
{
   "code" : 0,
   "data" : {
      "paths" : [
         "22-20-30.mp4",
         "22-13-12.mp4",
         "21-57-07.mp4",
         "21-19-18.mp4",
         "21-24-21.mp4",
         "21-15-10.mp4",
         "22-14-14.mp4"
      ],
      "rootPath" : "/www/live/ss/2020-01-24/"
   }
}

18. /index/api/startRecord

功能：开始录制hls或MP4
范例：http://127.0.0.1/index/api/startRecord?type=1&vhost=__defaultVhost__&app=live&stream=obs

参数：

参数	是否必选	释意	类型
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数	string
type	Y	0为hls，1为mp4	0/1
vhost	Y	虚拟主机，例如`__defaultVhost__`	string
app	Y	应用名，例如 live	string
stream	Y	流id，例如 obs	string
customized_path	N	录像保存目录	string
max_second	N	mp4录像切片时间大小,单位秒，置0则采用配置项	int

响应：

{
   "code" : 0,
   "result" : true # 成功与否
}

19. /index/api/stopRecord

功能：停止录制流
范例：http://127.0.0.1/index/api/stopRecord?type=1&vhost=__defaultVhost__&app=live&stream=obs

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
type	Y	0为hls，1为mp4
vhost	Y	虚拟主机，例如`__defaultVhost__`
app	Y	应用名，例如 live
stream	Y	流id，例如 obs

响应：

{
   "code" : 0,
   "result" : true # 成功与否
}

20. /index/api/isRecording

功能：获取流录制状态
范例：http://127.0.0.1/index/api/isRecording?type=1&vhost=__defaultVhost__&app=live&stream=obs

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
type	Y	0为hls，1为mp4
vhost	Y	虚拟主机，例如`__defaultVhost__`
app	Y	应用名，例如 live
stream	Y	流id，例如 obs

响应：

{
   "code" : 0,
   "status" : true # false:未录制,true:正在录制
}

21. /index/api/getSnap

功能：获取截图或生成实时截图并返回
范例：http://127.0.0.1/index/api/getSnap?url=rtmp://127.0.0.1/record/robot.mp4&timeout_sec=10&expire_sec=30

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
url	Y	需要截图的url，可以是本机的，也可以是远程主机的
timeout_sec	Y	截图失败超时时间，防止FFmpeg一直等待截图
expire_sec	Y	截图的过期时间，该时间内产生的截图都会作为缓存返回

响应：

jpeg格式的图片，可以在浏览器直接打开

22. /index/api/openRtpServer

功能：创建GB28181 RTP接收端口，如果该端口接收数据超时，则会自动被回收(不用调用closeRtpServer接口)
范例：http://127.0.0.1/index/api/openRtpServer?port=0&tcp_mode=1&stream_id=test

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
port	Y	接收端口，0则为随机端口
tcp_mode	Y	0 udp 模式，1 tcp 被动模式, 2 tcp 主动模式。 (兼容enable_tcp 为0/1)
stream_id	Y	该端口绑定的流ID，该端口只能创建这一个流(而不是根据ssrc创建多个)

响应：

{
   "code" : 0,
   "port" : 55463 #接收端口，方便获取随机端口号
}

23. /index/api/closeRtpServer

功能：关闭GB28181 RTP接收端口
范例：http://127.0.0.1/index/api/closeRtpServer?stream_id=test
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

stream_id Y 调用openRtpServer接口时提供的流ID

响应：

{
   "code": 0,
   "hit": 1 #是否找到记录并关闭
}

24. /index/api/listRtpServer

功能：获取openRtpServer接口创建的所有RTP服务器
范例：http://127.0.0.1/index/api/listRtpServer
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

响应：

{
   "code" : 0,
   "data" : [
      {
         "port" : 52183, #绑定的端口号
         "stream_id" : "test" #绑定的流ID
      }
   ]
}

25. /index/api/startSendRtp

功能：作为GB28181客户端，启动ps-rtp推流，支持rtp/udp方式；该接口支持rtsp/rtmp等协议转ps-rtp推流。第一次推流失败会直接返回错误，成功一次后，后续失败也将无限重试。
范例：http://127.0.0.1/index/api/startSendRtp?secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc&vhost=__defaultVhost__&app=live&stream=test&ssrc=1&dst_url=127.0.0.1&dst_port=10000&is_udp=0

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
vhost	Y	虚拟主机，例如defaultVhost
app	Y	应用名，例如 live
stream	Y	流id，例如 test
ssrc	Y	推流的rtp的ssrc,指定不同的ssrc可以同时推流到多个服务器
dst_url	Y	目标ip或域名
dst_port	Y	目标端口
is_udp	Y	是否为udp模式,否则为tcp模式
src_port	N	使用的本机端口，为0或不传时默认为随机端口
pt	N	发送时，rtp的pt（uint8_t）,不传时默认为96
use_ps	N	发送时，rtp的负载类型。为1时，负载为ps；为0时，为es；不传时默认为1
only_audio	N	当use_ps 为0时，有效。为1时，发送音频；为0时，发送视频；不传时默认为0

响应：

{
   "code": 0, #成功
   "local_port": 57152 #使用的本地端口号 
}

25.1. /index/api/startSendRtpPassive

功能：作为GB28181 Passive TCP服务器；该接口支持rtsp/rtmp等协议转ps-rtp被动推流。调用该接口，zlm会启动tcp服务器等待连接请求，连接建立后，zlm会关闭tcp服务器，然后源源不断的往客户端推流。第一次推流失败会直接返回错误，成功一次后，后续失败也将无限重试(不停地建立tcp监听，超时后再关闭)。
范例：http://127.0.0.1/index/api/startSendRtpPassive?secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc&vhost=__defaultVhost__&app=live&stream=test&ssrc=1

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
vhost	Y	虚拟主机，例如defaultVhost
app	Y	应用名，例如 live
stream	Y	流id，例如 test
ssrc	Y	推流的rtp的ssrc,指定不同的ssrc可以同时推流到多个服务器
src_port	N	使用的本机端口，为0或不传时默认为随机端口
pt	N	发送时，rtp的pt（uint8_t）,不传时默认为96
use_ps	N	发送时，rtp的负载类型。为1时，负载为ps；为0时，为es；不传时默认为1
only_audio	N	当use_ps 为0时，有效。为1时，发送音频；为0时，发送视频；不传时默认为0

响应：

{
   "code": 0, #成功
   "local_port": 57152 #使用的本地端口号 
}

26. /index/api/stopSendRtp

功能：停止GB28181 ps-rtp推流
范例：http://127.0.0.1/index/api/stopSendRtp?secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc&vhost=__defaultVhost__&app=live&stream=test

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
vhost	Y	虚拟主机，例如defaultVhost
app	Y	应用名，例如 live
stream	Y	流id，例如 test
ssrc	N	根据ssrc关停某路rtp推流，置空时关闭所有流

响应：
```
{
   "code": 0 #成功
}
```

27. /index/api/getStatistic

功能：获取主要对象个数统计，主要用于分析内存性能
范例：http://127.0.0.1/index/api/getStatistic?secret=035c73f7-bb6b-4889-a715-d9eb2d1925cc
参数：

参数是否必选释意

secret Y api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数

响应：

{
  "code": 0,
  "data": {
      "Buffer": 2,
      "BufferLikeString": 1,
      "BufferList": 0,
      "BufferRaw": 1,
      "Frame": 0,
      "FrameImp": 0,
      "MediaSource": 0,
      "MultiMediaSourceMuxer": 0,
      "Socket": 66,
      "TcpClient": 0,
      "TcpServer": 64,
      "TcpSession": 1
    }
}

28. /index/api/addStreamPusherProxy

功能：添加rtsp/rtmp主动推流(把本服务器的直播流推送到其他服务器去)
范例：http://127.0.0.1/index/api/addStreamPusherProxy?vhost=__defaultVhost__&app=proxy&stream=test&dst_url=rtmp://127.0.0.1/live/test2

参数：

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
vhost	Y	添加的流的虚拟主机，例如`__defaultVhost__`
schema	Y	协议，例如 rtsp或rtmp
app	Y	添加的流的应用名，例如live
stream	Y	需要转推的流id
dst_url	Y	目标转推url，带参数需要自行url转义
retry_count	N	转推失败重试次数，默认无限重试
rtp_type	N	rtsp拉流时，拉流方式，0：tcp，1：udp，2：组播
timeout_sec	N	拉流超时时间，单位秒，float类型

响应：

{
   "code" : 0,
   "data" : {
      "key" : "rtmp/__defaultVhost__/proxy/test/4AB43C9EABEB76AB443BB8260C8B2D12"  # 流的唯一标识
   }
}

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 205,132评论 6赞 478
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 87,802评论 2赞 381
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 151,566评论 0赞 338
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 54,858评论 1赞 277
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 63,867评论 5赞 368
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 48,695评论 1赞 282
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 38,064评论 3赞 399
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 36,705评论 0赞 258
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 42,915评论 1赞 300
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 35,677评论 2赞 323
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 37,796评论 1赞 333
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 33,432评论 4赞 322
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 39,041评论 3赞 307
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 29,992评论 0赞 19
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,223评论 1赞 260
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 45,185评论 2赞 352
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 42,535评论 2赞 343

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
Id	Y	客户端唯一id，可以通过getAllSession接口获取

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
key	Y	addStreamProxy接口返回的key

参数	是否必选	释意
secret	Y	api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数
key	Y	addFFmpegSource接口返回的key

3 ZLMediaKit API接口

ZLMediaKit API详解

推荐阅读更多精彩内容