Platform API

安装

npm install @cutos/core

引入依赖

import {CoreAPI} from '@cutos/core';

CoreAPI.init

初始化

CoreAPI.init(host, callback);

• host: CUTOS地址。host等于null时取值'localhost'。开发时可以修改为目标地址（安装有CUTOS的设备地址），如: '192.168.1.11'
• callback: 回调函数。回调函数会接收两个参数result（String）和error（Object）。其中error.name为错误名称，error.message为具体错误信息。

举例:

 CoreAPI.init('192.168.1.11', (result, error) => {
  if (!error) {
    console.log(result)
  } else {
    console.error('init failed' + error.message)
  }
})

• 返回结果示例:

{
  "result": "CUTOS CORE connected."
}

CoreAPI.getVersion

获取SDK版本信息

CoreAPI.getVersion();

• 返回结果示例:

"3.2.2"

CoreAPI.getPlatform

获取硬件平台信息

CoreAPI.getPlatform(callback);

• callback: 回调函数

举例:

CoreAPI.getPlatform(result => {
  console.log(result)
});

• 返回结果示例:

{
  "arch": "x64",
  "platform": "win32",
  "type": "Windows_NT",
  "release": "10.0.19045"
}

CoreAPI.getConfig

获取CUTOS配置信息

CoreAPI.getConfig(callback);

• callback: 回调函数

举例:

CoreAPI.getConfig(result => {
  console.log(result)
});

• 返回结果示例:

{
  "srvAddress": "www.cut-os.com",
  "srvRestProtocol": "https",
  "enableTimeSync": true,
  "playReport": false,
  "language": "Chinese",
  "debug": false
}

CoreAPI.getBoxInfo

获取主机信息

CoreAPI.getBoxInfo(callback);

• callback: 回调函数

举例:

CoreAPI.getBoxInfo(result => {
  console.log(result)
})

• 返回结果示例:

{
  "id": 1016,
  "macAddress": "00-F1-F5-2A-8E-8C",
  "ipAddress": "192.168.1.127",
  "masterIpAddress": "",
  "osVersion": "3.2.0"
}
`

• id: 主机ID
• macAddress: 主机MAC地址
• ipAddress: 主机IP地址
• masterIpAddress: 主IP地址，多台主机组成主机组时使用
• osVersion: CUTOS 播放器版本

CoreAPI.getDeviceInfo

获取设备信息

CoreAPI.getDeviceInfo(callback);

• callback: 回调函数

举例:

CoreAPI.getDeviceInfo(result => {
  console.log(result)
})

• 返回结果示例:

{
  "id": 1234,
  "name": "sipTimes office",
  "shortName": "",
  "groupId": 0,
  "groupName": null,
  "department": null,
  "description": null,
  "gwi": "9E1E3B67-...101B",
  "gwUrl": "ws://127.0.0.1:61614",
  "ext": null,
  "token": "D+yIxq1d3...BTgjK....."
}

• id: 设备ID
• name: 设备名称
• shortName: 设备简称
• groupId: 设备组ID
• groupName:设备组名称
• department: 部门
• description: 描述
• gwi: 网关ID
• gwUrl: 网关地址
• ext: 扩展信息
• token: 令牌

CoreAPI.getVolume

获取音量

CoreAPI.getVolume(callback);

• callback: 回调函数

举例:

CoreAPI.getVolume(result => {
  console.log(result)
})

• 返回结果示例:

"11"

CoreAPI.setVolume

设置音量

CoreAPI.setVolume(value, callback)

• value: 音量（0-100）
• callback: 回调函数

举例:

CoreAPI.setVolume(70, (result, error) => {
  if (!error) {
    console.log(result)
  }
})

• 返回结果示例:

{
  "result": 70
}

CoreAPI.setHttpProxy

设置代理，解决开发时lwa跨域问题

CoreAPI.setHttpProxy(api, target, callback)

• api: 接口名称
• target: 目标地址
• callback: 回调函数。成功回调函数返回result ，失败回调函数返回error。

举例:

CoreAPI.setHttpProxy('api', 'https://www.cut-os.com', (result, error) => {
  if (!error) {
    console.log(result)
  }
})

• 返回结果示例:

{
  "path": "proxy/api",
  "target": "https://www.cut-os.com"
}

• path: 请求地址前缀
• target: 目标地址

开发请求的地址

fetch(`http://localhost:3000/proxy/api/rest/sv/system/runtime/ping`)

真实请求的地址

fetch(`https://www.cut-os.com/rest/sv/system/runtime/ping`)

CoreAPI.shell

Shell命令执行

CoreAPI.shell(command, callback)

• command: 命令
• callback: 回调函数

举例:

CoreAPI.shell('pwd', (result, error) => {
  if (!error) {
    console.log(result)
  }
})

• 返回结果示例:

"/home/linaro"