@tencent-rtc/mcp 1.6.7 → 1.6.8

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 (248) hide show
  1. package/knowledge/build-index.js +3 -0
  2. package/knowledge/content-loader.js +3 -1
  3. package/knowledge/search/filter-pool.js +12 -4
  4. package/knowledge/search/query-normalizer.js +76 -0
  5. package/knowledge/search/search-knowledge.js +104 -5
  6. package/package.json +1 -1
  7. package/resource/_schema/feature-aliases.yaml +1 -0
  8. package/resource/_schema/query-normalization.yaml +9 -0
  9. package/resource/index/manifest.json +1 -1
  10. package/resource/integration/callkit/preset/android/integration.md +3 -14
  11. package/resource/integration/callkit/preset/flutter/integration.md +1 -12
  12. package/resource/integration/callkit/preset/ios/integration.md +2 -12
  13. package/resource/integration/callkit/preset/react/integration.md +1 -14
  14. package/resource/integration/callkit/preset/vue/integration.md +1 -14
  15. package/resource/integration/chat/preset/android/integration.md +6 -13
  16. package/resource/integration/chat/preset/flutter/integration.md +1 -8
  17. package/resource/integration/chat/preset/ios/integration.md +4 -12
  18. package/resource/integration/chat/preset/react/integration.md +6 -16
  19. package/resource/integration/chat/preset/vue/integration.md +0 -9
  20. package/resource/integration/livekit/preset/live/android/live-audience-integration.md +2 -6
  21. package/resource/integration/livekit/preset/live/android/live-host-integration.md +1 -11
  22. package/resource/integration/livekit/preset/live/android/live-list-integration.md +2 -6
  23. package/resource/integration/livekit/preset/live/android/prepare-integration.md +2 -7
  24. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +2 -7
  25. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +1 -13
  26. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +2 -10
  27. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +3 -8
  28. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -4
  29. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +1 -5
  30. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +2 -7
  31. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +2 -8
  32. package/resource/integration/roomkit/preset/vue/integration.md +0 -11
  33. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -7
  34. package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -8
  35. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -9
  36. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -8
  37. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -8
  38. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -16
  39. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -8
  40. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -8
  41. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -11
  42. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +178 -200
  43. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +195 -217
  44. package/resource/knowledge/callkit/faq/android.md +4 -14
  45. package/resource/knowledge/callkit/faq/common.md +0 -2
  46. package/resource/knowledge/callkit/faq/error-code.md +2 -4
  47. package/resource/knowledge/callkit/faq/ios.md +1 -4
  48. package/resource/knowledge/callkit/preset/android/api.md +0 -6
  49. package/resource/knowledge/callkit/preset/ios/api.md +0 -4
  50. package/resource/knowledge/callkit/preset/react/api.md +3 -4
  51. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +3 -4
  52. package/resource/knowledge/callkit/preset/vue/api.md +3 -4
  53. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +3 -4
  54. package/resource/knowledge/chat/preset/android/features/chat-setting.md +0 -5
  55. package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -7
  56. package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -6
  57. package/resource/knowledge/chat/preset/android/features/language.md +0 -8
  58. package/resource/knowledge/chat/preset/android/features/message-input.md +0 -6
  59. package/resource/knowledge/chat/preset/android/features/message-list.md +0 -8
  60. package/resource/knowledge/chat/preset/android/features/search.md +0 -7
  61. package/resource/knowledge/chat/preset/android/features/theme.md +0 -4
  62. package/resource/knowledge/chat/preset/android-view/integration.md +0 -6
  63. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +0 -4
  64. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +0 -9
  65. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -7
  66. package/resource/knowledge/chat/preset/flutter/features/language.md +0 -5
  67. package/resource/knowledge/chat/preset/flutter/features/message-input.md +0 -6
  68. package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -8
  69. package/resource/knowledge/chat/preset/flutter/features/search.md +0 -5
  70. package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -4
  71. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +0 -5
  72. package/resource/knowledge/chat/preset/ios/features/contact-list.md +0 -5
  73. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -7
  74. package/resource/knowledge/chat/preset/ios/features/language.md +1 -8
  75. package/resource/knowledge/chat/preset/ios/features/message-input.md +0 -6
  76. package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -8
  77. package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
  78. package/resource/knowledge/chat/preset/ios/features/theme.md +0 -4
  79. package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -6
  80. package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
  81. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
  82. package/resource/knowledge/chat/preset/react/features/conversation-list.md +4 -26
  83. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
  84. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  85. package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
  86. package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
  87. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
  88. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
  89. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -3
  90. package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
  91. package/resource/knowledge/chat/preset/vue/features/search.md +4 -3
  92. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  93. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
  94. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
  95. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  96. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  97. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  98. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  99. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
  100. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  101. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  102. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  103. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
  104. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +0 -2
  105. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  106. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
  107. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  108. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
  109. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  110. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  111. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  112. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
  113. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  114. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  115. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  116. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
  117. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  118. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  119. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
  120. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  121. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
  122. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  123. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  124. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  125. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
  126. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  127. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  128. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  129. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
  130. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +0 -2
  131. package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
  132. package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +2 -3
  133. package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
  134. package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +2 -2
  135. package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
  136. package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +3 -4
  137. package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
  138. package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +2 -4
  139. package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
  140. package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
  141. package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +2 -7
  142. package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
  143. package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
  144. package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +2 -4
  145. package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
  146. package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +2 -2
  147. package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
  148. package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +3 -4
  149. package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
  150. package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -4
  151. package/resource/knowledge/livekit/core-sdk/live/android/integration.md +1 -4
  152. package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +1 -3
  153. package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -1
  154. package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -4
  155. package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
  156. package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -3
  157. package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +1 -4
  158. package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
  159. package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -5
  160. package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +1 -4
  161. package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +1 -4
  162. package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +3 -6
  163. package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
  164. package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
  165. package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +1 -4
  166. package/resource/knowledge/livekit/faq/error-code.md +0 -1
  167. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
  168. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +3 -3
  169. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +3 -3
  170. package/resource/knowledge/push/api-reference/android.md +0 -1
  171. package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
  172. package/resource/knowledge/push/api-reference/react-native.md +3 -5
  173. package/resource/knowledge/push/api-reference/uni-app.md +3 -5
  174. package/resource/knowledge/push/api-reference/unity.md +0 -1
  175. package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
  176. package/resource/knowledge/push/config/android.md +0 -24
  177. package/resource/knowledge/push/config/harmonyos.md +0 -1
  178. package/resource/knowledge/push/config/ios.md +0 -3
  179. package/resource/knowledge/push/config/react-native.md +0 -29
  180. package/resource/knowledge/push/config/unity.md +1 -24
  181. package/resource/knowledge/push/config/unreal-engine.md +1 -24
  182. package/resource/knowledge/push/integration/android.md +0 -14
  183. package/resource/knowledge/push/integration/flutter.md +0 -19
  184. package/resource/knowledge/push/integration/harmonyos.md +0 -2
  185. package/resource/knowledge/push/integration/ios.md +0 -3
  186. package/resource/knowledge/push/integration/react-native.md +0 -24
  187. package/resource/knowledge/push/integration/uni-app.md +1 -11
  188. package/resource/knowledge/push/integration/unity.md +0 -9
  189. package/resource/knowledge/push/integration/unreal-engine.md +1 -17
  190. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -4
  191. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -4
  192. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -4
  193. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +1 -5
  194. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -4
  195. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -4
  196. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -4
  197. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +1 -5
  198. package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
  199. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -6
  200. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -9
  201. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -11
  202. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1 -5
  203. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -8
  204. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
  205. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -3
  206. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -5
  207. package/resource/knowledge/roomkit/preset/android/integration.md +0 -4
  208. package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -13
  209. package/resource/knowledge/roomkit/preset/ios/integration.md +0 -6
  210. package/resource/knowledge/roomkit/preset/react/integration.md +0 -16
  211. package/resource/knowledge/rtcengine/web/api.md +1 -8
  212. package/resource/knowledge/rtcengine/web/faq.md +3 -5
  213. package/resource/knowledge/rtcengine/web/how_to_integrated_web_sdk.md +0 -6
  214. package/resource/knowledge/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -1
  215. package/resource/knowledge/rtcengine/web/plugin/21-advanced-auto-play-policy.md +1 -1
  216. package/resource/knowledge/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +1 -1
  217. package/resource/knowledge/rtcengine/web/plugin/27-advanced-small-stream.md +1 -1
  218. package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -3
  219. package/resource/knowledge/rtcengine/web/plugin/34-advanced-proxy.md +2 -4
  220. package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
  221. package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -2
  222. package/resource/knowledge/trtc/android/TRTCCloud.md +8 -56
  223. package/resource/knowledge/trtc/android/TRTCCloudDef.md +6 -7
  224. package/resource/knowledge/trtc/android/TRTCCloudListener.md +1 -18
  225. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +0 -14
  226. package/resource/knowledge/trtc/android/TXDeviceManager.md +0 -1
  227. package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
  228. package/resource/knowledge/trtc/c++/ITRTCCloud.md +7 -59
  229. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +0 -14
  230. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +0 -4
  231. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1 -19
  232. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +6 -7
  233. package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
  234. package/resource/knowledge/trtc/ios/TRTCCloud.md +9 -60
  235. package/resource/knowledge/trtc/ios/TRTCCloudDef.md +6 -7
  236. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1 -19
  237. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +0 -13
  238. package/resource/knowledge/trtc/ios/TXDeviceManager.md +0 -4
  239. package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
  240. package/server.js +1 -1
  241. package/tools/common/search_trtc_knowledge.js +2 -0
  242. package/tools/definitions/search_trtc_knowledge_def.js +1 -0
  243. package/utils/report-cls-client.js +3 -3
  244. package/utils/report-es-client.js +1 -1
  245. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -230
  246. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -797
  247. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -325
  248. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -325
@@ -122,7 +122,6 @@ TRTC provides three different video streams, including:
122
122
  - Substream image: it is generally used for screen sharing. Only one user in the room is allowed to publish the substream video image at any time, while other users must wait for this user to close the substream before they can publish their own substream.
123
123
 
124
124
  > **Note**
125
- >
126
125
  > The SDK does not support enabling the smooth small image alone, which must be enabled together with the big image. It will automatically set the resolution and bitrate of the small image.
127
126
  >
128
127
 
@@ -674,9 +673,9 @@ You can test the network speed through the startSpeedTest: interface before the
674
673
  | expectedDownBandwidth | Expected downstream bandwidth (kbps, value range: 10 to 5000, no downlink bandwidth test when it is 0).<br><strong>Note</strong><br>When the parameter <code>scene</code> is set to TRTCSpeedTestScene_OnlineChorusTesting, in order to obtain more accurate information such as <code>rtt / jitter</code> , the value range is limited to [10, 1000]. |
675
674
  | expectedUpBandwidth | Expected upstream bandwidth (kbps, value range: 10 to 5000, no uplink bandwidth test when it is 0).<br><strong>Note</strong><br>When the parameter <code>scene</code> is set to TRTCSpeedTestScene_OnlineChorusTesting, in order to obtain more accurate information such as <code>rtt / jitter</code> , the value range is limited to [10, 1000]. |
676
675
  | scene | Speed test scene. |
677
- | sdkAppId | Application identification, please refer to the relevant instructions in TRTCParams. |
678
- | userId | User identification, please refer to the relevant instructions in TRTCParams. |
679
- | userSig | User signature, please refer to the relevant instructions in TRTCParams. |
676
+ | sdkAppId | Application identification, please . |
677
+ | userId | User identification, please . |
678
+ | userSig | User signature, please . |
680
679
 
681
680
  ## TRTCSpeedTestResult
682
681
 
@@ -763,7 +762,7 @@ These parameters are used to specify the layout position information of each vid
763
762
  | mixUsers | Field description: specify the position, size, layer, and stream type of each video image in On-Cloud MixTranscoding<br>Recommended value: this field is an array in <code>TRTCMixUser</code> type, where each element represents the information of a video image. |
764
763
  | mode | Field description: layout mode<br>Recommended value: please choose a value according to your business needs. The preset mode has better applicability. |
765
764
  | streamId | Field description: ID of the live stream output to CDN<br>Recommended value: default value: null, that is, the audio/video streams in the room will be mixed into the audio/video stream of the caller of this API.<br>- If you don't set this parameter, the SDK will execute the default logic, that is, it will mix the multiple audio/video streams in the room into the audio/video stream of the caller of this API, i.e., A + B => A.<br>- If you set this parameter, the SDK will mix the audio/video streams in the room into the live stream you specify, i.e., A + B => C (C is the <code>streamId</code> you specify). |
766
- | videoBitrate | Field description: specify the target video bitrate (Kbps) of On-Cloud MixTranscoding<br>Recommended value: if you enter 0, TRTC will estimate a reasonable bitrate value based on <code>videoWidth</code> and <code>videoHeight</code> . You can also refer to the recommended bitrate value in the video resolution enumeration definition (in the comment section). |
765
+ | videoBitrate | Field description: specify the target video bitrate (Kbps) of On-Cloud MixTranscoding<br>Recommended value: if you enter 0, TRTC will estimate a reasonable bitrate value based on <code>videoWidth</code> and <code>videoHeight</code> . You can also . |
767
766
  | videoFramerate | Field description: specify the target video frame rate (fps) of On-Cloud MixTranscoding<br>Recommended value: default value: 15 fps. Value range: (0,30]. |
768
767
  | videoGOP | Field description: specify the target video keyframe interval (GOP) of On-Cloud MixTranscoding<br>Recommended value: default value: 2 (in seconds). Value range: [1,8]. |
769
768
  | videoHeight | Field description: specify the target resolution (height) of On-Cloud MixTranscoding<br>Recommended value: 640 px. If you only mix audio streams, please set both <code>width</code> and <code>height</code> to 0; otherwise, there will be a black background in the live stream after mixtranscoding. |
@@ -813,7 +812,7 @@ The startLocalRecording API is an enhanced version of the startAudioRecording AP
813
812
 
814
813
  **Sound effect parameter (disused).**
815
814
 
816
- "Sound effects" in TRTC refer to some short audio files (usually only a few seconds), such as "applause" and "laughter".
815
+ "Sound effects" in TRTC .
817
816
 
818
817
  This parameter is used to specify the path and number of playback times of a sound effect file (short audio file) in the sound effect playback API TRTCCloud#playAudioEffect on legacy versions.
819
818
 
@@ -931,7 +930,7 @@ This enum type is used by the On-Cloud MixTranscoding parameter TRTCStreamMixing
931
930
  | videoEncodedFPS | <code>Description:</code> The frame rate (fps) of the stream to publish.<br><code>Value:</code> Value range: (0,30]. Default: 20. |
932
931
  | videoEncodedGOP | <code>Description:</code> The keyframe interval (GOP) of the stream to publish.<br><code>Value:</code> Value range: [1,5]. Default: 3 (seconds). |
933
932
  | videoEncodedHeight | <code>Description:</code> The resolution (height) of the stream to publish.<br><code>Value:</code> Recommended value: 640. If you mix only audio streams, to avoid displaying a black video in the transcoded stream, set both <code>width</code> and <code>height</code> to <code>0</code> . |
934
- | videoEncodedKbps | <code>Description:</code> The video bitrate (Kbps) of the stream to publish.<br><code>Value:</code> If you set this parameter to <code>0</code> , TRTC will work out a bitrate based on <code>videoWidth</code> and <code>videoHeight</code> . For details, refer to the recommended bitrates for the constants of the resolution enum type (see comment). |
933
+ | videoEncodedKbps | <code>Description:</code> The video bitrate (Kbps) of the stream to publish.<br><code>Value:</code> If you set this parameter to <code>0</code> , TRTC will work out a bitrate based on <code>videoWidth</code> and <code>videoHeight</code> . . |
935
934
  | videoEncodedWidth | <code>Description:</code> The resolution (width) of the stream to publish.<br><code>Value:</code> Recommended value: 368. If you mix only audio streams, to avoid displaying a black video in the transcoded stream, set both <code>width</code> and <code>height</code> to <code>0</code> . |
936
935
  | videoSeiParams | <code>Description:</code> SEI parameters. Default: null<br><code>Note:</code> the parameter is passed in the form of a JSON string. Here is an example to use it:<br>`{`<br>` "payLoadContent":"xxx",`<br>` "payloadType":5,`<br>` "payloadUuid":"1234567890abcdef1234567890abcdef",`<br>` "interval":1000,`<br>` "followIdr":false`<br>`}`<br>The currently supported fields and their meanings are as follows:<br>- payloadContent: Required. The payload content of the passthrough SEI, which cannot be empty.<br>- payloadType: Required. The type of the SEI message, with a value range of 5 or an integer within the range of [100, 254] (excluding 244, which is an internally defined timestamp SEI).<br>- payloadUuid: Required when payloadType is 5, and ignored in other cases. The value must be a 32-digit hexadecimal number.<br>- interval: Optional, default is 1000. The sending interval of the SEI, in milliseconds.<br>- followIdr: Optional, default is false. When this value is true, the SEI will be ensured to be carried when sending a key frame, otherwise it is not guaranteed. |
937
936
 
@@ -143,7 +143,6 @@ For more information on the error codes for room entry failure, see [Error Codes
143
143
  |result|If `result` is greater than 0, it indicates the time (in ms) the room entry takes; if `result` is less than 0, it represents the error code for room entry.|
144
144
 
145
145
  > **Note**
146
- >
147
146
  > 1. In TRTC versions below 6.6, the `onEnterRoom(result)` callback is returned only if room entry succeeds, and the onError callback is returned if room entry fails.
148
147
  >
149
148
  > 2. In TRTC 6.6 and above, the `onEnterRoom(result)` callback is returned regardless of whether room entry succeeds or fails, and the onError callback is also returned if room entry fails.
@@ -245,7 +244,6 @@ Due to performance concerns, this callback works differently in different scenar
245
244
  |userId|User ID of the remote user|
246
245
 
247
246
  > **Note**
248
- >
249
247
  > 1. The `onRemoteUserEnterRoom` callback indicates that a user entered the room, but it does not necessarily mean that the user enabled audio or video.
250
248
  >
251
249
  > 2. If you want to know whether a user enabled video, we recommend you use the onUserVideoAvailable callback.
@@ -294,7 +292,6 @@ You can then call startRemoteView to subscribe to the remote user’s video. If
294
292
  |userId|User ID of the remote user|
295
293
 
296
294
  > **Note**
297
- >
298
295
  > The API used to display substream images is startRemoteView, not startRemoteSubStreamView, startRemoteSubStreamView is deprecated.
299
296
  >
300
297
 
@@ -313,7 +310,6 @@ If you receive the `onUserAudioAvailable(userId, YES)` callback, it indicates
313
310
  |userId|User ID of the remote user|
314
311
 
315
312
  > **Note**
316
- >
317
313
  > The auto-subscription mode is used by default. You can switch to the manual subscription mode by calling setDefaultStreamRecvMode, but it must be called before room entry for the switch to take effect.
318
314
  >
319
315
 
@@ -334,7 +330,6 @@ The SDK returns this event callback when it starts rendering your first video fr
334
330
  |width|Video width|
335
331
 
336
332
  > **Note**
337
- >
338
333
  > 1. The callback of the first local video frame being rendered is triggered only after you call startLocalPreview or startScreenCapture.
339
334
  >
340
335
  > 2. The callback of the first video frame of a remote user being rendered is triggered only after you call startRemoteView or startRemoteSubStreamView.
@@ -445,7 +440,6 @@ This callback is returned every 2 seconds and notifies you of the statistics on
445
440
  |statistics|Statistics, including local statistics and the statistics of remote users. For details, please see TRTCStatistics.|
446
441
 
447
442
  > **Note**
448
- >
449
443
  > If you want to learn about only the current network quality and do not want to spend much time analyzing the statistics returned by this callback, we recommend you use onNetworkQuality.
450
444
  >
451
445
 
@@ -457,7 +451,7 @@ The callback is triggered by startSpeedTest.
457
451
 
458
452
  |Param|DESC|
459
453
  |---------|---------|
460
- |result|Speed test data, including loss rates, rtt and bandwidth rates, please refer to TRTCSpeedTestResult for details.|
454
+ |result|Speed test data, including loss rates, rtt and bandwidth rates, please .|
461
455
 
462
456
  ## onConnectionLost
463
457
 
@@ -537,7 +531,6 @@ Note that the SDK returns this callback at the specified interval regardless of
537
531
  |userVolumes|An array that represents the volume of all users who are speaking in the room. Value range: [0, 100]|
538
532
 
539
533
  > **Note**
540
- >
541
534
  > `userVolumes` is an array. If `userId` is empty, the elements in the array represent the volume of the local user’s audio. Otherwise, they represent the volume of a remote user’s audio.
542
535
  >
543
536
 
@@ -571,7 +564,6 @@ When users set the mic capturing volume via the UI or a keyboard shortcut, the S
571
564
  |volume|System audio capturing volume, which users can set in the audio control panel. Value range: [0, 100]|
572
565
 
573
566
  > **Note**
574
- >
575
567
  > You need to call enableAudioVolumeEvaluation and set the callback interval ( `interval` > 0) to enable the callback. To disable the callback, set `interval` to `0` .
576
568
  >
577
569
 
@@ -591,7 +583,6 @@ When users set the system’s playback volume via the UI or a keyboard shortcut,
591
583
  |volume|The system playback volume, which users can set in the audio control panel. Value range: 0-100|
592
584
 
593
585
  > **Note**
594
- >
595
586
  > You need to call enableAudioVolumeEvaluation and set the callback interval ( `interval` > 0) to enable the callback. To disable the callback, set `interval` to `0` .
596
587
  >
597
588
 
@@ -640,7 +631,6 @@ If the sender sets `reliable` to `YES` , the SDK will use this callback to no
640
631
  |userId|User ID|
641
632
 
642
633
  > **Note**
643
- >
644
634
  > The recipient receives this callback only if the sender sets `reliable` to `YES` .
645
635
  >
646
636
 
@@ -695,7 +685,6 @@ The SDK will then receive the execution result from the CVM and return the resul
695
685
  |errMsg|Error message|
696
686
 
697
687
  > **Note**
698
- >
699
688
  > If you receive a callback that the command is executed successfully, it only means that your command was sent to Tencent Cloud’s backend server. If the CDN vendor does not accept your streams, the publishing will still fail.
700
689
  >
701
690
 
@@ -930,7 +919,6 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
930
919
  |srcFrame|Used to carry images captured by TRTC via the camera|
931
920
 
932
921
  > **Note**
933
- >
934
922
  > Currently, only the OpenGL texture scheme is supported(PC supports TRTCVideoBufferType_Buffer format Only)
935
923
  >
936
924
 
@@ -954,7 +942,6 @@ After you configure the callback of custom audio processing, the SDK will return
954
942
  |frame|Audio frames in PCM format|
955
943
 
956
944
  > **Note**
957
- >
958
945
  > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
959
946
  >
960
947
  > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
@@ -986,7 +973,6 @@ Other users in the room can receive the message through the `TRTCAudioFrame.ext
986
973
  |frame|Audio frames in PCM format|
987
974
 
988
975
  > **Note**
989
- >
990
976
  > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
991
977
  >
992
978
  > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
@@ -1011,7 +997,6 @@ After you configure the callback of custom audio processing, the SDK will return
1011
997
  |userId|User ID|
1012
998
 
1013
999
  > **Note**
1014
- >
1015
1000
  > The audio data returned via this callback can be read but not modified.
1016
1001
  >
1017
1002
 
@@ -1031,7 +1016,6 @@ After you configure the callback of custom audio processing, the SDK will return
1031
1016
  |frame|Audio frames in PCM format|
1032
1017
 
1033
1018
  > **Note**
1034
- >
1035
1019
  > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
1036
1020
  >
1037
1021
  > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
@@ -1055,7 +1039,6 @@ After you configure the callback of custom audio processing, the SDK will return
1055
1039
  |frame|Audio frames in PCM format|
1056
1040
 
1057
1041
  > **Note**
1058
- >
1059
1042
  > 1. This data returned via this callback is mixed from all audio in the SDK, including local audio after pre-processing (ANS, AEC, and AGC), special effects application, and music mixing, as well as all remote audio, but it does not include the in-ear monitoring data.
1060
1043
  >
1061
1044
  > 2. The audio data returned via this callback cannot be modified.
@@ -1077,7 +1060,6 @@ After you configure the callback of custom audio processing, the SDK will return
1077
1060
  |frame|Audio frames in PCM format|
1078
1061
 
1079
1062
  > **Note**
1080
- >
1081
1063
  > 1. Please avoid time-consuming operations in this callback function, or it will cause audio exceptions.
1082
1064
  >
1083
1065
  > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
@@ -59,7 +59,6 @@ Given that not all phones deliver excellent in-ear monitoring effects, we have b
59
59
  |enable| `YES:` enable; `NO` : disable|
60
60
 
61
61
  > **Note**
62
- >
63
62
  > In-ear monitoring can be enabled only when earphones are used. Please remind anchors to use wired earphones.
64
63
  >
65
64
 
@@ -74,7 +73,6 @@ This API is used to set the volume of in-ear monitoring.
74
73
  |volume|Volume. Value range: [0, 150]; default: 100|
75
74
 
76
75
  > **Note**
77
- >
78
76
  > The volume of the ear monitor is one of the most important factors affecting the user experience. Considering that different users have different sensitivities to volume, it is strongly recommended to provide a ear monitor volume adjustment slider on the UI interface. The recommended adjustment range is between 0 and 150. The gain effect of 100-150 is very helpful for some Android phones with low recording volume.
79
77
  >
80
78
 
@@ -85,7 +83,6 @@ This API is used to set the volume of in-ear monitoring.
85
83
  This API is used to set reverb effects for human voice. For the effects supported, please see TXVoiceReverbType.
86
84
 
87
85
  > **Note**
88
- >
89
86
  > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
90
87
  >
91
88
 
@@ -96,7 +93,6 @@ This API is used to set reverb effects for human voice. For the effects supporte
96
93
  This API is used to set voice changing effects. For the effects supported, please see TXVoiceChangeType.
97
94
 
98
95
  > **Note**
99
- >
100
96
  > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
101
97
  >
102
98
 
@@ -111,7 +107,6 @@ This API is used to set the volume of speech. It is often used together with the
111
107
  |volume|Volume. Value range: [0, 150]; default: 100|
112
108
 
113
109
  > **Note**
114
- >
115
110
  > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
116
111
  >
117
112
 
@@ -139,7 +134,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
139
134
  |startBlock|Callback of starting music|
140
135
 
141
136
  > **Note**
142
- >
143
137
  > 1. If you play the same music track multiple times, please use the same ID instead of a separate ID for each playback.
144
138
  >
145
139
  > 2. If you want to play different music tracks at the same time, use different IDs for them.
@@ -185,7 +179,6 @@ This API is used to set the local and remote playback volume of background music
185
179
  |volume|Volume. Value range: [0, 150]; default: 60|
186
180
 
187
181
  > **Note**
188
- >
189
182
  > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
190
183
  >
191
184
 
@@ -201,7 +194,6 @@ This API is used to control the remote playback volume (the volume heard by audi
201
194
  |volume|Volume. Value range: [0, 150]; default: 60|
202
195
 
203
196
  > **Note**
204
- >
205
197
  > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
206
198
  >
207
199
 
@@ -217,7 +209,6 @@ This API is used to control the local playback volume (the volume heard by ancho
217
209
  |volume|Volume. Value range: [0, 150]. default: 60|
218
210
 
219
211
  > **Note**
220
- >
221
212
  > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
222
213
  >
223
214
 
@@ -271,7 +262,6 @@ The length of the specified music file is returned. -1 indicates failure to get
271
262
  |pts|Unit: millisecond|
272
263
 
273
264
  > **Note**
274
- >
275
265
  > Do not call this API frequently as the music file may be read and written to each time the API is called, which can be time-consuming.
276
266
  >
277
267
  > Wait till users finish dragging the progress bar before you call this API.
@@ -289,7 +279,6 @@ The length of the specified music file is returned. -1 indicates failure to get
289
279
  |scratchSpeedRate|Scratch disc speed, the default value is 1.0f, the range is: a floating point number between [-12.0 ~ 12.0], the positive/negative speed value indicates the direction is positive/negative, and the absolute value indicates the speed.|
290
280
 
291
281
  > **Note**
292
- >
293
282
  > Precondition preloadMusic succeeds.
294
283
  >
295
284
 
@@ -304,7 +293,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
304
293
  |musicParam|Music parameter|
305
294
 
306
295
  > **Note**
307
- >
308
296
  > 1. Preload supports up to 2 preloads with different IDs at the same time, and the preload time does not exceed 10 minutes,you need to call stopPlayMusic API after use, otherwise the memory will not be released.
309
297
  >
310
298
  > 2. If the music corresponding to the ID is being played, the preloading fails, and stopPlayMusic must be called first.
@@ -330,7 +318,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
330
318
  |index|Specify which track to play (the first track is played by default). Value range 0, total number of tracks).|
331
319
 
332
320
  > **Note**
333
- >
334
321
  > The total number of tracks can be obtained through the [getMusicTrackCount interface.
335
322
  >
336
323
 
@@ -125,7 +125,6 @@ This API can be used to achieve the following:
125
125
  |position|The spot to focus on. Pass in the coordinates of the spot you want to focus on.|
126
126
 
127
127
  > **Note**
128
- >
129
128
  > Before using this API, you must first disable auto focus using enableCameraAutoFocus.
130
129
  >
131
130
 
@@ -164,7 +163,6 @@ If the audio route is set to the speaker, the volume is relatively high, and the
164
163
  |type|Device type. Set it to the type of device you want to get. For details, please see the definition of TXMediaDeviceType.|
165
164
 
166
165
  > **Note**
167
- >
168
166
  > - To ensure that the SDK can manage the lifecycle of the `ITXDeviceCollection` object, after using this API, please call the `release` method to release the resources.
169
167
  > - Do not use `delete` to release the Collection object returned as deleting the ITXDeviceCollection* pointer will cause crash.
170
168
  > - The valid values of `type` are `TXMediaDeviceTypeMic` , `TXMediaDeviceTypeSpeaker` , and `TXMediaDeviceTypeCamera` .
@@ -229,7 +227,6 @@ This API is used to set the microphone and speaker types. Camera following the s
229
227
  **Starting camera testing (for desktop OS).**
230
228
 
231
229
  > **Note**
232
- >
233
230
  > You can use the setCurrentDevice API to switch between cameras during testing.
234
231
  >
235
232
 
@@ -248,7 +245,6 @@ This API is used to test whether the mic functions properly. The mic volume dete
248
245
  |interval|Interval of volume callbacks, in milliseconds.|
249
246
 
250
247
  > **Note**
251
- >
252
248
  > When this interface is called, the sound recorded by the microphone will be played back to the speakers by default.
253
249
  >
254
250
 
@@ -48,7 +48,7 @@
48
48
  | ERR_UNSUPPORTED_SAMPLERATE | -1306 | Unsupported audio sample rate. |
49
49
  | ERR_SYSTEM_LOOPBACK_START_FAILED | -1307 | System audio loopback startup encountered an error. Common error reasons and solutions are: 1. The current system version does not support the include or excluded specified process loopback function, which requires Windows system version 10.0.19042 (20H2) or higher. For x64 specified path loopback function, it also requires Windows system version 10.0.19042 (20H2) or higher. Please check the current system version. 2. Invalid input parameters (including empty parameters, non-existent input paths, non-existent process IDs, and non-existent device names). Please check whether the input parameters are legal. 3. No available speaker device, please check whether it is available. |
50
50
  | ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | The third party app loopback capture encountered an error. This error occurred after the third party app loopback was successfully started. During the sound collection process, the specified process or application unexpectedly exited. Please check the status of the specified process or application and try again by re-entering the process number |
51
- | ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason, refer to the error message for -3301 in <code>onError</code> . |
51
+ | ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason. |
52
52
  | ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | IP and signature request timed out. Check your network connection and whether your firewall allows UDP.<br>Try visiting the IP address 162.14.22.165:8000 or 162.14.6.105:8000 and the domain default-query.trtc.tencent-cloud.com:8000. |
53
53
  | ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | Room entry request timed out. Check your network connection and whether VPN is used. You can also switch to 4G to run a test. |
54
54
  | ERR_TRTC_ROOM_PARAM_NULL | -3316 | Empty room entry parameters. Please check whether valid parameters were passed in to the <code>enterRoom:appScene:</code> API. |
package/server.js CHANGED
@@ -36,7 +36,7 @@ Workflow:
36
36
  export function createServer() {
37
37
  const server = new McpServer({
38
38
  name: "Tencent RTC MCP Server",
39
- version: "1.6.6",
39
+ version: "1.6.8",
40
40
  }, {
41
41
  instructions: SERVER_INSTRUCTIONS,
42
42
  });
@@ -19,6 +19,7 @@ const registrySearchTRTCKnowledgeTool = (mcpServer) => {
19
19
  ])).optional().describe(parameter_descriptions.types),
20
20
  scenario: z.enum(['live', 'voice']).optional().describe(parameter_descriptions.scenario),
21
21
  limit: z.number().min(1).max(16).default(8).describe(parameter_descriptions.limit),
22
+ from: z.string().default('').describe(parameter_descriptions.from),
22
23
  },
23
24
  }, (params) => {
24
25
  const qid = params.queryID || randomUUID();
@@ -29,6 +30,7 @@ const registrySearchTRTCKnowledgeTool = (mcpServer) => {
29
30
  framework: params.frameworks?.join(',') ?? '',
30
31
  product: params.product ? params.product.join(',') : '',
31
32
  ide: params.ide,
33
+ from: params.from,
32
34
  });
33
35
  const response = searchKnowledge({
34
36
  prompt: params.prompt,
@@ -31,6 +31,7 @@ const PARAMETER_DESCRIPTIONS = {
31
31
  scenario: 'live | voice. Only valid for the live product.',
32
32
  queryID: "First call: ''. Follow-up calls in the same consultation MUST pass through the original queryID returned by the server.",
33
33
  ide: 'IDE name (cursor|claude-code|vscode|codebuddy|codex|trae|others). Required.',
34
+ from: 'Empty string by default.',
34
35
  limit: 'Number of fragments. Default 8, maximum 16.',
35
36
  };
36
37
  export const SEARCH_KNOWLEDGE_DEFINITION = {
@@ -23,12 +23,12 @@ function reportCLSClient(reportData) {
23
23
  }
24
24
  function sendCLSReport(reportData) {
25
25
  const { SDKAppID: _SDKAppID } = ServerConfig.getInstance().getConfig();
26
- const { SDKAppID = _SDKAppID, method = '', userID = '', framework = '', product = '', prompt = '', queryID = '', answer = '', feedback = '', info = '', ide = '', } = reportData;
26
+ const { SDKAppID = _SDKAppID, method = '', userID = '', framework = '', product = '', prompt = '', queryID = '', answer = '', feedback = '', info = '', ide = '', from = '', } = reportData;
27
27
  const identifier = getDeviceIdentifier();
28
28
  const time = Date.now();
29
29
  const data = {
30
30
  platform: 'mcp',
31
- verison: '1.6.7',
31
+ verison: '1.6.8',
32
32
  sdkappid: `${SDKAppID}`,
33
33
  method: method,
34
34
  userid: queryID || userID,
@@ -41,7 +41,7 @@ function sendCLSReport(reportData) {
41
41
  level: product,
42
42
  app: info,
43
43
  callkitversion: ide,
44
- isfromchat: '',
44
+ isfromchat: from,
45
45
  };
46
46
  return httpPost({
47
47
  hostname: 'ap-nanjing.cls.tencentcs.com',
@@ -7,7 +7,7 @@ function reportESClient(reportData) {
7
7
  report: [
8
8
  {
9
9
  platform: 'mcp',
10
- version: '1.6.7',
10
+ version: '1.6.8',
11
11
  sdkappid: `${SDKAppID}`,
12
12
  method: method,
13
13
  userID: `${userID}`,
@@ -1,230 +0,0 @@
1
- `RoomStore` 是 `AtomicXCore` 中专职房间事务管理的模块,深度集成了会中呼叫能力。本章节旨在指导如何利用 `RoomStore` 高效完成会中呼叫相关功能的开发与接入。
2
-
3
- ## 核心功能
4
- - **会中呼叫**:房间内任意参与者均可呼叫房间外任意成员加入房间。
5
-
6
- - **获取会中呼叫用户列表**:可以获取指定房间的会中呼叫的用户列表。
7
-
8
- ## 核心概念
9
-
10
- 在开始集成之前,需要通过下表了解一下 `RoomStore` 中与会中呼叫相关的几个核心概念:
11
- | <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
12
- | --- | --- |
13
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCallStatus.html">RoomCallStatus</a> | 代表会中呼叫的状态,包含:<br>- <code>none</code>(默认态)。<br>- <code>calling</code>(呼叫中)。<br>- <code>timeout</code>(呼叫超时)。<br>- <code>rejected</code>(呼叫被拒绝)。 |
14
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCallResult.html">RoomCallResult</a> | 代表会中呼叫的结果,包含:<br>- <code>success</code>(呼叫成功)。<br>- <code>alreadyInCalling</code>(已在呼叫中)。<br>- <code>alreadyInRoom</code>(已在房间中)。 |
15
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/CallRejectionReason.html">CallRejectionReason</a> | 代表呼叫被拒绝的原因,目前仅支持:<br>- <code>rejected</code>(主动拒绝)。<br>- <code>inOtherRoom</code>(在其他房间中)。 |
16
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCall-class.html">RoomCall</a> | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
17
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
18
- | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 <code>RoomListener</code> 来接收与会中呼叫相关的实时动态事件。 |
19
-
20
- ## 实现步骤
21
-
22
- ### 步骤1:组件集成
23
-
24
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
25
-
26
- ### 步骤2:呼叫方功能
27
-
28
- #### **1. 发起呼叫**
29
-
30
- 作为呼叫方调用 `RoomStore` 的 `callUserToRoom` 接口,可以批量呼叫用户进房。
31
- ``` java
32
- import 'package:atomic_x_core/atomicxcore.dart';
33
-
34
- Future<void> callUserToRoom({
35
- required List<String> userIDList,
36
- int timeout = 30,
37
- String? extensionInfo,
38
- }) async {
39
- final result = await RoomStore.shared.callUserToRoom(
40
- roomID: "roomID",
41
- userIDList: userIDList,
42
- timeout: timeout,
43
- extensionInfo: extensionInfo,
44
- );
45
-
46
- if (result.isSuccess) {
47
- print("呼叫用户请求发送成功");
48
- } else {
49
- print("呼叫用户失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
50
- }
51
- }
52
- ```
53
-
54
- #### **2. 取消呼叫**
55
-
56
- 作为呼叫方调用 `RoomStore` 的 `cancelCall` 接口,可以批量取消正在呼叫的申请。
57
- ``` java
58
- import 'package:atomic_x_core/atomicxcore.dart';
59
-
60
- Future<void> cancelCall(List<String> userIDList) async {
61
- final result = await RoomStore.shared.cancelCall(
62
- roomID: "roomID",
63
- userIDList: userIDList,
64
- );
65
-
66
- if (result.isSuccess) {
67
- print("取消呼叫成功");
68
- } else {
69
- print("取消呼叫失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
70
- }
71
- }
72
- ```
73
-
74
- #### **3. 获取呼叫列表信息**
75
-
76
- 进入房间后,调用 `RoomStore` 的 `getPendingCalls` 接口,可以分页查询当前房间正在呼叫的用户列表信息。
77
- ``` java
78
- import 'package:atomic_x_core/atomicxcore.dart';
79
-
80
- Future<void> getPendingCalls(String roomID, String? cursor) async {
81
- // cursor 为分页游标,首次调用时传入 null,获取第一页数据,后续调用时传入上次返回的 cursor 值。
82
- final result = await RoomStore.shared.getPendingCalls(
83
- roomID: roomID,
84
- cursor: cursor,
85
- );
86
-
87
- if (result.isSuccess) {
88
- print("获取呼叫列表成功,列表信息: ${result.data}, 分页游标: ${result.cursor}");
89
- } else {
90
- print("获取呼叫列表失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
91
- }
92
- }
93
- ```
94
-
95
- #### **4. 订阅会中呼叫事件**
96
-
97
- 作为呼叫方订阅 `RoomStore` 的 `RoomListener` 能够实时获取呼叫的生命周期事件。通过监听以下回调,可以精准捕捉呼叫的最终结果并据此更新 UI 状态或执行后续业务逻辑。
98
- ``` java
99
- import 'package:atomic_x_core/atomicxcore.dart';
100
-
101
- late RoomListener _listener;
102
-
103
- /// 订阅会中呼叫相关事件
104
- void addRoomCallListener() {
105
- _listener = RoomListener(
106
- onCallTimeout: (roomInfo, call) {
107
- print("呼叫超时 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}");
108
- },
109
- onCallAccepted: (roomInfo, call) {
110
- print("呼叫已被接受 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}");
111
- },
112
- onCallRejected: (roomInfo, call, reason) {
113
- print("呼叫被拒绝 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}, 拒绝原因: $reason");
114
- },
115
- );
116
-
117
- RoomStore.shared.addRoomListener(_listener);
118
- }
119
-
120
- void removeRoomCallListener() {
121
- RoomStore.shared.removeRoomListener(_listener);
122
- }
123
- ```
124
-
125
- **呼叫事件函数详细说明**
126
-
127
- |事件函数|触发时机与说明|
128
- |---------|---------|
129
- |[onCallTimeout](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallTimeout.html)|呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。|
130
- |[onCallAccepted](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallAccepted.html)|呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示被呼叫者即将进入房间,呼叫方应更新 UI 状态,例如将该用户从“呼叫中”列表移除,并等待后续的成员进房通知来刷新成员列表。|
131
- |[onCallRejected](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallRejected.html)|呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(如主动拒绝或在其他房间中)。|
132
-
133
- ### 步骤3:被呼叫方功能
134
-
135
- #### **1. 订阅会中呼叫事件**
136
-
137
- 作为被呼叫方订阅 `RoomStore` 的 `RoomListener` 可以实时监听并响应来自呼叫方的呼叫行为。以下是构建呼叫提醒界面以及维护呼叫链路状态的关键事件。
138
- ``` java
139
- import 'package:atomic_x_core/atomicxcore.dart';
140
-
141
- late RoomListener _listener;
142
-
143
- /// 订阅会中呼叫相关事件
144
- void addRoomCallListener() {
145
- _listener = RoomListener(
146
- onCallReceived: (roomInfo, call, extensionInfo) {
147
- print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo");
148
- },
149
- onCallCancelled: (roomInfo, call) {
150
- print("呼叫被取消 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}");
151
- },
152
- onCallRevokedByAdmin: (roomInfo, call, operatorUser) {
153
- print("呼叫被管理员移除 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 移除操作者: ${operatorUser.userID}");
154
- },
155
- onCallHandledByOtherDevice: (roomInfo, isAccepted) {
156
- print("呼叫已被其他设备处理 房间信息: ${roomInfo.roomID}, 处理结果: $isAccepted");
157
- },
158
- );
159
-
160
- RoomStore.shared.addRoomListener(_listener);
161
- }
162
-
163
- void removeRoomCallListener() {
164
- RoomStore.shared.removeRoomListener(_listener);
165
- }
166
- ```
167
-
168
- **事件函数详细说明**
169
-
170
- |事件函数|触发时机与说明|
171
- |---------|---------|
172
- |[onCallReceived](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallReceived.html)|收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。|
173
- |[onCallCancelled](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallCancelled.html)|呼叫被发起方取消。呼叫方在您未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。|
174
- |[onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallRevokedByAdmin.html)|呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。|
175
- |[onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallHandledByOtherDevice.html)|呼叫已在其他设备处理。当用户在多个设备(例如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。|
176
-
177
- #### **2. 接受呼叫、拒绝呼叫**
178
-
179
- 作为被呼叫方调用 `RoomStore` 的 `acceptCall` 或者 `rejectCall` 接口,处理接受或者拒绝呼叫邀请。
180
- ``` java
181
- import 'package:atomic_x_core/atomicxcore.dart';
182
-
183
- late RoomListener _listener;
184
-
185
- /// 订阅会中呼叫相关事件
186
- void addRoomCallListener() {
187
- _listener = RoomListener(
188
- onCallReceived: (roomInfo, call, extensionInfo) {
189
- print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo");
190
- // 接受、拒绝呼叫邀请操作
191
- },
192
- );
193
-
194
- RoomStore.shared.addRoomListener(_listener);
195
- }
196
-
197
- void removeRoomCallListener() {
198
- RoomStore.shared.removeRoomListener(_listener);
199
- }
200
-
201
- // 接受呼叫邀请
202
- Future<void> acceptCall(String roomID) async {
203
- final result = await RoomStore.shared.acceptCall(roomID);
204
-
205
- if (result.isSuccess) {
206
- print("接受呼叫成功,房间ID: $roomID");
207
- } else {
208
- print("接受呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
209
- }
210
- }
211
-
212
- // 拒绝呼叫邀请
213
- Future<void> rejectCall(String roomID, {CallRejectionReason reason = CallRejectionReason.rejected}) async {
214
- final result = await RoomStore.shared.rejectCall(
215
- roomID: roomID,
216
- reason: reason,
217
- );
218
-
219
- if (result.isSuccess) {
220
- print("拒绝呼叫成功,房间ID: $roomID");
221
- } else {
222
- print("拒绝呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
223
- }
224
- }
225
- ```
226
-
227
- ## API 文档
228
- | <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API 文档</strong> |
229
- | --- | --- | --- |
230
- | <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">API 文档</a> |