@nnepoch/dtc-sdk 3.0.0

package/docs/api/application/DTCEngine/classes/DTCEngine.md

@@ -0,0 +1,738 @@
+[@nnepoch/dtc-sdk](../../../index.md) / [application/DTCEngine](../index.md) / DTCEngine
+
+# Class: DTCEngine
+
+SDK 入口类，负责装配 API 模块、鉴权工作流与会话生命周期。
+
+## Constructors
+
+### Constructor
+
+> **new DTCEngine**(`config`, `options?`): `DTCEngine`
+
+创建 SDK 门面并立即触发鉴权启动流程。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | [`EngineConfig`](../../../types/interfaces/EngineConfig.md) |
+| `options?` | [`DTCEngineOptions`](../interfaces/DTCEngineOptions.md) |
+
+#### Returns
+
+`DTCEngine`
+
+## Properties
+
+### Events
+
+> `readonly` **Events**: `object`
+
+应用侧可订阅的事件常量集合。
+
+#### WebRtcConnected
+
+> `readonly` **WebRtcConnected**: `"webRtcConnected"` = `'webRtcConnected'`
+
+WebRTC 连接成功（sdk3 原始命名）
+
+#### WebOnConnect
+
+> `readonly` **WebOnConnect**: `"webRtcConnected"` = `'webRtcConnected'`
+
+WebRTC 连接成功（sdk2 兼容命名）
+
+#### MapLoaded
+
+> `readonly` **MapLoaded**: `"OnApiDataChannelStarted"` = `'OnApiDataChannelStarted'`
+
+地图加载完成
+
+#### WebRtcDisconnected
+
+> `readonly` **WebRtcDisconnected**: `"webRtcDisconnected"` = `'webRtcDisconnected'`
+
+WebRTC 连接断开（sdk3 原始命名）
+
+#### WebOnDisconnect
+
+> `readonly` **WebOnDisconnect**: `"webRtcDisconnected"` = `'webRtcDisconnected'`
+
+WebRTC 连接断开（sdk2 兼容命名）
+
+#### DataChannelDisconnet
+
+> `readonly` **DataChannelDisconnet**: `"webRtcDisconnected"` = `'webRtcDisconnected'`
+
+#### WebRtcConnecting
+
+> `readonly` **WebRtcConnecting**: `"webRtcConnecting"` = `'webRtcConnecting'`
+
+WebRTC 正在连接中
+
+#### WebRtcFailed
+
+> `readonly` **WebRtcFailed**: `"webRtcFailed"` = `'webRtcFailed'`
+
+WebRTC 连接失败
+
+#### StatsReceived
+
+> `readonly` **StatsReceived**: `"statsReceived"` = `'statsReceived'`
+
+收到底层 WebRTC 统计信息
+
+#### EngineStatus
+
+> `readonly` **EngineStatus**: `"EngineStatus"` = `'EngineStatus'`
+
+引擎状态聚合事件
+
+#### StreamLoading
+
+> `readonly` **StreamLoading**: `"streamLoading"` = `'streamLoading'`
+
+媒体流加载进度事件
+
+#### LoadingProgress
+
+> `readonly` **LoadingProgress**: `"LoadingProgress"` = `'LoadingProgress'`
+
+SDK 加载提示事件
+
+#### CenterConnected
+
+> `readonly` **CenterConnected**: `"Connect"` = `'Connect'`
+
+中心连接成功（sdk2 兼容命名）
+
+#### CenterDisconnected
+
+> `readonly` **CenterDisconnected**: `"UnConnect"` = `'UnConnect'`
+
+中心连接断开（sdk2 兼容命名）
+
+#### ConnectResult
+
+> `readonly` **ConnectResult**: `"ConnectResult"` = `'ConnectResult'`
+
+中心返回连接结果
+
+#### CenterCloseMessage
+
+> `readonly` **CenterCloseMessage**: `"CenterCloseMessage"` = `'CenterCloseMessage'`
+
+中心主动关闭会话通知
+
+#### TokenAuthorize
+
+> `readonly` **TokenAuthorize**: `"TokenAuthorize"` = `'TokenAuthorize'`
+
+Token 鉴权结果通知
+
+#### EngineServiceInit
+
+> `readonly` **EngineServiceInit**: `"EngineServiceInit"` = `'EngineServiceInit'`
+
+引擎服务初始化结果通知
+
+#### EngineServiceInitWait
+
+> `readonly` **EngineServiceInitWait**: `"EngineServiceInitWait"` = `'EngineServiceInitWait'`
+
+引擎服务处于排队等待状态
+
+#### EngineSocketClose
+
+> `readonly` **EngineSocketClose**: `"EngineSocketClose"` = `'EngineSocketClose'`
+
+引擎侧 socket 断开通知
+
+#### TokenWillExpired
+
+> `readonly` **TokenWillExpired**: `"TokenWillExpired"` = `'TokenWillExpired'`
+
+Token 即将过期通知
+
+#### AuthStateChanged
+
+> `readonly` **AuthStateChanged**: `"authStateChanged"` = `'authStateChanged'`
+
+鉴权状态变化总线事件
+
+#### AuthConnecting
+
+> `readonly` **AuthConnecting**: `"authConnecting"` = `'authConnecting'`
+
+鉴权流程：连接中心中
+
+#### AuthWaiting
+
+> `readonly` **AuthWaiting**: `"authWaiting"` = `'authWaiting'`
+
+鉴权流程：资源等待中
+
+#### AuthAuthorizing
+
+> `readonly` **AuthAuthorizing**: `"authAuthorizing"` = `'authAuthorizing'`
+
+鉴权流程：令牌校验中
+
+#### AuthConnected
+
+> `readonly` **AuthConnected**: `"authConnected"` = `'authConnected'`
+
+鉴权流程：已连接完成
+
+#### AuthFailed
+
+> `readonly` **AuthFailed**: `"authFailed"` = `'authFailed'`
+
+鉴权流程：失败
+
+#### SessionModeReady
+
+> `readonly` **SessionModeReady**: `"sessionModeReady"` = `'sessionModeReady'`
+
+会话模式就绪事件
+
+#### SessionModeFailed
+
+> `readonly` **SessionModeFailed**: `"sessionModeFailed"` = `'sessionModeFailed'`
+
+会话模式失败事件
+
+#### SceneConfig
+
+> `readonly` **SceneConfig**: `"SceneConfig"` = `'SceneConfig'`
+
+场景信息
+
+#### ModelClick
+
+> `readonly` **ModelClick**: `"ModelClick"` = `'ModelClick'`
+
+模型点击事件
+
+#### CameraHeight
+
+> `readonly` **CameraHeight**: `"CameraHeight"` = `'CameraHeight'`
+
+相机高度
+
+#### LeftClick
+
+> `readonly` **LeftClick**: `"MouseLeftButtonClick"` = `'MouseLeftButtonClick'`
+
+左键单击事件
+
+#### LeftDoubleClick
+
+> `readonly` **LeftDoubleClick**: `"MouseLeftButtonDoubleClick"` = `'MouseLeftButtonDoubleClick'`
+
+左键双击事件
+
+#### LeftLongPressed
+
+> `readonly` **LeftLongPressed**: `"MouseLeftButtonLongPressed"` = `'MouseLeftButtonLongPressed'`
+
+左键长按事件
+
+#### RightClick
+
+> `readonly` **RightClick**: `"MouseRightButtonClick"` = `'MouseRightButtonClick'`
+
+右键单击事件
+
+#### RightDoubleClick
+
+> `readonly` **RightDoubleClick**: `"MouseRightButtonDoubleClick"` = `'MouseRightButtonDoubleClick'`
+
+右键双击事件
+
+#### RightLongPressed
+
+> `readonly` **RightLongPressed**: `"MouseRightButtonLongPressed"` = `'MouseRightButtonLongPressed'`
+
+右键长按事件
+
+#### ModelTrigger
+
+> `readonly` **ModelTrigger**: `"ModelTrigger"` = `'ModelTrigger'`
+
+模型触发事件
+
+#### SyncPops
+
+> `readonly` **SyncPops**: `"SyncPops"` = `'SyncPops'`
+
+前端气泡同步事件
+
+#### NetworkLevelChanged
+
+> `readonly` **NetworkLevelChanged**: `"networkLevelChanged"` = `'networkLevelChanged'`
+
+弱网档位状态变化事件
+
+#### NetworkActionExecuted
+
+> `readonly` **NetworkActionExecuted**: `"networkActionExecuted"` = `'networkActionExecuted'`
+
+弱网策略动作执行结果事件
+
+#### NetworkModeChanged
+
+> `readonly` **NetworkModeChanged**: `"networkModeChanged"` = `'networkModeChanged'`
+
+弱网模式变化事件（Auto / Manual）
+
+#### NetworkDiagnosticsVisibilityChanged
+
+> `readonly` **NetworkDiagnosticsVisibilityChanged**: `"networkDiagnosticsVisibilityChanged"` = `'networkDiagnosticsVisibilityChanged'`
+
+弱网诊断面板可见性变化事件
+
+#### NetworkDiagnosticsUpdated
+
+> `readonly` **NetworkDiagnosticsUpdated**: `"networkDiagnosticsUpdated"` = `'networkDiagnosticsUpdated'`
+
+弱网诊断快照更新事件
+
+***
+
+### Enums
+
+> `readonly` **Enums**: `object`
+
+#### DlssQuality
+
+> **DlssQuality**: `object`
+
+##### DlssQuality.Off
+
+> `readonly` **Off**: `0` = `0`
+
+关闭 DLSS。默认值。
+
+##### DlssQuality.Auto
+
+> `readonly` **Auto**: `1` = `1`
+
+Auto 模式会根据系统性能自动选择最合适的 DLSS 质量档位，提供更智能的画质与性能平衡方案。
+
+##### DlssQuality.DLAA
+
+> `readonly` **DLAA**: `2` = `2`
+
+2倍效果
+
+##### DlssQuality.UltraQuality
+
+> `readonly` **UltraQuality**: `3` = `3`
+
+超高质量。
+
+##### DlssQuality.Quality
+
+> `readonly` **Quality**: `4` = `4`
+
+高质量。
+
+##### DlssQuality.Balanced
+
+> `readonly` **Balanced**: `5` = `5`
+
+平衡。
+
+##### DlssQuality.Performance
+
+> `readonly` **Performance**: `6` = `6`
+
+性能。
+
+##### DlssQuality.UltraPerformance
+
+> `readonly` **UltraPerformance**: `7` = `7`
+
+超高性能。
+
+#### LayerEnum
+
+> **LayerEnum**: *typeof* [`LayerEnum`](../../../types/enumerations/LayerEnum.md)
+
+#### ModelTransformType
+
+> **ModelTransformType**: *typeof* [`ModelTransformType`](../../../types/enumerations/ModelTransformType.md)
+
+#### ScreenRenderBitratePreset
+
+> **ScreenRenderBitratePreset**: `object`
+
+##### ScreenRenderBitratePreset.Auto
+
+> `readonly` **Auto**: `"auto"` = `'auto'`
+
+自动。
+
+##### ScreenRenderBitratePreset.Low
+
+> `readonly` **Low**: `"low"` = `'low'`
+
+标清。
+
+##### ScreenRenderBitratePreset.High
+
+> `readonly` **High**: `"high"` = `'high'`
+
+高清。
+
+##### ScreenRenderBitratePreset.Super
+
+> `readonly` **Super**: `"super"` = `'super'`
+
+超清。
+
+##### ScreenRenderBitratePreset.Blue
+
+> `readonly` **Blue**: `"blue"` = `'blue'`
+
+蓝光。
+
+#### Season
+
+> **Season**: `object`
+
+##### Season.Spring
+
+> `readonly` **Spring**: `0` = `0`
+
+春季。
+
+##### Season.Summer
+
+> `readonly` **Summer**: `1` = `1`
+
+夏季。
+
+##### Season.Autumn
+
+> `readonly` **Autumn**: `2` = `2`
+
+秋季。
+
+##### Season.Winter
+
+> `readonly` **Winter**: `3` = `3`
+
+冬季。
+
+#### VideoCodeType
+
+> **VideoCodeType**: *typeof* [`VideoCodeType`](../../../types/enumerations/VideoCodeType.md)
+
+***
+
+### Connect
+
+> `readonly` **Connect**: [`Connect`](../../../api/classes/Connect.md)
+
+连接控制模块。
+
+***
+
+### Type
+
+> `readonly` **Type**: `Type`
+
+SDK 支持的数据类型构造器。
+
+***
+
+### Screen
+
+> `readonly` **Screen**: [`Screen`](../../../api/classes/Screen.md)
+
+画面质量控制模块。
+
+***
+
+### Dlss
+
+> `readonly` **Dlss**: [`Dlss`](../../../api/classes/Dlss.md)
+
+DLSS 控制模块。
+
+***
+
+### Camera
+
+> `readonly` **Camera**: [`Camera`](../../../api/classes/Camera.md)
+
+相机控制模块。
+
+***
+
+### Scene
+
+> `readonly` **Scene**: [`Scene`](../../../api/classes/Scene.md)
+
+场景控制模块。
+
+***
+
+### Layer
+
+> `readonly` **Layer**: [`Layer`](../../../api/classes/Layer.md)
+
+图层控制模块。
+
+***
+
+### Model
+
+> `readonly` **Model**: [`Model`](../../../api/classes/Model.md)
+
+模型控制模块。
+
+***
+
+### UIPOI
+
+> `readonly` **UIPOI**: [`UIPOI`](../../../api/classes/UIPOI.md)
+
+UI 气泡模块。
+
+***
+
+### ModelPOI
+
+> `readonly` **ModelPOI**: [`ModelPOI`](../../../api/classes/ModelPOI.md)
+
+模型气泡模块。
+
+***
+
+### ModelTransform
+
+> `readonly` **ModelTransform**: [`ModelTransform`](../../../api/classes/ModelTransform.md)
+
+模型变换模块。
+
+***
+
+### PathPatrol
+
+> `readonly` **PathPatrol**: [`PathPatrol`](../../../api/classes/PathPatrol.md)
+
+路径巡逻模块。
+
+***
+
+### HighlighterEffect
+
+> `readonly` **HighlighterEffect**: [`HighLighterEffect`](../../../api/classes/HighLighterEffect.md)
+
+高亮效果模块。
+
+***
+
+### Popup
+
+> `readonly` **Popup**: [`Popup`](../../../api/classes/Popup.md)
+
+前端 Popup 模块。
+
+***
+
+### popupManager
+
+> `readonly` **popupManager**: `PopupManager`
+
+前端 Popup 管理器（气泡 DOM 挂载与定位）。
+
+***
+
+### Animation
+
+> `readonly` **Animation**: [`Animation`](../../../api/classes/Animation.md)
+
+动画控制模块。
+
+***
+
+### TimeLine
+
+> `readonly` **TimeLine**: [`TimeLine`](../../../api/classes/TimeLine.md)
+
+时间线模块。
+
+***
+
+### WeatherSystem
+
+> `readonly` **WeatherSystem**: [`WeatherSystem`](../../../api/classes/WeatherSystem.md)
+
+天气系统模块。
+
+## Methods
+
+### on()
+
+> **on**\<`K`\>(`event`, `listener`): `void`
+
+订阅 SDK 运行时事件。
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `K` *extends* keyof `EngineEventMap` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `K` |
+| `listener` | (`payload`) => `void` |
+
+#### Returns
+
+`void`
+
+***
+
+### off()
+
+> **off**\<`K`\>(`event`, `listener`): `void`
+
+取消订阅 SDK 运行时事件。
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `K` *extends* keyof `EngineEventMap` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `K` |
+| `listener` | (`payload`) => `void` |
+
+#### Returns
+
+`void`
+
+***
+
+### whenReady()
+
+> **whenReady**(): `Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+获取启动阶段最终快照结果。
+
+#### Returns
+
+`Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+***
+
+### setNetworkAdaptationMode()
+
+> **setNetworkAdaptationMode**(`mode`): `void`
+
+显式切换弱网策略模式（auto/manual）。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mode` | [`NetworkAdaptationMode`](../../../types/type-aliases/NetworkAdaptationMode.md) |
+
+#### Returns
+
+`void`
+
+***
+
+### setNetworkManualLevel()
+
+> **setNetworkManualLevel**(`level`): `void`
+
+手动模式下指定弱网档位。
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `level` | `"Normal"` \| `"Mild"` \| `"Moderate"` \| `"Severe"` |
+
+#### Returns
+
+`void`
+
+***
+
+### getNetworkDiagnosticsSnapshot()
+
+> **getNetworkDiagnosticsSnapshot**(): [`NetworkDiagnosticsSnapshot`](../../../types/interfaces/NetworkDiagnosticsSnapshot.md)
+
+获取当前弱网诊断快照。
+
+#### Returns
+
+[`NetworkDiagnosticsSnapshot`](../../../types/interfaces/NetworkDiagnosticsSnapshot.md)
+
+***
+
+### disconnect()
+
+> **disconnect**(): `void`
+
+关闭中心与会话连接，并重置鉴权状态。
+
+#### Returns
+
+`void`
+
+***
+
+### connect()
+
+> **connect**(): `Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+在显式 disconnect 后重新连接中心与 WebRTC 链路。
+
+#### Returns
+
+`Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+***
+
+### restart()
+
+> **restart**(): `Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+重启中心与 WebRTC 链路：
+1) 断开当前中心与 WebRTC；
+2) 等待旧鉴权流程稳定退出；
+3) 重新发起鉴权与建连。
+
+#### Returns
+
+`Promise`\<[`AuthSessionSnapshot`](../../../types/interfaces/AuthSessionSnapshot.md)\>
+
+***
+
+### getEngineConfig()
+
+> **getEngineConfig**(): [`ResolvedEngineConfig`](../../../types/interfaces/ResolvedEngineConfig.md)
+
+获取归一化后的引擎配置。
+返回的是 `resolveEngineConfig` 的结果，`dom`、`sceneName` 等字段已保证有值。
+
+#### Returns
+
+[`ResolvedEngineConfig`](../../../types/interfaces/ResolvedEngineConfig.md)