从服务器获取配置信息

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetDeviceConfig

系统规定参数。取值:GetDeviceConfig。

DeviceSn String 210235C41T320400****

设备序列号,由厂家分配的唯一编号,不可修改

DeviceTimeStamp String 1595837187

unix时间戳,单位秒

返回数据

名称 类型 示例值 描述
AudioEnable Boolean true

是否开启音频,默认开启。

AudioFormat String 6

音频编码格式:

<!-

  • 1:G.711A -->

<!-

  • 2: G.711U -->

<!-

  • 6: AAC-LC -->

<Mode>1,2,6</Mode>

默认6

BitRate String 2048

编码码率 kbps。

Code String 200

请求返回code

DeviceAddress String 浙江省杭州市文一西路xx号

设备地址,对应到国标设备信息对应字段。

DeviceName String 测试设备

设备名称,对应到国标设备信息相应字段。

EncodeFormat String 6

视频编码格式:

<!-

  • 3: MJPEG -->

    <!-

  • 6: H.264 -->

    <!-

  • 13: H.265-->

    <EncodeFormat>6</EncodeFormat>

    默认6

FrameRate String 25

帧率,FPS

GovLength Integer 50

GoP,I帧间隔,默认为FrameRate*2,50。

Latitude String 116.397128

经度

如果设备无获取经纬度能力,则依赖该值设置经纬度

Longitude String 39.916527

维度

如果设备无获取经纬度能力,则依赖该值设置经纬度

Message String success

请求返回结果消息。

OSDList Array

OSD叠加字符串列表。

LeftTopX String 10

字符串的X坐标,以播放窗口左上角像素为原点,水平向右为正。

LeftTopY String 10

字符串的Y坐标,以播放窗口左上角像素为原点,垂直向下为正。

Text String 浙江省杭州市文一西路xx号

OSD上叠加的字符串。

OSDTimeEnable String 1

<!-

  • 显示时间开关(可选),0-关闭;1-打开-->

    <element name="TimeEnable" type="integer" minOccurs="0"/>

    默认打开

OSDTimeType String 2

<!-

  • 时间显示类型(可选):

0

  • YYYY-MM-DD 星期W HH:MM:SS;

1

  • DD-MM-YYYY星期W HH:MM:SS;

2

  • YYYY年MM月DD日 星期W HH:MM:SS;

3

  • MM月DD日YYYY年 星期W HH:MM:SS;

4

  • YYYY-MM-DD HH:MM:SS;

5

  • DD-MM-YYYY HH:MM:SS;

6

  • YYYY年MM月DD日 HH:MM:SS;

7

  • MM月DD日YYYY年 HH:MM:SS -->

    默认为2

OSDTimeX String 1

<!-

  • 时间戳X像素坐标(可选),以播放窗口左上角像素为原点,水平向右为正-->

    <element name="TimeX" type="integer" minOccurs="0"/>

    默认为1

OSDTimeY String 1

<!-

  • 时间戳Y像素坐标(可选),以播放窗口左上角像素为原点,竖直向下为正-->

    <element name="TimeY" type="integer" minOccurs="0"/>

    默认为1

RequestId String ABCDE01

请求ID,一般为uuid。

Resolution String 1920*1080

编码分辨率。

RetryInterval String 300

发送下一个消息前的等待时间,单位秒,如果为0,马上发起相应消息。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDeviceConfig
&DeviceSn=210235C41T320400****
&DeviceTimeStamp=1595837187
&<公共请求参数>

正常返回示例

JSON 格式

{"FrameRate":"25","EncodeFormat":"6","Message":"success","RequestId":"ABCDE01","Latitude":"116.397128","Code":"200","Longitude":"39.916527","OSDList":[{"Text":"","LeftTopY":"","LeftTopX":""}],"OSDTimeY":"1","OSDTimeEnable":"1","DeviceAddress":"浙江省杭州市文一西路xx号","OSDTimeX":"1","GovLength":"50","RetryInterval":"300","AudioFormat":"6","BitRate":"2048","AudioEnable":"true","DeviceName":"测试设备","OSDTimeType":"2","Resolution":"1920*1080"}

错误码

访问错误中心查看更多错误码。