@nnepoch/dtc-sdk 3.0.10 → 3.0.12

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

@@ -0,0 +1,149 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorAddRequest
+
+# Interface: PointEditorAddRequest
+
+模型点位创建参数；不传 position/screenPosition 时 addPoint 等待一次网页点击。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+场景分组 ID；可使用既有 MQTT 加载的分组，不要求 SDK 新建分组。
+
+***
+
+### id
+
+> **id**: `string`
+
+点位全局标识，对应后端 globalId，不是数据库主键。
+
+***
+
+### type
+
+> **type**: `"MODEL"`
+
+本期只支持 MODEL，不支持独立 POI。
+
+***
+
+### code?
+
+> `optional` **code?**: `string`
+
+业务编码，不用于替代 id。
+
+***
+
+### name?
+
+> `optional` **name?**: `string`
+
+点位显示名称。
+
+***
+
+### position?
+
+> `optional` **position?**: [`PointEditorVector`](PointEditorVector.md)
+
+已知的经纬高位置；与 screenPosition 二选一。
+
+***
+
+### screenPosition?
+
+> `optional` **screenPosition?**: [`PointEditorScreenPosition`](PointEditorScreenPosition.md)
+
+drop 时记录的视频图像坐标；addPointByDrag 未传 position 时必填。
+
+***
+
+### rotation?
+
+> `optional` **rotation?**: [`PointEditorVector`](PointEditorVector.md)
+
+旋转（度）；与既有 payload 约定一致：X=Roll、Y=Pitch、Z=Yaw。
+
+***
+
+### scale?
+
+> `optional` **scale?**: [`PointEditorVector`](PointEditorVector.md)
+
+模型缩放，默认 (1, 1, 1)。
+
+***
+
+### show?
+
+> `optional` **show?**: `boolean`
+
+模型是否显示，默认 true。
+
+***
+
+### poiEnabled?
+
+> `optional` **poiEnabled?**: `boolean`
+
+附属 POI 是否显示，默认 true。
+
+***
+
+### poiOffsetY?
+
+> `optional` **poiOffsetY?**: `number`
+
+附属 POI 向上偏移（米），默认 0。
+
+***
+
+### poiScaleFactor?
+
+> `optional` **poiScaleFactor?**: `number`
+
+附属 POI 等比缩放，默认 1；允许 0。
+
+***
+
+### poiShowName?
+
+> `optional` **poiShowName?**: `boolean`
+
+附属 POI 是否显示名称，默认 true。
+
+***
+
+### extraProps?
+
+> `optional` **extraProps?**: `Record`\<`string`, `unknown`\>
+
+JSON 对象形式的业务属性，默认 {}；更新时整体替换此字段。
+
+***
+
+### lookAt?
+
+> `optional` **lookAt?**: `string`
+
+视角配置字符串，空字符串可清空。
+
+***
+
+### resource
+
+> **resource**: [`PointEditorResource`](PointEditorResource.md)
+
+模型及可选附属 POI 的资源。
+
+***
+
+### category?
+
+> `optional` **category?**: [`PointEditorCategory`](PointEditorCategory.md)
+
+业务分类。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorCategory
+
+# Interface: PointEditorCategory
+
+点位分类，保留业务目录的分类标识和名称。
+
+## Properties
+
+### code?
+
+> `optional` **code?**: `string`
+
+分类业务编码，沿用 sdk2 的 code 字段。
+
+***
+
+### name?
+
+> `optional` **name?**: `string`
+
+分类名称。
+
+***
+
+### type?
+
+> `optional` **type?**: `string`
+
+分类类型，沿用现有资源目录的 type。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorClientPosition
+
+# Interface: PointEditorClientPosition
+
+drop 当时的浏览器视口坐标，不是页面滚动坐标。
+
+## Properties
+
+### clientX
+
+> **clientX**: `number`
+
+浏览器事件 clientX。
+
+***
+
+### clientY
+
+> **clientY**: `number`
+
+浏览器事件 clientY。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorDeleteRequest
+
+# Interface: PointEditorDeleteRequest
+
+批量删除参数；先检查全部已存在目标的来源和类型，再执行删除。
+
+## Properties
+
+### parentId
+
+> **parentId**: `string`
+
+网页分组 ID。
+
+***
+
+### ids
+
+> **ids**: `string`[]
+
+待删除点位全局 ID 列表，不允许空数组或重复 ID。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorDeleteResult
+
+# Interface: PointEditorDeleteResult
+
+删除结果；不存在的 ID 进入 failedIds，不能视为全部成功。
+
+## Properties
+
+### deletedIds
+
+> **deletedIds**: `string`[]
+
+成功删除的点位 ID。
+
+***
+
+### failedIds
+
+> **failedIds**: `string`[]
+
+未找到或未成功删除的点位 ID。

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

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorResource
+
+# Interface: PointEditorResource
+
+UE 模型资源；由业务资源目录提供，不使用 Unity 资源路径。
+
+## Properties
+
+### type?
+
+> `optional` **type?**: `"MODEL"`
+
+资源类别，仅支持 MODEL。
+
+***
+
+### name?
+
+> `optional` **name?**: `string`
+
+资源名称。
+
+***
+
+### path
+
+> **path**: `string`
+
+可加载的 UE Actor 蓝图类路径。
+
+***
+
+### poiAsset?
+
+> `optional` **poiAsset?**: `string`
+
+模型附属 POI 的 UE Actor 蓝图路径；空字符串表示不创建图标。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorScreenPosition
+
+# Interface: PointEditorScreenPosition
+
+视频完整图像中的归一化位置，范围 [0,1]；需在实际 drop 时记录。
+
+## Properties
+
+### x
+
+> **x**: `number`
+
+图像从左到右的比例。
+
+***
+
+### y
+
+> **y**: `number`
+
+图像从上到下的比例。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / PointEditorVector
+
+# Interface: PointEditorVector
+
+点位向量；位置采用经纬高，旋转、缩放不做地理坐标转换。
+
+## Properties
+
+### x
+
+> **x**: `number`
+
+经度，或旋转/缩放的 X 分量。
+
+***
+
+### y
+
+> **y**: `number`
+
+纬度，或旋转/缩放的 Y 分量。
+
+***
+
+### z
+
+> **z**: `number`
+
+高度（米），或旋转/缩放的 Z 分量。

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

@@ -8,7 +8,7 @@ Popup.addPop 参数。
 
 ### groupName?
 
-> `optional` **groupName**: `string`
+> `optional` **groupName?**: `string`
 
 分组名称。
 
@@ -16,6 +16,6 @@ Popup.addPop 参数。
 
 ### popInfo?
 
-> `optional` **popInfo**: [`PopupItemRequest`](PopupItemRequest.md)[]
+> `optional` **popInfo?**: [`PopupItemRequest`](PopupItemRequest.md)[]
 
 气泡配置列表。

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

@@ -16,7 +16,7 @@ Popup.addPop 单项配置。
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -32,7 +32,7 @@ Popup.addPop 单项配置。
 
 ### visible?
 
-> `optional` **visible**: `boolean`
+> `optional` **visible?**: `boolean`
 
 是否可见。
 
@@ -40,7 +40,7 @@ Popup.addPop 单项配置。
 
 ### position?
 
-> `optional` **position**: `Vector3`
+> `optional` **position?**: `Vector3`
 
 显示位置。
 
@@ -48,7 +48,7 @@ Popup.addPop 单项配置。
 
 ### offSetX?
 
-> `optional` **offSetX**: `number`
+> `optional` **offSetX?**: `number`
 
 X 方向偏移。
 
@@ -56,6 +56,6 @@ X 方向偏移。
 
 ### offSetY?
 
-> `optional` **offSetY**: `number`
+> `optional` **offSetY?**: `number`
 
 Y 方向偏移。

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

@@ -8,7 +8,7 @@ Popup.removePop 参数。
 
 ### groupName?
 
-> `optional` **groupName**: `string`
+> `optional` **groupName?**: `string`
 
 分组名称。
 
@@ -16,6 +16,6 @@ Popup.removePop 参数。
 
 ### ids?
 
-> `optional` **ids**: `string`[]
+> `optional` **ids?**: `string`[]
 
 待删除气泡 ID 列表。

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

@@ -8,7 +8,7 @@ Popup.show 参数。
 
 ### groupName?
 
-> `optional` **groupName**: `string`
+> `optional` **groupName?**: `string`
 
 分组名称。
 
@@ -16,7 +16,7 @@ Popup.show 参数。
 
 ### ids?
 
-> `optional` **ids**: `string`[]
+> `optional` **ids?**: `string`[]
 
 气泡 ID 列表。
 
@@ -24,6 +24,6 @@ Popup.show 参数。
 
 ### show?
 
-> `optional` **show**: `boolean`
+> `optional` **show?**: `boolean`
 
 是否显示。

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

@@ -24,7 +24,7 @@ Popup 同步信息（引擎侧 SyncPops 推送 / 前端需同步的气泡条目
 
 ### parentId?
 
-> `optional` **parentId**: `string`
+> `optional` **parentId?**: `string`
 
 父节点 ID。
 
@@ -32,6 +32,6 @@ Popup 同步信息（引擎侧 SyncPops 推送 / 前端需同步的气泡条目
 
 ### position?
 
-> `optional` **position**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+> `optional` **position?**: [`Vector3Input`](../type-aliases/Vector3Input.md)
 
 显示位置。

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

@@ -38,28 +38,28 @@ QoS 事件结构。
 
 ### durationMs?
 
-> `optional` **durationMs**: `number`
+> `optional` **durationMs?**: `number`
 
 ***
 
 ### errorCode?
 
-> `optional` **errorCode**: `string`
+> `optional` **errorCode?**: `string`
 
 ***
 
 ### errorMessage?
 
-> `optional` **errorMessage**: `string`
+> `optional` **errorMessage?**: `string`
 
 ***
 
 ### attrs?
 
-> `optional` **attrs**: `Record`\<`string`, `unknown`\>
+> `optional` **attrs?**: `Record`\<`string`, `unknown`\>
 
 ***
 
 ### metrics?
 
-> `optional` **metrics**: `Record`\<`string`, `unknown`\>
+> `optional` **metrics?**: `Record`\<`string`, `unknown`\>

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

@@ -8,22 +8,22 @@
 
 ### appId?
 
-> `optional` **appId**: `string`
+> `optional` **appId?**: `string`
 
 ***
 
 ### env?
 
-> `optional` **env**: `string`
+> `optional` **env?**: `string`
 
 ***
 
 ### pageUrl?
 
-> `optional` **pageUrl**: `string`
+> `optional` **pageUrl?**: `string`
 
 ***
 
 ### userAgent?
 
-> `optional` **userAgent**: `string`
+> `optional` **userAgent?**: `string`

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

@@ -12,7 +12,7 @@
 
 ### signalingServer?
 
-> `optional` **signalingServer**: `string`
+> `optional` **signalingServer?**: `string`
 
 ***
 
@@ -54,19 +54,19 @@
 
 ### turnServer?
 
-> `optional` **turnServer**: `string`
+> `optional` **turnServer?**: `string`
 
 ***
 
 ### turnUser?
 
-> `optional` **turnUser**: `string`
+> `optional` **turnUser?**: `string`
 
 ***
 
 ### turnPwd?
 
-> `optional` **turnPwd**: `string`
+> `optional` **turnPwd?**: `string`
 
 ***
 
@@ -78,7 +78,7 @@
 
 ### engineUuid?
 
-> `optional` **engineUuid**: `string`
+> `optional` **engineUuid?**: `string`
 
 ***
 
@@ -112,6 +112,18 @@
 
 ***
 
+### includeStack
+
+> **includeStack**: [`EngineLogLevel`](../type-aliases/EngineLogLevel.md)
+
+***
+
+### pixelStreamingLogger
+
+> **pixelStreamingLogger**: [`EngineLogLevel`](../type-aliases/EngineLogLevel.md)
+
+***
+
 ### centerHeartbeatIntervalMs
 
 > **centerHeartbeatIntervalMs**: `number`

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

@@ -8,7 +8,7 @@ Screen.SetSceneFPS 参数。
 
 ### fps?
 
-> `optional` **fps**: `number`
+> `optional` **fps?**: `number`
 
 渲染帧率。
 默认值为 `150`，有效范围 `1-300`。

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

@@ -8,7 +8,7 @@ Screen.SetSceneRenderBitrate 参数。
 
 ### bitrate?
 
-> `optional` **bitrate**: [`ScreenRenderBitratePreset`](../type-aliases/ScreenRenderBitratePreset.md)
+> `optional` **bitrate?**: [`ScreenRenderBitratePreset`](../type-aliases/ScreenRenderBitratePreset.md)
 
 渲染码率档位。
 可选值：`auto / low / high / super / blue`。

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

@@ -8,7 +8,7 @@ Screen.SetScreenResolution 参数。
 
 ### width?
 
-> `optional` **width**: `number`
+> `optional` **width?**: `number`
 
 目标分辨率宽度。
 默认值 `1920`。
@@ -17,7 +17,7 @@ Screen.SetScreenResolution 参数。
 
 ### height?
 
-> `optional` **height**: `number`
+> `optional` **height?**: `number`
 
 目标分辨率高度。
 默认值 `1080`。

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

@@ -6,22 +6,22 @@
 
 ### signalingAddress?
 
-> `optional` **signalingAddress**: `string`
+> `optional` **signalingAddress?**: `string`
 
 ***
 
 ### signallingAddress?
 
-> `optional` **signallingAddress**: `string`
+> `optional` **signallingAddress?**: `string`
 
 ***
 
 ### ticket?
 
-> `optional` **ticket**: `string`
+> `optional` **ticket?**: `string`
 
 ***
 
 ### status?
 
-> `optional` **status**: `string`
+> `optional` **status?**: `string`

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / SpatialQueryLayerByModelBoxRequest
+
+# Interface: SpatialQueryLayerByModelBoxRequest
+
+SpatialQuery.layerQueryByModelBox 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId?**: `string`
+
+场景查询位置的对象上级编号，可以为空。
+
+***
+
+### id?
+
+> `optional` **id?**: `string`
+
+查询参照的位置对象唯一编号。
+
+***
+
+### queryParentIds
+
+> **queryParentIds**: `string`[]
+
+查询的图层组编号集合，至少一个。