@nnepoch/dtc-sdk 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/README.md +298 -0
  2. package/dist/browser/dtc-sdk-3.0.0.js +2 -0
  3. package/dist/cjs/index.cjs +38 -0
  4. package/dist/cjs/index.d.cts +5600 -0
  5. package/dist/esm/index.d.ts +5600 -0
  6. package/dist/esm/index.js +38 -0
  7. package/docs/api/api/classes/Animation.md +280 -0
  8. package/docs/api/api/classes/ApiRegistryError.md +60 -0
  9. package/docs/api/api/classes/Camera.md +601 -0
  10. package/docs/api/api/classes/Connect.md +257 -0
  11. package/docs/api/api/classes/Dlss.md +67 -0
  12. package/docs/api/api/classes/HighLighterEffect.md +173 -0
  13. package/docs/api/api/classes/Layer.md +444 -0
  14. package/docs/api/api/classes/Model.md +193 -0
  15. package/docs/api/api/classes/ModelPOI.md +279 -0
  16. package/docs/api/api/classes/ModelTransform.md +579 -0
  17. package/docs/api/api/classes/PathPatrol.md +337 -0
  18. package/docs/api/api/classes/Popup.md +323 -0
  19. package/docs/api/api/classes/Scene.md +272 -0
  20. package/docs/api/api/classes/Screen.md +157 -0
  21. package/docs/api/api/classes/TimeLine.md +274 -0
  22. package/docs/api/api/classes/UIPOI.md +318 -0
  23. package/docs/api/api/classes/WeatherSystem.md +581 -0
  24. package/docs/api/api/functions/createApiFacade.md +20 -0
  25. package/docs/api/api/index.md +45 -0
  26. package/docs/api/api/interfaces/ApiInstanceMap.md +107 -0
  27. package/docs/api/api/interfaces/ApiRegistryContext.md +47 -0
  28. package/docs/api/api/type-aliases/ApiFacade.md +7 -0
  29. package/docs/api/api/type-aliases/ApiModuleFactory.md +23 -0
  30. package/docs/api/api/type-aliases/ApiModuleKey.md +5 -0
  31. package/docs/api/api/type-aliases/ApiRegistry.md +7 -0
  32. package/docs/api/api/variables/API_MODULE_KEYS.md +5 -0
  33. package/docs/api/api/variables/PendingValidationSchemaMap.md +9 -0
  34. package/docs/api/api/variables/apiRegistry.md +7 -0
  35. package/docs/api/application/DTCEngine/classes/DTCEngine.md +738 -0
  36. package/docs/api/application/DTCEngine/index.md +11 -0
  37. package/docs/api/application/DTCEngine/interfaces/DTCEngineOptions.md +22 -0
  38. package/docs/api/index.md +7 -0
  39. package/docs/api/typedoc-sidebar.json +735 -0
  40. package/docs/api/types/enumerations/LayerEnum.md +21 -0
  41. package/docs/api/types/enumerations/ModelTransformType.md +251 -0
  42. package/docs/api/types/enumerations/VideoCodeType.md +37 -0
  43. package/docs/api/types/index.md +146 -0
  44. package/docs/api/types/interfaces/AnimationGetLengthRequest.md +29 -0
  45. package/docs/api/types/interfaces/AnimationPlayRequest.md +61 -0
  46. package/docs/api/types/interfaces/AnimationSetSpeedRequest.md +29 -0
  47. package/docs/api/types/interfaces/AnimationStartLoopRequest.md +53 -0
  48. package/docs/api/types/interfaces/AnimationStopLoopRequest.md +21 -0
  49. package/docs/api/types/interfaces/AnimationStopRequest.md +21 -0
  50. package/docs/api/types/interfaces/ApiRequestEnvelope.md +45 -0
  51. package/docs/api/types/interfaces/ApiResponseEnvelope.md +57 -0
  52. package/docs/api/types/interfaces/AuthErrorInfo.md +21 -0
  53. package/docs/api/types/interfaces/AuthSessionSnapshot.md +45 -0
  54. package/docs/api/types/interfaces/CameraFlyByPathRequest.md +37 -0
  55. package/docs/api/types/interfaces/CameraFlyToTargetRequest.md +29 -0
  56. package/docs/api/types/interfaces/CameraLookAtRequest.md +69 -0
  57. package/docs/api/types/interfaces/CameraObjFollowRequest.md +37 -0
  58. package/docs/api/types/interfaces/CameraSetFlySpeedRequest.md +13 -0
  59. package/docs/api/types/interfaces/CameraSetFovRequest.md +13 -0
  60. package/docs/api/types/interfaces/CameraSetPositionAndRotationRequest.md +21 -0
  61. package/docs/api/types/interfaces/CenterConnectResult.md +27 -0
  62. package/docs/api/types/interfaces/CenterEnvelope.md +33 -0
  63. package/docs/api/types/interfaces/CenterServiceInfo.md +33 -0
  64. package/docs/api/types/interfaces/CenterTokenAuthorizeResult.md +9 -0
  65. package/docs/api/types/interfaces/DlssSetEnableRequest.md +23 -0
  66. package/docs/api/types/interfaces/DlssSetQualityRequest.md +14 -0
  67. package/docs/api/types/interfaces/EngineConfig.md +127 -0
  68. package/docs/api/types/interfaces/EngineStatusInfo.md +59 -0
  69. package/docs/api/types/interfaces/FeatureToggleRequest.md +21 -0
  70. package/docs/api/types/interfaces/HighLighterEnableRequest.md +11 -0
  71. package/docs/api/types/interfaces/HighLighterRemoveHighLightModelRequest.md +21 -0
  72. package/docs/api/types/interfaces/HighLighterSetHighLightModelRequest.md +29 -0
  73. package/docs/api/types/interfaces/LayerAddRequest.md +61 -0
  74. package/docs/api/types/interfaces/LayerChildElementRequest.md +21 -0
  75. package/docs/api/types/interfaces/LayerModelAddRequest.md +75 -0
  76. package/docs/api/types/interfaces/LayerModelRemoveRequest.md +21 -0
  77. package/docs/api/types/interfaces/LayerPOIAddRequest.md +117 -0
  78. package/docs/api/types/interfaces/LayerSelectorRequest.md +21 -0
  79. package/docs/api/types/interfaces/LayerShowUIPopRequest.md +51 -0
  80. package/docs/api/types/interfaces/LayerSwitchModelRequest.md +29 -0
  81. package/docs/api/types/interfaces/ModelAddRequest.md +61 -0
  82. package/docs/api/types/interfaces/ModelBoundsRequest.md +21 -0
  83. package/docs/api/types/interfaces/ModelPOIAddRequest.md +53 -0
  84. package/docs/api/types/interfaces/ModelPOIDeleteByGroupRequest.md +13 -0
  85. package/docs/api/types/interfaces/ModelPOIDeleteByIdRequest.md +21 -0
  86. package/docs/api/types/interfaces/ModelPOIGetInfoRequest.md +21 -0
  87. package/docs/api/types/interfaces/ModelPOIUpdateRequest.md +53 -0
  88. package/docs/api/types/interfaces/ModelPOIVisibleByGroupRequest.md +21 -0
  89. package/docs/api/types/interfaces/ModelRemoveRequest.md +21 -0
  90. package/docs/api/types/interfaces/ModelSelectorRequest.md +21 -0
  91. package/docs/api/types/interfaces/ModelSetVisibleByTagsRequest.md +21 -0
  92. package/docs/api/types/interfaces/ModelSetVisibleRequest.md +29 -0
  93. package/docs/api/types/interfaces/ModelTransformNodeRequest.md +21 -0
  94. package/docs/api/types/interfaces/ModelTransformRestoreRequest.md +21 -0
  95. package/docs/api/types/interfaces/ModelTransformRotateByTargetRequest.md +85 -0
  96. package/docs/api/types/interfaces/ModelTransformRotateRequest.md +29 -0
  97. package/docs/api/types/interfaces/ModelTransformScaleRequest.md +37 -0
  98. package/docs/api/types/interfaces/ModelTransformStartMoveRequest.md +61 -0
  99. package/docs/api/types/interfaces/NetworkAdaptationActionResult.md +47 -0
  100. package/docs/api/types/interfaces/NetworkAdaptationActionStep.md +29 -0
  101. package/docs/api/types/interfaces/NetworkAdaptationState.md +41 -0
  102. package/docs/api/types/interfaces/NetworkDecisionTrace.md +53 -0
  103. package/docs/api/types/interfaces/NetworkDiagnosticsSnapshot.md +53 -0
  104. package/docs/api/types/interfaces/NetworkMetricsSnapshot.md +59 -0
  105. package/docs/api/types/interfaces/PathPatrolAddRequest.md +109 -0
  106. package/docs/api/types/interfaces/PathPatrolNodeRequest.md +21 -0
  107. package/docs/api/types/interfaces/PathPatrolSetTimeNodeRequest.md +37 -0
  108. package/docs/api/types/interfaces/PathPatrolUpdateRequest.md +53 -0
  109. package/docs/api/types/interfaces/PopupAddRequest.md +21 -0
  110. package/docs/api/types/interfaces/PopupDelayRequest.md +13 -0
  111. package/docs/api/types/interfaces/PopupItemRequest.md +61 -0
  112. package/docs/api/types/interfaces/PopupRemoveRequest.md +21 -0
  113. package/docs/api/types/interfaces/PopupShowDistanceRequest.md +13 -0
  114. package/docs/api/types/interfaces/PopupShowRequest.md +29 -0
  115. package/docs/api/types/interfaces/PopupSyncInfoRequest.md +37 -0
  116. package/docs/api/types/interfaces/QosEvent.md +65 -0
  117. package/docs/api/types/interfaces/QosReportingPayload.md +47 -0
  118. package/docs/api/types/interfaces/QosRuntimeContext.md +29 -0
  119. package/docs/api/types/interfaces/QosSessionContext.md +29 -0
  120. package/docs/api/types/interfaces/QosWarnErrorSummary.md +37 -0
  121. package/docs/api/types/interfaces/ResolvedEngineConfig.md +123 -0
  122. package/docs/api/types/interfaces/SceneListenCompassRequest.md +13 -0
  123. package/docs/api/types/interfaces/SceneSwitchRequest.md +13 -0
  124. package/docs/api/types/interfaces/ScreenSetSceneFPSRequest.md +14 -0
  125. package/docs/api/types/interfaces/ScreenSetSceneRenderBitrateRequest.md +15 -0
  126. package/docs/api/types/interfaces/ScreenSetScreenResolutionRequest.md +23 -0
  127. package/docs/api/types/interfaces/ScreenSetVideoDecodeRequest.md +13 -0
  128. package/docs/api/types/interfaces/SignallingAllocateResponse.md +27 -0
  129. package/docs/api/types/interfaces/StandardResponse.md +33 -0
  130. package/docs/api/types/interfaces/TimeSerialNode.md +21 -0
  131. package/docs/api/types/interfaces/TimelineNodeRequest.md +21 -0
  132. package/docs/api/types/interfaces/TimelinePlayRequest.md +53 -0
  133. package/docs/api/types/interfaces/TimelineSetSpeedRequest.md +37 -0
  134. package/docs/api/types/interfaces/TimelineStopRequest.md +45 -0
  135. package/docs/api/types/interfaces/UIPOIAddRequest.md +21 -0
  136. package/docs/api/types/interfaces/UIPOIDeleteByGroupRequest.md +13 -0
  137. package/docs/api/types/interfaces/UIPOIDeleteByIdRequest.md +21 -0
  138. package/docs/api/types/interfaces/UIPOIEnableOverlapRequest.md +13 -0
  139. package/docs/api/types/interfaces/UIPOIShowDistanceRequest.md +13 -0
  140. package/docs/api/types/interfaces/UIPOIUpdateRequest.md +21 -0
  141. package/docs/api/types/interfaces/UIPOIUpdateStateRequest.md +21 -0
  142. package/docs/api/types/interfaces/Vector3JsonInput.md +27 -0
  143. package/docs/api/types/interfaces/WeatherChangeSeasonRequest.md +21 -0
  144. package/docs/api/types/interfaces/WeatherOpenCameraFogRequest.md +69 -0
  145. package/docs/api/types/interfaces/WeatherSetAnimateTimeOfDayRequest.md +29 -0
  146. package/docs/api/types/interfaces/WeatherSetDayAndNightRequest.md +13 -0
  147. package/docs/api/types/interfaces/WeatherSetSceneTimeRequest.md +21 -0
  148. package/docs/api/types/interfaces/WeatherSetTimeSyncRequest.md +13 -0
  149. package/docs/api/types/interfaces/WeatherTypeRequest.md +27 -0
  150. package/docs/api/types/type-aliases/ApiCallback.md +21 -0
  151. package/docs/api/types/type-aliases/AuthWorkflowState.md +5 -0
  152. package/docs/api/types/type-aliases/DlssQuality.md +7 -0
  153. package/docs/api/types/type-aliases/EngineLogLevel.md +5 -0
  154. package/docs/api/types/type-aliases/EngineViewMode.md +5 -0
  155. package/docs/api/types/type-aliases/GetWeatherTypeRequest.md +7 -0
  156. package/docs/api/types/type-aliases/NetworkAdaptationActionType.md +7 -0
  157. package/docs/api/types/type-aliases/NetworkAdaptationLevel.md +7 -0
  158. package/docs/api/types/type-aliases/NetworkAdaptationMode.md +9 -0
  159. package/docs/api/types/type-aliases/QosEventName.md +9 -0
  160. package/docs/api/types/type-aliases/QosLevel.md +7 -0
  161. package/docs/api/types/type-aliases/QosStage.md +7 -0
  162. package/docs/api/types/type-aliases/QosStatus.md +7 -0
  163. package/docs/api/types/type-aliases/ScreenRenderBitratePreset.md +7 -0
  164. package/docs/api/types/type-aliases/Season.md +7 -0
  165. package/docs/api/types/type-aliases/Vector3Input.md +5 -0
  166. package/docs/api/types/variables/DlssQuality.md +57 -0
  167. package/docs/api/types/variables/QOS_EVENT_NAMES.md +7 -0
  168. package/docs/api/types/variables/ScreenRenderBitratePreset.md +39 -0
  169. package/docs/api/types/variables/ScreenRenderBitratePresetOptions.md +5 -0
  170. package/docs/api/types/variables/ScreenRenderBitratePresetValueMap.md +27 -0
  171. package/docs/api/types/variables/Season.md +33 -0
  172. package/package.json +86 -0
@@ -0,0 +1,69 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherOpenCameraFogRequest
2
+
3
+ # Interface: WeatherOpenCameraFogRequest
4
+
5
+ WeatherSystem.openCameraFog 参数。
6
+
7
+ ## Properties
8
+
9
+ ### fogIntensity?
10
+
11
+ > `optional` **fogIntensity**: `number`
12
+
13
+ 雾强度。
14
+
15
+ ***
16
+
17
+ ### fogStartColor?
18
+
19
+ > `optional` **fogStartColor**: `string`
20
+
21
+ 雾近端颜色。
22
+
23
+ ***
24
+
25
+ ### fogEndColor?
26
+
27
+ > `optional` **fogEndColor**: `string`
28
+
29
+ 雾远端颜色。
30
+
31
+ ***
32
+
33
+ ### fogStartDistance?
34
+
35
+ > `optional` **fogStartDistance**: `number`
36
+
37
+ 雾起始距离。
38
+
39
+ ***
40
+
41
+ ### fogEndDistance?
42
+
43
+ > `optional` **fogEndDistance**: `number`
44
+
45
+ 雾终止距离。
46
+
47
+ ***
48
+
49
+ ### directionalIntensity?
50
+
51
+ > `optional` **directionalIntensity**: `number`
52
+
53
+ 方向光强度。
54
+
55
+ ***
56
+
57
+ ### directionalFallOff?
58
+
59
+ > `optional` **directionalFallOff**: `number`
60
+
61
+ 方向光衰减。
62
+
63
+ ***
64
+
65
+ ### directionalColor?
66
+
67
+ > `optional` **directionalColor**: `string`
68
+
69
+ 方向光颜色。
@@ -0,0 +1,29 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherSetAnimateTimeOfDayRequest
2
+
3
+ # Interface: WeatherSetAnimateTimeOfDayRequest
4
+
5
+ WeatherSystem.setAnimateTimeOfDay 参数。
6
+
7
+ ## Properties
8
+
9
+ ### isAnimate?
10
+
11
+ > `optional` **isAnimate**: `boolean`
12
+
13
+ 是否模拟白天,黑夜时间动画。
14
+
15
+ ***
16
+
17
+ ### dayLength?
18
+
19
+ > `optional` **dayLength**: `number`
20
+
21
+ 白天持续时间(分)。 默认0.5分钟
22
+
23
+ ***
24
+
25
+ ### nightLength?
26
+
27
+ > `optional` **nightLength**: `number`
28
+
29
+ 夜晚持续时间(分)。 默认0.5分钟
@@ -0,0 +1,13 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherSetDayAndNightRequest
2
+
3
+ # Interface: WeatherSetDayAndNightRequest
4
+
5
+ WeatherSystem.setDayAndNight 参数。
6
+
7
+ ## Properties
8
+
9
+ ### dayType
10
+
11
+ > **dayType**: `string`
12
+
13
+ 日夜类型,如 day/night。
@@ -0,0 +1,21 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherSetSceneTimeRequest
2
+
3
+ # Interface: WeatherSetSceneTimeRequest
4
+
5
+ WeatherSystem.setSceneTime 参数。
6
+
7
+ ## Properties
8
+
9
+ ### hour
10
+
11
+ > **hour**: `number`
12
+
13
+ 小时值。 0~24小时
14
+
15
+ ***
16
+
17
+ ### timeDuration?
18
+
19
+ > `optional` **timeDuration**: `number`
20
+
21
+ 时间变化持续的时间(秒)。
@@ -0,0 +1,13 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherSetTimeSyncRequest
2
+
3
+ # Interface: WeatherSetTimeSyncRequest
4
+
5
+ WeatherSystem.setTimeSync 参数。
6
+
7
+ ## Properties
8
+
9
+ ### syncSystemTime?
10
+
11
+ > `optional` **syncSystemTime**: `boolean`
12
+
13
+ 是否同步系统时间。
@@ -0,0 +1,27 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / WeatherTypeRequest
2
+
3
+ # Interface: WeatherTypeRequest
4
+
5
+ WeatherSystem.changeWeatherType 参数。
6
+
7
+ ## Properties
8
+
9
+ ### type
10
+
11
+ > **type**: `number`
12
+
13
+ 天气类型名称。
14
+
15
+ ***
16
+
17
+ ### timeDuration
18
+
19
+ > **timeDuration**: `number`
20
+
21
+ 天气类型持续时间(秒)。
22
+
23
+ ***
24
+
25
+ ### test?
26
+
27
+ > `optional` **test**: `string`
@@ -0,0 +1,21 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ApiCallback
2
+
3
+ # Type Alias: ApiCallback()\<T\>
4
+
5
+ > **ApiCallback**\<`T`\> = (`result`) => `void`
6
+
7
+ ## Type Parameters
8
+
9
+ | Type Parameter |
10
+ | ------ |
11
+ | `T` |
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type |
16
+ | ------ | ------ |
17
+ | `result` | `T` |
18
+
19
+ ## Returns
20
+
21
+ `void`
@@ -0,0 +1,5 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / AuthWorkflowState
2
+
3
+ # Type Alias: AuthWorkflowState
4
+
5
+ > **AuthWorkflowState** = `"idle"` \| `"centerConnecting"` \| `"centerConnected"` \| `"serviceAllocating"` \| `"waiting"` \| `"authorizing"` \| `"webrtcConnecting"` \| `"connected"` \| `"failed"`
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / DlssQuality
2
+
3
+ # Type Alias: DlssQuality
4
+
5
+ > **DlssQuality** = *typeof* [`DlssQuality`](../variables/DlssQuality.md)\[keyof *typeof* [`DlssQuality`](../variables/DlssQuality.md)\]
6
+
7
+ Dlss.setDlssQuality 参数。
@@ -0,0 +1,5 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / EngineLogLevel
2
+
3
+ # Type Alias: EngineLogLevel
4
+
5
+ > **EngineLogLevel** = `"silent"` \| `"error"` \| `"warn"` \| `"info"` \| `"debug"`
@@ -0,0 +1,5 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / EngineViewMode
2
+
3
+ # Type Alias: EngineViewMode
4
+
5
+ > **EngineViewMode** = `"bs"` \| `"cs"`
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / GetWeatherTypeRequest
2
+
3
+ # Type Alias: GetWeatherTypeRequest
4
+
5
+ > **GetWeatherTypeRequest** = `Record`\<`string`, `never`\>
6
+
7
+ WeatherSystem.changeWeatherType 参数。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NetworkAdaptationActionType
2
+
3
+ # Type Alias: NetworkAdaptationActionType
4
+
5
+ > **NetworkAdaptationActionType** = `"SetSceneRenderBitrate"` \| `"SetSceneFPS"` \| `"SetScreenResolution"`
6
+
7
+ 策略动作类型。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NetworkAdaptationLevel
2
+
3
+ # Type Alias: NetworkAdaptationLevel
4
+
5
+ > **NetworkAdaptationLevel** = `"Normal"` \| `"Mild"` \| `"Moderate"` \| `"Severe"` \| `"Recovering"`
6
+
7
+ 弱网自适应档位。
@@ -0,0 +1,9 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / NetworkAdaptationMode
2
+
3
+ # Type Alias: NetworkAdaptationMode
4
+
5
+ > **NetworkAdaptationMode** = `"auto"` \| `"manual"`
6
+
7
+ 弱网自适应运行模式:
8
+ - auto: 自动策略决策
9
+ - manual: 手动接管档位
@@ -0,0 +1,9 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosEventName
2
+
3
+ # Type Alias: QosEventName
4
+
5
+ > **QosEventName** = *typeof* [`QOS_EVENT_NAMES`](../variables/QOS_EVENT_NAMES.md)\[`number`\]
6
+
7
+ QoS V1 事件名类型。
8
+
9
+ 注意:V1 明确不包含 `ue_request_timeout`。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosLevel
2
+
3
+ # Type Alias: QosLevel
4
+
5
+ > **QosLevel** = `"info"` \| `"warn"` \| `"error"`
6
+
7
+ QoS 事件日志等级(仅用于事件严重程度标记)。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosStage
2
+
3
+ # Type Alias: QosStage
4
+
5
+ > **QosStage** = `"auth"` \| `"center"` \| `"webrtc"` \| `"media"` \| `"ue_api"` \| `"session"`
6
+
7
+ QoS 事件阶段定义。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QosStatus
2
+
3
+ # Type Alias: QosStatus
4
+
5
+ > **QosStatus** = `"start"` \| `"success"` \| `"failed"` \| `"update"` \| `"end"`
6
+
7
+ QoS 事件状态定义。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ScreenRenderBitratePreset
2
+
3
+ # Type Alias: ScreenRenderBitratePreset
4
+
5
+ > **ScreenRenderBitratePreset** = *typeof* [`ScreenRenderBitratePreset`](../variables/ScreenRenderBitratePreset.md)\[keyof *typeof* [`ScreenRenderBitratePreset`](../variables/ScreenRenderBitratePreset.md)\]
6
+
7
+ Screen.setSceneRenderBitrate 参数。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / Season
2
+
3
+ # Type Alias: Season
4
+
5
+ > **Season** = *typeof* [`Season`](../variables/Season.md)\[keyof *typeof* [`Season`](../variables/Season.md)\]
6
+
7
+ WeatherSystem.changeSeason 参数。
@@ -0,0 +1,5 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / Vector3Input
2
+
3
+ # Type Alias: Vector3Input
4
+
5
+ > **Vector3Input** = `Vector3` \| [`Vector3JsonInput`](../interfaces/Vector3JsonInput.md)
@@ -0,0 +1,57 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / DlssQuality
2
+
3
+ # Variable: DlssQuality
4
+
5
+ > `const` **DlssQuality**: `object`
6
+
7
+ Dlss.setDlssQuality 参数。
8
+
9
+ ## Type Declaration
10
+
11
+ ### Off
12
+
13
+ > `readonly` **Off**: `0` = `0`
14
+
15
+ 关闭 DLSS。默认值。
16
+
17
+ ### Auto
18
+
19
+ > `readonly` **Auto**: `1` = `1`
20
+
21
+ Auto 模式会根据系统性能自动选择最合适的 DLSS 质量档位,提供更智能的画质与性能平衡方案。
22
+
23
+ ### DLAA
24
+
25
+ > `readonly` **DLAA**: `2` = `2`
26
+
27
+ 2倍效果
28
+
29
+ ### UltraQuality
30
+
31
+ > `readonly` **UltraQuality**: `3` = `3`
32
+
33
+ 超高质量。
34
+
35
+ ### Quality
36
+
37
+ > `readonly` **Quality**: `4` = `4`
38
+
39
+ 高质量。
40
+
41
+ ### Balanced
42
+
43
+ > `readonly` **Balanced**: `5` = `5`
44
+
45
+ 平衡。
46
+
47
+ ### Performance
48
+
49
+ > `readonly` **Performance**: `6` = `6`
50
+
51
+ 性能。
52
+
53
+ ### UltraPerformance
54
+
55
+ > `readonly` **UltraPerformance**: `7` = `7`
56
+
57
+ 超高性能。
@@ -0,0 +1,7 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / QOS\_EVENT\_NAMES
2
+
3
+ # Variable: QOS\_EVENT\_NAMES
4
+
5
+ > `const` **QOS\_EVENT\_NAMES**: readonly \[`"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"`\]
6
+
7
+ QoS V1 事件名集合。
@@ -0,0 +1,39 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ScreenRenderBitratePreset
2
+
3
+ # Variable: ScreenRenderBitratePreset
4
+
5
+ > `const` **ScreenRenderBitratePreset**: `object`
6
+
7
+ Screen.setSceneRenderBitrate 参数。
8
+
9
+ ## Type Declaration
10
+
11
+ ### Auto
12
+
13
+ > `readonly` **Auto**: `"auto"` = `'auto'`
14
+
15
+ 自动。
16
+
17
+ ### Low
18
+
19
+ > `readonly` **Low**: `"low"` = `'low'`
20
+
21
+ 标清。
22
+
23
+ ### High
24
+
25
+ > `readonly` **High**: `"high"` = `'high'`
26
+
27
+ 高清。
28
+
29
+ ### Super
30
+
31
+ > `readonly` **Super**: `"super"` = `'super'`
32
+
33
+ 超清。
34
+
35
+ ### Blue
36
+
37
+ > `readonly` **Blue**: `"blue"` = `'blue'`
38
+
39
+ 蓝光。
@@ -0,0 +1,5 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ScreenRenderBitratePresetOptions
2
+
3
+ # Variable: ScreenRenderBitratePresetOptions
4
+
5
+ > `const` **ScreenRenderBitratePresetOptions**: readonly \[\{ `label`: `"自动"`; `type`: `"auto"`; `value`: `12000000`; \}, \{ `label`: `"标清"`; `type`: `"low"`; `value`: `4000000`; \}, \{ `label`: `"高清"`; `type`: `"high"`; `value`: `8000000`; \}, \{ `label`: `"超清"`; `type`: `"super"`; `value`: `12000000`; \}, \{ `label`: `"蓝光"`; `type`: `"blue"`; `value`: `24000000`; \}\]
@@ -0,0 +1,27 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / ScreenRenderBitratePresetValueMap
2
+
3
+ # Variable: ScreenRenderBitratePresetValueMap
4
+
5
+ > `const` **ScreenRenderBitratePresetValueMap**: `object`
6
+
7
+ ## Type Declaration
8
+
9
+ ### auto
10
+
11
+ > `readonly` **auto**: `12000000` = `12000000`
12
+
13
+ ### low
14
+
15
+ > `readonly` **low**: `4000000` = `4000000`
16
+
17
+ ### high
18
+
19
+ > `readonly` **high**: `8000000` = `8000000`
20
+
21
+ ### super
22
+
23
+ > `readonly` **super**: `12000000` = `12000000`
24
+
25
+ ### blue
26
+
27
+ > `readonly` **blue**: `24000000` = `24000000`
@@ -0,0 +1,33 @@
1
+ [@nnepoch/dtc-sdk](../../index.md) / [types](../index.md) / Season
2
+
3
+ # Variable: Season
4
+
5
+ > `const` **Season**: `object`
6
+
7
+ WeatherSystem.changeSeason 参数。
8
+
9
+ ## Type Declaration
10
+
11
+ ### Spring
12
+
13
+ > `readonly` **Spring**: `0` = `0`
14
+
15
+ 春季。
16
+
17
+ ### Summer
18
+
19
+ > `readonly` **Summer**: `1` = `1`
20
+
21
+ 夏季。
22
+
23
+ ### Autumn
24
+
25
+ > `readonly` **Autumn**: `2` = `2`
26
+
27
+ 秋季。
28
+
29
+ ### Winter
30
+
31
+ > `readonly` **Winter**: `3` = `3`
32
+
33
+ 冬季。
package/package.json ADDED
@@ -0,0 +1,86 @@
1
+ {
2
+ "name": "@nnepoch/dtc-sdk",
3
+ "version": "3.0.0",
4
+ "description": "UE frontend SDK built on official Pixel Streaming frontend package",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "main": "dist/cjs/index.cjs",
8
+ "module": "dist/esm/index.js",
9
+ "types": "dist/esm/index.d.ts",
10
+ "exports": {
11
+ ".": {
12
+ "types": "./dist/esm/index.d.ts",
13
+ "import": "./dist/esm/index.js",
14
+ "require": "./dist/cjs/index.cjs"
15
+ }
16
+ },
17
+ "files": [
18
+ "dist",
19
+ "docs/api"
20
+ ],
21
+ "scripts": {
22
+ "changeset": "npx @changesets/cli",
23
+ "clean": "rimraf ./dist ./docs/api",
24
+ "watch": "tsdown --config tsdown.config.ts --filter library --watch",
25
+ "dev:browser": "tsdown --config tsdown.config.ts --filter browser --watch",
26
+ "playground": "vite --config playground/vite.config.ts",
27
+ "playground:dev": "vite --config playground/vite.config.ts",
28
+ "playground:build": "vite build --config playground/vite.config.ts",
29
+ "playground:preview": "vite preview --config playground/vite.config.ts",
30
+ "playground:vue:dev": "vite --config playground/vue/vite.config.ts",
31
+ "playground:vanilla:dev": "vite --config playground/vanilla/vite.config.ts",
32
+ "playground:hzjz:dev": "vite --config playground/hzjz/vite.config.ts",
33
+ "build": "pnpm run build:lib && pnpm run build:browser",
34
+ "rebuild": "pnpm run clean && pnpm run build",
35
+ "build:browser": "tsdown --config tsdown.config.ts --filter browser && node scripts/rename-browser-bundle.mjs && pnpm run build:obfuscate",
36
+ "build:obfuscate": "node scripts/obfuscate.mjs",
37
+ "build:lib": "tsc --noEmit --pretty false && pnpm exec tsdown --config tsdown.config.ts --filter library",
38
+ "build:release": "pnpm run rebuild && pnpm run docs:build",
39
+ "verify:build": "node scripts/verify-build.mjs",
40
+ "generate:agent-metadata": "node --import tsx scripts/extract-agent-metadata.mts",
41
+ "docs:api": "typedoc",
42
+ "docs": "pnpm run docs:api",
43
+ "docs:dev": "npm run docs:api && vitepress dev docs",
44
+ "docs:build": "npm run docs:api && vitepress build docs",
45
+ "docs:preview": "vitepress preview docs",
46
+ "typecheck": "tsc --noEmit --pretty false",
47
+ "dev": "pnpm run watch",
48
+ "lint": "eslint src --ext .ts --ignore-pattern '**/*.test.ts' --ignore-pattern '**/*.spec.ts' --ignore-pattern '**/__tests__/**'",
49
+ "test": "vitest run"
50
+ },
51
+ "dependencies": {
52
+ "@epicgames-ps/lib-pixelstreamingcommon-ue5.6": "^0.1.4",
53
+ "@epicgames-ps/lib-pixelstreamingfrontend-ue5.6": "^0.2.5",
54
+ "axios": "^1.13.6",
55
+ "pako": "^2.1.0",
56
+ "zod": "^3.25.76"
57
+ },
58
+ "devDependencies": {
59
+ "@changesets/cli": "^2.30.0",
60
+ "@eslint/js": "^9.39.1",
61
+ "@rollup/plugin-commonjs": "^28.0.8",
62
+ "@rollup/plugin-node-resolve": "^16.0.3",
63
+ "@rollup/plugin-terser": "^0.4.4",
64
+ "@rollup/plugin-typescript": "^12.3.0",
65
+ "@types/node": "^24.9.1",
66
+ "@types/pako": "^2.0.4",
67
+ "@vitejs/plugin-vue": "^6.0.4",
68
+ "eslint": "^9.39.1",
69
+ "javascript-obfuscator": "^4.1.1",
70
+ "rimraf": "^6.0.1",
71
+ "rollup": "^4.50.1",
72
+ "tsdown": "^0.22.14",
73
+ "tslib": "^2.8.1",
74
+ "tsx": "^4.22.3",
75
+ "typedoc": "^0.28.14",
76
+ "typedoc-plugin-markdown": "^4.10.0",
77
+ "typedoc-vitepress-theme": "^1.1.2",
78
+ "typescript": "^5.9.3",
79
+ "typescript-eslint": "^8.46.4",
80
+ "unrun": "^0.3.1",
81
+ "vite": "7.3.1",
82
+ "vitepress": "2.0.0-alpha.16",
83
+ "vitest": "^4.0.3",
84
+ "vue": "^3.5.30"
85
+ }
86
+ }