@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/Animation.md

@@ -0,0 +1,280 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / Animation
+
+# Class: Animation
+
+控制模型 Animator 和循环动画。
+
+## Agent Title
+
+模型动画
+
+## Agent Capabilities
+
+循环动画播放, 循环动画停止, Animator 播放, Animator 停止, 动画速度控制, 动画长度查询
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### startLoopAnimation()
+
+> **startLoopAnimation**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+播放循环动画片段。
+默认值：`speed=1`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationStartLoopRequest`](../../types/interfaces/AnimationStartLoopRequest.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.Animation.startLoopAnimation(
+  { parentId: 'AnimatorTest', id: 'rotateObj', stateName: 'door_open', loopStartTime: 0, loopEndTime: 3, speed: 1 },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### stopLoopAnimation()
+
+> **stopLoopAnimation**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止循环动画片段。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationStopLoopRequest`](../../types/interfaces/AnimationStopLoopRequest.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.Animation.stopLoopAnimation({ parentId: 'AnimatorTest', id: 'rotateObj' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### playAnimator()
+
+> **playAnimator**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+播放 Animator 动画片段。
+默认值：`speed=1`、`startTime=0`、`endTime=1`、`isStop=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationPlayRequest`](../../types/interfaces/AnimationPlayRequest.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.Animation.playAnimator(
+  { parentId: 'AnimatorTest', id: 'rotateObj', stateName: 'door_open', speed: 1, startTime: 0, endTime: 1, isStop: false },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### setAnimatorSpeed()
+
+> **setAnimatorSpeed**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置 Animator 动画播放速度。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationSetSpeedRequest`](../../types/interfaces/AnimationSetSpeedRequest.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.Animation.setAnimatorSpeed({ parentId: 'AnimatorTest', id: 'rotateObj', speed: 1.5 }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getAnimationLength()
+
+> **getAnimationLength**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+获取动画片段长度。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationGetLengthRequest`](../../types/interfaces/AnimationGetLengthRequest.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
+
+read
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.Animation.getAnimationLength(
+  { parentId: 'AnimatorTest', id: 'rotateObj', stateName: 'door_open' },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### stopAnimator()
+
+> **stopAnimator**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止指定对象的 Animator 播放。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`AnimationStopRequest`](../../types/interfaces/AnimationStopRequest.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.Animation.stopAnimator({ parentId: 'AnimatorTest', id: 'rotateObj' }, (result) => {
+  console.log(result);
+});
+```

package/docs/api/api/classes/ApiRegistryError.md

@@ -0,0 +1,60 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / ApiRegistryError
+
+# Class: ApiRegistryError
+
+API 注册表运行时校验错误。
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new ApiRegistryError**(`code`, `message`, `moduleName?`, `dependencyName?`): `ApiRegistryError`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `code` | `"CONTEXT_INVALID"` \| `"REGISTRY_INVALID"` \| `"REGISTRY_INCOMPLETE"` \| `"REGISTRY_UNKNOWN_MODULE"` \| `"FACTORY_INVALID"` \| `"FACTORY_FAILED"` \| `"FACTORY_EMPTY_RESULT"` |
+| `message` | `string` |
+| `moduleName?` | `string` |
+| `dependencyName?` | `string` |
+
+#### Returns
+
+`ApiRegistryError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### name
+
+> `readonly` **name**: `"ApiRegistryError"` = `'ApiRegistryError'`
+
+#### Overrides
+
+`Error.name`
+
+***
+
+### code
+
+> `readonly` **code**: `"CONTEXT_INVALID"` \| `"REGISTRY_INVALID"` \| `"REGISTRY_INCOMPLETE"` \| `"REGISTRY_UNKNOWN_MODULE"` \| `"FACTORY_INVALID"` \| `"FACTORY_FAILED"` \| `"FACTORY_EMPTY_RESULT"`
+
+***
+
+### moduleName?
+
+> `readonly` `optional` **moduleName**: `string`
+
+***
+
+### dependencyName?
+
+> `readonly` `optional` **dependencyName**: `string`