开发者平台

 TP-LINK官网首页
VMS平台
V2.0.19
开发者平台 / 视频管理系统（VMS）/API功能接口定义/设备消息透传

4.14.12 摄像头显示OSD配置

4.14.12.1 获取字符信息

              Request:
              {
                "method": "get",
                "OSD": {
                  "table": "label_info"
                }
              }

              Response:
              {
                "error_code": 0,
                "OSD": {
                  "label_info": [
                    {
                      "label_info_1": {
                        "x_coor": "1000",
                        "y_coor": "8000",
                        "enabled": "off",
                        "link_chn_to_dev": "on",
                        "text": "TP IPC",
                        "align_type": "0"
                      }
                    }
                  ]
                }
              }

返回参数说明：

参数 类型 说明
x_coor 整型 起点x坐标
y_coor 整型 起点y坐标
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏
link_chn_to_dev 字符串 是否需要联动通道名称和设备名称，
取值范围：
on：显示
off：隐藏
text 字符串 字符显示文本
align_type 整型 对齐方式
取值范围：
0：左对齐（默认）
1：居中对齐
2：右对齐

4.14.12.2 设置字符信息

        Request:
        {
          "method": "set",
          "OSD": {
            "label_info_1":{
              "x_coor": "1000",
              "y_coor": "8000",
              "enabled": "off",
              "link_chn_to_dev": "on",
              "text": "TP IPC",
              "align_type": "0"
            }
          }
        }

        Response:
        {
          "error_code": 0
        }

请求参数说明：

参数 类型 说明
x_coor 整型 起点x坐标
y_coor 整型 起点y坐标
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏
link_chn_to_dev 字符串 是否需要联动通道名称和设备名称，
取值范围：
on：显示
off：隐藏
text 字符串 字符显示文本
align_type 整型 对齐方式
取值范围：
0：左对齐（默认）
1：居中对齐
2：右对齐

4.14.12.3 获取显示配置时间

              Request:
              {
                "method": "get",
                "OSD": {
                  "name": "font"
                }
              }

              Response:
              {
                "error_code": 0,
                "OSD": {
                  "font": {
                    "display": "ntnb",
                    "size": "auto",
                    "color_type": "auto",
                    "color": "white"
                  }
                }
              }

返回参数说明：

参数 类型 说明
display 字符串 字体显示，
该字段可选值范围由osd_capability模块中capability的 display_mode 决定。
否则，取值范围是 ntnb 和 ntb。
ntnb：不透明，不闪烁
tnb：透明，不闪烁
ntb不透明，闪烁
tb：透明，闪烁
size 字符串 字体大小，
该字段可选值范围由 osd_capability 模块中 capability 的 font_size 决定。否则，取值范围如下：自动、16*16、32*32、48*48、64*64
color_type 字符串 字体颜色类型，
该字段可选值范围由 osd_capability 模块中 capability 的 font_color 决定。
若 font_color 取值范围只有auto，则 color_type 只能被配置成auto。
若 font_color 取值范围包含 black 等任意颜色字段，则 color_type 允许被配置成 user_defined。
否则，取值范围如下：
auto：默认
user_defined：自定义
color 字符串 字体颜色，
仅当 color_type 设置为 user_defined 时有效，当存在 osd_capability 时，该字段取值范围由 osd_capability 模块中 capability 的 font_color 字段决定。
当不存在osd_capability 时，取值范围如下：black、 white

4.14.12.4 设置显示配置信息

              Request:
              {
                "method": "set",
                "OSD": {
                  "font": {
                    "display": "ntnb",
                    "size": "auto",
                    "color_type": "auto",
                    "color": "white"
                  }
                }
              }

              Response:
              {
                "error_code": 0
              }

请求参数说明：

参数 类型 说明
display 字符串 字体显示，
该字段可选值范围由osd_capability模块中capability的 display_mode 决定。
否则，取值范围是 ntnb 和 ntb。
ntnb：不透明，不闪烁
tnb：透明，不闪烁
ntb不透明，闪烁
tb：透明，闪烁
size 字符串 字体大小，
该字段可选值范围由 osd_capability 模块中 capability 的 font_size 决定。否则，取值范围如下：自动、16*16、32*32、48*48、64*64
color_type 字符串 字体颜色类型，
该字段可选值范围由 osd_capability 模块中 capability 的 font_color 决定。
若 font_color 取值范围只有auto，则 color_type 只能被配置成auto。
若 font_color 取值范围包含 black 等任意颜色字段，则 color_type 允许被配置成 user_defined。
否则，取值范围如下：
auto：默认
user_defined：自定义
color 字符串 字体颜色，
仅当 color_type 设置为 user_defined 时有效，当存在 osd_capability 时，该字段取值范围由 osd_capability 模块中 capability 的 font_color 字段决定。
当不存在osd_capability 时，取值范围如下：black、 white

4.14.12.5 获取时间信息

              Request:
              {
                "method": "get",
                "OSD": {
                  "name": "date"
                }
              }

              Response:
              {
                "error_code": 0,
                "OSD": {
                  "date": {
                    "x_coor": "1000",
                    "y_coor": "500",
                    "enabled": "on"
                  }
                }
              }

返回参数说明：

参数 类型 说明
x_coor 整型 起点x坐标
y_coor 整型 起点y坐标
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏

4.14.12.6 设置时间信息

        Request:
        {
          "method": "set",
          "OSD": {
            "date": {
              "x_coor": "1000",
              "y_coor": "500",
              "enabled": "on"
            }
          }
        }

        Response:
        {
          "error_code": 0
        }

请求参数说明：

参数 类型 说明
x_coor 整型 起点x坐标
y_coor 整型 起点y坐标
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏

4.14.12.7 获取星期信息

              Request:
              {
                "method": "get",
                "OSD": {
                  "name": "week"
                }
              }

              Response:
              {
                "error_code": 0,
                "OSD": {
                  "week": {
                    "x_coor": "6000",
                    "y_coor": "500",
                    "enabled": "on"
                  }
                }
              }

返回参数说明：

参数 类型 说明
x_coor 整型 起点x坐标，实际上此字段不生效，week 的坐标信息，永远是根据 date 这个数据块来定的，也就是 week 永远处理日期和时间的中间。
y_coor 整型 起点y坐标，实际上此字段不生效，week 的坐标信息，永远是根据 date 这个数据块来定的，也就是 week 永远处理日期和时间的中间。
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏

4.14.12.8 设置星期信息

        Request:
        {
          "method": "set",
          "OSD": {
            "week": {
              "x_coor": "6000",
              "y_coor": "500",
              "enabled": "on"
            }
          }
        }
        Response:
        {
          "error_code": 0
        }

返回参数说明：

参数 类型 说明
x_coor 整型 起点x坐标，实际上此字段不生效，week 的坐标信息，永远是根据 date 这个数据块来定的，也就是 week 永远处理日期和时间的中间。
y_coor 整型 起点y坐标，实际上此字段不生效，week 的坐标信息，永远是根据 date 这个数据块来定的，也就是 week 永远处理日期和时间的中间。
enabled 字符串 隐藏/显示
取值范围：
on：显示
off：隐藏