@tencentcloud/sdk-mcp 1.6.6 → 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 (272) hide show
  1. package/knowledge/build-index.js +4 -1
  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/component-slugs.json +1 -0
  10. package/resource/index/doc-source-urls.json +1 -0
  11. package/resource/index/manifest.json +1 -0
  12. package/resource/integration/callkit/preset/android/integration.md +0 -14
  13. package/resource/integration/callkit/preset/flutter/integration.md +0 -9
  14. package/resource/integration/callkit/preset/ios/integration.md +2 -15
  15. package/resource/integration/callkit/preset/react/integration.md +0 -21
  16. package/resource/integration/callkit/preset/vue/integration.md +0 -27
  17. package/resource/integration/chat/preset/android/integration.md +3 -10
  18. package/resource/integration/chat/preset/flutter/integration.md +11 -13
  19. package/resource/integration/chat/preset/ios/integration.md +9 -16
  20. package/resource/integration/chat/preset/react/integration.md +1 -9
  21. package/resource/integration/chat/preset/uni-app/integration.md +0 -9
  22. package/resource/integration/chat/preset/vue/integration.md +3 -13
  23. package/resource/integration/livekit/preset/live/android/live-host-integration.md +0 -4
  24. package/resource/integration/livekit/preset/live/android/prepare-integration.md +8 -21
  25. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +0 -1
  26. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +0 -5
  27. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +0 -4
  28. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -9
  29. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +1 -5
  30. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +36 -147
  31. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +1 -6
  32. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +432 -286
  33. package/resource/integration/roomkit/preset/vue/integration.md +18 -31
  34. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +1 -20
  35. package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -12
  36. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -12
  37. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -19
  38. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -13
  39. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -17
  40. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -13
  41. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -13
  42. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -12
  43. package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +0 -1
  44. package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +0 -2
  45. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -15
  46. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -15
  47. package/resource/knowledge/callkit/core-sdk/web/call-engine.md +0 -1
  48. package/resource/knowledge/callkit/core-sdk/web/call-event.md +0 -1
  49. package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +0 -1
  50. package/resource/knowledge/callkit/faq/android.md +5 -15
  51. package/resource/knowledge/callkit/faq/common.md +0 -1
  52. package/resource/knowledge/callkit/faq/ios.md +1 -4
  53. package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
  54. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +0 -5
  55. package/resource/knowledge/callkit/faq/web.md +1 -5
  56. package/resource/knowledge/callkit/preset/android/api.md +0 -6
  57. package/resource/knowledge/callkit/preset/ios/api.md +0 -4
  58. package/resource/knowledge/callkit/preset/miniprogram/api.md +0 -2
  59. package/resource/knowledge/callkit/preset/react/api.md +2 -4
  60. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +2 -8
  61. package/resource/knowledge/callkit/preset/vue/api.md +2 -4
  62. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +2 -8
  63. package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -4
  64. package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -5
  65. package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -10
  66. package/resource/knowledge/chat/preset/android/features/language.md +1 -12
  67. package/resource/knowledge/chat/preset/android/features/message-input.md +1 -9
  68. package/resource/knowledge/chat/preset/android/features/message-list.md +1 -11
  69. package/resource/knowledge/chat/preset/android/features/search.md +0 -7
  70. package/resource/knowledge/chat/preset/android/features/theme.md +0 -6
  71. package/resource/knowledge/chat/preset/android-view/integration.md +3 -5
  72. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +1 -4
  73. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +1 -6
  74. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +1 -10
  75. package/resource/knowledge/chat/preset/flutter/features/language.md +0 -3
  76. package/resource/knowledge/chat/preset/flutter/features/message-input.md +1 -9
  77. package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -11
  78. package/resource/knowledge/chat/preset/flutter/features/search.md +0 -7
  79. package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -6
  80. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -4
  81. package/resource/knowledge/chat/preset/ios/features/contact-list.md +1 -8
  82. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -10
  83. package/resource/knowledge/chat/preset/ios/features/language.md +0 -11
  84. package/resource/knowledge/chat/preset/ios/features/message-input.md +1 -9
  85. package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -11
  86. package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
  87. package/resource/knowledge/chat/preset/ios/features/theme.md +0 -6
  88. package/resource/knowledge/chat/preset/ios-uikit/integration.md +5 -17
  89. package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -2
  90. package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
  91. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
  92. package/resource/knowledge/chat/preset/react/features/conversation-list.md +2 -23
  93. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
  94. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -3
  96. package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -5
  97. package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
  98. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
  99. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
  100. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -5
  101. package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
  102. package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -4
  103. package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -4
  104. package/resource/knowledge/chat/preset/vue/features/search.md +4 -1
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +4 -6
  106. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  107. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
  108. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
  109. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  110. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  111. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  112. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  113. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
  114. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  117. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
  119. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  120. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
  121. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  122. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
  123. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  124. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  125. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  126. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
  127. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  129. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  132. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  133. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
  134. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  135. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
  136. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  137. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  138. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  139. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
  140. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
  145. package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
  146. package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +1 -3
  147. package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
  148. package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
  149. package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
  150. package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +2 -2
  151. package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
  152. package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -4
  153. package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
  154. package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
  155. package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +3 -7
  156. package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
  157. package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
  158. package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +1 -3
  159. package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
  160. package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
  161. package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
  162. package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +2 -2
  163. package/resource/knowledge/livekit/core-sdk/features/uni-app/audience-list.md +2 -2
  164. package/resource/knowledge/livekit/core-sdk/features/uni-app/audio-effect.md +1 -2
  165. package/resource/knowledge/livekit/core-sdk/features/uni-app/barrage.md +2 -2
  166. package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
  167. package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +4 -8
  168. package/resource/knowledge/livekit/core-sdk/features/uni-app/live-list.md +2 -2
  169. package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
  170. package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -2
  171. package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -7
  172. package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
  173. package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -2
  174. package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -7
  175. package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
  176. package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -2
  177. package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -7
  178. package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -2
  179. package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -2
  180. package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -5
  181. package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +1 -3
  182. package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +4 -13
  183. package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +5 -5
  184. package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +0 -3
  185. package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +18 -21
  186. package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
  187. package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +2 -11
  188. package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +8 -8
  189. package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
  190. package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +1 -4
  191. package/resource/knowledge/livekit/faq/error-code.md +1 -1
  192. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -5
  193. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
  194. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +0 -3
  195. package/resource/knowledge/push/api-reference/donut.md +1 -6
  196. package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
  197. package/resource/knowledge/push/api-reference/react-native.md +0 -3
  198. package/resource/knowledge/push/api-reference/uni-app.md +3 -5
  199. package/resource/knowledge/push/api-reference/unity.md +0 -1
  200. package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
  201. package/resource/knowledge/push/config/android/fcm.md +0 -6
  202. package/resource/knowledge/push/config/android/honor.md +1 -7
  203. package/resource/knowledge/push/config/android/huawei.md +1 -9
  204. package/resource/knowledge/push/config/android/meizu.md +1 -7
  205. package/resource/knowledge/push/config/android/oppo.md +1 -3
  206. package/resource/knowledge/push/config/android/vivo.md +1 -12
  207. package/resource/knowledge/push/config/android/xiaomi.md +0 -5
  208. package/resource/knowledge/push/config/donut.md +0 -12
  209. package/resource/knowledge/push/config/harmonyos.md +18 -7
  210. package/resource/knowledge/push/config/ios.md +26 -33
  211. package/resource/knowledge/push/config/react-native.md +0 -31
  212. package/resource/knowledge/push/config/unity.md +0 -31
  213. package/resource/knowledge/push/config/unreal-engine.md +0 -31
  214. package/resource/knowledge/push/integration/android.md +137 -46
  215. package/resource/knowledge/push/integration/donut.md +5 -21
  216. package/resource/knowledge/push/integration/flutter.md +1 -3
  217. package/resource/knowledge/push/integration/harmonyos.md +17 -16
  218. package/resource/knowledge/push/integration/ios.md +27 -15
  219. package/resource/knowledge/push/integration/react-native.md +9 -59
  220. package/resource/knowledge/push/integration/uni-app.md +3 -25
  221. package/resource/knowledge/push/integration/unity.md +8 -77
  222. package/resource/knowledge/push/integration/unreal-engine.md +37 -96
  223. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
  224. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
  225. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +3 -5
  226. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +4 -6
  227. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
  228. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
  229. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +2 -4
  230. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +4 -6
  231. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
  232. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
  233. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +3 -5
  234. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +4 -6
  235. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -5
  236. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -3
  237. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -5
  238. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -3
  239. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -7
  240. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +1 -2
  241. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -1
  242. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -3
  243. package/resource/knowledge/roomkit/preset/android/integration.md +202 -6
  244. package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -16
  245. package/resource/knowledge/roomkit/preset/ios/integration.md +201 -7
  246. package/resource/knowledge/roomkit/preset/react/integration.md +205 -4
  247. package/resource/knowledge/rtcengine/web/api.md +0 -2
  248. package/resource/knowledge/rtcengine/web/plugin/22-advanced-audio-mixer.md +2 -2
  249. package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +3 -3
  250. package/resource/knowledge/rtcengine/web/plugin/28-advanced-beauty.md +1 -1
  251. package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
  252. package/resource/knowledge/share/userSig.md +2 -2
  253. package/resource/knowledge/trtc/android/TRTCCloud.md +16 -16
  254. package/resource/knowledge/trtc/android/TRTCCloudDef.md +5 -5
  255. package/resource/knowledge/trtc/android/TRTCCloudListener.md +3 -3
  256. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +2 -2
  257. package/resource/knowledge/trtc/android/TXDeviceManager.md +1 -1
  258. package/resource/knowledge/trtc/c++/ITRTCCloud.md +14 -14
  259. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +2 -2
  260. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -4
  261. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +3 -3
  262. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +5 -5
  263. package/resource/knowledge/trtc/ios/TRTCCloud.md +14 -14
  264. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +3 -3
  265. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +2 -2
  266. package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -4
  267. package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +5 -5
  268. package/server.js +1 -1
  269. package/tools/common/search_trtc_knowledge.js +2 -0
  270. package/tools/definitions/search_trtc_knowledge_def.js +1 -0
  271. package/utils/report-cls-client.js +3 -3
  272. package/utils/report-es-client.js +1 -1
@@ -14,8 +14,6 @@
14
14
 
15
15
  ### 步骤1:开通服务
16
16
 
17
- 请参见 开通服务,获取体验版或付费版 `SDK`。
18
-
19
17
  ### 步骤2:在当前项目中导入 AtomicXCore
20
18
 
21
19
  **安装组件**:请在您的 `build.gradle` 文件中添加 `implementation 'com.tencent.atomicx:atomicxcore:latest'` 依赖,然后执行 `Gradle Sync`。
@@ -34,7 +32,6 @@ dependencies {
34
32
  在项目中调用 `LoginStore.shared.login` 完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
35
33
 
36
34
  > **重要:**
37
- >
38
35
  > 推荐在您 `App` 自身的用户账户登录成功后,再调用 `LoginStore.shared.login`,以确保登录业务逻辑的清晰和一致。
39
36
  >
40
37
 
@@ -179,6 +176,9 @@ class YourAnchorActivity : AppCompatActivity() {
179
176
  // 传入所需的麦位数量(例如 9),系统会自动配置麦位开关、房主占位及最大人数
180
177
  seatTemplate = SeatLayoutTemplate.AudioSalon(seatCount = 9)
181
178
 
179
+ // 主播开播后自动上麦
180
+ keepOwnerOnSeat = true
181
+
182
182
  // 设置上麦模式(例如申请上麦)
183
183
  seatMode = TakeSeatMode.APPLY
184
184
  }
@@ -204,6 +204,7 @@ class YourAnchorActivity : AppCompatActivity() {
204
204
  | --- | --- | --- | --- |
205
205
  | <code>liveID</code> | <code>String</code> | 必填 | 直播间的唯一标识符。 |
206
206
  | <code>liveName</code> | <code>String</code> | 选填 | 直播间的标题。 |
207
+ | <code>keepOwnerOnSeat</code> | <code>Boolean</code> | 选填 | 主播开播后是否自动上麦。默认为 false。<br>- 当传入 true 时,主播创建房间后,会自动上到第一个麦位上。主播通过麦克风采集的声音会同步到直播间内。<br>- 当传入 false 时,主播创建房间后,不会自动上麦,主播通过麦克风采集的声音不会同步到直播间内。可以调用 LiveSeatStore.takeSeat 实现将主播上麦。 |
207
208
  | <code>notice</code> | <code>String</code> | 选填 | 直播间的公告信息。 |
208
209
  | <code>isMessageDisable</code> | <code>Boolean</code> | 选填 | 是否禁言(<code>true</code>:是,<code>false</code>:否)。 |
209
210
  | <code>isPublicVisible</code> | <code>Boolean</code> | 选填 | 是否公开可见(<code>true</code>:是,<code>false</code>:否)。 |
@@ -376,7 +377,7 @@ class YourAudienceActivity : AppCompatActivity() {
376
377
 
377
378
  #### **3. 构建麦位 UI 界面**
378
379
 
379
- 观众构建麦位 UI 界面的流程与主播完全一致,请参考主播 构建麦位 UI 界面。
380
+ 观众构建麦位 UI 界面的流程与主播完全一致。
380
381
 
381
382
  #### **4. 退出语聊房**
382
383
 
@@ -426,7 +427,6 @@ class YourAudienceActivity : AppCompatActivity() {
426
427
  #### 实现方式
427
428
 
428
429
  > **提示:**
429
- >
430
430
  > 麦上用户说话时展示波浪动画效果,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.kt](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Android/tuilivekit/src/main/java/com/trtc/uikit/livekit/voiceroomcore/SeatGridView.kt) 文件来了解完整的实现逻辑。
431
431
  >
432
432
 
@@ -13,10 +13,7 @@
13
13
 
14
14
  ### 步骤1:组件集成
15
15
 
16
- 请参考 开播与收听 集成 **AtomicXCore**。
17
-
18
16
  > **说明:**
19
- >
20
17
  > 在开始实现连麦功能之前,您需要获取 `liveId`(直播间唯一标识),用于区分不同的直播房间。获取方式如下
21
18
  >
22
19
  > - **主播端**:通过 `LiveListStore.shared.createLive(liveInfo)` 创建直播时指定。
@@ -14,8 +14,6 @@
14
14
 
15
15
  ### 步骤1:开通服务
16
16
 
17
- 请参见 开通服务,获取体验版或付费版 `SDK`。
18
-
19
17
  ### 步骤2:在当前项目中导入 AtomicXCore
20
18
  1. **安装组件**:请在您的 `pubspec.yaml` 文件中添加 `atomic_x_core` 依赖,然后执行 `flutter pub get`。
21
19
 
@@ -62,7 +60,6 @@ end
62
60
  在项目中调用 `LoginStore.shared.login` 完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
63
61
 
64
62
  > **重要:**
65
- >
66
63
  > 推荐在您 App 自身的用户账户登录成功后,再调用 LoginStore.shared.login,以确保登录业务逻辑的清晰和一致。
67
64
  >
68
65
 
@@ -205,6 +202,8 @@ class _YourAnchorPageState extends State<YourAnchorPage> {
205
202
  seatTemplate: AudioSalon(9),
206
203
  // 5. 设置上麦模式,例如申请上麦
207
204
  seatMode: TakeSeatMode.apply,
205
+ // 6. 设置主播开播后自动上麦
206
+ keepOwnerOnSeat: true,
208
207
  );
209
208
 
210
209
  // 9. 调用 createLive 开始直播
@@ -222,26 +221,25 @@ class _YourAnchorPageState extends State<YourAnchorPage> {
222
221
  ```
223
222
 
224
223
  **LiveInfo 参数说明:**
225
-
226
- |**参数名**|**类型**|**属性**|**描述**|
227
- |---------|---------|---------|---------|
228
- |`liveID`|`String`|必填|直播间的唯一标识符。|
229
- |`liveName`|`String`|选填|直播间的标题。|
230
- |`notice`|`String`|选填|直播间的公告信息。|
231
- |`isMessageDisable`|`bool`|选填|是否禁言(`true`:是,`false`:否)。|
232
- |`isPublicVisible`|`bool`|选填|是否公开可见(`true`:是,`false`:否)。|
233
- |`seatMode`|`TakeSeatMode`|选填|上麦模式(`free`:自由上麦,`apply`:申请上麦)。|
234
- |`seatTemplate`|`SeatLayoutTemplate`|必填|麦位布局模板。|
235
- |`coverURL`|`String`|选填|直播间的封面图片地址。|
236
- |`backgroundURL`|`String`|选填|直播间的背景图片地址。|
237
- |`categoryList`|`List<int>`|选填|直播间的分类标签列表。|
238
- |`activityStatus`|`int`|选填|直播活动状态。|
239
- |`isGiftEnabled`|`bool`|选填|是否启用礼物功能(`true`:是,`false`:否)。|
224
+ | <strong>参数名</strong> | <strong>类型</strong> | <strong>属性</strong> | <strong>描述</strong> |
225
+ | --- | --- | --- | --- |
226
+ | <code>liveID</code> | <code>String</code> | 必填 | 直播间的唯一标识符。 |
227
+ | <code>liveName</code> | <code>String</code> | 选填 | 直播间的标题。 |
228
+ | <code>keepOwnerOnSeat</code> | <code>bool</code> | 选填 | 主播开播后是否自动上麦。默认为 false。<br>- 当传入 true 时,主播创建房间后,会自动上到第一个麦位上。主播通过麦克风采集的声音会同步到直播间内。<br>- 当传入 false 时,主播创建房间后,不会自动上麦,主播通过麦克风采集的声音不会同步到直播间内。可以调用 LiveSeatStore.takeSeat 实现将主播上麦。 |
229
+ | <code>notice</code> | <code>String</code> | 选填 | 直播间的公告信息。 |
230
+ | <code>isMessageDisable</code> | <code>bool</code> | 选填 | 是否禁言(<code>true</code>:是,<code>false</code>:否)。 |
231
+ | <code>isPublicVisible</code> | <code>bool</code> | 选填 | 是否公开可见(<code>true</code>:是,<code>false</code>:否)。 |
232
+ | <code>seatMode</code> | <code>TakeSeatMode</code> | 选填 | 上麦模式(<code>free</code>:自由上麦,<code>apply</code>:申请上麦)。 |
233
+ | <code>seatTemplate</code> | <code>SeatLayoutTemplate</code> | 必填 | 麦位布局模板。 |
234
+ | <code>coverURL</code> | <code>String</code> | 选填 | 直播间的封面图片地址。 |
235
+ | <code>backgroundURL</code> | <code>String</code> | 选填 | 直播间的背景图片地址。 |
236
+ | <code>categoryList</code> | <code>List<int></code> | 选填 | 直播间的分类标签列表。 |
237
+ | <code>activityStatus</code> | <code>int</code> | 选填 | 直播活动状态。 |
238
+ | <code>isGiftEnabled</code> | <code>bool</code> | 选填 | 是否启用礼物功能(<code>true</code>:是,<code>false</code>:否)。 |
240
239
 
241
240
  #### 4. 构建麦位 UI 界面
242
241
 
243
242
  > **提示:**
244
- >
245
243
  > 麦位 `UI` 效果的业务代码,可参考 `TUILiveKit` 开源项目中的 [seat_grid_widget.dart](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/live/livekit/lib/seat_grid_widget/seat_grid_widget.dart) 文件来了解完整的实现逻辑。
246
244
  >
247
245
 
@@ -420,7 +418,7 @@ class _YourAudiencePageState extends State<YourAudiencePage> {
420
418
 
421
419
  #### 3. 构建麦位 UI 界面
422
420
 
423
- 观众构建麦位 UI 界面的流程与主播完全一致,请参考构建麦位 UI 界面。
421
+ 观众构建麦位 UI 界面的流程与主播完全一致。
424
422
 
425
423
  #### 4. 退出语聊房
426
424
 
@@ -454,7 +452,6 @@ class _YourAudiencePageState extends State<YourAudiencePage> {
454
452
  #### 实现方式
455
453
 
456
454
  > **提示:**
457
- >
458
455
  > 麦上用户说话时展示波浪动画效果,可参考 `TUILiveKit` 开源项目中的 [seat_grid_widget.dart](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/live/livekit/lib/seat_grid_widget/seat_grid_widget.dart) 文件来了解完整的实现逻辑。
459
456
  >
460
457
 
@@ -13,8 +13,6 @@
13
13
 
14
14
  ### 步骤1:组件集成
15
15
 
16
- 请参考 开播与收听 集成 **AtomicXCore**。
17
-
18
16
  ### 步骤2:实现观众申请上麦
19
17
 
20
18
  #### 观众端实现
@@ -13,8 +13,6 @@
13
13
 
14
14
  ## 前提条件
15
15
 
16
- 请参考 开播与收听 集成 **AtomicXCore SDK**,并完成 **主播开播** 和 **观众观看** 的功能实现。
17
-
18
16
  ## 主播发起一场连线
19
17
 
20
18
  ### 步骤1:查看正在开播中的主播列表
@@ -24,7 +22,6 @@
24
22
  **实现方式:** 调用 `LiveListStore.shared.fetchLiveList`。
25
23
 
26
24
  > **注意:**
27
- >
28
25
  > - 如果接口返回的列表中没有找到您想要的直播间,您需要检查开播时设置的 `TUILiveInfo` 的 `isPublicVisible` 字段是否为 `true`;
29
26
  > - 该接口支持分页继续拉取,您可以使用 `result` 为 `success` 时的 `cursor` 作为下一次续拉的游标,如果返回的 `cursor` 为空,则表示直播间列表已全部拉取完;
30
27
  > - 为了性能考虑,建议您将 count 设置为 20。
@@ -56,7 +53,6 @@ func fetchLiveListForCoHost() {
56
53
  您可以在主播选中指定的主播连线时,调用 `CoHostStore` 的 `requestHostConnection` 接口发起连线邀请。
57
54
 
58
55
  > **说明:**
59
- >
60
56
  > - AtomicXCore 最大支持 **9** 个房间互相连线,每个房间支持 **50** 路用户。
61
57
  > - 该接口支持批量发起邀请,您可以按需使用;单个直播间是否邀请成功,您需要在 `completion` 回调中检查 `Result` 是否为`.success`。
62
58
  > - 该接口支持扩展字段,邀请发送成功后,该字段会随着 `CoHostEventPublisher` 的 `onCoHostRequestReceived` 回调通知给对端主播,您可以在这个字段中携带 “**是否立即开始 PK 对战**” 等信息,来实现自己的特殊业务。
@@ -255,7 +251,6 @@ func onExitButtonClicked() {
255
251
 
256
252
  ### 场景一:主播在连线后再发起 PK
257
253
 
258
- AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下图,主要包含以下 UI 交互:
259
254
  1. 发起连线邀请,对端被邀请的主播接受连线邀请。
260
255
 
261
256
  2. 参与连线的主播,点击 PK 按钮发起一场限时的对战,可以通过主播收到的礼物数来判定对战的胜负。
@@ -273,7 +268,6 @@ AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下
273
268
  当主播已经处于跨房连线时,可以在参与连线的主播之间发起一场限时 PK,`AtomicXCore` 支持您设置 PK 的时长、是否需要对端主播同意才开始 PK 以及发起 PK 时携带扩展信息。您可以调用 `BattleStore` 的 `requestBattle` 接口发起 PK 邀请。
274
269
 
275
270
  > **说明:**
276
- >
277
271
  > - 当您不设置 `BattleConfig` 的 `duration` 字段时, PK 默认时长为 5 分钟。
278
272
  > - 当您不需要对端主播同意时,您可以设置 `BattleConfig` 的 `needResponse` 字段为 `false`,当邀请发出后 PK 会立即开始。
279
273
  > - 当 `BattleConfig` 的 `needResponse` 字段为 `false` 时,`requestBattle` 接口的 `timeout` 字段必须设置为 0。
@@ -322,7 +316,6 @@ battleStore.battleEventPublisher
322
316
 
323
317
  #### 步骤 3. 进入 PK 状态
324
318
 
325
- 如下图,当主播监听到 `BattleEventPublisher` 的 `onBattleStarted` 回调之后,**可以在 UI 上渲染 PK 进度条**。
326
319
  - 当 `needResponse` 设置为 `false`, 则当邀请成功发出后,会自动进入 PK 状态。
327
320
 
328
321
  - 当 `needResponse` 设置为 `true`,则当被邀请的所有对端主播都调用 `BattleStore` 的 `acceptBattle` 接口同意后进入 PK 状态。
@@ -358,17 +351,15 @@ battleStore.exitBattle(battleID: battleID, completion: { [weak self] result in
358
351
  })
359
352
  ```
360
353
 
361
- 当 PK 结束之后 (也即 `BattleEventPublisher` 的 `onBattleEnded` 回调触发时),您可以通过该回调在 UI 上展示 PK 结束,并区分出胜负(详见区分胜负章节)
354
+ 当 PK 结束之后 (也即 `BattleEventPublisher` 的 `onBattleEnded` 回调触发时),您可以通过该回调在 UI 上展示 PK 结束,并区分出胜负(
362
355
 
363
356
  > **说明:**
364
- >
365
357
  > - 在连线过程中发起的 PK,当 PK 结束后会自动恢复到跨房连线状态。
366
358
  > - 如果您想在 PK 结束之后同步结束跨房连线,可以调用 `CoHostStore` 的 `exitHostConnection` 结束连线。
367
359
 
368
360
  ### 场景二:主播发起带 PK 模式的连线
369
361
 
370
- AtomicXCore 支持您在房间内直播时,直接发起 PK (中间不经历连线的交互过程),当 PK 结束后自动恢复到房间内直播状态。如下图所示:
371
- 1. 主播在个人直播过程中,点击 PK 按钮,打开 UI 面板展示当前正在开播的主播列表(详见《主播发起一场连线》的步骤 1)。
362
+ 1. 主播在个人直播过程中,点击 PK 按钮,打开 UI 面板展示当前正在开播的主播列表(。
372
363
 
373
364
  2. 主播选中其中一个主播,发起 PK 邀请。
374
365
 
@@ -14,8 +14,6 @@
14
14
 
15
15
  ### 步骤1:开通服务
16
16
 
17
- 请参见 开通服务,获取体验版或付费版 `SDK`。
18
-
19
17
  ### 步骤2:在当前项目中导入 AtomicXCore
20
18
  1. **安装组件**:请在您的 **Podfile** 文件中添加 `pod 'AtomicXCore'` 依赖,然后执行 `pod install`。
21
19
 
@@ -37,7 +35,6 @@
37
35
  在项目中调用 `LoginStore.shared.login` 完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
38
36
 
39
37
  > **重要:**
40
- >
41
38
  > 推荐在您 App 自身的用户账户登录成功后,再调用 LoginStore.shared.login,以确保登录业务逻辑的清晰和一致。
42
39
  >
43
40
 
@@ -165,10 +162,14 @@ class YourAnchorViewController: UIViewController {
165
162
  liveInfo.liveName = "test 语聊房"
166
163
  // 4. 设置语聊房布局模板(传入 9 即代表有 9 个麦位)
167
164
  liveInfo.seatTemplate = SeatLayoutTemplate.AudioSalon(seatCount: 9)
168
- // 5. 设置上麦模式,例如申请上麦
165
+
166
+ // 5. 设置主播开播后自动上麦
167
+ liveInfo.keepOwnerOnSeat = true
168
+
169
+ // 6. 设置上麦模式,例如申请上麦
169
170
  liveInfo.seatMode = .apply
170
171
 
171
- // 6. 调用 createLive 开始直播
172
+ // 7. 调用 createLive 开始直播
172
173
  liveListStore.createLive(liveInfo) { [weak self] result in
173
174
  guard let self = self else { return }
174
175
  switch result {
@@ -189,6 +190,7 @@ class YourAnchorViewController: UIViewController {
189
190
  | --- | --- | --- | --- |
190
191
  | <code>liveID</code> | <code>String</code> | 必填 | 直播间的唯一标识符。 |
191
192
  | <code>liveName</code> | <code>String</code> | 选填 | 直播间的标题。 |
193
+ | <code>keepOwnerOnSeat</code> | <code>Bool</code> | 选填 | 主播开播后是否自动上麦。默认为 false。<br>- 当传入 true 时,主播创建房间后,会自动上到第一个麦位上。主播通过麦克风采集的声音会同步到直播间内。<br>- 当传入 false 时,主播创建房间后,不会自动上麦,主播通过麦克风采集的声音不会同步到直播间内。可以调用 LiveSeatStore.takeSeat 实现将主播上麦。 |
192
194
  | <code>notice</code> | <code>String</code> | 选填 | 直播间的公告信息。 |
193
195
  | <code>isMessageDisable</code> | <code>Bool</code> | 选填 | 是否禁言(<code>true</code>:是,<code>false</code>:否)。 |
194
196
  | <code>isPublicVisible</code> | <code>Bool</code> | 选填 | 是否公开可见(<code>true</code>:是,<code>false</code>:否)。 |
@@ -203,7 +205,6 @@ class YourAnchorViewController: UIViewController {
203
205
  #### **4. 构建麦位 UI 界面**
204
206
 
205
207
  > **提示:**
206
- >
207
208
  > 麦位 `UI` 效果的业务代码,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
208
209
  >
209
210
 
@@ -353,7 +354,7 @@ class YourAudienceViewController: UIViewController {
353
354
 
354
355
  #### **3. 构建麦位 UI 界面**
355
356
 
356
- 观众构建麦位 UI 界面的流程与主播完全一致,请参考主播 构建麦位 UI 界面。
357
+ 观众构建麦位 UI 界面的流程与主播完全一致。
357
358
 
358
359
  #### **4. 退出语聊房**
359
360
 
@@ -394,7 +395,6 @@ class YourAudienceViewController: UIViewController {
394
395
  #### 实现方式
395
396
 
396
397
  > **提示:**
397
- >
398
398
  > 麦上用户说话时展示波浪动画效果,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
399
399
  >
400
400
 
@@ -13,8 +13,6 @@
13
13
 
14
14
  ### 步骤1:组件集成
15
15
 
16
- 请参考 开播与收听 集成 **AtomicXCore**。
17
-
18
16
  ### 步骤2:实现观众申请上麦
19
17
 
20
18
  #### 观众端实现
@@ -4,8 +4,6 @@
4
4
 
5
5
  ### 步骤1:开通服务
6
6
 
7
- 请参见 开通服务,获取体验版或付费版 SDK。
8
-
9
7
  ### 步骤2:导入 tuikit-atomic-x
10
8
  1. **安装组件**:打开 [AtomicXCore SDK](https://ext.dcloud.net.cn/plugin) ,单击**下载插件并导入 HBuilderX**,选择需要集成的项目并单击**确定**。
11
9
 
@@ -33,7 +31,6 @@
33
31
  在您的项目中调用 LoginState 中的 login 方法完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
34
32
 
35
33
  > **重要:**
36
- >
37
34
  > 推荐在您 App 自身的用户账户登录成功后,再调用 LoginState 中的 login 方法,以确保登录业务逻辑的清晰和一致。
38
35
  >
39
36
 
@@ -229,7 +226,7 @@ const handleJoinLive = () => {
229
226
 
230
227
  #### **3. 构建麦位 UI 界面**
231
228
 
232
- 观众构建麦位 UI 的流程与主播完全一致,请参考主播 构建麦位 UI 界面。
229
+ 观众构建麦位 UI 的流程与主播完全一致。
233
230
 
234
231
  #### **4. 退出语聊房**
235
232
 
@@ -35,7 +35,7 @@ keywords: ['错误码', '报错', 'live', 'liveKit', '直播间异常', 'pk 报
35
35
 
36
36
  ## 错误码 70013
37
37
  **原因:** 用户 ID 与用户签名不匹配。
38
- **解决方案:** 请检查用户 ID 与用户签名是否匹配,。可前往[腾讯云控制台](https://console.cloud.tencent.com/trtc/usersigtool)验证签名。
38
+ **解决方案:** 请检查用户 ID 与用户签名是否匹配。可前往[腾讯云控制台](https://console.cloud.tencent.com/trtc/usersigtool)验证签名。
39
39
 
40
40
  ## 错误码 100004
41
41
  **原因:** 房间不存在。
@@ -1,9 +1,5 @@
1
1
  `TUILiveKit` 弹幕系统为直播场景提供完整互动解决方案,能够增强直播的互动性和趣味性。通过本文档,您可快速实现直播间弹幕互动功能,并支持深度定制以满足业务需求。
2
2
 
3
- |**PC 浏览器**|**移动端 H5**|
4
- |---------|---------|
5
- |||
6
-
7
3
  ## 组件构成
8
4
 
9
5
  |**组件名称**|**具体内容**|
@@ -104,7 +100,6 @@ onMounted(async () => {
104
100
  | | | | |
105
101
 
106
102
  > **注意:**
107
- >
108
103
  > 使用 BarrageList 的默认消息组件时,表情消息会自动渲染为图片。但当您通过 `Message Props` 或 `message-item` Slot 接管自定义消息渲染时,message.textContent 中的表情编码(例如 [TUIEmoji_Flower])不会自动解析,需要您参考 如何处理自定义弹幕消息时的表情渲染 处理。
109
104
  >
110
105
 
@@ -10,7 +10,7 @@
10
10
 
11
11
  ### 步骤1:环境配置及开通服务
12
12
 
13
- 在进行快速接入之前,请参考 准备工作,完成相关环境配置及开通对应服务。
13
+ 在进行快速接入之前。
14
14
 
15
15
  ### 步骤2:安装依赖
16
16
 
@@ -10,9 +10,6 @@
10
10
 
11
11
  ## 效果展示
12
12
 
13
- |**自定义连麦挂件**|**自定义控制栏操作按钮**|
14
- |---------|---------|
15
- |||
16
13
  |**自定义刷新时 Loading 效果**|**自定义播放器控制栏 UI 样式**|
17
14
  |||
18
15
 
@@ -17,7 +17,6 @@
17
17
  ### 注册推送服务
18
18
 
19
19
  > **注意:**
20
- >
21
20
  > 必须在 App 用户同意了隐私政策,并且确定为 App 用户开始提供推送服务后,再调用该接口使用推送服务。否则可能因提前获取用户隐私导致上架失败。
22
21
  >
23
22
 
@@ -30,7 +29,7 @@ registerPush(sdkAppID: number, appKey: string): Promise<JSON>;
30
29
 
31
30
  |参数|类型|说明|获取路径|
32
31
  |---------|---------|---------|---------|
33
- |sdkAppID|number|推送(Push)应用 ID|[IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier)<br>|
32
+ |sdkAppID|number|推送(Push)应用 ID|[IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier)<br>|
34
33
  |appKey|string|推送(Push)应用客户端密钥||
35
34
 
36
35
  #### 返回值说明
@@ -55,7 +54,6 @@ unRegisterPush(): Promise<JSON>;
55
54
  ### 设置推送 ID 标识 RegistrationID
56
55
 
57
56
  > **注意:**
58
- >
59
57
  > 需要在注册推送服务之前调用。
60
58
  >
61
59
 
@@ -79,7 +77,6 @@ setRegistrationID(registrationID: string): Promise<JSON>;
79
77
  ### 获取推送 ID 标识 RegistrationID
80
78
 
81
79
  > **说明:**
82
- >
83
80
  > 需要在注册推送服务成功之后调用。
84
81
  >
85
82
 
@@ -137,7 +134,6 @@ disablePostNotificationInForeground(disable: boolean): void;
137
134
  ### 创建客户端通知 channel
138
135
 
139
136
  > **说明:**
140
- >
141
137
  > 如果不同厂商的 ChannelID 各不相同,那么每个 Channel 都需要创建。
142
138
  >
143
139
 
@@ -168,7 +164,6 @@ createNotificationChannel(options: {
168
164
  ### 设置应用角标数字
169
165
 
170
166
  > **注意:**
171
- >
172
167
  > - 需要在注册推送服务之后调用。
173
168
  > - 仅支持华为、iOS。
174
169
 
@@ -42,7 +42,6 @@ unRegisterPush(): Promise<TIMPushResult>;
42
42
  ### 设置推送 ID 标识 RegistrationID
43
43
 
44
44
  > **说明:**
45
- >
46
45
  > 如果您调用此接口,请务必在 `registerPush` 前调用。
47
46
  >
48
47
 
@@ -60,7 +59,6 @@ setRegistrationID(registrationID: string): Promise<TIMPushResult>;
60
59
  ### 获取推送 ID 标识 RegistrationID
61
60
 
62
61
  > **说明:**
63
- >
64
62
  > 若您调用过 `setRegistrationID` 接口设置标识 ID,此接口将返回您设置的标识 ID,否则返回由 Push SDK 生成的随机值。
65
63
  >
66
64
 
@@ -45,7 +45,6 @@ unRegisterPush(onSuccess: () => void, onError?: (errCode: number, errMsg: string
45
45
  ### 设置推送 ID 标识 RegistrationID
46
46
 
47
47
  > **说明:**
48
- >
49
48
  > 需要在注册推送服务之前调用。
50
49
  >
51
50
 
@@ -64,7 +63,6 @@ setRegistrationID(registrationID: string, onSuccess: () => void): void;
64
63
  ### 获取推送 ID 标识 RegistrationID
65
64
 
66
65
  > **说明:**
67
- >
68
66
  > - 需要在注册推送服务成功之后调用。
69
67
  > - 若您调用过 `setRegistrationID` 接口设置标识 ID,此接口将返回您设置的标识 ID,否则返回由 Push SDK 生成的随机值。
70
68
 
@@ -82,7 +80,6 @@ getRegistrationID(onSuccess: (registrationID: string) => void): void;
82
80
  ### 获取点击透传的内容
83
81
 
84
82
  > **说明:**
85
- >
86
83
  > 收到离线推送时,点击通知栏拉起 App,调用此接口可获取推送扩展信息。
87
84
  >
88
85
 
@@ -32,7 +32,7 @@ registerPush(SDKAppID, appKey, onSuccess, onError)
32
32
 
33
33
  #### 接口
34
34
  ``` javascript
35
- unRegisterPush(onSuccess, onError)
35
+ unRegisterPush(onSuccess, onError)
36
36
  ```
37
37
 
38
38
  #### 参数说明:
@@ -45,12 +45,11 @@ registerPush(SDKAppID, appKey, onSuccess, onError)
45
45
  ### 设置推送 ID 标识 RegistrationID
46
46
 
47
47
  > **说明:**
48
- >
49
48
  > 1. 如果您调用此接口,请务必在 `registerPush` 前调用。
50
49
 
51
50
  #### 接口
52
51
  ``` javascript
53
- setRegistrationID(registrationID, onSuccess)
52
+ setRegistrationID(registrationID, onSuccess)
54
53
  ```
55
54
 
56
55
  #### 参数说明:
@@ -63,13 +62,12 @@ registerPush(SDKAppID, appKey, onSuccess, onError)
63
62
  ### 获取推送 ID 标识 RegistrationID
64
63
 
65
64
  > **说明:**
66
- >
67
65
  > 若您调用过 `setRegistrationID` 接口设置标识 ID,此接口将返回您设置的标识 ID,否则返回由 Push SDK 生成的随机值。
68
66
  >
69
67
 
70
68
  #### 接口
71
69
  ``` javascript
72
- getRegistrationID(onSuccess)
70
+ getRegistrationID(onSuccess)
73
71
  ```
74
72
 
75
73
  #### 参数说明:
@@ -114,6 +114,5 @@ public class PushListener:Push 监听器类
114
114
  点击通知栏消息回调。
115
115
 
116
116
  > **注意:**
117
- >
118
117
  > 控制台推送证书需要配置为"打开应用内指定界面",并使用默认填充值生效。
119
118
  >
@@ -118,6 +118,5 @@ class PushListener:Push 监听器类
118
118
  点击通知栏消息回调。
119
119
 
120
120
  > **注意:**
121
- >
122
121
  > 控制台推送证书需要配置为"打开应用内指定界面",并使用默认填充值生效。
123
122
  >
@@ -16,7 +16,6 @@
16
16
  ## Firebase 控制台配置
17
17
 
18
18
  > **提示:**
19
- >
20
19
  > 本文配置流程可对照 Firebase 官方 [将 Firebase 添加到 Android 项目](https://firebase.google.cn/docs/android/setup) 操作。
21
20
  >
22
21
 
@@ -63,7 +62,6 @@
63
62
  在 Firebase 控制台**项目设置 > Cloud Messaging** 中,确认 **Firebase Cloud Messaging API (V1)**已启用。新接入场景请使用 HTTP v1 API 和服务账号私钥进行 FCM 鉴权。
64
63
 
65
64
  > **注意:**
66
- >
67
65
  > FCM 旧版 Server Key(HTTP/XMPP)已被弃用。TIMPush 的 Google FCM 通道应使用 HTTP v1 API 和服务账号私钥,请勿混用旧版 Server Key 凭据。
68
66
  >
69
67
 
@@ -72,9 +70,6 @@
72
70
  ### 添加 Google FCM 厂商证书
73
71
 
74
72
  登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加 Google FCM 厂商证书,并按控制台要求上传或填写服务账号私钥相关配置。
75
- | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
76
- | --- | --- |
77
- | | |
78
73
 
79
74
  ### 选择 FCM 消息类型
80
75
 
@@ -89,7 +84,6 @@ FCM 支持通知消息和数据消息。腾讯云控制台默认选择通知消
89
84
  控制台可通过**消息类型**选项进行切换:
90
85
 
91
86
  > **注意:**
92
- >
93
87
  > FCM 数据消息能力仅支持 TIMPush 7.8 及以上版本的 Pixel 手机,其他厂商设备需自测支持情况。
94
88
  >
95
89
 
@@ -15,7 +15,6 @@
15
15
  ## 荣耀开发者服务平台配置
16
16
 
17
17
  > **提示:**
18
- >
19
18
  > 本文配置流程可对照荣耀官方 [推送服务上架申请指南](https://developer.honor.com/cn/docs/11002/guides/app-registration) 操作。
20
19
  >
21
20
 
@@ -55,9 +54,6 @@
55
54
  ### 添加荣耀厂商证书
56
55
 
57
56
  登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加荣耀厂商证书,并按控制台要求填写厂商参数。其中"应用内指定界面"请使用控制台默认配置。
58
- | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
59
- | --- | --- |
60
- | | |
61
57
 
62
58
  ### 配置回执和点击统计
63
59
 
@@ -77,14 +73,12 @@
77
73
  |资讯营销类|可能受到每日推送数量、展示策略或夜间管控影响。|适用于活动、资讯、营销推广等非即时消息。|
78
74
 
79
75
  > **警告:**
80
- >
81
76
  > 如果消息分类与实际内容不符,可能导致消息被厂商降级、限频或影响通道权限。营销、广告类消息不建议配置为服务通讯类。
82
77
  >
83
78
 
84
- 完成荣耀平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置荣耀 `importance`。具体 API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
79
+ 完成荣耀平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置荣耀 `importance`。具体 API 使用方式。
85
80
 
86
81
  > **说明:**
87
- >
88
82
  > 荣耀推送和系统版本有关。当前荣耀通道仅支持国内 Magic UI 4.0 及以上和境外 Magic UI 4.2 及以上荣耀设备使用,低于上述版本的荣耀设备可以按华为厂商接入推送。
89
83
  >
90
84
 
@@ -15,7 +15,6 @@
15
15
  ## 华为 AppGallery Connect 配置
16
16
 
17
17
  > **提示:**
18
- >
19
18
  > 本文配置流程可对照华为官方 [推送服务](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/service-introduction-0000001050040060) 操作。
20
19
  >
21
20
 
@@ -37,7 +36,6 @@
37
36
  单击**项目设置 > 常规**,添加应用。
38
37
 
39
38
  > **注意:**
40
- >
41
39
  > 应用包名与 Android 工程的 `applicationId` 需要保持一致。
42
40
  >
43
41
 
@@ -46,7 +44,6 @@
46
44
  单击**项目设置 > 常规**,获取应用信息。常规页面包含项目和应用的 Client ID 和 Client Secret,两者对应的参数不一致,请下拉至页面底部,获取应用的 Client ID 和 Client Secret。
47
45
 
48
46
  > **警告:**
49
- >
50
47
  > 必须添加打包的 [SHA256 证书指纹](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section193351110105114),SHA256 证书指纹需与自己的打包证书一致,**否则可能导致无法正常接收离线推送消息**。
51
48
  >
52
49
 
@@ -55,16 +52,12 @@
55
52
  ### 添加华为厂商证书
56
53
 
57
54
  登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加华为厂商证书,并按控制台要求填写厂商参数。Client ID 对应 AppID,Client Secret 对应 AppSecret。"应用内指定界面"请使用控制台默认配置。
58
- | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
59
- | --- | --- |
60
- | | |
61
55
 
62
56
  ### 配置回执和点击统计
63
57
 
64
58
  如需统计消息触达或点击数据,请配置回执,回调地址填写:`https://api.im.qcloud.com/v3/offline_push_report/huawei`。
65
59
 
66
60
  > **注意:**
67
- >
68
61
  > 华为推送证书 ID <= 11344 时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID 。
69
62
  >
70
63
 
@@ -78,11 +71,10 @@
78
71
  |资讯营销类|按应用类型设每日推送上限;0:00 - 6:00 期间可能被缓存,待管控解除后再尝试下发。|适用于活动、资讯、推广等非即时消息。|
79
72
 
80
73
  > **警告:**
81
- >
82
74
  > 如果消息分类与实际内容不符,**可能导致消息被厂商降级、限频或影响通道权限**。营销、广告类消息不建议配置为服务与通讯类。
83
75
  >
84
76
 
85
- 配置消息分类时,可在华为侧申请自分类权益。完成华为平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置华为 `Category`。具体的 SDK API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
77
+ 配置消息分类时,可在华为侧申请自分类权益。完成华为平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置华为 `Category`。具体的 SDK API 使用方式。
86
78
 
87
79
  ## 配置完成检查
88
80