所选语种没有对应资源,请选择:

本站点使用Cookies,继续浏览表示您同意我们使用Cookies。Cookies和隐私政策>

提示

尊敬的用户,您的IE浏览器版本过低,为获取更好的浏览体验,请升级您的IE浏览器。

升级

TE10, TE20 会议电视终端 V600R019C00 HTTP API 编程参考

为了方便用户在自定义操作界面上控制终端,终端提供了大量的API(Application Programming Interface)命令行接口,用户可以通过调用这些接口控制终端。
评分并提供意见反馈 :
华为采用机器翻译与人工审校相结合的方式将此文档翻译成不同语言,希望能帮助您更容易理解此文档的内容。 请注意:即使是最好的机器翻译,其准确度也不及专业翻译人员的水平。 华为对于翻译的准确性不承担任何责任,并建议您参考英文文档(已提供链接)。
图像与声音类

图像与声音类

打开MIC开关

接口名称

WEB_OpenMicAPI

功能描述

打开本地MIC。对应的关闭本地MIC的接口为WEB_CloseMicAPI。

应用场景

当终端入会后,可以调用该接口打开本地MIC。

URL

POST /action.cgi?ActionID=WEB_OpenMicAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

关闭MIC开关

接口名称

WEB_CloseMicAPI

功能描述

关闭MIC开关。

应用场景

当终端入会后,可以调用该接口关闭本地MIC。

URL

POST /action.cgi?ActionID=WEB_CloseMicAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

音频输出设置

接口名称

WEB_SaveAudioOutCtrlParams

功能描述

音频输出参数设置。

应用场景

调节本端音频输出参数;。

URL

POST /action.cgi?ActionID= WEB_SaveAudioOutCtrlParams

请求参数结构

{"AudioOutAll":1,

"SpeakerSwitch":1,

"speakerValue":18,

"hintSoundValue":3

}

/* AudioOutAll :固定为1;

SpeakerSwitch :扬声器开关,0关,1开;

speakerValue :扬声器音量大小[0,21]

hintSoundValue :提示音音量[0-3]*/

请求参数示例

{"AudioOutAll":1,"SpeakerSwitch":1,"speakerValue":18,"hintSoundValue":3}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

查询是否接入演示输入源

接口名称

WEB_IsConnectAuxSourceAPI

功能描述

查询是否接入演示输入源。

应用场景

如果当前终端接了演示视频源,则可以发送演示。反之,则不能。

URL

POST /action.cgi?ActionID=WEB_IsConnectAuxSourceAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data": {

"isSrcConnect": "",

"errorId": 12345,

"errorStr": ""

}

}

success表示响应结果,0表示失败,1表示成功;isSrcConnect表示是否连接演示源,"connect"表示有演示源接入,"unconnect"表示没有演示源接入。errorId表示错误码ID,errorStr表示演示接入失败信息,如果演示正常接入时是"EMPTY","INVALID_VI_VGA_SEND"表示终端不支持该分辨率,"INVALID_VI_DVI_SEND"表示终端无视频源或者不支持该分辨率,"NO_CONNECT_AUX_VIDEO"表示终端没有连接演示视频源。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询当前是否正在发送演示

接口名称

WEB_IsSendAuxStreamAPI

功能描述

查询当前是否正在发送演示。

应用场景

如果当前正在发送演示,则不可以进行发送演示操作。反之,则可以。

URL

POST /action.cgi?ActionID=WEB_IsSendAuxStreamAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"isSendAux\":\"auxOpen\"

}"

}

success表示响应结果,0表示失败,1表示成功。isSendAux表示是否正在发送演示,"auxOpen"表示正在发送演示,"auxClose"表示没有在发演示。

成功响应示例

{"success":1,"data":"{

\"isSendAux\":\"auxOpen\"

}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

启动发送演示

接口名称

WEB_StartSendAuxStreamAPI

功能描述

启动发送演示。对应的停止发送演示的接口为WEB_StopSendAuxStreamAPI。一般同3.1.6.5接口配置使用,只有在终端连接演示视频源时,才能调用该接口发演示。

应用场景

当前没有发演示时,才可以去发送演示,发送演示是否成功,通过MSG_AUXVIDEO_SEND_RESULT消息上报。

URL

POST /action.cgi?ActionID=WEB_StartSendAuxStreamAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

停止发送演示

接口名称

WEB_StopSendAuxStreamAPI

功能描述

停止发送演示。

应用场景

停止发送演示。

URL

POST /action.cgi?ActionID=WEB_StopSendAuxStreamAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询是否正在接收远端演示

接口名称

WEB_IsReceiveRemAuxStrmAPI

功能描述

查询是否正在接收远端演示。

应用场景

终端处在会议中,才可以进行查询是否正在接收远端演示的操作。

URL

POST /action.cgi?ActionID=WEB_IsReceiveRemAuxStrmAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"isSendAux\":\"auxOpen\"

}"

}

success表示响应结果0表示失败,1表示成功。isSendAux表示是否正在接收远端演示,"auxOpen"表示正在接收,"auxClose"表示没有接收。

成功响应示例

{"success":1,"data":"{

\"isSendAux\":\"auxOpen\"

}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询单个无线演示客户端信息

接口名称

WEB_AirAuxInfoAPI

功能描述

有无线演示客户端请求连接时,查询客户端信息;

应用场景

无线演示客户端请求连接,在收到消息:MSG_MC_UI_AIRAUX_MATCH_REQ情况下,调用该接口查看无线演示客户端信息,用于提示用户有客户端连接,消息param1中携带对应的客户端标识id;

URL

POST /action.cgi?ActionID= WEB_AirAuxInfoAPI

请求参数结构

{

"Param1":id,

"Param2":0,

"Param3":0,

"Param4":0

}

演示客户端支持多连接后,Param1表示客户端的id;如果不带参数则返回第一个连接的客户端信息;

请求参数示例

成功响应结构

{"success":1,

"data":

"{

\"clientIp\":\"192.168.1.100\",

\"clientName\":\"auxClient\"

}"

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":"{\"clientIp\":\"192.168.1.100\",\"clientName\":\" auxClient \"}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询所有无线演示客户端信息

接口名称

WEB_GetAllAirAuxInfoAPI

功能描述

查询所有客户端信息;

应用场景

有单个或者多个无线演示客户端连接时,可以使用该接口查看所有客户端的信息,包括对应的连接id,ip,用户名及当前发送状态;

URL

POST /action.cgi?ActionID= WEB_GetAllAirAuxInfoAPI

请求参数结构

请求参数示例

成功响应结构

{"success":1,"data":

"{\"clientsCount\":2,

\"clientsList\":[

{\"clientID\":-1844257792,

\"SendAuxStatus\":0,

\"clientIp\":\"192.168.2.10\",

\"clientName\":\"clientName1\"},

{\"clientID\":233029889,

\"SendAuxStatus\":0,

\"clientIp\":\"192.168.2.20\",

\"clientName\":\"clientName2\"}

]}"

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,clientsList客户端列别信息,允许为空。

成功响应示例

{"success":1,"data":"{\"clientsCount\":2,\"clientsList\":[

{\"clientID\":-1844257792,\"SendAuxStatus\":0,\"clientIp\":\"192.168.2.10\",\"clientName\":\"clientName1\"},{\"clientID\":233029889,\"SendAuxStatus\":0,\"clientIp\":\"192.168.2.20\",\"clientName\":\"clientName2\"}]}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

是否允许无线演示连接

接口名称

WEB_IsAgreeWirAuxConnAPI

功能描述

有无线演示客户端请求连接时,是否同意连接请求;

应用场景

无线演示客户端请求连接,在收到消息:MSG_MC_UI_AIRAUX_MATCH_REQ情况下,调用该接口同意或拒绝连接请求;消息param2中携带对应的客户端标识id

URL

POST /action.cgi?ActionID= WEB_IsAgreeWirAuxConnAPI

请求参数结构

{

"Param1":1,

"Param2":id,

"Param3":0,

"Param4":0

}

Param1:表示是否接受客户端连接请求;1:同意请求;0拒绝请求;Param2对应的客户端id;

请求参数示例

{

"Param1":1,

"Param2":1543809,

"Param3":0,

"Param4":0

}

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

当前是否连接无线演示

接口名称

WEB_IsAirAuxConnectedAPI

功能描述

查询当前是否连接无线演示。

应用场景

查询当前是否连接无线演示。

URL

POST /action.cgi?ActionID= WEB_IsAirAuxConnectedAPI

请求参数结构

请求参数示例

成功响应结构

{"success":1,

"data":"

{

\"ucIsWireAuxConn\":0

}"

}

“success”字段表示响应结果,0表示失败,1表示成功。ucIsWireAuxConn,1表示有无线演示客户端连接;0表示无客户端连接;

成功响应示例

{"success":1,"data":"{\"ucIsWireAuxConn\":0}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

断开无线演示

接口名称

WEB_CloseWirelessAuxClientCon

功能描述

断开无线演示。

应用场景

断开无线演示。

URL

POST /action.cgi?ActionID= WEB_CloseWirelessAuxClientCon

请求参数结构

{

"Param1":id,

"Param2":0,

"Param3":0,

"Param4":0

}

Param1:对应的客户端id;

请求参数示例

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

读取组合画面/画中画模式

接口名称

WEB_InitCombinationParam

功能描述

读取组合画面/画中画模式时调用该接口。

应用场景

读取组合画面/画中画模式。

URL

POST /action.cgi?ActionID= WEB_InitCombinationParam

请求参数结构

请求参数示例

成功响应结构

{"success":1,

"data":"

{\"modeList\":[2,1,11,12,6,7,8,9,20,20,20],\"curMode\":1,

\"pipModeList\":[1,0,4,4,4,4,4,4,10,10,10]}"}

success字段表示响应结果,0表示失败,1表示成功;

modeList:当前支持的组合画面,最多支持11个多画面;取值:[1-19],分别表示:

1:本地主流;

2:远端主流;

3:本地演示;

4:远端演示;

5:取消子画面显示;

6:子画面在左上角;

7:子画面在右上角;

8:子画面在右下角;

9:子画面在左下角;

10:画中画自动;

11:二分屏上下等比;

12:二分屏左右等比;

13:二分屏左右不等比;

14:三分屏, POP 1+2上大

15:三分屏, POP 1+2左大

16:远端主流形式布局;

17:远端主流加本端主流布局;

18:远端主流加本端主流再加会议演示布局;

19:远端主流加会议演示布局;

20:填充值,无意义;

pipModeList:组合画面显示模式,最多支持11个多画面;取值:[0-9],分别表示:

0:本端主流 ;

1:远端主流;

2:本端演示;

3:远端演示;

4:远端主流+本端主流;

5:本端演示+本端主流;

6:本端演示+远端主流;

7:远端演示+远端主流;

8:远端演示+远端主流+本端主流;

9:本端演示+本端主流+远端主流;

10:填充值,无意义;

curMode:当前的多画面模式;modeList中某一个合法值;

成功响应示例

{"success":1,

"data":

"{\"modeList\":[2,1,11,12,6,7,8,9,20,20,20],\"curMode\":12,

\"pipModeList\":[1,0,4,4,4,4,4,4,10,10,10]}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置组合画面/画中画模式

接口名称

WEB_ChangeCombinationMode

功能描述

设置组合画面/画中画模式调用该接口。

应用场景

设置组合画面/画中画模式。

URL

POST /action.cgi?ActionID= WEB_ChangeCombinationMode

请求参数结构

{

"Param1":11,

"Param2":0,

"Param3":0,

"Param4":0

}

Param1:表示需要设置的多画面值;该值必须是WEB_InitCombinationParam返回的modeList数组中的合法值;

请求参数示例

{

"Param1":11,

"Param2":0,

"Param3":0,

"Param4":0

}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

设置扬声器音量

接口名称

WEB_SetSpeakVolumeAPI

功能描述

设置扬声器音量时调用该接口。

应用场景

设置扬声器音量

URL

POST /action.cgi?ActionID=WEB_SetSpeakVolumeAPI

请求参数结构

{

"speaker":1,

"speakerValue":0

}

speaker表示音响开关状态,0是关,1是开;'speakerValue'表示音量值。

请求参数示例

{"speaker":1,"speakerValue":0}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

开始音量检测

接口名称

WEB_StartCheckCurAudioParam

功能描述

开始进行音量检测。

应用场景

检测音量参数。

URL

POST /action.cgi?ActionID=WEB_StartCheckCurAudioParam

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

获取音量指示参数

接口名称

WEB_GetCurrentAudioParamAPI

功能描述

获取音量指示参数。

应用场景

获取当前音量值。

URL

POST /action.cgi?ActionID=WEB_GetCurrentAudioParamAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data": audioData

}

success字段表示响应结果,0表示失败,1表示成功;audioData是JSON格式的音量值,参见音量指示数据

成功响应示例

参见音量指示数据

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

获取音频参数

接口名称

WEB_InitAudioCtrlParamsAPI

功能描述

获取音频参数

应用场景

获取音频参数

URL

POST /action.cgi?ActionID=WEB_InitAudioCtrlParamsAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data": AudioParam

}

AudioParam是JSON格式的返回数据,示例参见音频参数结构

成功响应示例

示例参见音频参数结构

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置音频参数

接口名称

WEB_SaveAudioCtrlParamsAPI

功能描述

音频设置,开关mic。

应用场景

音频设置,开关mic。

URL

POST /action.cgi?ActionID=WEB_SaveAudioCtrlParamsAPI

请求参数结构

{

"MicSwitch":0,

"audioinall":1

}

请求参数示例

同上,MicSwitch参数为1,表示打开MIC;为0,表示关闭MIC;audioinall为预留参数,暂时没有使用到,固定为1即可。

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置本地音频输出

接口名称

WEB_SetAIOutputAPI

功能描述

设置本地音频输出时调用该接口。

应用场景

设置本地音频输出是否启用。

URL

POST /action.cgi?ActionID=WEB_SetAIOutputAPI

请求参数结构

{

"enableAIOutput": 0

}

enableAIOutput表示是否启用line in本地输出

请求参数示例

{"enableAIOutput":1}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询接入视频源状态

接口名称

WEB_GetLocalCamListStateAPI

功能描述

查询接入视频源状态时调用该接口。

应用场景

查询视频输入口接入视频源状态。

URL

POST /action.cgi?ActionID=WEB_GetLocalCamListStateAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"itemList\":[]

}"

}

success表示响应结果,0表示失败,1表示成功;itemList是数组结构,其中的每个元素都是如下结构,itemID表示枚举索引值,szItemName表示该选项的名称,itemState表示该输入口是否连接视频源,1表示连接上。

{

"itemID":0,

"itemState":1,

"szItemName":"CAM IN"

}

成功响应示例

{"success":1,

"data":"

{\"itemList\":[

{\"itemID\":0,

\"itemState\":1,

\"szItemName\":\"CAM IN\"}

]

}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

摄像机控制

接口名称

WEB_CtrlCameraOpeateAPI

功能描述

摄像机控制操作。

应用场景

进入视频控制页面,操作摄像机操作键对摄像机进行旋转、聚焦等操作。

URL

POST /action.cgi?ActionID=WEB_CtrlCameraOpeateAPI

请求参数结构

{

"camState":"localCam",

"camAction":0,

"camPos":255,

"camSrc":0

}

camState字段表示控制的是本地摄像机或远端摄像机,TE20、TE10目前只支持本端摄像机:"localCam"。camAction表示摄像机控制指令;camPos表示摄像机预置位;camSrc表示摄像机输入口,只支持内置摄像机,camSrc必须是0。摄像机操作命令具体如下:

0: 开始往右平移

1: 开始往左平移

2: 开始往上倾斜

3: 开始往下倾斜

4: 开始Zoom In

5: 开始Zoom Out

6: 开始Focus In

7: 开始Focus Out

8: 停止向右平移

9: 停止向做倾斜

10: 停止向上倾斜

11: 停止向下倾斜

12: 停止Zoom In

13: 停止Zoom Out

14: 停止Focus In

15: 停止Focus Out

16: Move Home

17: 自动调焦

请求参数示例

{

"camState":"localCam",

"camAction":0,

"camPos":255,

"camSrc":0

}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

查询视频源

接口名称

WEB_GetCurCtrlCamSrcAPI

功能描述

查询视频源时调用该接口。

应用场景

查询当前的主流视频源、演示视频源、远端摄像机以及本地摄像机。

URL

POST /action.cgi?ActionID=WEB_GetCurCtrlCamSrcAPI

请求参数结构

请求参数示例

成功响应结构

{"success":1,

"data":"

{\"localInMainSource\":0,

\"localInAuxSource\":1,

\"remoteInSource\":0,

\"curCtrlCam\":0

}"

}

“success”字段表示响应结果,0表示失败,1表示成功。localInMainSource表示本地主流视频源;localInAuxSource表示本地演示视频源;remoteInSource表示远端摄像机;curCtrlCam表示本端摄像机。

成功响应示例

{"success":1,"data":"{\"localInMainSource\":0,\"localInAuxSource\":1,\"remoteInSource\":0,\"curCtrlCam\":0}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置主流和演示视频源

接口名称

WEB_SetLocalMainAuxAPI

功能描述

设置主流视频源、演示视频源时调用该接口。

该接口TE10/20已停止使用;为保持兼容性,该接口直接返回成功;请使用WEB_SwitchVedioSource。

应用场景

设置主流视频源、演示视频源。

URL

POST /action.cgi?ActionID=WEB_SetLocalMainAuxAPI

请求参数结构

{

"localMainSrc1":0,

"localMainSrc2":0,

"localMainSrc3":0,

"localAuxSrc":1

}

localMainSrc1-3表示三个主流视频源,localAuxSrc表示本端演示视频源

请求参数示例

{

"localMainSrc1":0,

"localMainSrc2":0,

"localMainSrc3":0,

"localAuxSrc":1

}

成功响应结构

{

"success":1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

切换主流或演示视频源

接口名称

WEB_SwitchVedioSource

功能描述

设置主流视频源、演示视频源时调用该接口。

该接口仅TE20支持;

应用场景

设置主流视频源、演示视频源。

URL

POST /action.cgi?ActionID=WEB_SetLocalMainAuxAPI

请求参数结构

{

"pos":"XXXX",

"mainSrc":0,

"auxSrc":0

}

pos:位置:"left" \ "center" \ "right",目前只允许设置为center;

mainSrc:主流输入口;

auxSrc:演示输入口;

请求参数示例

{

"pos":"center",

"mainSrc":0,

"auxSrc":1

}

成功响应结构

{

"success":1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

获取主流视频源

接口名称

WEB_GetMainVideoSourceListAPI

功能描述

查询当前主流视频源列表。

该接口仅TE20支持;

应用场景

查询当前主视频源列表。

URL

POST /action.cgi?ActionID=WEB_GetMainVideoSourceListAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"itemList\":[]

}"}

success表示响应结果,0表示失败,1表示成功;itemList是数组结构,其中的每个元素都是如下结构,itemID表示枚举索引值,szItemName表示该选项的名称。

成功响应示例

{"success":1,

"data":

"{\"itemList\":

[

{\"itemID\":0,\"szItemName\":\"CAM IN\"}

]

}

"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}

获取演示视频源

接口名称

WEB_GetSubVideoSourceListAPI

功能描述

获取演示视频源。查询演示视频源列表;该接口仅TE20 支持;

应用场景

获取演示视频源的下拉列表框内容。

URL

POST /action.cgi?ActionID=WEB_GetSubVideoSourceListAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"itemList\":[]

}"

}

success表示响应结果,0表示失败,1表示成功;itemList是数组结构,其中的每个元素都是如下结构,itemID表示枚举索引值,szItemName表示该选项的名称。

成功响应示例

{"success":1,

"data":"

{\"itemList\":

[

{\"itemID\":0,\"szItemName\":\"CAM IN\"},

{\"itemID\":1,\"szItemName\":\"PC IN\"}

]

}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

改变输出口显示内容

接口名称

WEB_ChangeVideoOutSrcAPI

功能描述

改变输出口显示内容时调用该接口。

应用场景

改变输出口显示内容。

URL

POST /action.cgi?ActionID=WEB_ChangeVideoOutSrcAPI

请求参数结构

{

"hdOut":0,

"videoSrc":"local_main"

}

hdOut字段表示输入口,videoSrc字段表示本远端主流、演示,"local_main"表示本地主流,"local_aux"表示本地演示,"remote_main"表示远端主流,"remote_aux"表示远端演示。

请求参数示例

{

"hdOut":0,

"videoSrc":"local_main"

}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

改变其他输出口显示内容

接口名称

WEB_ChangeVideoOutSrcLimitAPI

功能描述

改变输出口显示内容时调用该接口,该接口与WEB_ChangeVideoOutSrcAPI区别在于,该接口可以修改演示输出口等接口显示内容。WEB_ChangeVideoOutSrcAPI只能修改设置为主流输出口的输出口显示内容;

该接口TE20/10暂不支持设置;直接返回成功;

应用场景

改变演示输出口显示内容。

URL

POST /action.cgi?ActionID=WEB_ChangeVideoOutSrcLimitAPI

请求参数结构

{

"hdOut":0,

"videoSrc":"local_main"

}

hdOut字段表示输入口,videoSrc字段表示本远端主流、演示,"local_main"表示本地主流,"local_aux"表示本地演示,"remote_main"表示远端主流,"remote_aux"表示远端演示。

请求参数示例

{

"hdOut":0,

"videoSrc":"local_main"

}

成功响应结构

{

"success": 1,

"data":""

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

读取输出口显示内容

接口名称

WEB_GetVideoOutSourceAPI

功能描述

读取输出口显示内容时调用该接口。

应用场景

读取输出口显示内容。

URL

POST /action.cgi?ActionID=WEB_GetVideoOutSourceAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

\"VideoOut1\":\"local_main\",

\"VideoOut2\":\"local_aux\",

\"VideoOut3 \":\"local_aux\",

\"VideoOut5\":\"local_main\,

\"VideoOut6\":\"local_main\,

\"VideoOut7\":\"local_main\

"}\

"}

“success”字段表示响应结果,0表示失败,1表示成功;

成功响应示例

同上

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置演示屏画面内容

接口名称

WEB_SetAuxVideoOutCombinePicModeAPI

功能描述

设置演示屏画面内容。

应用场景

双屏设备下,通过调用该接口可以设置演示屏输出口的显示内容,可以显示本地主流,本地演示,远端主流,远端演示或者华为Logo。

该接口TE10/20已不支持,为保持兼容性,直接返回成功;

URL

POST /action.cgi?ActionID=WEB_SetAuxVideoOutCombinePicModeAPI

请求参数结构

{"videoContent": videoContent}

videoContent表示演示屏要显示的内容,包括以下可选项:

本地主流:"local_main"

本地演示:"local_aux"

远端主流:"remote_main"

远端演示:"remote_aux"

华为Logo:"logo"

请求参数示例

{"videoContent": "local_main"}

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功;

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

进入摄像机控制界面

接口名称

WEB_EnterCamControlAPI

功能描述

进入摄像机控制界面。

应用场景

当需要进入终端的摄像机控制界面时调用该接口;

URL

POST /action.cgi?ActionID=WEB_EnterCamControlAPI

请求参数结构

-

请求参数示例

-

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功;

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

启动视频监控

接口名称

WEB_RequestStartVideoMonitor

功能描述

启动视频监控

应用场景

客户端定时获取终端本、远端监控图片之前,首先要调用本接口启动终端的视频监控。

URL

POST /action.cgi?ActionID=WEB_RequestStartVideoMonitor

请求参数结构

{"line":2,"videosrc1":0,"videosrc2":3}

"line"参数表示监控几路视频,终端最大支持监控2路,一路是本地图像,一路是远端图像,"videosrc1"、"videosrc2"两个参数分别表示本地监控图像源、远端图像监控源,本地图像支持监控本地主流(参数:0)、本地辅流(参数:1),远端图像支持监控远端主流(参数:3)、远端辅流(参数:4)

请求参数示例

{"line":2,"videosrc1":0,"videosrc2":3}

成功响应结构

{"success":1,"data":""}

"success"字段表示响应结果,1表示成功;0表示失败。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

"success"字段表示响应结果,0表示失败,1表示成功。"code"字段表示错误码,而"params"字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

获取监控图片

接口名称

videomonitor.jpg?VmniLineId=1/0

功能描述

获取监控图片

应用场景

在调用WEB_RequestStartVideoMonitor接口成功后,就可以获取监控图片了,一般都是由客户端软件启动定时器,时间间隔不要太小,建议大于1秒。另外,监控图像的分辨率较低,一般是CIF或者QCIF。

URL

GET /videomonitor.jpg?VmniLineId=1

请求参数结构

GET /videomonitor.jpg?VmniLineId=1

请求参数示例

参数1表示是获取远端监控图片(也就是第2路监控图片),如果是0,表示获取本地监控图像(也就是第1路监控图片);如果是3表示获取抓拍图片。

成功响应结构

监控图片内容,略

成功响应示例

监控图片内容,略

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

"success"字段表示响应结果,0表示失败,1表示成功。"code"字段表示错误码,而"params"字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

停止视频监控

接口名称

WEB_RequestStopVideoMonitor

功能描述

停止视频监控

应用场景

当客户端停止获取终端本、远端监控图片后,需要调用本接口停止监控。

URL

POST /action.cgi?ActionID=WEB_RequestStopVideoMonitor

请求参数结构

{"line":2,"videosrc1":0,"videosrc2":3}

"line"参数表示监控几路视频,终端最大支持监控2路,一路是本地图像,一路是远端图像,"videosrc1"、"videosrc2"两个参数分别表示本地监控图像源、远端图像监控源,本地图像支持监控本地主流(参数:0)、本地辅流(参数:1),远端图像支持监控远端主流(参数:3)、远端辅流(参数:4)

请求参数示例

{"line":2,"videosrc1":0,"videosrc2":3}

成功响应结构

{"success":1,"data":""}

"success"字段表示响应结果,1表示成功;0表示失败。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

"success"字段表示响应结果,0表示失败,1表示成功。"code"字段表示错误码,而"params"字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

图像抓拍

接口名称

WEB_RequestSnapShot

功能描述

截取本地或远端的一张监控图像

应用场景

截取本地或远端的一张监控图像。调用本接口之前,首先要先启动监控。

URL

POST /action.cgi?ActionID=WEB_RequestSnapShot

请求参数结构

{"line":2,"videosrc1":0,"videosrc2":3}

"line"参数表示监控几路视频,终端最大支持监控2路,一路是本地图像,一路是远端图像,"videosrc1"、"videosrc2"两个参数分别表示本地监控图像源、远端图像监控源,本地图像支持监控本地主流(参数:0)、本地辅流(参数:1),远端图像支持监控远端主流(参数:3)、远端辅流(参数:4)

请求参数示例

{"line":2,"videosrc1":0,"videosrc2":3}

成功响应结构

{"success":1,"data":""}

"success"字段表示响应结果,1表示成功;0表示失败。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

"success"字段表示响应结果,0表示失败,1表示成功。"code"字段表示错误码,而"params"字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

摄像机控制

接口名称

WEB_CtrlCameraOpeateAPI

功能描述

摄像机控制操作。

应用场景

进入视频控制页面,操作摄像机操作键对摄像机进行旋转、聚焦等操作。

URL

POST /action.cgi?ActionID=WEB_CtrlCameraOpeateAPI

请求参数结构

{

"camState":"localCam",

"camAction": 11,

"camPos":5,

"camSrc":0

}

camState字段表示控制的是本地摄像机或远端摄像机,本端摄像机是"localCam",远端摄像机是"remoteCam"。camAction表示摄像机控制指令;camPos表示摄像机预置位;camSrc表示摄像机输入口。摄像机操作命令具体如下:

0: 开始往右平移

1: 开始往左平移

2: 开始往上倾斜

3: 开始往下倾斜

4: 开始Zoom In

5: 开始Zoom Out

6: 开始Focus In

7: 开始Focus Out

8: 停止向右平移

9: 停止向左

10: 停止向上倾斜

11: 停止向下倾斜

12: 停止Zoom In

13: 停止Zoom Out

14: 停止Focus In

15: 停止Focus Out

16: Move Home

17: 自动调焦

18: 存储预置位置(需一个参数[1..30]表示位置)

19: 激活预置位置(需一个参数[1..30]表示位置)

20: 清除预置位置(需一个参数[1..30]表示位置)

请求参数示例

{

"camState":"localCam",

"camAction":11,

"camPos":5,

"camSrc":0

}

成功响应结构

{

"success": 1,

"data":""

}

"success"字段表示响应结果,1表示成功。"data"字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

"success"字段表示响应结果,0表示失败,1表示成功。"code"字段表示错误码,而"params"字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

翻译
下载文档
更新时间:2019-03-08

文档编号:EDOC1100044503

浏览量:4789

下载量:63

平均得分:
本文档适用于这些产品
相关文档
相关版本
Share
上一页 下一页