@tencentcloud/sdk-mcp 1.7.7 → 1.7.9-beta.1
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.
- package/CHANGELOG.md +13 -0
- package/README.md +7 -9
- package/index.js +8 -8
- package/knowledge/chunker.js +1 -0
- package/knowledge/doc-url-resolver.js +16 -9
- package/knowledge/embedding/build-vectors.js +92 -0
- package/knowledge/embedding/embed-model.js +41 -0
- package/knowledge/embedding/vector-augment.js +126 -0
- package/knowledge/embedding/vector-index.js +70 -0
- package/knowledge/frontmatter-meta.js +23 -0
- package/knowledge/path-meta.js +56 -0
- package/knowledge/search/exact-lookup.js +145 -16
- package/knowledge/search/filter-pool.js +77 -33
- package/knowledge/search/rank-profile.js +25 -0
- package/knowledge/search/requires-framework.js +4 -1
- package/knowledge/search/search-core.js +74 -13
- package/knowledge/search/search-knowledge.js +24 -34
- package/knowledge/search/search-pass.js +495 -169
- package/knowledge/search/url-row-scorer.js +24 -6
- package/package.json +3 -1
- package/resource/index/manifest.json +1 -1
- package/resource/index/vectors/index.json +4 -0
- package/resource/integration/callkit/preset/android/integration.md +0 -2
- package/resource/integration/callkit/preset/ios/integration.md +0 -2
- package/resource/integration/chat/preset/react/integration.md +9 -5
- package/resource/integration/chat/preset/uni-app/integration.md +4 -0
- package/resource/integration/chat/preset/vue/integration.md +10 -6
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +0 -4
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -4
- package/resource/integration/roomkit/preset/vue/integration.md +154 -208
- package/resource/knowledge/callkit/best-practice/android/video-chat-dating.md +0 -2
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -2
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -2
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -4
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -2
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +0 -2
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -2
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -4
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -2
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -2
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -2
- package/resource/knowledge/callkit/faq/ios.md +0 -2
- package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
- package/resource/knowledge/callkit/preset/miniprogram/integration.md +2 -3
- package/resource/knowledge/callkit/preset/miniprogram/uniapp-integration.md +0 -2
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -16
- package/resource/knowledge/chat/preset/react/h5/integration.md +16 -5
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +6 -3
- package/resource/knowledge/chat/preset/vue/h5/integration.md +7 -4
- package/resource/knowledge/iot/app/activate-service.md +95 -0
- package/resource/knowledge/iot/app/demo/android.md +93 -0
- package/resource/knowledge/iot/app/demo/ios.md +87 -0
- package/resource/knowledge/iot/app/demo/miniprogram.md +79 -0
- package/resource/knowledge/iot/app/device-binding.md +378 -0
- package/resource/knowledge/iot/app/device-sharing.md +414 -0
- package/resource/knowledge/iot/app/family-management.md +762 -0
- package/resource/knowledge/iot/app/integration/android.md +328 -0
- package/resource/knowledge/iot/app/integration/harmonyos.md +326 -0
- package/resource/knowledge/iot/app/integration/ios.md +351 -0
- package/resource/knowledge/iot/app/integration/miniprogram.md +268 -0
- package/resource/knowledge/iot/app/monitor-playback.md +557 -0
- package/resource/knowledge/iot/app/remote-control.md +139 -0
- package/resource/knowledge/iot/app/video-call.md +559 -0
- package/resource/knowledge/iot/app/wechat-call/device-call-miniprogram.md +204 -0
- package/resource/knowledge/iot/app/wechat-call/miniprogram-call-device.md +193 -0
- package/resource/knowledge/iot/client-api/app/android/txiotcallsession.md +189 -0
- package/resource/knowledge/iot/client-api/app/android/txiotcloudstorage.md +77 -0
- package/resource/knowledge/iot/client-api/app/android/txiotdevicemanager.md +175 -0
- package/resource/knowledge/iot/client-api/app/android/txiotengine.md +172 -0
- package/resource/knowledge/iot/client-api/app/android/txiotenginedef.md +163 -0
- package/resource/knowledge/iot/client-api/app/android/txiotfamilymanager.md +146 -0
- package/resource/knowledge/iot/client-api/app/android/txiotmonitorsession.md +246 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotcallsession.md +191 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotcloudstorage.md +77 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotdevicemanager.md +183 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotengine.md +186 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotenginedef.md +164 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotfamilymanager.md +150 -0
- package/resource/knowledge/iot/client-api/app/harmonyos/txiotmonitorsession.md +252 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotcallsession.md +199 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotcloudstorage.md +76 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotdevicemanager.md +173 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotengine.md +173 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotenginedef.md +171 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotfamilymanager.md +146 -0
- package/resource/knowledge/iot/client-api/app/ios/txiotmonitorsession.md +250 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotcallsession.md +180 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotcloudstorage.md +76 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotdevicemanager.md +281 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotengine.md +183 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotenginedef.md +152 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotfamilymanager.md +179 -0
- package/resource/knowledge/iot/client-api/app/miniprogram/txiotmonitorsession.md +226 -0
- package/resource/knowledge/iot/client-api/device/android-smart-device.md +813 -0
- package/resource/knowledge/iot/client-api/device/linux-rtos-device.md +2027 -0
- package/resource/knowledge/iot/device/activate-service.md +167 -0
- package/resource/knowledge/iot/device/ai-voice-chat/advanced-features/custom-agent.md +171 -0
- package/resource/knowledge/iot/device/ai-voice-chat/advanced-features/smart-device-control.md +721 -0
- package/resource/knowledge/iot/device/ai-voice-chat/integration-guide/android-smart-device.md +247 -0
- package/resource/knowledge/iot/device/ai-voice-chat/integration-guide/linux-rtos-device.md +368 -0
- package/resource/knowledge/iot/device/ai-voice-chat/overview.md +84 -0
- package/resource/knowledge/iot/device/cloud-storage.md +696 -0
- package/resource/knowledge/iot/device/data-model.md +972 -0
- package/resource/knowledge/iot/device/demo/android-smart-device.md +97 -0
- package/resource/knowledge/iot/device/demo/linux-rtos-device.md +106 -0
- package/resource/knowledge/iot/device/device-ota-upgrade.md +237 -0
- package/resource/knowledge/iot/device/dynamic-registration/android-smart-device.md +275 -0
- package/resource/knowledge/iot/device/dynamic-registration/linux-rtos-device.md +297 -0
- package/resource/knowledge/iot/device/login-and-register/android-smart-device.md +131 -0
- package/resource/knowledge/iot/device/login-and-register/linux-rtos-device.md +291 -0
- package/resource/knowledge/iot/device/monitor-pushing/android-smart-device.md +237 -0
- package/resource/knowledge/iot/device/monitor-pushing/linux-rtos-device.md +493 -0
- package/resource/knowledge/iot/device/video-call/android-smart-device.md +299 -0
- package/resource/knowledge/iot/device/video-call/linux-rtos-device.md +465 -0
- package/resource/knowledge/iot/device/wechat-call/android-smart-device.md +534 -0
- package/resource/knowledge/iot/device/wechat-call/linux-rtos-device.md +681 -0
- package/resource/knowledge/iot/kids-watch/overview.md +28 -0
- package/resource/knowledge/iot/security-camera/activate-service.md +74 -0
- package/resource/knowledge/iot/security-camera/monitor-playback/app-integration.md +302 -0
- package/resource/knowledge/iot/security-camera/monitor-playback/device-integration/android.md +237 -0
- package/resource/knowledge/iot/security-camera/monitor-playback/device-integration/linux-rtos.md +493 -0
- package/resource/knowledge/iot/security-camera/overview.md +31 -0
- package/resource/knowledge/iot/security-camera/ptz-control.md +153 -0
- package/resource/knowledge/iot/security-camera/recording-and-snapshot.md +182 -0
- package/resource/knowledge/iot/security-camera/voice-intercom.md +174 -0
- package/resource/knowledge/iot/smart-vision/serviceoverview.md +114 -0
- package/resource/knowledge/iot/voice-recorder/app-demo.md +99 -0
- package/resource/knowledge/iot/voice-recorder/device-demo.md +189 -0
- package/resource/knowledge/iot/voice-recorder/overview.md +64 -0
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +0 -4
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +0 -4
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +0 -4
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -10
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -10
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -10
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +0 -2
- package/resource/knowledge/livekit/faq/error-code.md +0 -2
- package/resource/knowledge/push/config/android/honor.md +16 -1
- package/resource/knowledge/push/config/android/huawei.md +20 -4
- package/resource/knowledge/push/config/android/meizu.md +19 -5
- package/resource/knowledge/push/config/android/vivo.md +20 -1
- package/resource/knowledge/push/config/donut.md +0 -2
- package/resource/knowledge/push/config/harmonyos.md +21 -5
- package/resource/knowledge/push/integration/android.md +0 -5
- package/resource/knowledge/push/integration/donut.md +0 -3
- package/resource/knowledge/push/integration/flutter.md +1 -4
- package/resource/knowledge/push/integration/harmonyos.md +0 -3
- package/resource/knowledge/push/integration/ios.md +0 -3
- package/resource/knowledge/push/integration/react-native.md +0 -5
- package/resource/knowledge/push/integration/uni-app.md +0 -3
- package/resource/knowledge/push/integration/unity.md +0 -3
- package/resource/knowledge/push/integration/unreal-engine.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
- package/resource/knowledge/roomkit/preset/uniapp-app/integration.md +18 -14
- package/resource/knowledge/rtcengine/web/how_to_run_web_sdk_demo.md +0 -2
- package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +30 -0
- package/resource/knowledge/rtcengine/web/plugin/24-advanced-network-quality.md +0 -2
- package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +4 -0
- package/resource/knowledge/trtc/android/TRTCCloud.md +94 -85
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +48 -46
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +48 -48
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +18 -18
- package/resource/knowledge/trtc/android/TXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +90 -90
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +18 -18
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +9 -9
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +47 -47
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +47 -45
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/ios/TRTCCloud.md +93 -93
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +50 -50
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +8 -8
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +9 -9
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +48 -46
- package/server-config.js +8 -9
- package/server.js +1 -1
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +1 -1
- package/tools/common/search_trtc_knowledge.js +22 -3
- package/tools/definitions/search_trtc_knowledge_def.js +3 -2
- package/utils/preflight-route.js +19 -2
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- android
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
TXIoTMonitorSession 负责拉取设备实时监控画面,包括开始/停止会话、远端拉流与清晰度切换、与设备进行对讲、云台控制、截图与本地录制。TXIoTMonitorSession 通过 TXIoTEngine.getMonitorSession 获取实例,需在登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 回调模型:所有 Listener 回调在主线程触发,公共类型与错误码定义见 TXIoTEngineDef。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|addListener|添加实时监控事件监听器。|
|
|
24
|
+
|removeListener|移除实时监控事件监听器。|
|
|
25
|
+
|startSession|开启实时监控。|
|
|
26
|
+
|stopSession|停止实时监控。|
|
|
27
|
+
|startRemoteView|开始渲染远端视频流。|
|
|
28
|
+
|stopRemoteView|停止渲染远端视频流。|
|
|
29
|
+
|switchRemoteStream|切换远端视频流类型(高清/标清)。|
|
|
30
|
+
|muteRemoteAudio|静音/取消静音单路远端音频。|
|
|
31
|
+
|muteAllRemoteAudio|静音/取消静音所有远端音频。|
|
|
32
|
+
|startLocalAudio|开启本地音频采集和推送(用于实现对讲功能)。|
|
|
33
|
+
|stopLocalAudio|关闭本地音频采集和推送。|
|
|
34
|
+
|muteLocalAudio|静音/取消静音本地音频。|
|
|
35
|
+
|startLocalVideo|开启本地视频采集和推送。|
|
|
36
|
+
|stopLocalVideo|关闭本地视频采集和推送。|
|
|
37
|
+
|sendPTZCommand|发送云台控制指令。|
|
|
38
|
+
|takeSnapshot|对当前正在观看的通道进行截图。|
|
|
39
|
+
|startLocalRecording|开始对当前正在观看的通道进行录像。|
|
|
40
|
+
|stopLocalRecording|停止本地录像。|
|
|
41
|
+
|
|
42
|
+
### addListener
|
|
43
|
+
|
|
44
|
+
**添加实时监控事件监听器**
|
|
45
|
+
|
|
46
|
+
|参数|描述|
|
|
47
|
+
|---------|---------|
|
|
48
|
+
|listener|`TXIoTMonitorSessionListener`;监听器实例。|
|
|
49
|
+
|
|
50
|
+
### removeListener
|
|
51
|
+
|
|
52
|
+
**移除实时监控事件监听器**
|
|
53
|
+
|
|
54
|
+
|参数|描述|
|
|
55
|
+
|---------|---------|
|
|
56
|
+
|listener|`TXIoTMonitorSessionListener`;监听器实例。|
|
|
57
|
+
|
|
58
|
+
### startSession
|
|
59
|
+
|
|
60
|
+
**开启实时监控**
|
|
61
|
+
|
|
62
|
+
|参数|描述|
|
|
63
|
+
|---------|---------|
|
|
64
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
65
|
+
|
|
66
|
+
### stopSession
|
|
67
|
+
|
|
68
|
+
**停止实时监控**
|
|
69
|
+
|
|
70
|
+
### startRemoteView
|
|
71
|
+
|
|
72
|
+
**开始渲染远端视频流**
|
|
73
|
+
|
|
74
|
+
|参数|描述|
|
|
75
|
+
|---------|---------|
|
|
76
|
+
|channelId|`int`;通道 ID。|
|
|
77
|
+
|streamType|TXIoTStreamType;视频流类型(高清/标清)。|
|
|
78
|
+
|view|`TXCloudVideoView`;视频渲染视图。|
|
|
79
|
+
|
|
80
|
+
### stopRemoteView
|
|
81
|
+
|
|
82
|
+
**停止渲染远端视频流**
|
|
83
|
+
|
|
84
|
+
|参数|描述|
|
|
85
|
+
|---------|---------|
|
|
86
|
+
|channelId|`int`;通道 ID。|
|
|
87
|
+
|
|
88
|
+
### switchRemoteStream
|
|
89
|
+
|
|
90
|
+
**切换远端视频流类型(高清/标清)**
|
|
91
|
+
|
|
92
|
+
|参数|描述|
|
|
93
|
+
|---------|---------|
|
|
94
|
+
|channelId|`int`;通道 ID。|
|
|
95
|
+
|streamType|TXIoTStreamType;视频流类型(高清/标清)。|
|
|
96
|
+
|
|
97
|
+
### muteRemoteAudio
|
|
98
|
+
|
|
99
|
+
**静音/取消静音单路远端音频**
|
|
100
|
+
|
|
101
|
+
|参数|描述|
|
|
102
|
+
|---------|---------|
|
|
103
|
+
|channelId|`int`;通道 ID。|
|
|
104
|
+
|mute|`boolean`;是否静音。|
|
|
105
|
+
|
|
106
|
+
### muteAllRemoteAudio
|
|
107
|
+
|
|
108
|
+
**静音/取消静音所有远端音频**
|
|
109
|
+
|
|
110
|
+
|参数|描述|
|
|
111
|
+
|---------|---------|
|
|
112
|
+
|mute|`boolean`;是否静音。|
|
|
113
|
+
|
|
114
|
+
### startLocalAudio
|
|
115
|
+
|
|
116
|
+
**开启本地音频采集和推送(用于实现对讲功能)**
|
|
117
|
+
|
|
118
|
+
### stopLocalAudio
|
|
119
|
+
|
|
120
|
+
**停止本地音频采集和推送**
|
|
121
|
+
|
|
122
|
+
### muteLocalAudio
|
|
123
|
+
|
|
124
|
+
**静音/取消静音本地音频**
|
|
125
|
+
|
|
126
|
+
|参数|描述|
|
|
127
|
+
|---------|---------|
|
|
128
|
+
|mute|`boolean`;是否静音。|
|
|
129
|
+
|
|
130
|
+
### startLocalVideo
|
|
131
|
+
|
|
132
|
+
**开启本地视频采集和推送**
|
|
133
|
+
|
|
134
|
+
|参数|描述|
|
|
135
|
+
|---------|---------|
|
|
136
|
+
|view|`TXCloudVideoView`;视频渲染视图。|
|
|
137
|
+
|videoEncoderParams|TXIoTVideoEncoderParams;视频编码参数。|
|
|
138
|
+
|
|
139
|
+
### stopLocalVideo
|
|
140
|
+
|
|
141
|
+
**停止本地视频采集和推送**
|
|
142
|
+
|
|
143
|
+
### sendPTZCommand
|
|
144
|
+
|
|
145
|
+
**发送云台控制指令**
|
|
146
|
+
|
|
147
|
+
|参数|描述|
|
|
148
|
+
|---------|---------|
|
|
149
|
+
|channelId|`int`;通道 ID。|
|
|
150
|
+
|command|TXIoTPTZCommand;云台控制指令。|
|
|
151
|
+
|speed|`int`;云台运动速度。|
|
|
152
|
+
|
|
153
|
+
### takeSnapshot
|
|
154
|
+
|
|
155
|
+
**对当前正在观看的通道进行截图**
|
|
156
|
+
|
|
157
|
+
|参数|描述|
|
|
158
|
+
|---------|---------|
|
|
159
|
+
|channelId|`int`;通道 ID。|
|
|
160
|
+
|
|
161
|
+
### startLocalRecording
|
|
162
|
+
|
|
163
|
+
**开始对当前正在观看的通道进行录像**
|
|
164
|
+
|
|
165
|
+
|参数|描述|
|
|
166
|
+
|---------|---------|
|
|
167
|
+
|channelId|`int`;通道 ID。|
|
|
168
|
+
|params|TXIoTLocalRecordingParams;本地录像参数。|
|
|
169
|
+
|
|
170
|
+
### stopLocalRecording
|
|
171
|
+
|
|
172
|
+
**停止本地录像**
|
|
173
|
+
|
|
174
|
+
|参数|描述|
|
|
175
|
+
|---------|---------|
|
|
176
|
+
|channelId|`int`;通道 ID。|
|
|
177
|
+
|
|
178
|
+
## 监控事件回调
|
|
179
|
+
|
|
180
|
+
|回调方法|说明|
|
|
181
|
+
|---------|---------|
|
|
182
|
+
|`onError(int channelId, TXIoTErrorCode errCode, String errMsg)`|监控发生错误。|
|
|
183
|
+
|`onSessionEstablished()`|监控会话建立成功。|
|
|
184
|
+
|`onSessionReconnecting()`|会话重连中。|
|
|
185
|
+
|`onSessionRecovery()`|会话恢复成功。|
|
|
186
|
+
|`onRemoteStreamAvailable(int channelId, boolean available)`|远端流可用性变化。|
|
|
187
|
+
|`onRenderFirstFrame(int channelId)`|首帧渲染完成。|
|
|
188
|
+
|`onPlayStateChanged(int channelId, TXIoTPlayState state)`|播放状态变化。|
|
|
189
|
+
|`onSnapshotComplete(int channelId, Bitmap image, TXIoTErrorCode errCode)`|截图完成,成功时 image 非 null。|
|
|
190
|
+
|`onLocalRecordBegin(int channelId, TXIoTErrorCode errCode, String storagePath)`|本地录像开始。|
|
|
191
|
+
|`onLocalRecording(int channelId, long durationMs, String storagePath)`|本地录像进行中,周期性回调时长。|
|
|
192
|
+
|`onLocalRecordComplete(int channelId, TXIoTErrorCode errCode, String storagePath)`|本地录像完成。|
|
|
193
|
+
|
|
194
|
+
## 监控相关数据结构与枚举
|
|
195
|
+
|
|
196
|
+
### TXIoTStreamType
|
|
197
|
+
|
|
198
|
+
|枚举|说明|
|
|
199
|
+
|---------|---------|
|
|
200
|
+
|HD|高清|
|
|
201
|
+
|SD|标清|
|
|
202
|
+
|
|
203
|
+
### TXIoTPTZCommand
|
|
204
|
+
|
|
205
|
+
|枚举|说明|
|
|
206
|
+
|---------|---------|
|
|
207
|
+
|UP|上|
|
|
208
|
+
|DOWN|下|
|
|
209
|
+
|LEFT|左|
|
|
210
|
+
|RIGHT|右|
|
|
211
|
+
|ZOOM_IN|变焦放大|
|
|
212
|
+
|ZOOM_OUT|变焦缩小|
|
|
213
|
+
|STOP|停止|
|
|
214
|
+
|
|
215
|
+
### TXIoTPlayState
|
|
216
|
+
|
|
217
|
+
|枚举|说明|
|
|
218
|
+
|---------|---------|
|
|
219
|
+
|PLAYING|正在播放|
|
|
220
|
+
|LOADING|加载中|
|
|
221
|
+
|STOPPED|已停止|
|
|
222
|
+
|
|
223
|
+
### TXIoTVideoResolution
|
|
224
|
+
|
|
225
|
+
|枚举|说明|
|
|
226
|
+
|---------|---------|
|
|
227
|
+
|RESOLUTION_640_360|横屏 640×360|
|
|
228
|
+
|RESOLUTION_960_540|横屏 960×540|
|
|
229
|
+
|RESOLUTION_1280_720|横屏 1280×720|
|
|
230
|
+
|RESOLUTION_1920_1080|横屏 1920×1080|
|
|
231
|
+
|RESOLUTION_360_640|竖屏 360×640|
|
|
232
|
+
|RESOLUTION_540_960|竖屏 540×960|
|
|
233
|
+
|RESOLUTION_720_1280|竖屏 720×1280|
|
|
234
|
+
|RESOLUTION_1080_1920|竖屏 1080×1920|
|
|
235
|
+
|
|
236
|
+
### TXIoTVideoEncoderParams
|
|
237
|
+
|
|
238
|
+
|字段|说明|
|
|
239
|
+
|---------|---------|
|
|
240
|
+
|resolution|视频编码分辨率。|
|
|
241
|
+
|
|
242
|
+
### TXIoTLocalRecordingParams
|
|
243
|
+
|
|
244
|
+
|字段|说明|
|
|
245
|
+
|---------|---------|
|
|
246
|
+
|filePath|录像文件保存路径。|
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- harmonyos
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
TXIoTCallSession 负责与设备之间的音视频通话,包括发起呼叫、挂断、远端画面渲染、麦克风/摄像头控制及音频输出设备选择。TXIoTCallSession 通过 TXIoTEngine.getCallSession 获取实例,需在登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 回调模型:通话事件通过 `TXIoTCallListener` 接口回调,所有 Listener 回调在主线程触发,公共类型与错误码定义见 TXIoTEngineDef。渲染视图参数 `TXView` 为 `string` 类型,传 ArkUI `XComponent` 组件的 id(该 XComponent 需设置 `type: XComponentType.SURFACE`、`libraryname: 'liteavsdk'`)。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|`addListener`|添加通话事件监听器。|
|
|
24
|
+
|`removeListener`|移除通话事件监听器。|
|
|
25
|
+
|`callDevice`|向设备发起通话(音频/视频)。|
|
|
26
|
+
|`hangup`|挂断当前通话。|
|
|
27
|
+
|`startRemoteView`|开始渲染远端视频。|
|
|
28
|
+
|`stopRemoteView`|停止渲染远端视频。|
|
|
29
|
+
|`openMicrophone`|打开麦克风。|
|
|
30
|
+
|`closeMicrophone`|关闭麦克风。|
|
|
31
|
+
|`openCamera`|打开摄像头并设置本地预览视图。|
|
|
32
|
+
|`closeCamera`|关闭摄像头。|
|
|
33
|
+
|`switchCamera`|切换摄像头(前后置)。|
|
|
34
|
+
|`selectAudioPlaybackDevice`|选择音频播放设备(扬声器/听筒)。|
|
|
35
|
+
|
|
36
|
+
### addListener
|
|
37
|
+
|
|
38
|
+
**添加通话事件监听器**
|
|
39
|
+
|
|
40
|
+
|参数|描述|
|
|
41
|
+
|---------|---------|
|
|
42
|
+
|listener|`TXIoTCallListener`;监听器实例。|
|
|
43
|
+
|
|
44
|
+
### removeListener
|
|
45
|
+
|
|
46
|
+
**移除通话事件监听器**
|
|
47
|
+
|
|
48
|
+
|参数|描述|
|
|
49
|
+
|---------|---------|
|
|
50
|
+
|listener|`TXIoTCallListener`;监听器实例。|
|
|
51
|
+
|
|
52
|
+
### callDevice
|
|
53
|
+
|
|
54
|
+
**向设备发起通话(音频/视频)**
|
|
55
|
+
|
|
56
|
+
|参数|描述|
|
|
57
|
+
|---------|---------|
|
|
58
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
59
|
+
|callType|`TXIoTCallMediaType`;通话类型(音频/视频)。|
|
|
60
|
+
|
|
61
|
+
### hangup
|
|
62
|
+
|
|
63
|
+
**挂断当前进行中的通话**
|
|
64
|
+
|
|
65
|
+
### startRemoteView
|
|
66
|
+
|
|
67
|
+
**开始渲染远端视频**
|
|
68
|
+
|
|
69
|
+
|参数|描述|
|
|
70
|
+
|---------|---------|
|
|
71
|
+
|callUser|`TXIoTCallUser`;参与通话的用户。|
|
|
72
|
+
|view|`TXView`(`string`);视频渲染视图,传 XComponent 组件的 id。|
|
|
73
|
+
|
|
74
|
+
### stopRemoteView
|
|
75
|
+
|
|
76
|
+
**停止渲染远端视频**
|
|
77
|
+
|
|
78
|
+
|参数|描述|
|
|
79
|
+
|---------|---------|
|
|
80
|
+
|callUser|`TXIoTCallUser`;参与通话的用户。|
|
|
81
|
+
|
|
82
|
+
### openMicrophone
|
|
83
|
+
|
|
84
|
+
**打开麦克风**
|
|
85
|
+
|
|
86
|
+
### closeMicrophone
|
|
87
|
+
|
|
88
|
+
**关闭麦克风**
|
|
89
|
+
|
|
90
|
+
### openCamera
|
|
91
|
+
|
|
92
|
+
**打开摄像头并设置本地预览视图**
|
|
93
|
+
|
|
94
|
+
|参数|描述|
|
|
95
|
+
|---------|---------|
|
|
96
|
+
|camera|`TXIoTCamera`;摄像头(前置/后置)。|
|
|
97
|
+
|view|`TXView`(`string`);本地预览渲染视图,传 XComponent 组件的 id。|
|
|
98
|
+
|
|
99
|
+
### closeCamera
|
|
100
|
+
|
|
101
|
+
**关闭摄像头**
|
|
102
|
+
|
|
103
|
+
### switchCamera
|
|
104
|
+
|
|
105
|
+
**切换摄像头(前后置)**
|
|
106
|
+
|
|
107
|
+
|参数|描述|
|
|
108
|
+
|---------|---------|
|
|
109
|
+
|camera|`TXIoTCamera`;摄像头(前置/后置)。|
|
|
110
|
+
|
|
111
|
+
### selectAudioPlaybackDevice
|
|
112
|
+
|
|
113
|
+
**选择音频播放设备(扬声器/听筒)**
|
|
114
|
+
|
|
115
|
+
|参数|描述|
|
|
116
|
+
|---------|---------|
|
|
117
|
+
|device|`TXIoTAudioPlaybackDevice`;音频播放设备(扬声器/听筒)。|
|
|
118
|
+
|
|
119
|
+
## 通话事件回调
|
|
120
|
+
|
|
121
|
+
`TXIoTCallListener` 为 ArkTS 接口,所有回调方法均为可选,调用方可按需实现。
|
|
122
|
+
|
|
123
|
+
|回调方法|说明|
|
|
124
|
+
|---------|---------|
|
|
125
|
+
|`onError(code: TXIoTErrorCode, msg: string)`|通话发生错误。|
|
|
126
|
+
|`onCallBegin(mediaType: TXIoTCallMediaType)`|通话开始。|
|
|
127
|
+
|`onCallEnd(mediaType: TXIoTCallMediaType, reason: TXIoTCallEndReason)`|通话结束,携带结束原因。|
|
|
128
|
+
|`onCallRejected(callUser: TXIoTCallUser)`|通话被对方拒接。|
|
|
129
|
+
|`onCallNoResponse(callUser: TXIoTCallUser)`|对方无应答。|
|
|
130
|
+
|`onCallLineBusy(callUser: TXIoTCallUser)`|对方占线。|
|
|
131
|
+
|`onCallUserOffline(callUser: TXIoTCallUser)`|对方离线。|
|
|
132
|
+
|`onCallUserAudioAvailable(callUser: TXIoTCallUser, available: boolean)`|远端用户音频状态发生变化。|
|
|
133
|
+
|`onCallUserVideoAvailable(callUser: TXIoTCallUser, available: boolean)`|远端用户视频状态发生变化。|
|
|
134
|
+
|`onCallNetworkQualityChanged(localQuality: TXIoTQuality, remoteQualityList: TXIoTQuality[])`|网络质量变化通知。|
|
|
135
|
+
|
|
136
|
+
## 通话相关数据结构与枚举
|
|
137
|
+
|
|
138
|
+
### TXIoTCallMediaType
|
|
139
|
+
|
|
140
|
+
|枚举|说明|
|
|
141
|
+
|---------|---------|
|
|
142
|
+
|AUDIO|音频通话。|
|
|
143
|
+
|VIDEO|视频通话。|
|
|
144
|
+
|
|
145
|
+
### TXIoTCallEndReason
|
|
146
|
+
|
|
147
|
+
|枚举|说明|
|
|
148
|
+
|---------|---------|
|
|
149
|
+
|UNKNOWN|未知原因。|
|
|
150
|
+
|LOCAL_HANGUP|本地挂断。|
|
|
151
|
+
|REMOTE_HANGUP|远端挂断。|
|
|
152
|
+
|CALL_PERMISSION_DENIED|呼叫权限被拒绝。|
|
|
153
|
+
|NETWORK_ERROR|网络错误。|
|
|
154
|
+
|
|
155
|
+
### TXIoTAudioPlaybackDevice
|
|
156
|
+
|
|
157
|
+
|枚举|说明|
|
|
158
|
+
|---------|---------|
|
|
159
|
+
|SPEAKER_PHONE|扬声器(外放)。|
|
|
160
|
+
|EAR_PIECE|听筒。|
|
|
161
|
+
|
|
162
|
+
### TXIoTCamera
|
|
163
|
+
|
|
164
|
+
|枚举|说明|
|
|
165
|
+
|---------|---------|
|
|
166
|
+
|FRONT|前置摄像头。|
|
|
167
|
+
|BACK|后置摄像头。|
|
|
168
|
+
|
|
169
|
+
### TXIoTNetworkQuality
|
|
170
|
+
|
|
171
|
+
|枚举|说明|
|
|
172
|
+
|---------|---------|
|
|
173
|
+
|EXCELLENT|极佳。|
|
|
174
|
+
|GOOD|良好。|
|
|
175
|
+
|POOR|较差。|
|
|
176
|
+
|BAD|差。|
|
|
177
|
+
|VERY_BAD|很差。|
|
|
178
|
+
|DOWN|网络不可用。|
|
|
179
|
+
|
|
180
|
+
### TXIoTCallUser
|
|
181
|
+
|
|
182
|
+
|字段|说明|
|
|
183
|
+
|---------|---------|
|
|
184
|
+
|deviceId|参与通话的设备 ID。|
|
|
185
|
+
|
|
186
|
+
### TXIoTQuality
|
|
187
|
+
|
|
188
|
+
|字段|说明|
|
|
189
|
+
|---------|---------|
|
|
190
|
+
|callUser|网络质量对应的通话用户。|
|
|
191
|
+
|quality|网络质量等级,见 `TXIoTNetworkQuality`。|
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- harmonyos
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
`TXIoTCloudStorage` 是云存功能模块,通过 `TXIoTEngine.getCloudStorage(deviceId)` 获取,提供设备云端录像的日期列表与事件列表查询能力。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 线程模型:SDK 接口可在任意线程调用;回调均在主线程(UI 线程)触发,调用方可在回调中直接操作 UI。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|`getDayList`|查询指定通道有云端录像的日期列表。|
|
|
24
|
+
|`getEventList`|分页查询指定日期的云存事件列表。|
|
|
25
|
+
|
|
26
|
+
### getDayList
|
|
27
|
+
|
|
28
|
+
**查询有云端录像的日期列表**
|
|
29
|
+
|
|
30
|
+
|参数|描述|
|
|
31
|
+
|---------|---------|
|
|
32
|
+
|channelId|`number`;通道 ID,从 0 开始计数;单通道设备填 0。|
|
|
33
|
+
|timeZone|`string`;按天统计录像所用的时区,IANA 时区 ID(如 `Asia/Shanghai`),可通过 `i18n.getTimeZone().getID()` 获取系统时区。|
|
|
34
|
+
|callback|`TXIoTCallback<string[]>`;结果回调。onSuccess 返回有云端录像的日期字符串列表,格式为 `yyyy-MM-dd`(如 `2026-08-20`);onError 返回错误码与错误描述。|
|
|
35
|
+
|
|
36
|
+
### getEventList
|
|
37
|
+
|
|
38
|
+
**分页查询指定日期的云存事件列表**
|
|
39
|
+
|
|
40
|
+
|参数|描述|
|
|
41
|
+
|---------|---------|
|
|
42
|
+
|channelId|`number`;通道 ID,从 0 开始计数;单通道设备填 0。|
|
|
43
|
+
|timeZone|`string`;按天统计事件所用的时区,IANA 时区 ID(如 `Asia/Shanghai`)。|
|
|
44
|
+
|date|`string`;要查询的日期,格式为 `yyyy-MM-dd`(如 `2026-08-20`),通常取自 `getDayList` 的返回结果。|
|
|
45
|
+
|nextPageToken|`string`;分页标记。首次查询传空字符串 `""`;翻页时传入上一次回调返回的 `TXIoTPageResult.nextPageToken`。|
|
|
46
|
+
|callback|`TXIoTCallback<TXIoTPageResult<TXIoTEvent>>`;结果回调。onSuccess 返回分页结果,`dataList` 为本页事件列表,`nextPageToken` 为空字符串表示没有更多数据;onError 返回错误码与错误描述。|
|
|
47
|
+
|
|
48
|
+
> **注意:**
|
|
49
|
+
> `date` 不能为空字符串,否则回调 onError 并返回参数错误。
|
|
50
|
+
>
|
|
51
|
+
|
|
52
|
+
## 云存相关数据结构
|
|
53
|
+
|
|
54
|
+
### TXIoTEvent
|
|
55
|
+
|
|
56
|
+
**云存事件,包含事件类型、缩略图、发生时间及关联录像文件**
|
|
57
|
+
|
|
58
|
+
|字段|说明|
|
|
59
|
+
|---------|---------|
|
|
60
|
+
|eventType|事件类型标识,可能为空字符串,调用方可按需过滤。|
|
|
61
|
+
|thumbnailUrl|事件缩略图 URL。|
|
|
62
|
+
|eventTimeMs|事件发生时间,Unix 毫秒级时间戳。|
|
|
63
|
+
|durationMs|事件时长,单位毫秒。|
|
|
64
|
+
|videoFiles|事件关联的录像文件列表,元素类型为 `TXIoTVideoFile`。|
|
|
65
|
+
|
|
66
|
+
### TXIoTVideoFile
|
|
67
|
+
|
|
68
|
+
**云存录像文件,包含播放地址与云点播(VOD)播放信息**
|
|
69
|
+
|
|
70
|
+
|字段|说明|
|
|
71
|
+
|---------|---------|
|
|
72
|
+
|videoUrl|录像文件播放地址。|
|
|
73
|
+
|vodAppId|云点播应用 ID,用于通过 VOD 播放器播放。|
|
|
74
|
+
|vodFileId|云点播文件 ID,用于通过 VOD 播放器播放。|
|
|
75
|
+
|vodPlaySign|云点播播放签名。|
|
|
76
|
+
|startTimeMs|录像片段起始时间,Unix 毫秒级时间戳。|
|
|
77
|
+
|durationMs|录像片段时长,单位毫秒。|
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- harmonyos
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例,需在登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 设备必须先绑定到家庭后才能进行后续操作。绑定方式有两种:
|
|
17
|
+
>
|
|
18
|
+
> - (1)通过 `bindDevice` 使用设备绑定签名直接绑定。
|
|
19
|
+
> - (2)通过 `bindDeviceSharedWithMe` 接受他人分享的设备。
|
|
20
|
+
|
|
21
|
+
## 方法列表
|
|
22
|
+
|
|
23
|
+
|方法签名|描述|
|
|
24
|
+
|---------|---------|
|
|
25
|
+
|`bindDevice`|绑定设备到家庭。|
|
|
26
|
+
|`unbindDevice`|从家庭解绑设备。|
|
|
27
|
+
|`addDeviceToRoom`|将设备添加到房间。|
|
|
28
|
+
|`removeDeviceFromRoom`|将设备从房间移除。|
|
|
29
|
+
|`getDeviceList`|获取家庭设备列表(支持分页)。|
|
|
30
|
+
|`createDeviceSharingToken`|创建设备分享令牌。|
|
|
31
|
+
|`bindDeviceSharedWithMe`|绑定别人分享给我的设备。|
|
|
32
|
+
|`unbindDeviceSharedWithMe`|取消绑定别人分享给我的设备。|
|
|
33
|
+
|`getDeviceSharedUsers`|获取设备已分享的用户列表。|
|
|
34
|
+
|`removeDeviceSharedUser`|移除设备已分享用户。|
|
|
35
|
+
|`getDeviceListSharedWithMe`|获取别人分享给我的设备列表(支持分页)。|
|
|
36
|
+
|`sendCommand`|向设备发送指令。|
|
|
37
|
+
|`getProperties`|查询设备属性。|
|
|
38
|
+
|`modifyAliasName`|修改设备别名。|
|
|
39
|
+
|
|
40
|
+
### bindDevice
|
|
41
|
+
|
|
42
|
+
**绑定设备到家庭**
|
|
43
|
+
|
|
44
|
+
|参数|描述|
|
|
45
|
+
|---------|---------|
|
|
46
|
+
|familyId|`string`;家庭 ID。|
|
|
47
|
+
|deviceBindSignature|`string`;设备绑定签名。|
|
|
48
|
+
|callback|`TXIoTCallback<TXIoTDeviceInfo>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
49
|
+
|
|
50
|
+
### unbindDevice
|
|
51
|
+
|
|
52
|
+
**从家庭解绑设备**
|
|
53
|
+
|
|
54
|
+
|参数|描述|
|
|
55
|
+
|---------|---------|
|
|
56
|
+
|familyId|`string`;家庭 ID。|
|
|
57
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
58
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
59
|
+
|
|
60
|
+
### addDeviceToRoom
|
|
61
|
+
|
|
62
|
+
**将设备添加到房间**
|
|
63
|
+
|
|
64
|
+
|参数|描述|
|
|
65
|
+
|---------|---------|
|
|
66
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
67
|
+
|familyId|`string`;家庭 ID。|
|
|
68
|
+
|roomId|`string`;房间 ID。|
|
|
69
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
70
|
+
|
|
71
|
+
### removeDeviceFromRoom
|
|
72
|
+
|
|
73
|
+
**将设备从房间移除**
|
|
74
|
+
|
|
75
|
+
|参数|描述|
|
|
76
|
+
|---------|---------|
|
|
77
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
78
|
+
|familyId|`string`;家庭 ID。|
|
|
79
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
80
|
+
|
|
81
|
+
### getDeviceList
|
|
82
|
+
|
|
83
|
+
**获取家庭设备列表(支持分页)**
|
|
84
|
+
|
|
85
|
+
|参数|描述|
|
|
86
|
+
|---------|---------|
|
|
87
|
+
|familyId|`string`;家庭 ID。|
|
|
88
|
+
|nextPageToken|`string`;分页令牌,首次传空字符串 `""`;翻页时传入上一次回调返回的 `TXIoTPageResult.nextPageToken`,为空字符串表示已到最后一页。|
|
|
89
|
+
|callback|`TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
90
|
+
|
|
91
|
+
> **说明:**
|
|
92
|
+
> 返回结果中设备的 `status.isOnline` 已包含查询时刻的在线状态,业务层无需额外查询;该状态为查询时刻快照,实时上下线请通过 `TXIoTEngineListener.onReceivePushMessage` 监听。
|
|
93
|
+
>
|
|
94
|
+
|
|
95
|
+
### createDeviceSharingToken
|
|
96
|
+
|
|
97
|
+
**创建设备分享令牌**
|
|
98
|
+
|
|
99
|
+
|参数|描述|
|
|
100
|
+
|---------|---------|
|
|
101
|
+
|familyId|`string`;家庭 ID。|
|
|
102
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
103
|
+
|callback|`TXIoTCallback<string>`;异步回调,onSuccess 返回分享令牌字符串。|
|
|
104
|
+
|
|
105
|
+
### bindDeviceSharedWithMe
|
|
106
|
+
|
|
107
|
+
**绑定别人分享给我的设备**
|
|
108
|
+
|
|
109
|
+
|参数|描述|
|
|
110
|
+
|---------|---------|
|
|
111
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
112
|
+
|shareToken|`string`;分享令牌。|
|
|
113
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
114
|
+
|
|
115
|
+
### unbindDeviceSharedWithMe
|
|
116
|
+
|
|
117
|
+
**取消绑定别人分享给我的设备**
|
|
118
|
+
|
|
119
|
+
|参数|描述|
|
|
120
|
+
|---------|---------|
|
|
121
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
122
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
123
|
+
|
|
124
|
+
### getDeviceSharedUsers
|
|
125
|
+
|
|
126
|
+
**获取设备已分享的用户列表**
|
|
127
|
+
|
|
128
|
+
|参数|描述|
|
|
129
|
+
|---------|---------|
|
|
130
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
131
|
+
|callback|`TXIoTCallback<TXIoTUserInfo[]>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
132
|
+
|
|
133
|
+
> **注意:**
|
|
134
|
+
> 该接口不支持分页,单次最多返回 100 条用户记录。
|
|
135
|
+
>
|
|
136
|
+
|
|
137
|
+
### removeDeviceSharedUser
|
|
138
|
+
|
|
139
|
+
**移除设备已分享用户**
|
|
140
|
+
|
|
141
|
+
|参数|描述|
|
|
142
|
+
|---------|---------|
|
|
143
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
144
|
+
|userId|`string`;用户 ID,取 `getDeviceSharedUsers` 返回的 `TXIoTUserInfo.userId` 原值。|
|
|
145
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
146
|
+
|
|
147
|
+
### getDeviceListSharedWithMe
|
|
148
|
+
|
|
149
|
+
**获取别人分享给我的设备列表(支持分页)**
|
|
150
|
+
|
|
151
|
+
|参数|描述|
|
|
152
|
+
|---------|---------|
|
|
153
|
+
|nextPageToken|`string`;分页令牌,首次传空字符串 `""`;翻页时传入上一次回调返回的 `TXIoTPageResult.nextPageToken`,为空字符串表示已到最后一页。|
|
|
154
|
+
|callback|`TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
155
|
+
|
|
156
|
+
### sendCommand
|
|
157
|
+
|
|
158
|
+
**向设备发送指令**
|
|
159
|
+
|
|
160
|
+
|参数|描述|
|
|
161
|
+
|---------|---------|
|
|
162
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
163
|
+
|jsonData|`string`;JSON 格式的指令数据。|
|
|
164
|
+
|callback|`TXIoTCallback<string>`;异步回调,通过 onSuccess / onError 通知结果。|
|
|
165
|
+
|
|
166
|
+
### getProperties
|
|
167
|
+
|
|
168
|
+
**查询设备属性**
|
|
169
|
+
|
|
170
|
+
|参数|描述|
|
|
171
|
+
|---------|---------|
|
|
172
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
173
|
+
|callback|`TXIoTCallback<string>`;异步回调,onSuccess 返回 JSON 格式的设备属性数据。|
|
|
174
|
+
|
|
175
|
+
### modifyAliasName
|
|
176
|
+
|
|
177
|
+
**修改设备别名**
|
|
178
|
+
|
|
179
|
+
|参数|描述|
|
|
180
|
+
|---------|---------|
|
|
181
|
+
|deviceId|TXIoTDeviceId;设备标识(含 productId / deviceName)。|
|
|
182
|
+
|aliasName|`string`;设备别名。|
|
|
183
|
+
|callback|`TXIoTCallback<void>`;异步回调,通过 onSuccess / onError 通知结果。|
|