颗粒资源检查API

颗粒资源检查API

为第三方应用提供检查实验颗粒关联的资源列表、实验颗粒打包资源搜集等接口,方便在实验播放之前准备好所有实验资源。

1. 获取资源下载地址

简要描述:

  • 获取资源下载地址,在用户插入实验颗粒时调用,返回需要下载的资源地址和存放路径。
  • 注意调用此接口前需要设置语言,默认使用简体中文(zh_CN)。
  • 实验资源包括实验器材、实验药品、核心/业务组件、器材资源、语言包资源。
  • 注意区分旧颗粒和新颗粒,旧颗粒通过旧管理平台下载,旧颗粒关联的实验资源有:实验器材、实验药品、核心/业务组件;新颗粒通过新管理平台下载,新颗粒关联的实验资源有:实验资源包括实验器材、实验药品、核心/业务组件、器材资源、语言包资源。

接口定义:

const char* __stdcall ComponentUpdateCheckTool(const char* strLabFilePath, const char* strLabObjPath)

参数:

参数名 说明
strLabFilePath 实验颗粒文件路径
strLabObjPath 资源包存放根目录(如E:\NdCloud\labobjs)

返回示例1[旧颗粒]

  "{
    "error_code": 0,
    "data": [
    {
      "url": "http://cs.101.com/v0.1/static/esp_developer/experimentMaterial/1114112/1.0.3.0/20190515162019/ff8080816ab645f5016aba93f4f94029.ele?attachment=true&name=CurrentSourceElement_PC_1.0.3.0.ele",
      "path": "E:\NdCloud\labobjs\CurrentSourceElement_PC"
    }]
  }"

返回示例2[新颗粒]

  "{
    "error_code": 0,
    "data": [
    {
      "url": "https://cs.101.com/v0.1/static/vlab/packages/equipments/CurrentSourceElement_1.4.7_200520002.ele",
      "path": "E:\NdCloud\labobjs\NewModule\CurrentSourceElement_PC"
    },
    {
      "url": "https://cs.101.com/v0.1/static/vlab/packages/resources/CurrentSourceElementModel_1.3.0_191107002.pkg",
      "path": "E:\NdCloud\labobjs\NewModule\CurrentSourceElementModel_PC"
    },
    {
      "url": "https://cs.101.com/v0.1/static/vlab/packages/languages/xxxxxxx/zh_CN.json",
      "path": "E:\NdCloud\labobjs\NewModule\CurrentSourceElement_PC\Language\"
    }]
  }"

返回参数说明

参数名 类型 说明
error_code int 错误码:[0(成功),-1(参数错误),-2(网络错误且本地器材包都存在), -3(网络错误且有器材包本地未存在), -4(其它错误,程序异常)]
url string 资源下载地址
path string 资源包存放根目录(如E:\NdCloud\labobjs)
2. 打包实验资源

简要描述:

  • 101PPT用户在编辑一个PPT文档后,保存PPT文档时,会把文档中的实验颗粒文件和资源包一起打包。其中,打包实验颗粒需要把关联的资源包一起打包。
  • 根据实验颗粒文件,获取该实验颗粒关联的资源包列表。
const char* __stdcall GetNeedPackageObjPath(const char* strLabFilePath, const char* strLabObjPath)

参数:

参数名 说明
strLabFilePath 实验颗粒文件路径
strLabObjPath NDCloud中的器材存放根目录

返回示例1[旧颗粒]

  "{
    "error_code": 0,
    "data": [{
      "packPath": "E:\NdCloud\labobjs\CurrentSourceElement_PC",
      "relatePath;": ""
    }]
  }"

返回示例2[新颗粒]

  "{
    "error_code": 0,
    "data": [
    {
      "packPath": "E:\NdCloud\labobjs\NewModule\CurrentSourceElement_PC",
      "relatePath;": "NewModule"
    },
    {
      "packPath": "E:\NdCloud\labobjs\NewModule\CurrentSourceElementModel_PC",
      "relatePath;": "NewModule"
    }]
  }"

返回参数说明

参数名 类型 说明
error_code int 错误码[0(成功),-1(参数错误),-2(器材包不完整),-3(其它错误)]
packPath string 资源包目录
relatePath string 资源包存放相对路径,为空表示直接放在最上层目录中
3. 设置当前语言

简要描述:

  • 设置当前语言编码,如zh_CN、en_US、ar_SA,语言编码需要和新管理平台一致。
void __stdcall SetLanguage(const char* strLanguage)

参数:

参数名 说明
strLanguage 语言编码
4. 获取资源包根目录

简要描述:

  • 启动播放器需要指定器材包根目录,目前播放器需要兼容旧资源和新资源
const char* __stdcall GetCorrectLabObjPath(const char* strLabFilePath, const char* strLabObjPath)

参数:

参数名 说明
strLabFilePath 实验颗粒文件路径
strLabObjPath 资源包存放根目录(如E:\NdCloud\labobjs),如果颗粒不存在/颗粒数据问题,返回空(NULL)

返回示例1[旧颗粒]

  "E:\NdCloud\labobjs"

返回示例2[新颗粒]

  "E:\NdCloud\labobjs\NewModule"

更新记录

2020/05/07 v1.0.0[黄金民(171517)]
2020/05/28 v1.1.0[刘剑(281001)]
1.完善接口描述。
2.补充返回示例(区分旧颗粒和新颗粒)。