getVideoEncoding.lua
[返回首页]

API说明

获取指定码流(主码流/子码流)的编码参数和/或状态

参数

HTTP提交参数:GET; POST

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

Stream
(必需参数)

指定要获取的码流。

main

主码流

sub

子码流

测试值:

Config
整数

可选。

1

指明需要获取编码参数配置。

0

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

测试值:

Status
整数

可选。

1

指明需要获取编码状态(默认)。

0

不返回编码状态。

测试值:

返回

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

{
/*对象*/

"Result":
数值

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

"Status":
"字符串"

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

"Data": {
/*对象*/

"Stream":
"字符串"

当前码流。

main

主码流

sub

子码流

"SnapUrl":
"字符串"

http://...

用于获取预览视频图片的HTTP URL(注:本质上,无论哪个码流,SnapUrl获得的内容均相同,因为只有一个MotionJPEG压缩服务)

"Config": {
/*对象*/

编码配置参数 (请求参数中如果指定Config=1返回)

"Scaling":
"字符串"

编码缩放大小。

default

表示不缩放,对主码流而言,输入视频是什么格式,编码大小就是多大。

对子码流而言,默认大小是720x576。

(w)x(h)

(w)表示宽度,(h)表示高度(如1280x720)。指定的缩放大小。

"Chrome":
整数

0|1, 0表示彩色,1表示灰度

"Codec":
"字符串"

H264|H265, 视频编码算法(目前仅支持H264)

"Profile":
"字符串"

base|main|high, 指定H.264编码的Profile

"BRCtrl":
"字符串"

cbr|vbr, Bitrate控制方式,cbr或vbr。

"Bitrate":
整数

编码码率,单位bps。如1000000表示1Mbps

"FrameRateMode":
"字符串"

编码帧率模式

default

表示全帧率,即输入视频帧率为多少,编码帧率为多少

half

表示当输入视频的帧率 >=50 时,自动降半帧率

custom

表示手动指定帧率

"FrameRate":
数值

指定的编码帧率(如果FrameRateMode为default/half,则不必要指定FrameRate值)

"GOPSize":
整数

H.264 GOP大小(决定I帧之间的间隔),以帧数为单位

"RefFrame":
整数

1|2, 参数帧。1表示单一参考帧,2表示多参考帧

"BindAudioChannel":
整数

绑定的音频编码引擎通道号, -1表示无音频绑定

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

当前实时编码状态信息 (请求参数中如果指定Status=1返回)

"Codec":
"字符串"

H264|H265, 当前编码算法

"Profile":
"字符串"

base|main|high,当前编码的Profile

"BindAudioChannel":
整数

绑定的音频编码引擎通道号, -1表示无音频绑定(同Config中的同名参数)

"Width":
整数

实际编码的视频宽度

"Height":
整数

实际编码的视频高度

"FrameRate":
数值

实际编码的帧率

"Bitrate":
整数

视频实际编码的实时码率(Kbps)

}
}
}

说明

注:音频如果需要获取实时状态,请根据BindAudioChannel参数的ID,另行获取音频的实时编码状态(参见getAudioEngChannel.lua

其它说明

KILOVIEW Device HTTP API, v1.0