@nnepoch/dtc-sdk 3.0.0

package/docs/api/types/interfaces/NetworkMetricsSnapshot.md

@@ -0,0 +1,59 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NetworkMetricsSnapshot
+
+# Interface: NetworkMetricsSnapshot
+
+媒体链路实时指标快照。
+
+## Properties
+
+### ts
+
+> **ts**: `number`
+
+***
+
+### connected
+
+> **connected**: `boolean`
+
+***
+
+### fps?
+
+> `optional` **fps**: `number`
+
+***
+
+### bitrateKbps?
+
+> `optional` **bitrateKbps**: `number`
+
+***
+
+### packetLossRate?
+
+> `optional` **packetLossRate**: `number`
+
+***
+
+### jitterMs?
+
+> `optional` **jitterMs**: `number`
+
+***
+
+### rttMs?
+
+> `optional` **rttMs**: `number`
+
+***
+
+### frameWidth?
+
+> `optional` **frameWidth**: `number`
+
+***
+
+### frameHeight?
+
+> `optional` **frameHeight**: `number`

package/docs/api/types/interfaces/PathPatrolAddRequest.md

@@ -0,0 +1,109 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PathPatrolAddRequest
+
+# Interface: PathPatrolAddRequest
+
+PathPatrol.add 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型对象父对象编号。
+
+***
+
+### id
+
+> **id**: `string`
+
+场景的模型对象编号。
+
+***
+
+### assetPath?
+
+> `optional` **assetPath**: `string`
+
+场景的模型路径，可为空；为空时根据 id 到场景中寻找模型对象。
+
+***
+
+### scale
+
+> **scale**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+模型缩放的大小。
+
+***
+
+### showPath?
+
+> `optional` **showPath**: `boolean`
+
+是否显示巡逻轨迹，默认 `true`。
+
+***
+
+### passedColor?
+
+> `optional` **passedColor**: `string`
+
+巡逻过的路径的显示颜色，默认 `#ffffff`。
+
+***
+
+### lineColor?
+
+> `optional` **lineColor**: `string`
+
+未巡逻路径的颜色，默认 `#00ff00`。
+
+***
+
+### lineWidth
+
+> **lineWidth**: `number`
+
+线路的宽度。
+
+***
+
+### duration?
+
+> `optional` **duration**: `number`
+
+全程所需时间。
+
+***
+
+### nodes?
+
+> `optional` **nodes**: [`Vector3Input`](../type-aliases/Vector3Input.md)[]
+
+路径点的集合，至少需要 2 个节点。
+
+***
+
+### timeNodes?
+
+> `optional` **timeNodes**: [`TimeSerialNode`](TimeSerialNode.md)[]
+
+路径点时间序列的集合。
+
+***
+
+### lineLayer?
+
+> `optional` **lineLayer**: `string`
+
+线的图层，如 TransparentFX。
+
+***
+
+### afterRender?
+
+> `optional` **afterRender**: `boolean`
+
+是否后渲染，默认 `false`；`true` 后渲染（渲染不会阻挡），`false` 前渲染。

package/docs/api/types/interfaces/PathPatrolNodeRequest.md

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PathPatrolNodeRequest
+
+# Interface: PathPatrolNodeRequest
+
+PathPatrol.pause / resume / stop 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型对象父对象编号。
+
+***
+
+### id
+
+> **id**: `string`
+
+巡逻对象编号。

package/docs/api/types/interfaces/PathPatrolSetTimeNodeRequest.md

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PathPatrolSetTimeNodeRequest
+
+# Interface: PathPatrolSetTimeNodeRequest
+
+PathPatrol.setTimeNode 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型对象父对象编号。
+
+***
+
+### id
+
+> **id**: `string`
+
+巡逻对象编号。
+
+***
+
+### timeStart?
+
+> `optional` **timeStart**: `string`
+
+时间节点，格式为 "2025-09-10 00:05:00"。`timeStart` 与 `startNodeIndex` 只能有一个不为空。
+
+***
+
+### startNodeIndex?
+
+> `optional` **startNodeIndex**: `string`
+
+开始节点索引，不能小于 0。`timeStart` 与 `startNodeIndex` 只能有一个不为空。

package/docs/api/types/interfaces/PathPatrolUpdateRequest.md

@@ -0,0 +1,53 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PathPatrolUpdateRequest
+
+# Interface: PathPatrolUpdateRequest
+
+PathPatrol.update 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型对象父对象编号。
+
+***
+
+### id
+
+> **id**: `string`
+
+巡逻轨迹编号。
+
+***
+
+### lineColor?
+
+> `optional` **lineColor**: `string`
+
+巡逻轨迹的颜色。
+
+***
+
+### lineWidth?
+
+> `optional` **lineWidth**: `number`
+
+巡逻路线的宽度。
+
+***
+
+### passedColor?
+
+> `optional` **passedColor**: `string`
+
+巡逻过的路径的显示颜色。
+
+***
+
+### speed?
+
+> `optional` **speed**: `number`
+
+调整速度，不能小于 0。

package/docs/api/types/interfaces/PopupAddRequest.md

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupAddRequest
+
+# Interface: PopupAddRequest
+
+Popup.addPop 参数。
+
+## Properties
+
+### groupName?
+
+> `optional` **groupName**: `string`
+
+分组名称。
+
+***
+
+### popInfo?
+
+> `optional` **popInfo**: [`PopupItemRequest`](PopupItemRequest.md)[]
+
+气泡配置列表。

package/docs/api/types/interfaces/PopupDelayRequest.md

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupDelayRequest
+
+# Interface: PopupDelayRequest
+
+Popup.setPopDelayFrame 参数。
+
+## Properties
+
+### time
+
+> **time**: `number`
+
+延迟时间。

package/docs/api/types/interfaces/PopupItemRequest.md

@@ -0,0 +1,61 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupItemRequest
+
+# Interface: PopupItemRequest
+
+Popup.addPop 单项配置。
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+气泡 ID。
+
+***
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+父节点 ID。
+
+***
+
+### div
+
+> **div**: `HTMLDivElement`
+
+气泡 div 内容。
+
+***
+
+### visible?
+
+> `optional` **visible**: `boolean`
+
+是否可见。
+
+***
+
+### position?
+
+> `optional` **position**: `Vector3`
+
+显示位置。
+
+***
+
+### offSetX?
+
+> `optional` **offSetX**: `number`
+
+X 方向偏移。
+
+***
+
+### offSetY?
+
+> `optional` **offSetY**: `number`
+
+Y 方向偏移。

package/docs/api/types/interfaces/PopupRemoveRequest.md

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupRemoveRequest
+
+# Interface: PopupRemoveRequest
+
+Popup.removePop 参数。
+
+## Properties
+
+### groupName?
+
+> `optional` **groupName**: `string`
+
+分组名称。
+
+***
+
+### ids?
+
+> `optional` **ids**: `string`[]
+
+待删除气泡 ID 列表。

package/docs/api/types/interfaces/PopupShowDistanceRequest.md

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupShowDistanceRequest
+
+# Interface: PopupShowDistanceRequest
+
+Popup.setPopShowDistance 参数。
+
+## Properties
+
+### distance
+
+> **distance**: `number`
+
+最远显示距离。

package/docs/api/types/interfaces/PopupShowRequest.md

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupShowRequest
+
+# Interface: PopupShowRequest
+
+Popup.show 参数。
+
+## Properties
+
+### groupName?
+
+> `optional` **groupName**: `string`
+
+分组名称。
+
+***
+
+### ids?
+
+> `optional` **ids**: `string`[]
+
+气泡 ID 列表。
+
+***
+
+### show?
+
+> `optional` **show**: `boolean`
+
+是否显示。

package/docs/api/types/interfaces/PopupSyncInfoRequest.md

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PopupSyncInfoRequest
+
+# Interface: PopupSyncInfoRequest
+
+Popup 同步信息（引擎侧 SyncPops 推送 / 前端需同步的气泡条目）。
+
+## Properties
+
+### groupName
+
+> **groupName**: `string`
+
+分组名称。
+
+***
+
+### id
+
+> **id**: `string`
+
+气泡 ID。
+
+***
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+父节点 ID。
+
+***
+
+### position?
+
+> `optional` **position**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+显示位置。

package/docs/api/types/interfaces/QosEvent.md

@@ -0,0 +1,65 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosEvent
+
+# Interface: QosEvent
+
+QoS 事件结构。
+
+## Properties
+
+### eventName
+
+> **eventName**: `"session_start"` \| `"auth_start"` \| `"auth_success"` \| `"auth_failed"` \| `"center_connect_start"` \| `"center_connected"` \| `"center_disconnected"` \| `"center_message_received"` \| `"webrtc_connect_start"` \| `"webrtc_connected"` \| `"webrtc_disconnected"` \| `"first_frame_rendered"` \| `"media_stats_sample"` \| `"ue_request_sent"` \| `"ue_response_received"` \| `"session_end"`
+
+***
+
+### stage
+
+> **stage**: [`QosStage`](../type-aliases/QosStage.md)
+
+***
+
+### status
+
+> **status**: [`QosStatus`](../type-aliases/QosStatus.md)
+
+***
+
+### ts
+
+> **ts**: `number`
+
+***
+
+### level
+
+> **level**: [`QosLevel`](../type-aliases/QosLevel.md)
+
+***
+
+### durationMs?
+
+> `optional` **durationMs**: `number`
+
+***
+
+### errorCode?
+
+> `optional` **errorCode**: `string`
+
+***
+
+### errorMessage?
+
+> `optional` **errorMessage**: `string`
+
+***
+
+### attrs?
+
+> `optional` **attrs**: `Record`\<`string`, `unknown`\>
+
+***
+
+### metrics?
+
+> `optional` **metrics**: `Record`\<`string`, `unknown`\>

package/docs/api/types/interfaces/QosReportingPayload.md

@@ -0,0 +1,47 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosReportingPayload
+
+# Interface: QosReportingPayload
+
+QoS 批量上报载荷。
+
+## Properties
+
+### schemaVersion
+
+> **schemaVersion**: `"1.0.0"`
+
+***
+
+### source
+
+> **source**: `"enginesdk3"`
+
+***
+
+### sdkVersion
+
+> **sdkVersion**: `string`
+
+***
+
+### sentAt
+
+> **sentAt**: `number`
+
+***
+
+### session
+
+> **session**: [`QosSessionContext`](QosSessionContext.md)
+
+***
+
+### context
+
+> **context**: [`QosRuntimeContext`](QosRuntimeContext.md)
+
+***
+
+### events
+
+> **events**: [`QosEvent`](QosEvent.md)[]

package/docs/api/types/interfaces/QosRuntimeContext.md

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosRuntimeContext
+
+# Interface: QosRuntimeContext
+
+运行环境上下文。
+
+## Properties
+
+### appId?
+
+> `optional` **appId**: `string`
+
+***
+
+### env?
+
+> `optional` **env**: `string`
+
+***
+
+### pageUrl?
+
+> `optional` **pageUrl**: `string`
+
+***
+
+### userAgent?
+
+> `optional` **userAgent**: `string`

package/docs/api/types/interfaces/QosSessionContext.md

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosSessionContext
+
+# Interface: QosSessionContext
+
+会话维度上下文。
+
+## Properties
+
+### sessionId
+
+> **sessionId**: `string`
+
+***
+
+### traceId
+
+> **traceId**: `string`
+
+***
+
+### runMode
+
+> **runMode**: `string`
+
+***
+
+### viewMode
+
+> **viewMode**: `string`

package/docs/api/types/interfaces/QosWarnErrorSummary.md

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosWarnErrorSummary
+
+# Interface: QosWarnErrorSummary
+
+warn/error 聚合统计指标。
+
+## Properties
+
+### logWarnCount
+
+> **logWarnCount**: `number`
+
+***
+
+### logErrorCount
+
+> **logErrorCount**: `number`
+
+***
+
+### logErrorByStage
+
+> **logErrorByStage**: `Partial`\<`Record`\<[`QosStage`](../type-aliases/QosStage.md), `number`\>\>
+
+***
+
+### logErrorTopCodes
+
+> **logErrorTopCodes**: `object`[]
+
+#### code
+
+> **code**: `string`
+
+#### count
+
+> **count**: `number`