@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/Connect.md

@@ -0,0 +1,257 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Connect
+
+# Class: Connect
+
+连接控制 API。
+
+## Agent Title
+
+连接控制
+
+## Agent Capabilities
+
+连接建立, 连接断开, 连接重连, 会话接管, 会话保活, 服务状态查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### connect()
+
+> **connect**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+发起连接（兼容接口，SDK 实际已在 `new DTCEngine` 后自动连接）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+connection
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Connect.connect((result) => { console.log(result); });
+```
+
+***
+
+### disconnect()
+
+> **disconnect**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+断开连接。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+connection
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Connect.disconnect((result) => { console.log(result); });
+```
+
+***
+
+### reconnect()
+
+> **reconnect**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+重新连接。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`void`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+connection
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Connect.reconnect((result) => { console.log(result); });
+```
+
+***
+
+### KickOtherConnect()
+
+> **KickOtherConnect**(`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
+
+connection
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Connect.KickOtherConnect((result) => { console.log(result); });
+```
+
+***
+
+### KeepConnect()
+
+> **KeepConnect**(`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
+
+connection
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Connect.KeepConnect((result) => { console.log(result); });
+```
+
+***
+
+### GetEngineServiceStatus()
+
+> **GetEngineServiceStatus**(`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.Connect.GetEngineServiceStatus((result) => { console.log(result); });
+```

package/docs/api/api/classes/Dlss.md

@@ -0,0 +1,67 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Dlss
+
+# Class: Dlss
+
+DLSS 画质控制 API。
+
+## Agent Title
+
+DLSS 画质控制
+
+## Agent Capabilities
+
+DLSS 开关控制, DLSS 质量档位控制
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### setDlss()
+
+> **setDlss**(`payload?`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+同时设置 DLSS 开关和质量档位。
+默认值：`enable=false`、`quality=DlssQuality.Balanced`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`DlssSetEnableRequest`](../../types/interfaces/DlssSetEnableRequest.md) | DLSS 开关参数。 |
+| `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.Dlss.setDlss(
+   {
+     enable: true,
+     quality: dtcEngine.Enums.DlssQuality.Balanced
+   },
+   (result) => {
+     console.log(result);
+   }
+ );
+```

package/docs/api/api/classes/HighLighterEffect.md

@@ -0,0 +1,173 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / HighLighterEffect
+
+# Class: HighLighterEffect
+
+高亮效果 API，控制场景中模型对象的高亮。
+
+## Agent Title
+
+高亮效果
+
+## Agent Capabilities
+
+打开高亮, 关闭高亮, 模型高亮, 移除模型高亮, 清除全部高亮
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### enable()
+
+> **enable**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+打开高亮效果。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HighLighterEnableRequest`](../../types/interfaces/HighLighterEnableRequest.md) | - |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 回调函数 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Example
+
+```
+示例： 打开高亮效果
+dtcEngine.HighlighterEffect.enable({enable: true}, result => console.log(result));
+```
+示例： 关闭高亮效果
+```
+dtcEngine.HighlighterEffect.enable({enable: false}, result => console.log(result));
+```
+
+***
+
+### setHighLightModel()
+
+> **setHighLightModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置场景当中，指定模型对象  高亮效果
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HighLighterSetHighLightModelRequest`](../../types/interfaces/HighLighterSetHighLightModelRequest.md) | 参数 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 回调函数 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```
+ dtcEngine.HighlighterEffect.setHighLightModel({parentId:'test',ids: ["Sphere", "Sphere1"]} ,result =>console.log(result));
+```
+
+***
+
+### removeHighLightModel()
+
+> **removeHighLightModel**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+清除 指定模型对象的高亮效果
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`HighLighterRemoveHighLightModelRequest`](../../types/interfaces/HighLighterRemoveHighLightModelRequest.md) | 参数 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 回调 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```
+ dtcEngine.HighlighterEffect.removeHighLightModel({parentId:'test',ids: ["Sphere", "Sphere1"] },result=>console.log(result));
+```
+
+***
+
+### clear()
+
+> **clear**(`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`\>\>
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Example
+
+```
+   dtcEngine.HighlighterEffect.clear(result=>console.log(result));
+```