针对 Ultra Encode API，方便开发人员与设备交互，如获取设备的基本信息（设备名称、固件版本等），修改设备配置，更新固件等。这些 API 基于 HTTP 协议，是一种轻量级、无连接状态的接口，响应数据为 JSON 格式。通过本文档，您可以更详细地了解每个 API 的功能和请求方式。

本文档中的 API 可适用于以下产品：
•Ultra Encode HDMI
•Ultra Encode SDI 

本文通过 Node.js 环境下的两个实例介绍 Ultra Encode API 如何调用。

DEMO 下载链接：ultra-encode-api-demo-nodejs.zip

DEMO 目录结构：
ultra-encode-api-demo-nodejs
|
|-- httpUtils.js // 基于 nodejs 的 HTTP 模块封装了 get 方法和 upload 方法
|-- xxxx.mwf // upload.js 调用 upload-update-file 接口上传的测试固件
|-- get.js // 通过 GET 方式调用接口获取数据
|-- upload.js // 通过 POST 方式实现文件上传


环境准备
•操作系统：支持 macOS，Linux，Windows
•运行环境：建议选择 LTS 版本，最低要求 8.x

运行方式
1.在终端控制台进入 DEMO 目录cd ultra-encode-demo-nodejs


2.将 get.js 和 upload.js 中的 deviceIP 替换成测试设备的 IP 地址

3.运行 get.js
node get

4.运行 upload.js
node upload

环境准备
•操作系统：支持 Windows、macOS、Linux

源码编译
•开发者自己准备相应平台(Windows/macOS/Linux/...) 的"curl sdk"
•DEMO 下载链接：ultra-encode-api-demo-c.zip
•编译 "ultra_encode_curl.c"，链接到"libcurl"
•生成可执行性文件 "ultra_encode_curl"

运行方式
•在终端控制台进入 bin 目录, 将固件文件拷贝到相应平台，执行相应平台的 ultra_encode_curl
cd ultra-encode-api/demo/c/bin
cp ultra_encode_hdmi_rev_a_1_3_328.mwf linux
cd linux
./ultra_encode_curl

•输出结果

***** 1. login *****
login response data:
{
"result": 0
}

***** 2. get info *****
get info response data:
{
"result": 0,
"mac-addr": {
"eth": "70:b3:d5:75:d0:4c",
"wifi": "70:b3:d5:75:d0:4d",
"blue": "70:b3:d5:75:d0:4e"
},
"snapshot": "/tmp/sbox-snapshot/sbox-quarter.jpg",
"product": {
"sn": "A304201201001",
"product-id": 772,
"hardware-ver": "A",
"firmware-id": 1,
"firmware-ver-s": "1.3.328",
"factory-firmware-ver-s": "1.3.328",
"product-name": "Ultra Encode",
"module-name": "Ultra Encode HDMI",
"manu-name": "MAGEWELL",
"features": 1,
"max-lock-count": 2
},
"audio-range": {
"hdmi": {
"max": 6.00,
"min": -100.00,
"def": 0.00
},
"mic": {
"max": 55.25,
"min": -12.00,
"def": 0.00
},
"phone": {
"max": 6.00,
"min": -57.00,
"def": 0.00
}
},
"codec-cap": {}
}

***** 3. upload firmware *****
upload firmware response data:
{
"result": 0,
"up-to-date": true,
"version": "1.2.123",
"size": 12494463
}