统一开发 API

Appearance

应用构造操作 ​

目录 ​

1. 构造应用 ​

引入版本：3.0 起支持

功能描述 ​

构造应用

调用方法 ​

JavaScript
let appInstance = new TGApp.App();

返回本章目录

2. 销毁应用 ​

引入版本：3.0 起支持

功能描述 ​

销毁应用

调用方法 ​

JavaScript
appInstance.uniCall('destroy', {}, (result) => {
  console.log(result);
});

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

返回本章目录

3. 获取应用状态信息 ​

引入版本：3.2 起支持

功能描述 ​

获取应用状态信息

调用方法 ​

JavaScript
appInstance.uniCall('getAppInfo', {}, (result) => {
  console.log(result);
});

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。",
  "tgApiSdkVer": "3.3",
  "tgApiDocUrl": "http://www.tuguan.net/doc/tg-api/",
  "clientWidth": 1920,
  "clientHeight": 1080,
  "streamingSdkVer": "3.3.1",
  "streamingServerVer": "3.3",
  "streamingEngineVer": "3.2.1",
  "streamingWidthMax": 1920,
  "streamingHeightMax": 1080,
  "streamingRateMax": 51200,
  "streamingFpsMax": 60,
  "sceneSdkVer": "3.3"
}

回调数据参数描述 ​

属性类型说明端渲染流渲染
resultNumber1：代表成功；0：代表失败支持支持
messageString成功或者失败原因支持支持
tgApiSdkVerString图观 API 版本支持支持
tgApiDocUrlString图观 API 文档在线地址支持支持
sceneSdkVerString端渲染 SDK 小版本支持不支持
streamingSdkVerString流渲染 SDK 小版本不支持支持
streamingServerVerString流渲染服务器版本不支持支持
streamingEngineVerString流渲染引擎版本不支持支持
streamingWidthMaxNumber流渲染通道最大宽不支持支持
streamingHeightMaxNumber流渲染通道最大高不支持支持
streamingRateMaxNumber流渲染通道最大码率，单位 kbps不支持支持
streamingFpsMaxNumber流渲染通道最大帧率不支持支持
clientWidthNumber当前客户端控件宽，端渲染对应 canvas 尺寸，流渲染对应串流画面实际分辨率支持支持
clientHeightNumber当前客户端控件高，端渲染对应 canvas 尺寸，流渲染对应串流画面实际分辨率支持支持

返回本章目录

4. 添加事件监听函数 ​

引入版本：3.1 起支持

功能描述 ​

以指令方式注册事件监听，用于在 uniCall 回调之外按事件名订阅场景或图层事件。

调用方法 ​

JavaScript
appInstance.uniCall(
  'addEventListener',
  {
    eventName: '事件名称',
    callback: function (event) {
      console.log(event);
    },
  },
  (response) => {
    console.log(response);
  }
);

参数描述 ​

属性类型说明
eventNameString事件名称，全局事件如 onSceneClick、onCameraMove，图层事件如 onLandmarkClick
idLayerString图层事件必填，指定监听的图层 ID
callbackIdString回调函数标识符，供 removeEventListener 后续移除监听
callbackFunction事件触发时的回调函数

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。",
  "data": {
    "listenerId": "lst_onSceneClick"
  }
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因
dataObject含 listenerId 监听器 ID

各事件页的示例采用的是事件回调直接写在业务侧的方式；本指令用于需要按事件名统一注册与反注册的场景。

返回本章目录

5. 移除事件监听函数 ​

引入版本：3.1 起支持

功能描述 ​

移除先前通过 addEventListener 注册的事件监听。

调用方法 ​

JavaScript
appInstance.uniCall(
  'removeEventListener',
  {
    eventName: '事件名称',
    callback: window.eventCallback,
  },
  (response) => {
    console.log(response);
  }
);

参数描述 ​

属性类型说明
eventNameString事件名称
idLayerString图层事件必填，指定监听的图层 ID
listenerIdString监听器 ID 或回调函数标识符
callbackFunction要移除的回调函数，不能是匿名函数

回调数据 ​

JSON
{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述 ​

属性类型说明
resultNumber1：代表成功；0：代表失败
messageString成功或者失败原因

移除时不传监听器标识会清空该事件的全部监听器，请务必带上 listenerId 或 callbackId。

返回本章目录