@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,252 @@
|
|
|
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
|
+
TXIoTMonitorSession 负责拉取设备实时监控画面,包括开始/停止会话、远端拉流与清晰度切换、与设备进行对讲、云台控制、截图与本地录制。TXIoTMonitorSession 通过 TXIoTEngine.getMonitorSession 获取实例,需在登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 回调模型:所有 Listener 回调在主线程触发,公共类型与错误码定义见 TXIoTEngineDef。渲染视图参数 `TXView` 为 `string` 类型,传 ArkUI `XComponent` 组件的 id(该 XComponent 需设置 `type: XComponentType.SURFACE`、`libraryname: 'liteavsdk'`)。
|
|
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|`number`;通道 ID,从 0 开始计数;单通道设备填 0。|
|
|
77
|
+
|streamType|`TXIoTStreamType`;视频流类型(高清/标清)。|
|
|
78
|
+
|view|`TXView`(`string`);视频渲染视图,传 XComponent 组件的 id。|
|
|
79
|
+
|
|
80
|
+
### stopRemoteView
|
|
81
|
+
|
|
82
|
+
**停止渲染远端视频流**
|
|
83
|
+
|
|
84
|
+
|参数|描述|
|
|
85
|
+
|---------|---------|
|
|
86
|
+
|channelId|`number`;通道 ID。|
|
|
87
|
+
|
|
88
|
+
### switchRemoteStream
|
|
89
|
+
|
|
90
|
+
**切换远端视频流类型(高清/标清)**
|
|
91
|
+
|
|
92
|
+
|参数|描述|
|
|
93
|
+
|---------|---------|
|
|
94
|
+
|channelId|`number`;通道 ID。|
|
|
95
|
+
|streamType|`TXIoTStreamType`;视频流类型(高清/标清)。|
|
|
96
|
+
|
|
97
|
+
### muteRemoteAudio
|
|
98
|
+
|
|
99
|
+
**静音/取消静音单路远端音频**
|
|
100
|
+
|
|
101
|
+
|参数|描述|
|
|
102
|
+
|---------|---------|
|
|
103
|
+
|channelId|`number`;通道 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|`TXView`(`string`);本地预览渲染视图,传 XComponent 组件的 id。|
|
|
137
|
+
|videoEncoderParams|`TXIoTVideoEncoderParams`;视频编码参数。|
|
|
138
|
+
|
|
139
|
+
### stopLocalVideo
|
|
140
|
+
|
|
141
|
+
**停止本地视频采集和推送**
|
|
142
|
+
|
|
143
|
+
### sendPTZCommand
|
|
144
|
+
|
|
145
|
+
**发送云台控制指令**
|
|
146
|
+
|
|
147
|
+
|参数|描述|
|
|
148
|
+
|---------|---------|
|
|
149
|
+
|channelId|`number`;通道 ID。|
|
|
150
|
+
|command|`TXIoTPTZCommand`;云台控制指令。|
|
|
151
|
+
|speed|`number`;云台运动速度。|
|
|
152
|
+
|
|
153
|
+
### takeSnapshot
|
|
154
|
+
|
|
155
|
+
**对当前正在观看的通道进行截图**
|
|
156
|
+
|
|
157
|
+
|参数|描述|
|
|
158
|
+
|---------|---------|
|
|
159
|
+
|channelId|`number`;通道 ID。|
|
|
160
|
+
|
|
161
|
+
> **说明:**
|
|
162
|
+
> 截图结果通过 `onSnapshotComplete` 回调返回,成功时 `image` 为 `image.PixelMap` 对象(`@ohos.multimedia.image`),失败时为 `null`。
|
|
163
|
+
>
|
|
164
|
+
|
|
165
|
+
### startLocalRecording
|
|
166
|
+
|
|
167
|
+
**开始对当前正在观看的通道进行录像**
|
|
168
|
+
|
|
169
|
+
|参数|描述|
|
|
170
|
+
|---------|---------|
|
|
171
|
+
|channelId|`number`;通道 ID。|
|
|
172
|
+
|params|`TXIoTLocalRecordingParams`;本地录像参数。|
|
|
173
|
+
|
|
174
|
+
### stopLocalRecording
|
|
175
|
+
|
|
176
|
+
**停止本地录像**
|
|
177
|
+
|
|
178
|
+
|参数|描述|
|
|
179
|
+
|---------|---------|
|
|
180
|
+
|channelId|`number`;通道 ID。|
|
|
181
|
+
|
|
182
|
+
## 监控事件回调
|
|
183
|
+
|
|
184
|
+
`TXIoTMonitorSessionListener` 为 ArkTS 接口,所有回调方法均为可选,调用方可按需实现。
|
|
185
|
+
|
|
186
|
+
|回调方法|说明|
|
|
187
|
+
|---------|---------|
|
|
188
|
+
|`onError(channelId: number, errCode: TXIoTErrorCode, errMsg: string)`|监控发生错误。|
|
|
189
|
+
|`onSessionEstablished()`|监控会话建立成功。|
|
|
190
|
+
|`onSessionReconnecting()`|会话重连中。|
|
|
191
|
+
|`onSessionRecovery()`|会话恢复成功。|
|
|
192
|
+
|`onRemoteStreamAvailable(channelId: number, available: boolean)`|远端流可用性变化。|
|
|
193
|
+
|`onRenderFirstFrame(channelId: number)`|首帧渲染完成。|
|
|
194
|
+
|`onPlayStateChanged(channelId: number, state: TXIoTPlayState)`|播放状态变化。|
|
|
195
|
+
|`onSnapshotComplete(channelId: number, image: image.PixelMap \| null, errCode: TXIoTErrorCode)`|截图完成,成功时 image 非 null。|
|
|
196
|
+
|`onLocalRecordBegin(channelId: number, errCode: TXIoTErrorCode, storagePath: string)`|本地录像开始。|
|
|
197
|
+
|`onLocalRecording(channelId: number, durationMs: number, storagePath: string)`|本地录像进行中,周期性回调时长(单位:毫秒)。|
|
|
198
|
+
|`onLocalRecordComplete(channelId: number, errCode: TXIoTErrorCode, storagePath: string)`|本地录像完成。|
|
|
199
|
+
|
|
200
|
+
## 监控相关数据结构与枚举
|
|
201
|
+
|
|
202
|
+
### TXIoTStreamType
|
|
203
|
+
|
|
204
|
+
|枚举|说明|
|
|
205
|
+
|---------|---------|
|
|
206
|
+
|HD|高清。|
|
|
207
|
+
|SD|标清。|
|
|
208
|
+
|
|
209
|
+
### TXIoTPTZCommand
|
|
210
|
+
|
|
211
|
+
|枚举|说明|
|
|
212
|
+
|---------|---------|
|
|
213
|
+
|UP|上。|
|
|
214
|
+
|DOWN|下。|
|
|
215
|
+
|LEFT|左。|
|
|
216
|
+
|RIGHT|右。|
|
|
217
|
+
|ZOOM_IN|变焦放大。|
|
|
218
|
+
|ZOOM_OUT|变焦缩小。|
|
|
219
|
+
|STOP|停止。|
|
|
220
|
+
|
|
221
|
+
### TXIoTPlayState
|
|
222
|
+
|
|
223
|
+
|枚举|说明|
|
|
224
|
+
|---------|---------|
|
|
225
|
+
|PLAYING|正在播放。|
|
|
226
|
+
|LOADING|加载中。|
|
|
227
|
+
|STOPPED|已停止。|
|
|
228
|
+
|
|
229
|
+
### TXIoTVideoResolution
|
|
230
|
+
|
|
231
|
+
|枚举|说明|
|
|
232
|
+
|---------|---------|
|
|
233
|
+
|RESOLUTION_640_360|横屏 640×360。|
|
|
234
|
+
|RESOLUTION_960_540|横屏 960×540。|
|
|
235
|
+
|RESOLUTION_1280_720|横屏 1280×720。|
|
|
236
|
+
|RESOLUTION_1920_1080|横屏 1920×1080。|
|
|
237
|
+
|RESOLUTION_360_640|竖屏 360×640。|
|
|
238
|
+
|RESOLUTION_540_960|竖屏 540×960。|
|
|
239
|
+
|RESOLUTION_720_1280|竖屏 720×1280。|
|
|
240
|
+
|RESOLUTION_1080_1920|竖屏 1080×1920。|
|
|
241
|
+
|
|
242
|
+
### TXIoTVideoEncoderParams
|
|
243
|
+
|
|
244
|
+
|字段|说明|
|
|
245
|
+
|---------|---------|
|
|
246
|
+
|resolution|视频编码分辨率,见 `TXIoTVideoResolution`,默认为 RESOLUTION_640_360。|
|
|
247
|
+
|
|
248
|
+
### TXIoTLocalRecordingParams
|
|
249
|
+
|
|
250
|
+
|字段|说明|
|
|
251
|
+
|---------|---------|
|
|
252
|
+
|filePath|录像文件保存路径。|
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- ios
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
TXIoTCallSession 负责与设备之间的音视频通话,包括发起呼叫、挂断、远端画面渲染、麦克风/摄像头控制及音频输出设备选择。TXIoTCallSession 通过 TXIoTEngine.getCallSession 获取实例,需在 TXIoTEngine 登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 回调模型:通话事件通过 `TXIoTCallDelegate` 协议回调,所有 Delegate 回调在主线程触发。公共类型与错误码定义见 TXIoTEngineDef。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|addDelegate:|添加通话事件代理。|
|
|
24
|
+
|removeDelegate:|移除通话事件代理。|
|
|
25
|
+
|callDevice:callType:|向设备发起音视频通话。|
|
|
26
|
+
|hangup|挂断当前通话。|
|
|
27
|
+
|startRemoteView:view:|开始远端画面渲染。|
|
|
28
|
+
|stopRemoteView:|停止远端画面渲染。|
|
|
29
|
+
|openMicrophone|打开麦克风。|
|
|
30
|
+
|closeMicrophone|关闭麦克风。|
|
|
31
|
+
|openCamera:view:|打开摄像头。|
|
|
32
|
+
|closeCamera|关闭摄像头。|
|
|
33
|
+
|switchCamera:|切换摄像头。|
|
|
34
|
+
|selectAudioPlaybackDevice:|选择音频播放设备。|
|
|
35
|
+
|
|
36
|
+
### addDelegate:
|
|
37
|
+
|
|
38
|
+
**添加通话事件代理**
|
|
39
|
+
|
|
40
|
+
|参数|描述|
|
|
41
|
+
|---------|---------|
|
|
42
|
+
|delegate|`id<TXIoTCallDelegate>`;通话事件代理对象。|
|
|
43
|
+
|
|
44
|
+
### removeDelegate:
|
|
45
|
+
|
|
46
|
+
**移除通话事件代理**
|
|
47
|
+
|
|
48
|
+
|参数|描述|
|
|
49
|
+
|---------|---------|
|
|
50
|
+
|delegate|`id<TXIoTCallDelegate>`;要移除的通话事件代理对象。|
|
|
51
|
+
|
|
52
|
+
### callDevice:callType:
|
|
53
|
+
|
|
54
|
+
**向设备发起音视频通话**
|
|
55
|
+
|
|
56
|
+
|参数|描述|
|
|
57
|
+
|---------|---------|
|
|
58
|
+
|deviceId|TXIoTDeviceId*;目标设备 ID。|
|
|
59
|
+
|callType|TXIoTCallMediaType;通话类型:音频或视频。|
|
|
60
|
+
|
|
61
|
+
### hangup
|
|
62
|
+
|
|
63
|
+
**挂断当前通话**
|
|
64
|
+
|
|
65
|
+
### startRemoteView:view:
|
|
66
|
+
|
|
67
|
+
**开始渲染远端画面**
|
|
68
|
+
|
|
69
|
+
|参数|描述|
|
|
70
|
+
|---------|---------|
|
|
71
|
+
|callUser|TXIoTCallUser*;通话用户对象。|
|
|
72
|
+
|view|`TXView*`;用于渲染远端画面的视图。|
|
|
73
|
+
|
|
74
|
+
### stopRemoteView:
|
|
75
|
+
|
|
76
|
+
**停止远端画面渲染**
|
|
77
|
+
|
|
78
|
+
|参数|描述|
|
|
79
|
+
|---------|---------|
|
|
80
|
+
|callUser|TXIoTCallUser*;参与本次通话的用户对象。|
|
|
81
|
+
|
|
82
|
+
### openMicrophone
|
|
83
|
+
|
|
84
|
+
**打开麦克风**
|
|
85
|
+
|
|
86
|
+
### closeMicrophone
|
|
87
|
+
|
|
88
|
+
**关闭麦克风**
|
|
89
|
+
|
|
90
|
+
### openCamera:view:
|
|
91
|
+
|
|
92
|
+
**打开摄像头**
|
|
93
|
+
|
|
94
|
+
|参数|描述|
|
|
95
|
+
|---------|---------|
|
|
96
|
+
|camera|TXIoTCamera;摄像头类型:前置或后置。|
|
|
97
|
+
|view|`TXView*`;用于渲染本地画面的视图。|
|
|
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
|
+
`TXIoTCallDelegate` 协议定义通话事件回调,所有方法均为 `@optional`。
|
|
122
|
+
|
|
123
|
+
|回调|说明|
|
|
124
|
+
|---------|---------|
|
|
125
|
+
|onError:errorMessage:|通话过程中发生错误,错误码见 TXIoTErrorCode。|
|
|
126
|
+
|onCallBegin:|通话开始,返回通话类型(音频/视频)。|
|
|
127
|
+
|onCallEnd:reason:|通话结束,返回挂断原因。|
|
|
128
|
+
|onCallRejected:|对方拒绝接听。|
|
|
129
|
+
|onCallNoResponse:|对方无响应。|
|
|
130
|
+
|onCallLineBusy:|对方线路忙。|
|
|
131
|
+
|onCallUserOffline:|对方不在线。|
|
|
132
|
+
|onCallUserAudioAvailable:available:|远端音频可用性变化。|
|
|
133
|
+
|onCallUserVideoAvailable:available:|远端视频可用性变化。|
|
|
134
|
+
|onCallNetworkQualityChanged:remoteQualityList:|网络质量变化通知。|
|
|
135
|
+
|
|
136
|
+
## 通话相关数据结构与枚举
|
|
137
|
+
|
|
138
|
+
### TXIoTCallUser
|
|
139
|
+
|
|
140
|
+
参与通话的用户信息,用于标识通话对端。
|
|
141
|
+
|
|
142
|
+
|字段|说明|
|
|
143
|
+
|---------|---------|
|
|
144
|
+
|deviceId|通话对端的设备 ID。|
|
|
145
|
+
|
|
146
|
+
### TXIoTQuality
|
|
147
|
+
|
|
148
|
+
网络质量信息。
|
|
149
|
+
|
|
150
|
+
|字段|说明|
|
|
151
|
+
|---------|---------|
|
|
152
|
+
|callUser|网络质量对应的通话用户。|
|
|
153
|
+
|quality|网络质量等级。|
|
|
154
|
+
|
|
155
|
+
### TXIoTCallMediaType
|
|
156
|
+
|
|
157
|
+
通话类型枚举。
|
|
158
|
+
|
|
159
|
+
|枚举|取值|说明|
|
|
160
|
+
|---------|---------|---------|
|
|
161
|
+
|TXIoTCallMediaTypeAudio|0|音频通话。|
|
|
162
|
+
|TXIoTCallMediaTypeVideo|1|视频通话。|
|
|
163
|
+
|
|
164
|
+
### TXIoTCallEndReason
|
|
165
|
+
|
|
166
|
+
通话结束原因枚举。
|
|
167
|
+
|
|
168
|
+
|枚举|取值|说明|
|
|
169
|
+
|---------|---------|---------|
|
|
170
|
+
|TXIoTCallEndReasonUnknown|0|未知原因。|
|
|
171
|
+
|TXIoTCallEndReasonLocalHangup|1|本地挂断。|
|
|
172
|
+
|TXIoTCallEndReasonRemoteHangup|2|远端挂断。|
|
|
173
|
+
|TXIoTCallEndReasonCallPermissionDenied|3|呼叫权限被拒绝。|
|
|
174
|
+
|TXIoTCallEndReasonNetworkError|4|网络错误。|
|
|
175
|
+
|
|
176
|
+
### TXIoTAudioPlaybackDevice
|
|
177
|
+
|
|
178
|
+
|枚举|取值|说明|
|
|
179
|
+
|---------|---------|---------|
|
|
180
|
+
|TXIoTAudioPlaybackDeviceSpeakerphone|0|扬声器(外放)。|
|
|
181
|
+
|TXIoTAudioPlaybackDeviceEarpiece|1|听筒。|
|
|
182
|
+
|
|
183
|
+
### TXIoTCamera
|
|
184
|
+
|
|
185
|
+
|枚举|取值|说明|
|
|
186
|
+
|---------|---------|---------|
|
|
187
|
+
|TXIoTCameraFront|0|前置摄像头。|
|
|
188
|
+
|TXIoTCameraBack|1|后置摄像头。|
|
|
189
|
+
|
|
190
|
+
### TXIoTNetworkQuality
|
|
191
|
+
|
|
192
|
+
|枚举|取值|说明|
|
|
193
|
+
|---------|---------|---------|
|
|
194
|
+
|TXIoTNetworkQualityExcellent|0|极佳|
|
|
195
|
+
|TXIoTNetworkQualityGood|1|良好|
|
|
196
|
+
|TXIoTNetworkQualityPoor|2|较差|
|
|
197
|
+
|TXIoTNetworkQualityBad|3|差|
|
|
198
|
+
|TXIoTNetworkQualityVeryBad|4|很差|
|
|
199
|
+
|TXIoTNetworkQualityDown|5|网络不可用|
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- ios
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
`TXIoTCloudStorage` 是云存功能模块,通过 `TXIoTEngine` 的 `getCloudStorage`获取(未登录时返回`nil`,提供设备云端录像的日期列表与事件列表查询能力。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 线程模型:SDK 接口可在任意线程调用;回调均在主线程(UI 线程)触发,调用方可在回调中直接操作 UI。查询结果通过 `TXIoTCallback` 对象的 `onSuccess` / `onError` block 返回。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|`getDayList:timeZone:callback:`|查询指定通道有云端录像的日期列表。|
|
|
24
|
+
|`getEventList:timeZone:date:nextPageToken:callback:`|分页查询指定日期的云存事件列表。|
|
|
25
|
+
|
|
26
|
+
### getDayList
|
|
27
|
+
|
|
28
|
+
**查询有云端录像的日期列表**
|
|
29
|
+
|
|
30
|
+
|参数|描述|
|
|
31
|
+
|---------|---------|
|
|
32
|
+
|channelId|通道 ID,从 0 开始计数;单通道设备填 0。|
|
|
33
|
+
|timeZone|按天统计录像所用的时区,如 `[NSTimeZone localTimeZone]`。传 `nil` 时使用系统默认时区。|
|
|
34
|
+
|callback|结果回调。`onSuccess` 返回有云端录像的日期字符串数组,格式为 `yyyy-MM-dd`(如 `2026-08-20`);`onError` 返回错误码与错误描述。|
|
|
35
|
+
|
|
36
|
+
### getEventList
|
|
37
|
+
|
|
38
|
+
**分页查询指定日期的云存事件列表**
|
|
39
|
+
|
|
40
|
+
|参数|描述|
|
|
41
|
+
|---------|---------|
|
|
42
|
+
|channelId|通道 ID,从 0 开始计数;单通道设备填 0。|
|
|
43
|
+
|timeZone|按天统计事件所用的时区,如 `[NSTimeZone localTimeZone]`。传 `nil` 时使用系统默认时区。|
|
|
44
|
+
|date|要查询的日期,格式为 `yyyy-MM-dd`(如 `2026-08-20`),通常取自 `getDayList` 的返回结果。|
|
|
45
|
+
|nextPageToken|分页标记。首次查询传空字符串 `@""`;翻页时传入上一次回调返回的 `TXIoTPageResult.nextPageToken`。|
|
|
46
|
+
|callback|结果回调。`onSuccess` 返回分页结果,`dataList` 为本页事件数组,`nextPageToken` 为空字符串表示没有更多数据;`onError` 返回错误码与错误描述。|
|
|
47
|
+
|
|
48
|
+
> **注意:**
|
|
49
|
+
> - `date` 不能为空字符串,否则回调 `onError` 并返回参数错误。
|
|
50
|
+
|
|
51
|
+
## 云存相关数据结构
|
|
52
|
+
|
|
53
|
+
### TXIoTEvent
|
|
54
|
+
|
|
55
|
+
**云存事件,包含事件类型、缩略图、发生时间及关联录像文件**
|
|
56
|
+
|
|
57
|
+
|字段|说明|
|
|
58
|
+
|---------|---------|
|
|
59
|
+
|eventType|事件类型标识,可能为空字符串,调用方可按需过滤。|
|
|
60
|
+
|thumbnailUrl|事件缩略图 URL。|
|
|
61
|
+
|eventTimeMs|事件发生时间,Unix 毫秒级时间戳。|
|
|
62
|
+
|durationMs|事件时长,单位毫秒。|
|
|
63
|
+
|videoFiles|事件关联的录像文件数组。|
|
|
64
|
+
|
|
65
|
+
### TXIoTVideoFile
|
|
66
|
+
|
|
67
|
+
**云存录像文件,包含播放地址与云点播(VOD)播放信息**
|
|
68
|
+
|
|
69
|
+
|字段|说明|
|
|
70
|
+
|---------|---------|
|
|
71
|
+
|videoUrl|录像文件播放地址。|
|
|
72
|
+
|vodAppId|云点播应用 ID,用于通过 VOD 播放器播放。|
|
|
73
|
+
|vodFileId|云点播文件 ID,用于通过 VOD 播放器播放。|
|
|
74
|
+
|vodPlaySign|云点播播放签名。|
|
|
75
|
+
|startTimeMs|录像片段起始时间,Unix 毫秒级时间戳。|
|
|
76
|
+
|durationMs|录像片段时长,单位毫秒。|
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
---
|
|
2
|
+
product: iot
|
|
3
|
+
framework:
|
|
4
|
+
- ios
|
|
5
|
+
types:
|
|
6
|
+
- api
|
|
7
|
+
retrievable_scope: always
|
|
8
|
+
feature_domain: client_api
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 概述
|
|
12
|
+
|
|
13
|
+
TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例,需在 TXIoTEngine 登录成功后调用。
|
|
14
|
+
|
|
15
|
+
> **说明:**
|
|
16
|
+
> 回调模型:所有接口为异步操作,通过 TXIoTCallback / TXIoTVoidCallback 回调返回结果,回调在主线程触发。公共类型定义见 TXIoTEngineDef。
|
|
17
|
+
>
|
|
18
|
+
|
|
19
|
+
## 方法列表
|
|
20
|
+
|
|
21
|
+
|方法签名|描述|
|
|
22
|
+
|---------|---------|
|
|
23
|
+
|bindDevice:deviceBindSignature:callback:|绑定设备到指定家庭。|
|
|
24
|
+
|unbindDevice:deviceId:callback:|从家庭解绑设备。|
|
|
25
|
+
|addDeviceToRoom:familyId:roomId:callback:|将设备加入房间。|
|
|
26
|
+
|removeDeviceFromRoom:familyId:callback:|将设备移出房间。|
|
|
27
|
+
|getDeviceList:nextPageToken:callback:|获取家庭下的设备列表(支持分页)。|
|
|
28
|
+
|createDeviceSharingToken:deviceId:callback:|创建设备分享令牌。|
|
|
29
|
+
|bindDeviceSharedWithMe:shareToken:callback:|绑定他人分享给我的设备。|
|
|
30
|
+
|unbindDeviceSharedWithMe:callback:|解绑他人分享给我的设备。|
|
|
31
|
+
|getDeviceSharedUsers:callback:|获取设备被分享的用户列表。|
|
|
32
|
+
|removeDeviceSharedUser:userId:callback:|移除设备的某个被分享用户。|
|
|
33
|
+
|getDeviceListSharedWithMe:callback:|获取分享给我的设备列表(支持分页)。|
|
|
34
|
+
|sendCommand:jsonData:callback:|向设备下发控制指令。|
|
|
35
|
+
|getProperties:callback:|获取设备属性。|
|
|
36
|
+
|modifyAliasName:aliasName:callback:|修改设备别名。|
|
|
37
|
+
|
|
38
|
+
### bindDevice:deviceBindSignature:callback:
|
|
39
|
+
|
|
40
|
+
**绑定设备到指定家庭**
|
|
41
|
+
|
|
42
|
+
|参数|描述|
|
|
43
|
+
|---------|---------|
|
|
44
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
45
|
+
|deviceBindSignature|`NSString*`;设备绑定签名。|
|
|
46
|
+
|callback|TXIoTCallback<TXIoTDeviceInfo*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回设备信息。|
|
|
47
|
+
|
|
48
|
+
### unbindDevice:deviceId:callback:
|
|
49
|
+
|
|
50
|
+
**从家庭解绑设备**
|
|
51
|
+
|
|
52
|
+
|参数|描述|
|
|
53
|
+
|---------|---------|
|
|
54
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
55
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
56
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
57
|
+
|
|
58
|
+
### addDeviceToRoom:familyId:roomId:callback:
|
|
59
|
+
|
|
60
|
+
**将设备加入房间**
|
|
61
|
+
|
|
62
|
+
|参数|描述|
|
|
63
|
+
|---------|---------|
|
|
64
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
65
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
66
|
+
|roomId|`NSString*`;房间 ID。|
|
|
67
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
68
|
+
|
|
69
|
+
### removeDeviceFromRoom:familyId:callback:
|
|
70
|
+
|
|
71
|
+
**将设备移出房间**
|
|
72
|
+
|
|
73
|
+
|参数|描述|
|
|
74
|
+
|---------|---------|
|
|
75
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
76
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
77
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
78
|
+
|
|
79
|
+
### getDeviceList:nextPageToken:callback:
|
|
80
|
+
|
|
81
|
+
**获取家庭下的设备列表(支持分页)**
|
|
82
|
+
|
|
83
|
+
|参数|描述|
|
|
84
|
+
|---------|---------|
|
|
85
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
86
|
+
|nextPageToken|`NSString* _Nullable`;分页标记,首页传空字符串。|
|
|
87
|
+
|callback|TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo*>*>*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
88
|
+
|
|
89
|
+
### createDeviceSharingToken:deviceId:callback:
|
|
90
|
+
|
|
91
|
+
**创建设备分享令牌**
|
|
92
|
+
|
|
93
|
+
|参数|描述|
|
|
94
|
+
|---------|---------|
|
|
95
|
+
|familyId|`NSString*`;家庭 ID。|
|
|
96
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
97
|
+
|callback|TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回分享令牌字符串。|
|
|
98
|
+
|
|
99
|
+
### bindDeviceSharedWithMe:shareToken:callback:
|
|
100
|
+
|
|
101
|
+
**绑定他人分享给我的设备**
|
|
102
|
+
|
|
103
|
+
|参数|描述|
|
|
104
|
+
|---------|---------|
|
|
105
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
106
|
+
|shareToken|`NSString*`;分享令牌。|
|
|
107
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
108
|
+
|
|
109
|
+
### unbindDeviceSharedWithMe:callback:
|
|
110
|
+
|
|
111
|
+
**解绑他人分享给我的设备**
|
|
112
|
+
|
|
113
|
+
|参数|描述|
|
|
114
|
+
|---------|---------|
|
|
115
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
116
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
117
|
+
|
|
118
|
+
### getDeviceSharedUsers:callback:
|
|
119
|
+
|
|
120
|
+
**获取设备被分享的用户列表**
|
|
121
|
+
|
|
122
|
+
|参数|描述|
|
|
123
|
+
|---------|---------|
|
|
124
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
125
|
+
|callback|TXIoTCallback<NSArray<TXIoTUserInfo*>*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回用户列表。|
|
|
126
|
+
|
|
127
|
+
### removeDeviceSharedUser:userId:callback:
|
|
128
|
+
|
|
129
|
+
**移除设备的某个被分享用户**
|
|
130
|
+
|
|
131
|
+
|参数|描述|
|
|
132
|
+
|---------|---------|
|
|
133
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
134
|
+
|userId|`NSString\*`;用户 ID。|
|
|
135
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|
|
136
|
+
|
|
137
|
+
### getDeviceListSharedWithMe:callback:
|
|
138
|
+
|
|
139
|
+
**获取分享给我的设备列表(支持分页)**
|
|
140
|
+
|
|
141
|
+
|参数|描述|
|
|
142
|
+
|---------|---------|
|
|
143
|
+
|nextPageToken|`NSString\* _Nullable`;分页标记,首页传 nil。|
|
|
144
|
+
|callback|TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo*>*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回分页结果。|
|
|
145
|
+
|
|
146
|
+
### sendCommand:jsonData:callback:
|
|
147
|
+
|
|
148
|
+
**向设备下发控制指令**
|
|
149
|
+
|
|
150
|
+
|参数|描述|
|
|
151
|
+
|---------|---------|
|
|
152
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
153
|
+
|jsonData|`NSString*`;JSON 格式的控制指令数据。|
|
|
154
|
+
|callback|TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回设备响应数据。|
|
|
155
|
+
|
|
156
|
+
### getProperties:callback:
|
|
157
|
+
|
|
158
|
+
**获取设备属性**
|
|
159
|
+
|
|
160
|
+
|参数|描述|
|
|
161
|
+
|---------|---------|
|
|
162
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
163
|
+
|callback|TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回 JSON 格式的设备属性。|
|
|
164
|
+
|
|
165
|
+
### modifyAliasName:aliasName:callback:
|
|
166
|
+
|
|
167
|
+
**修改设备别名**
|
|
168
|
+
|
|
169
|
+
|参数|描述|
|
|
170
|
+
|---------|---------|
|
|
171
|
+
|deviceId|TXIoTDeviceId*;设备 ID。|
|
|
172
|
+
|aliasName|`NSString*`;新的别名。|
|
|
173
|
+
|callback|TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。|
|