From c0134eb8ac8c1a77e966be4820ae3587de992e26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A4=8F=E6=A5=9A?= <771730766@qq.com> Date: Fri, 13 Dec 2019 13:47:57 +0800 Subject: [PATCH] =?UTF-8?q?getMediaList=E6=8E=A5=E5=8F=A3=E8=BF=94?= =?UTF-8?q?=E5=9B=9E=E5=80=BC=E6=B7=BB=E5=8A=A0=E5=8F=82=E6=95=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- MediaServer支持的HTTP-API.md | 101 ++++++++++++++++++++++------------- 1 file changed, 63 insertions(+), 38 deletions(-) diff --git a/MediaServer支持的HTTP-API.md b/MediaServer支持的HTTP-API.md index 22377e2..975818a 100644 --- a/MediaServer支持的HTTP-API.md +++ b/MediaServer支持的HTTP-API.md @@ -46,8 +46,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 { "data" : [ { - "delay" : 0, #该线程延时 - "load" : 0 #该线程负载，0 ~ 100 + "delay" : 0, # 该线程延时 + "load" : 0 # 该线程负载，0 ~ 100 }, { "delay" : 0, @@ -73,8 +73,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 { "data" : [ { - "delay" : 0, #该线程延时 - "load" : 0 #该线程负载，0 ~ 100 + "delay" : 0, # 该线程延时 + "load" : 0 # 该线程负载，0 ~ 100 }, { "delay" : 0, @@ -188,8 +188,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { - "changed" : 0, #配置项变更个数 - "code" : 0 #0代表成功 + "changed" : 0, # 配置项变更个数 + "code" : 0 # 0代表成功 } ``` @@ -231,29 +231,54 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | | schema | N | 筛选协议，例如 rtsp或rtmp | - | vhost | N | 筛选虚拟主机，例如`__defaultVhost__` | + | vhost | N | 筛选虚拟主机，例如`__defaultVhost__` | | app | N | 筛选应用名，例如 live | - 响应： ```json { - "code" : 0, - "data" : [ - { - "app" : "live", - "schema" : "rtsp", - "stream" : "0", - "vhost" : "__defaultVhost__" - }, - { - "app" : "live", - "schema" : "rtmp", - "stream" : "0", - "vhost" : "__defaultVhost__" - } - ], - "msg" : "success" + "code" : 0, + "data" : [ + { + "app" : "live", # 应用名 + "readerCount" : 0, # 总观看人数(包括rtsp/rtmp) + "schema" : "rtsp", # 协议 + "stream" : "obs", # 流id + "tracks" : [ # 音视频轨道 + { + "codec_id" : 0, # H264 = 0, H265 = 1, AAC = 2 + "codec_type" : 0, # Video = 0, Audio = 1 + "ready" : true # 轨道是否准备就绪 + }, + { + "codec_id" : 2, + "codec_type" : 1, + "ready" : true + } + ], + "vhost" : "__defaultVhost__" # 虚拟主机名 + }, + { + "app" : "live", + "readerCount" : 0, + "schema" : "rtmp", + "stream" : "obs", + "tracks" : [ + { + "codec_id" : 0, + "codec_type" : 0, + "ready" : true + }, + { + "codec_id" : 2, + "codec_type" : 1, + "ready" : true + } + ], + "vhost" : "__defaultVhost__" + } + ] } ``` @@ -271,7 +296,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | | schema | Y | 协议，例如 rtsp或rtmp | - | vhost | Y | 虚拟主机，例如`__defaultVhost__` | + | vhost | Y | 虚拟主机，例如`__defaultVhost__` | | app | Y | 应用名，例如 live | | stream | Y | 流id，例如 test | | force | N | 是否强制关闭(有人在观看是否还关闭) | @@ -298,7 +323,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | | schema | N | 协议，例如 rtsp或rtmp | - | vhost | N | 虚拟主机，例如`__defaultVhost__` | + | vhost | N | 虚拟主机，例如`__defaultVhost__` | | app | N | 应用名，例如 live | | stream | N | 流id，例如 test | | force | N | 是否强制关闭(有人在观看是否还关闭) | @@ -308,8 +333,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { "code" : 0, - "count_hit" : 1, #筛选命中的流个数 - "count_closed" : 1 #被关闭的流个数，可能小于count_hit + "count_hit" : 1, # 筛选命中的流个数 + "count_closed" : 1 # 被关闭的流个数，可能小于count_hit } ``` @@ -405,7 +430,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { "code" : 0, - "count_hit" : 1,#筛选命中客户端个数 + "count_hit" : 1,# 筛选命中客户端个数 "msg" : "success" } ``` @@ -494,7 +519,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 { "code" : 0, "data" : { - "key" : "5f748d2ef9712e4b2f6f970c1d44d93a" #唯一key + "key" : "5f748d2ef9712e4b2f6f970c1d44d93a" # 唯一key } } ``` @@ -539,7 +564,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | | schema | Y | 协议，例如 rtsp或rtmp | - | vhost | Y | 虚拟主机，例如`__defaultVhost__` | + | vhost | Y | 虚拟主机，例如`__defaultVhost__` | | app | Y | 应用名，例如 live | | stream | Y | 流id，例如 obs | @@ -549,7 +574,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { "code" : 0, - "online" : true #是否在线 + "online" : true # 是否在线 } ``` @@ -566,7 +591,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | :-------------: | :------: | :----------------------------------------------------------: | ------ | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | string | | type | Y | 0为hls，1为mp4 | 0/1 | - | vhost | Y | 虚拟主机，例如`__defaultVhost__` | string | + | vhost | Y | 虚拟主机，例如`__defaultVhost__` | string | | app | Y | 应用名，例如 live | string | | stream | Y | 流id，例如 obs | string | | wait_for_record | Y | 1代表等待流注册后再录制，置0在流未注册时返回失败 | 0/1 | @@ -578,7 +603,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { "code" : 0, - "result" : 0 #0代表成功，负数代表失败及原因 + "result" : 0 # 0代表成功，负数代表失败及原因 } ``` @@ -594,8 +619,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | 参数 | 是否必选 | 释意 | | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | - | type | Y | 0为hls，1为mp4 | - | vhost | Y | 虚拟主机，例如`__defaultVhost__` | + | type | Y | 0为hls，1为mp4 | + | vhost | Y | 虚拟主机，例如`__defaultVhost__` | | app | Y | 应用名，例如 live | | stream | Y | 流id，例如 obs | @@ -622,8 +647,8 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 | 参数 | 是否必选 | 释意 | | :----: | :------: | :----------------------------------------------------------: | | secret | Y | api操作密钥(配置文件配置)，如果操作ip是127.0.0.1，则不需要此参数 | - | type | Y | 0为hls，1为mp4 | - | vhost | Y | 虚拟主机，例如`__defaultVhost__` | + | type | Y | 0为hls，1为mp4 | + | vhost | Y | 虚拟主机，例如`__defaultVhost__` | | app | Y | 应用名，例如 live | | stream | Y | 流id，例如 obs | @@ -633,6 +658,6 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些 ```json { "code" : 0, - "status" : 1 #0:未录制,1:等待流注册，注册成功后立即开始录制,2:流已注册，并且正在录制 + "status" : 1 # 0:未录制,1:等待流注册，注册成功后立即开始录制,2:流已注册，并且正在录制 } ``` \ No newline at end of file