@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/Scene.md

@@ -0,0 +1,272 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Scene
+
+# Class: Scene
+
+场景管理 API。
+
+## Agent Title
+
+场景管理
+
+## Agent Capabilities
+
+场景列表查询, 场景切换, 当前场景查询, 地图罗盘监听, 场景特性开关, 场景元数据查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### getAllSceneName()
+
+> **getAllSceneName**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取当前引擎服务支持的场景名称列表。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.getAllSceneName((data) => {
+  console.log(data);
+});
+```
+
+***
+
+### switchSceneByName()
+
+> **switchSceneByName**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+按场景名称切换场景。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`SceneSwitchRequest`](../../types/interfaces/SceneSwitchRequest.md) | 场景切换参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.switchSceneByName({ sceneName: 'TestScene' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getCurrentSceneName()
+
+> **getCurrentSceneName**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取当前正在运行的场景名称。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.getCurrentSceneName((result) => {
+  console.log(result);
+});
+```
+
+***
+
+### listenMapCompass()
+
+> **listenMapCompass**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+监听地图指北针角度变化。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`SceneListenCompassRequest`](../../types/interfaces/SceneListenCompassRequest.md) | 开关参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.listenMapCompass({ enable: true }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### setFeatureToggle()
+
+> **setFeatureToggle**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置场景特性开关。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`FeatureToggleRequest`](../../types/interfaces/FeatureToggleRequest.md) | 特性键值。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.setFeatureToggle({ key: 'minimap', enabled: true }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getSceneMeta()
+
+> **getSceneMeta**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取当前场景扩展元信息。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Scene.getSceneMeta((result) => {
+  console.log(result);
+});
+```

package/docs/api/api/classes/Screen.md

@@ -0,0 +1,157 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Screen
+
+# Class: Screen
+
+屏幕与渲染质量控制 API。
+
+## Agent Title
+
+画面质量控制
+
+## Agent Capabilities
+
+渲染码率调整, 场景帧率调整, 屏幕分辨率调整
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### setSceneRenderBitrate()
+
+> **setSceneRenderBitrate**(`payload?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置场景渲染码率档位。
+默认值：`bitrate=high`。
+可选档位：`auto / low / high / super / blue`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ScreenSetSceneRenderBitrateRequest`](../../types/interfaces/ScreenSetSceneRenderBitrateRequest.md) \| \{ `bitrate`: `number`; \} | 码率档位参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的调用结果。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Screen.setSceneRenderBitrate(
+   { bitrate: dtcEngine.Enums.ScreenRenderBitratePreset.High },
+   (result) => {
+     console.log(result);
+   }
+ );
+
+ dtcEngine.Screen.setSceneRenderBitrate({
+   bitrate: dtcEngine.Enums.ScreenRenderBitratePreset.Blue
+ });
+```
+
+***
+
+### setSceneFPS()
+
+> **setSceneFPS**(`payload?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置场景帧率。
+默认值：`fps=150`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ScreenSetSceneFPSRequest`](../../types/interfaces/ScreenSetSceneFPSRequest.md) | 帧率参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的调用结果。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Screen.setSceneFPS({ fps: 45 }, (result) => {
+   console.log(result);
+ });
+```
+
+***
+
+### setScreenResolution()
+
+> **setScreenResolution**(`payload?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置渲染分辨率。
+默认值：`width=1920`、`height=1080`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ScreenSetScreenResolutionRequest`](../../types/interfaces/ScreenSetScreenResolutionRequest.md) | 分辨率参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的调用结果。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.Screen.setScreenResolution({ width: 1280, height: 720 }, (result) => {
+   console.log(result);
+ });
+```

package/docs/api/api/classes/TimeLine.md

@@ -0,0 +1,274 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / TimeLine
+
+# Class: TimeLine
+
+TimeLine 动画控制 API。
+
+## Agent Title
+
+时间线动画
+
+## Agent Capabilities
+
+时间线播放, 时间线暂停, 时间线恢复, 时间线停止, 全部时间线停止, 播放速度控制
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### play()
+
+> **play**(`payload`, `callback?`): `StreamRequestPromise`\<`unknown`\>
+
+播放指定 TimeLine 动画。
+默认值：`speed=1`、`initialTime=0`、`keepLastFrame=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TimelinePlayRequest`](../../types/interfaces/TimelinePlayRequest.md) | 播放参数。 |
+| `callback?` | `StreamRequestCallback`\<`unknown`\> | 可选回调函数。 |
+
+#### Returns
+
+`StreamRequestPromise`\<`unknown`\>
+
+支持 data/done/error/cancel 事件的流式 Promise。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.TimeLine.play({ id: 'Path1', speed: 2 }, (event) => {
+   console.log(event.type, event.response);
+ });
+```
+
+***
+
+### pause()
+
+> **pause**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+暂停指定 TimeLine 动画。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TimelineNodeRequest`](../../types/interfaces/TimelineNodeRequest.md) | 时间线标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.TimeLine.pause({ id: 'Path1' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### resume()
+
+> **resume**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+继续播放指定 TimeLine 动画。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TimelineNodeRequest`](../../types/interfaces/TimelineNodeRequest.md) | 时间线标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.TimeLine.resume({ id: 'Path1' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### stop()
+
+> **stop**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止指定 TimeLine 动画。
+默认值：`resetTime=-1`、`isCameraToStart=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TimelineStopRequest`](../../types/interfaces/TimelineStopRequest.md) | 停止参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.TimeLine.stop({ id: 'Path1' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### stopAll()
+
+> **stopAll**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止全部 TimeLine 动画。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.TimeLine.stopAll((result) => { console.log(result); });
+```
+
+***
+
+### setSpeed()
+
+> **setSpeed**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置指定 TimeLine 的播放速度。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`TimelineSetSpeedRequest`](../../types/interfaces/TimelineSetSpeedRequest.md) | 速度参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.TimeLine.setSpeed({ id: 'Path1', speed: 1.2 }, (result) => {
+  console.log(result);
+});
+```