@nnepoch/dtc-sdk 3.0.0

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

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ApiRequestEnvelope
+
+# Interface: ApiRequestEnvelope\<T\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+## Properties
+
+### AssemblyName
+
+> **AssemblyName**: `string`
+
+***
+
+### fn
+
+> **fn**: `string`
+
+***
+
+### ClassName
+
+> **ClassName**: `string`
+
+***
+
+### FunctionName
+
+> **FunctionName**: `string`
+
+***
+
+### Value?
+
+> `optional` **Value**: `any`
+
+***
+
+### ts
+
+> **ts**: `number`

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

@@ -0,0 +1,57 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ApiResponseEnvelope
+
+# Interface: ApiResponseEnvelope\<T\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+## Properties
+
+### requestId
+
+> **requestId**: `string`
+
+***
+
+### success
+
+> **success**: `boolean`
+
+***
+
+### code
+
+> **code**: `string`
+
+***
+
+### message
+
+> **message**: `string`
+
+***
+
+### params?
+
+> `optional` **params**: `any`
+
+***
+
+### errorMsg?
+
+> `optional` **errorMsg**: `string`
+
+***
+
+### data?
+
+> `optional` **data**: `T`
+
+***
+
+### ts
+
+> **ts**: `number`

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / AuthErrorInfo
+
+# Interface: AuthErrorInfo
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+***
+
+### message
+
+> **message**: `string`
+
+***
+
+### retryable
+
+> **retryable**: `boolean`

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

@@ -0,0 +1,45 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / AuthSessionSnapshot
+
+# Interface: AuthSessionSnapshot
+
+## Properties
+
+### state
+
+> **state**: [`AuthWorkflowState`](../type-aliases/AuthWorkflowState.md)
+
+***
+
+### reconnecting
+
+> **reconnecting**: `boolean`
+
+***
+
+### webToken?
+
+> `optional` **webToken**: `string`
+
+***
+
+### engineToken?
+
+> `optional` **engineToken**: `string`
+
+***
+
+### signallingUrl?
+
+> `optional` **signallingUrl**: `string`
+
+***
+
+### lastError?
+
+> `optional` **lastError**: [`AuthErrorInfo`](AuthErrorInfo.md)
+
+***
+
+### updatedAt
+
+> **updatedAt**: `number`

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

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraFlyByPathRequest
+
+# Interface: CameraFlyByPathRequest
+
+Camera.flyByPath 参数。
+
+## Properties
+
+### points?
+
+> `optional` **points**: `string` \| `Vector3`[]
+
+相机路径点集合。
+
+***
+
+### lookAts?
+
+> `optional` **lookAts**: `string` \| `Vector3`[]
+
+视线目标点集合。
+
+***
+
+### time?
+
+> `optional` **time**: `number`
+
+飞行时长（秒）。
+
+***
+
+### smoothMode?
+
+> `optional` **smoothMode**: `0` \| `1`
+
+路径平滑模式。

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

@@ -0,0 +1,29 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraFlyToTargetRequest
+
+# Interface: CameraFlyToTargetRequest
+
+Camera.flyToTarget 参数。
+
+## Properties
+
+### point?
+
+> `optional` **point**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+飞行终点坐标。
+
+***
+
+### target?
+
+> `optional` **target**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+飞行过程中看向目标点。
+
+***
+
+### time?
+
+> `optional` **time**: `number`
+
+飞行时长（秒）。

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

@@ -0,0 +1,69 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraLookAtRequest
+
+# Interface: CameraLookAtRequest
+
+Camera.lookAt 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型所属父节点 ID，可选。
+
+***
+
+### id
+
+> **id**: `string` \| `string`[]
+
+模型 ID，支持单个或多个。
+
+***
+
+### offSet?
+
+> `optional` **offSet**: [`Vector3Input`](../type-aliases/Vector3Input.md)
+
+视角方向偏移向量。
+
+***
+
+### offSetX?
+
+> `optional` **offSetX**: `number`
+
+水平偏移量。
+
+***
+
+### distance?
+
+> `optional` **distance**: `number`
+
+到目标的距离比例。
+
+***
+
+### time?
+
+> `optional` **time**: `number`
+
+飞行时长（秒）。
+
+***
+
+### isRotate?
+
+> `optional` **isRotate**: `boolean`
+
+是否在飞行中旋转视角。
+
+***
+
+### isHighlight?
+
+> `optional` **isHighlight**: `boolean`
+
+是否高亮目标。

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

@@ -0,0 +1,37 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraObjFollowRequest
+
+# Interface: CameraObjFollowRequest
+
+Camera.startCameraObjFollow 参数。
+
+## Properties
+
+### parentId?
+
+> `optional` **parentId**: `string`
+
+模型所属父节点 ID，可选。
+
+***
+
+### id
+
+> **id**: `string`
+
+相机跟随的对象编号。
+
+***
+
+### offSet?
+
+> `optional` **offSet**: `Vector3`
+
+相机位置偏移量（x, y, z）。
+
+***
+
+### smooth?
+
+> `optional` **smooth**: `number`
+
+轨迹的平滑度，取值范围 0~1，默认 0.85；取值越大，相机跟随得越慢，跟随轨迹越平滑。

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

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraSetFlySpeedRequest
+
+# Interface: CameraSetFlySpeedRequest
+
+Camera.setFlySpeed 参数。
+
+## Properties
+
+### speed
+
+> **speed**: `number`
+
+飞行速度。

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

@@ -0,0 +1,13 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraSetFovRequest
+
+# Interface: CameraSetFovRequest
+
+Camera.setCameraFov 参数。
+
+## Properties
+
+### fov
+
+> **fov**: `number`
+
+相机视场角。

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

@@ -0,0 +1,21 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CameraSetPositionAndRotationRequest
+
+# Interface: CameraSetPositionAndRotationRequest
+
+Camera.setCameraPositionAndRotation 参数。
+
+## Properties
+
+### point
+
+> **point**: `Vector3`
+
+相机位置。
+
+***
+
+### rotation
+
+> **rotation**: `Vector3`
+
+相机旋转。

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

@@ -0,0 +1,27 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CenterConnectResult
+
+# Interface: CenterConnectResult
+
+## Properties
+
+### webToken?
+
+> `optional` **webToken**: `string`
+
+***
+
+### turn\_server?
+
+> `optional` **turn\_server**: `string`
+
+***
+
+### turn\_user?
+
+> `optional` **turn\_user**: `string`
+
+***
+
+### turn\_pwd?
+
+> `optional` **turn\_pwd**: `string`

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

@@ -0,0 +1,33 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CenterEnvelope
+
+# Interface: CenterEnvelope
+
+## Properties
+
+### fn
+
+> **fn**: `string`
+
+***
+
+### success?
+
+> `optional` **success**: `boolean`
+
+***
+
+### status?
+
+> `optional` **status**: `string`
+
+***
+
+### message?
+
+> `optional` **message**: `string`
+
+***
+
+### values?
+
+> `optional` **values**: `string`

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

@@ -0,0 +1,33 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CenterServiceInfo
+
+# Interface: CenterServiceInfo
+
+## Properties
+
+### token?
+
+> `optional` **token**: `string`
+
+***
+
+### uuid?
+
+> `optional` **uuid**: `string`
+
+***
+
+### isSpecify?
+
+> `optional` **isSpecify**: `boolean`
+
+***
+
+### PrivateKey?
+
+> `optional` **PrivateKey**: `string`
+
+***
+
+### privateKey?
+
+> `optional` **privateKey**: `string`

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

@@ -0,0 +1,9 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / CenterTokenAuthorizeResult
+
+# Interface: CenterTokenAuthorizeResult
+
+## Properties
+
+### signalingServer?
+
+> `optional` **signalingServer**: `string`

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

@@ -0,0 +1,23 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / DlssSetEnableRequest
+
+# Interface: DlssSetEnableRequest
+
+Dlss.setDlssEnable 参数。
+
+## Properties
+
+### enable?
+
+> `optional` **enable**: `boolean`
+
+是否开启 DLSS。
+默认值 `true`。
+
+***
+
+### quality?
+
+> `optional` **quality**: [`DlssQuality`](../type-aliases/DlssQuality.md)
+
+DLSS 质量档位。
+默认值 `DlssQuality.Balanced`。

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

@@ -0,0 +1,14 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / DlssSetQualityRequest
+
+# Interface: DlssSetQualityRequest
+
+Dlss.setDlssQuality 参数。
+
+## Properties
+
+### quality?
+
+> `optional` **quality**: [`DlssQuality`](../type-aliases/DlssQuality.md)
+
+DLSS 质量档位。
+默认值 `DlssQuality.Balanced`。

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

@@ -0,0 +1,127 @@
+[@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / EngineConfig
+
+# Interface: EngineConfig
+
+## Properties
+
+### centerIP?
+
+> `optional` **centerIP**: `string`
+
+鉴权服务器地址
+
+***
+
+### signalingServer?
+
+> `optional` **signalingServer**: `string`
+
+信令服务 HTTP 基地址，SDK 会基于该地址调用 `/api/v1/allocate` 获取最终 ws 播放地址
+
+***
+
+### sceneName?
+
+> `optional` **sceneName**: `string`
+
+***
+
+### token?
+
+> `optional` **token**: `string`
+
+***
+
+### dom?
+
+> `optional` **dom**: `HTMLDivElement`
+
+***
+
+### showProgressBar?
+
+> `optional` **showProgressBar**: `boolean`
+
+***
+
+### codec?
+
+> `optional` **codec**: `string`
+
+***
+
+### viewMode?
+
+> `optional` **viewMode**: [`EngineViewMode`](../type-aliases/EngineViewMode.md)
+
+***
+
+### turnServer?
+
+> `optional` **turnServer**: `string`
+
+TURN 服务器地址
+
+***
+
+### turnUser?
+
+> `optional` **turnUser**: `string`
+
+TURN 用户名
+
+***
+
+### turnPwd?
+
+> `optional` **turnPwd**: `string`
+
+TURN 密码
+
+***
+
+### privateKey?
+
+> `optional` **privateKey**: `string`
+
+私有密钥
+
+***
+
+### engineUuid?
+
+> `optional` **engineUuid**: `string`
+
+***
+
+### mapType?
+
+> `optional` **mapType**: `string`
+
+***
+
+### operationType?
+
+> `optional` **operationType**: `string`
+
+***
+
+### freeCheckInterval?
+
+> `optional` **freeCheckInterval**: `number`
+
+***
+
+### initialSettings?
+
+> `optional` **initialSettings**: `Record`\<`string`, `unknown`\>
+
+PixelStreaming initialSettings
+
+***
+
+### logger?
+
+> `optional` **logger**: [`EngineLogLevel`](../type-aliases/EngineLogLevel.md)
+
+日志级别，默认值为 info