getStreamService.lua
[返回首页]

API说明

获得指定码流(主码流/子码流/Motion-JPEG码流)的媒体服务信息。

媒体服务,是指RTSP/RTMP/HLS/...等服务。

KILOVIEW编码器产品,支持多种流媒体服务功能,并且每一项功能均可设定开启/关闭,或动态添加/删除服务[ 说明:RTSP服务和KMP服务为固定存在的服务,不能添加/删除]。

参数

HTTP提交参数:GET; POST

通过HTTP测试该API调用 (URL):

Stream
(必需参数)

指定要获取媒体服务的码流。

main

主码流

sub

子码流

jpeg

Motion-JPEG码流

测试值:

Config
整数

可选。

1

指明需要获取媒体服务的配置参数。

0

(或未指定,默认)则不返回配置参数。

测试值:

Status
整数

可选。

1

指明需要获取媒体服务的状态(默认)。

0

不返回媒体服务的状态。

测试值:

返回

返回JSON格式的结果。该JSON数据的格式如下:

{
/*对象*/

"Result":
数值

200表示OK, 其它错误码含义类似于HTTP Response.

"Status":
"字符串"

状态消息。反馈API执行的结果状态,如有错误,将描述出错的原因。

"Data": {
/*对象*/

"Stream":
"字符串"

当前码流

main

主码流

sub

子码流

jpeg

Motion JPEG码流

"Enable":
整数

当前码流的开启状态。

0

关闭。如果值为0,则以下参数均不会返回。

1

开启。

"ServiceConfigs": [
/*数组*/

每一项代表一个媒体服务的配置参数。仅当请求参数Config=1时返回。

{
/*对象*/

"ID":
"字符串"

媒体服务的Unique ID。值可能为

Rtsp_server

Kmp_pullingServer

Dynamic_services[0]

Dynamic_services[1]

Dynamic_services[2]

Dynamic_services[3]

Dynamic_services[4]

Dynamic_services[5]

Dynamic_services[6]

Dynamic_services[7]

"Type":
"字符串"

服务类型, 值可能为以下列表中的某一个。这些服务类型可能随着功能的扩展而增加。

Rtsp_server

RTSP服务

Kmp_pullingServer

KILOVIEW Media Protocol的拉取服务

Rtmp_push

RTMP推送服务

Rtp_push

RTP推送或组播服务

Kmp_push

KILOVIEW Media Protocol的推送服务

Sproxy_push

特定OEM客户的推送服务,一般情况下请勿考虑

TS_push

TS/UDP推送或组播服务

HLS

HLS(HTTP Live Streaming)服务

"Rtsp_server": {
/*对象*/

对应RTSP服务的配置参数 [仅当 Type = Rtsp_server 时返回]

"port":
整数

RTSP服务端口,默认为554

"session":
"字符串"

RTSP服务的SessionID

"ssm":
整数

0|1,是否开启RTSP Multicast服务。1表示开启,0表示关闭。

"multicast_addr":
"字符串"

RTSP组播的Multicast地址

"multicast_video_port":
整数

multicast视频端口

"multicast_audio_port":
整数

multicast音频端口

"multicast_ttl":
整数

multicast TTL值

}
"Kmp_pullingServer": {
/*对象*/

对应Kmp_pullingServer服务的配置参数 [仅当 Type = Kmp_pullingServer 时返回]

"enabled":
整数

0|1,是否开启KMP拉流服务。0关闭,1开启。

}
"Rtmp_push": {
"字符串"

对应Rtmp推送服务的配置参数 [仅当 Type = Rtmp_push 时返回]

"enabled":
整数

0|1, 是否开启RTMP推流。0关闭,1开启。

"pubPoint":
"字符串"

RTMP推流的发布地址URL

"username":
"字符串"

RTMP推流身份认证用户名

"password":
"字符串"

RTMP推流身份认证用户密码

"timeout":
整数

RTMP连接超时(单位:秒)

"reconnect_interval":
整数

RTMP断开后重连的间隔时间(单位:秒)

}
"Rtp_push": {
"字符串"

对应Rtp推送服务的配置参数 [仅当 Type = Rtp_push 时返回]

"enabled":
整数

0|1, 是否开启Rtp推送功能。0关闭,1开启。

"target_video_IP":
"字符串"

视频目标推送IP或组播IP

"target_video_port":
整数

视频目标推送端口

"target_audio_IP":
"字符串"

音视频目标推送IP或组播IP

"target_audio_port":
整数

音频目标推送端口

"ttl":
整数

如果目标IP为Multicast地址,指定组播TTL值

}
"Kmp_push": {
"字符串"

对应KMP推送服务的配置参数 [仅当 Type = Kmp_push 时返回]

"enabled":
整数

0|1, 是否开启KMP推送。0关闭,1开启。

"pubPoint":
"字符串"

KMP推流的发布地址URL

"username":
"字符串"

KMP推流身份认证用户名

"password":
"字符串"

KMP推流身份认证用户密码

"timeout":
整数

KMP连接超时(单位:秒)

"reconnect_interval":
整数

KMP断开后重连的间隔时间(单位:秒)

}
"Sproxy_push": {
"字符串"

对应Sproxy推送服务的配置参数 [仅当 Type = Sproxy_push 时返回]

"...":
"字符串"

特殊应用,参数暂未提供

}
"TS_push": {
"字符串"

对应TS/UDP推送服务的配置参数 [仅当 Type = TS_push 时返回]

"enabled":
整数

0|1, 是否开启TS推送。0关闭,1开启。

"address":
"字符串"

推送目标IP地址或组播IP

"port":
整数

推送端口

"ttl":
整数

组播的TTL

}
"HLS": {
"字符串"

对应HLS服务的配置参数 [仅当 Type = HLS 时返回]

"enabled":
整数

0|1,是否开启HLS服务。0关闭,1开启。

"session":
"字符串"

HLS的会话ID, 决定HLS的URL路径。HLS的最终访问路径为 http://<ip address>/<session>/playlist.m3u8

"segmentTime":
整数

HLS切片时长(近似值,单位毫秒),实际切片时长以该值为参照,但可能会因为编码数据的原因有所偏差

"maxSegments":
整数

在一个m3u8的playlist中,最多同时允许存在的切片数。按HLS规范,该值必须 >=3

}
}
]
"ServiceStatus": [
/*数组*/

每一项代表一个媒体服务的工作状态信息。

{
/*对象*/

"ID":
"字符串"

媒体服务的Unique ID。值可能为

Rtsp_server

Kmp_pullingServer

Dynamic_services[0]

Dynamic_services[1]

Dynamic_services[2]

Dynamic_services[3]

Dynamic_services[4]

Dynamic_services[5]

Dynamic_services[6]

Dynamic_services[7]

"Type":
"字符串"

服务类型, 值可能为

Rtsp_server

RTSP服务

Kmp_pullingServer

KILOVIEW Media Protocol的拉取服务

Rtmp_push

RTMP推送服务

Rtp_push

RTP推送或组播服务

Kmp_push

KILOVIEW Media Protocol的推送服务

Sproxy_push

特定OEM客户的推送服务,一般情况下请勿考虑

TS_push

TS/UDP推送或组播服务

HLS

HLS(HTTP Live Streaming)服务

"Enable":
整数

0|1,返回当前服务的开启状态。1表示开启,0表示关闭。

"Status":
"字符串"

工作状态,指示该媒体服务的实时状态

error

表示出错

offline

表示未开启/不在线

connecting

表示正在连接

online

表示在线、已开启

"URL":
"字符串"

该媒体服务的访问URL

}
]
}
}

其它说明

KILOVIEW Device HTTP API, v1.0