@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/WeatherSystem.md

@@ -0,0 +1,581 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / WeatherSystem
+
+# Class: WeatherSystem
+
+天气与时间环境控制 API。
+
+## Agent Title
+
+天气时间环境
+
+## Agent Capabilities
+
+天气类型查询, 天气切换, 天气重置, 天气时间重置, 场景时间设置, 时间同步控制, 昼夜动画控制, 昼夜模式设置, 季节切换, 季节重置, 雾效开启, 雾效关闭
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### changeWeatherType()
+
+> **changeWeatherType**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+切换天气类型。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherTypeRequest`](../../types/interfaces/WeatherTypeRequest.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.WeatherSystem.changeWeatherType({ type: 0, timeDuration: 60 }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### getWeatherTypes()
+
+> **getWeatherTypes**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+得到所有天气类型
+备注：（需在配置 提前预制UDS天气系统）
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+*
+
+#### Agent Side Effects
+
+read
+ *
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+ *
+
+#### Agent Risk Level
+
+low
+ *
+
+#### Agent Example
+
+#### Example
+
+```
+dtcEngine.WeatherSystem.getWeatherTypes((result)=>{console.log(result)})
+```
+
+***
+
+### resetWeather()
+
+> **resetWeather**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+重置天气
+备注：（需在配置 提前预制UDS天气系统）
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `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.WeatherSystem.resetWeather((result)=>{console.log(result)})
+```
+
+***
+
+### setSceneTime()
+
+> **setSceneTime**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置场景时间（小时）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherSetSceneTimeRequest`](../../types/interfaces/WeatherSetSceneTimeRequest.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.WeatherSystem.setSceneTime({ hour: 10.5 }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### setTimeSync()
+
+> **setTimeSync**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置是否同步系统时间。
+默认值：`syncSystemTime=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherSetTimeSyncRequest`](../../types/interfaces/WeatherSetTimeSyncRequest.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.WeatherSystem.setTimeSync({ syncSystemTime: true }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### resetSceneTime()
+
+> **resetSceneTime**(`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
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.WeatherSystem.resetSceneTime((result) => {
+   console.log(result);
+});
+```
+
+***
+
+### setAnimateTimeOfDay()
+
+> **setAnimateTimeOfDay**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置是否模拟白天，黑夜轮换动画。
+默认值：`syncSystemTime=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherSetAnimateTimeOfDayRequest`](../../types/interfaces/WeatherSetAnimateTimeOfDayRequest.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.WeatherSystem.setAnimateTimeOfDay({ isAnimate: true,dayLength:0.5,nightLength:0.5 },(result) => {
+   console.log(result);
+});
+```
+
+***
+
+### resetWeatherAndTime()
+
+> **resetWeatherAndTime**(`callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+场景天气和时间重置
+默认值：`syncSystemTime=false`。
+
+#### 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.WeatherSystem.resetWeatherAndTime({ (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### changeSeason()
+
+> **changeSeason**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+切换场景季节状态。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherChangeSeasonRequest`](../../types/interfaces/WeatherChangeSeasonRequest.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.WeatherSystem.changeSeason({ season: dtcEngine.Enums.Season.Summer, duration: 5 }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### resetSeason()
+
+> **resetSeason**(`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
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.WeatherSystem.resetSeason((result) => {
+   console.log(result);
+ });
+```
+
+***
+
+### setDayAndNight()
+
+> **setDayAndNight**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+在白天与夜晚模式之间切换。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherSetDayAndNightRequest`](../../types/interfaces/WeatherSetDayAndNightRequest.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.WeatherSystem.setDayAndNight({ dayType: 'night' }, (result) => {
+  console.log(result);
+});
+```
+
+***
+
+### openCameraFog()
+
+> **openCameraFog**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+开启并调整相机镜头雾效。
+默认值：未填的数值字段统一按 `-1` 下发（沿用 sdk2 语义）。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`WeatherOpenCameraFogRequest`](../../types/interfaces/WeatherOpenCameraFogRequest.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.WeatherSystem.openCameraFog(
+  { fogStartDistance: 20, fogEndDistance: 1500, fogIntensity: 0.5 },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### closeCameraFog()
+
+> **closeCameraFog**(`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
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.WeatherSystem.closeCameraFog((result) => { console.log(result); });
+```

package/docs/api/api/functions/createApiFacade.md

@@ -0,0 +1,20 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / createApiFacade
+
+# Function: createApiFacade()
+
+> **createApiFacade**(`context`, `registry?`): [`ApiFacade`](../type-aliases/ApiFacade.md)
+
+依据注册表批量创建 API 门面实例。
+
+在任何模块实例对外暴露前，先校验上下文和完整注册表。
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `context` | [`ApiRegistryContext`](../interfaces/ApiRegistryContext.md) | `undefined` |
+| `registry` | [`ApiRegistry`](../type-aliases/ApiRegistry.md) | `apiRegistry` |
+
+## Returns
+
+[`ApiFacade`](../type-aliases/ApiFacade.md)

package/docs/api/api/index.md

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../index.md) / api
+
+# api
+
+## Classes
+
+- [Animation](classes/Animation.md)
+- [Camera](classes/Camera.md)
+- [Connect](classes/Connect.md)
+- [Dlss](classes/Dlss.md)
+- [HighLighterEffect](classes/HighLighterEffect.md)
+- [Layer](classes/Layer.md)
+- [Model](classes/Model.md)
+- [ModelPOI](classes/ModelPOI.md)
+- [ModelTransform](classes/ModelTransform.md)
+- [PathPatrol](classes/PathPatrol.md)
+- [Popup](classes/Popup.md)
+- [Scene](classes/Scene.md)
+- [Screen](classes/Screen.md)
+- [TimeLine](classes/TimeLine.md)
+- [UIPOI](classes/UIPOI.md)
+- [WeatherSystem](classes/WeatherSystem.md)
+- [ApiRegistryError](classes/ApiRegistryError.md)
+
+## Interfaces
+
+- [ApiRegistryContext](interfaces/ApiRegistryContext.md)
+- [ApiInstanceMap](interfaces/ApiInstanceMap.md)
+
+## Type Aliases
+
+- [ApiModuleKey](type-aliases/ApiModuleKey.md)
+- [ApiModuleFactory](type-aliases/ApiModuleFactory.md)
+- [ApiRegistry](type-aliases/ApiRegistry.md)
+- [ApiFacade](type-aliases/ApiFacade.md)
+
+## Variables
+
+- [apiRegistry](variables/apiRegistry.md)
+- [API\_MODULE\_KEYS](variables/API_MODULE_KEYS.md)
+- [PendingValidationSchemaMap](variables/PendingValidationSchemaMap.md)
+
+## Functions
+
+- [createApiFacade](functions/createApiFacade.md)