@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/definitions/get_callkit_api_def.js +28 -0
  275. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  276. package/tools/definitions/get_faq_def.js +18 -19
  277. package/tools/definitions/get_faq_def.js.map +1 -1
  278. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  279. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  280. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  281. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  282. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  283. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  284. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  285. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  286. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  288. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  289. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  290. package/tools/definitions/get_usersig_def.js +17 -24
  291. package/tools/definitions/get_usersig_def.js.map +1 -1
  292. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  293. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  294. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  295. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  297. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  298. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  299. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  301. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  302. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  303. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  304. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  305. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  306. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  307. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  308. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  309. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  314. package/tools/definitions/present_framework_choice_def.js +23 -12
  315. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  316. package/tools/index.js +47 -61
  317. package/tools/index.js.map +1 -1
  318. package/tools/live/get_native_livekit_core_features.js +65 -0
  319. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  320. package/tools/live/get_native_livekit_core_integration.js +59 -0
  321. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  322. package/tools/live/get_web_live_uikit_integration.js +48 -0
  323. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  324. package/tools/live/get_web_livekit_api.js +32 -0
  325. package/tools/live/get_web_livekit_api.js.map +1 -0
  326. package/tools/live/get_web_livekit_component_detail.js +34 -0
  327. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  328. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  329. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  330. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  331. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  332. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  333. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  334. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  335. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  338. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  339. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  340. package/utils/generate-structured-result.js +61 -17
  341. package/utils/generate-structured-result.js.map +1 -1
  342. package/utils/report-cls-client.js +12 -1
  343. package/utils/report-cls-client.js.map +1 -1
  344. package/utils/report-es-client.js +1 -1
  345. package/resource/doc/chatuikit/android/workflow.md +0 -713
  346. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  347. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  348. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  349. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  350. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  351. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  352. package/resource/doc/chatuikit/react/components/search.md +0 -885
  353. package/resource/doc/chatuikit/react/create-group.md +0 -22
  354. package/resource/doc/chatuikit/react/init.md +0 -25
  355. package/resource/doc/chatuikit/react/workflow.md +0 -254
  356. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  357. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  358. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  359. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  360. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  361. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  362. package/resource/doc/chatuikit/vue/init.md +0 -35
  363. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  364. package/resource/doc/livekit/live/android/workflow.md +0 -322
  365. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  366. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  367. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  368. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  369. package/resource/doc/livekit/live/vue/faq.md +0 -0
  370. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  371. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  372. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  373. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  374. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  375. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  376. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  377. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  378. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  379. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  380. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  381. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  382. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  383. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  384. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  385. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  386. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  387. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  388. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  389. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  390. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  391. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  392. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  393. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  394. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  395. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  396. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  397. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  398. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  399. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  400. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  401. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  402. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  403. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  404. package/resource/doc/roomkit/vue/workflow.md +0 -733
  405. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  406. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  407. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  408. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  409. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  410. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  411. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  412. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  413. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  414. package/resource/doc/tuicallkit/react/api.md +0 -1512
  415. package/resource/doc/tuicallkit/react/faq.md +0 -986
  416. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  417. package/tools/call/get-native-call-integration.js +0 -43
  418. package/tools/call/get-native-call-integration.js.map +0 -1
  419. package/tools/call/get-web-call-api.js +0 -27
  420. package/tools/call/get-web-call-api.js.map +0 -1
  421. package/tools/call/get-web-call-integration.js.map +0 -1
  422. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  423. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  424. package/tools/chat/get-native-chat-integration.js +0 -45
  425. package/tools/chat/get-native-chat-integration.js.map +0 -1
  426. package/tools/chat/get-web-chat-component-detail.js +0 -31
  427. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  428. package/tools/chat/get-web-chat-integration.js +0 -45
  429. package/tools/chat/get-web-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  431. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  432. package/tools/chat/get-web-create-group-doc.js +0 -28
  433. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  434. package/tools/common/get-faq.js +0 -91
  435. package/tools/common/get-faq.js.map +0 -1
  436. package/tools/common/get-usersig.js.map +0 -1
  437. package/tools/common/present-framework-choice.js +0 -16
  438. package/tools/common/present-framework-choice.js.map +0 -1
  439. package/tools/common/present-scenario-choice.js +0 -16
  440. package/tools/common/present-scenario-choice.js.map +0 -1
  441. package/tools/common/record-prompt.js +0 -55
  442. package/tools/common/record-prompt.js.map +0 -1
  443. package/tools/common/record-result.js +0 -60
  444. package/tools/common/record-result.js.map +0 -1
  445. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  446. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  447. package/tools/definitions/get_native_live_api_def.js +0 -22
  448. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  449. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  450. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  452. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  454. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  455. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  456. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  457. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  458. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  459. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  460. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  461. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  462. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  463. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  464. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  465. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  466. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  467. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  468. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  469. package/tools/definitions/present_scenario_choice_def.js +0 -53
  470. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  471. package/tools/definitions/record_prompt_def.js +0 -58
  472. package/tools/definitions/record_prompt_def.js.map +0 -1
  473. package/tools/definitions/record_result_def.js +0 -46
  474. package/tools/definitions/record_result_def.js.map +0 -1
  475. package/tools/live/get-native-live-uikit-integration.js +0 -177
  476. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  477. package/tools/live/get-web-live-component-detail.js +0 -31
  478. package/tools/live/get-web-live-component-detail.js.map +0 -1
  479. package/tools/live/get-web-live-state-detail.js +0 -31
  480. package/tools/live/get-web-live-state-detail.js.map +0 -1
  481. package/tools/live/get-web-live-uikit-integration.js +0 -52
  482. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  483. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  484. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  485. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  486. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  487. package/tools/native_live/get-native-live-api.js +0 -31
  488. package/tools/native_live/get-native-live-api.js.map +0 -1
  489. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  490. package/tools/room/get-web-room-integration.js.map +0 -1
  491. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  492. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  493. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  494. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  495. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  496. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  498. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  500. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  502. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  503. package/tools/trtc/get-trtc-native-api.js +0 -31
  504. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  505. package/utils/handle-component-name.js +0 -33
  506. package/utils/handle-component-name.js.map +0 -1
  507. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  508. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  509. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  510. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -1,613 +0,0 @@
1
- 本文档将帮助开发者使用 `AtomicXCore SDK` 的 `LiveListState` 和 `LiveSeatState` 快速构建一个包含主播开播和观众进房功能的语聊房 `App`。
2
-
3
- ## 准备工作
4
-
5
- ### 步骤 1. 开通服务
6
-
7
- 请参见 [开通服务](https://write.woa.com/document/141302177829593088),获取体验版或付费版 SDK。
8
-
9
- ### 步骤2. 导入 tuikit-atomic-x
10
- 1. **安装组件**:打开 [AtomicXCore SDK](https://ext.dcloud.net.cn/plugin?id=25488) ,单击**下载插件并导入HBuilderX**,选择需要集成的项目并单击**确定**。
11
-
12
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/b6046271bb8811f0b4c35254001c06ec.png)
13
-
14
- 2. **配置工程权限: **请在应用的 manifest.json 文件的app-plus > distribute 节点下,确保添加了以下必要的权限:
15
-
16
- - Android 平台(`android`节点):在 `permissions` 数组中,请确保包含以下权限:
17
-
18
- ``` json
19
- "<uses-permission android:name=\"android.permission.RECORD_AUDIO\" />"
20
- ```
21
- - iOS 平台(ios 节点):在 `privacyDescription` 对象中,请确保包含以下描述:
22
-
23
- ``` json
24
- "NSMicrophoneUsageDescription" : "应用需要访问您的麦克风以进行直播"
25
- ```
26
-
27
- 在 `UIBackgroundModes` 数组中,添加 `audio` 以支持后台播放音频。
28
-
29
- ``` json
30
- "UIBackgroundModes" : [ "audio" ]
31
- ```
32
-
33
- ### 步骤 3. 完成登录
34
-
35
- 在您的项目中调用 LoginState 中的 login 方法完成登录,**这是使用 **`AtomicXCore`** 所有功能的关键前提**。
36
-
37
- > **重要:**
38
- >
39
-
40
- > 推荐在您 App 自身的用户账户登录成功后,再调用 LoginState 中的 login 方法,以确保登录业务逻辑的清晰和一致。
41
- >
42
-
43
- ``` typescript
44
- import { useLoginState } from "@/uni_modules/tuikit-atomic-x/state/LoginState";
45
-
46
- const { login } = useLoginState();
47
-
48
- const handleLogin = () => {
49
- login({
50
- sdkAppID: 1400000001, // 替换为您的 SDKAppID
51
- userID: "test_001", // 替换为您的 UserID
52
- userSig: "xxxxxxxxxx" // 替换为您的 UserSig
53
- })
54
- }
55
- ```
56
-
57
- **登录接口参数说明:**
58
- <table>
59
- <tr>
60
- <td rowspan="1" colSpan="1" >参数</td>
61
-
62
- <td rowspan="1" colSpan="1" >类型</td>
63
-
64
- <td rowspan="1" colSpan="1" >说明</td>
65
- </tr>
66
-
67
- <tr>
68
- <td rowspan="1" colSpan="1" >sdkAppID</td>
69
-
70
- <td rowspan="1" colSpan="1" >number</td>
71
-
72
- <td rowspan="1" colSpan="1" >从 [控制台](https://console.cloud.tencent.com/trtc)获取,通常是以 `140` 或 `160` 开头的 10 位整数。</td>
73
- </tr>
74
-
75
- <tr>
76
- <td rowspan="1" colSpan="1" >userID</td>
77
-
78
- <td rowspan="1" colSpan="1" >string</td>
79
-
80
- <td rowspan="1" colSpan="1" >当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,**请勿使用**`1`、`123`**等简单 ID**。</td>
81
- </tr>
82
-
83
- <tr>
84
- <td rowspan="1" colSpan="1" >userSig</td>
85
-
86
- <td rowspan="1" colSpan="1" >string</td>
87
-
88
- <td rowspan="1" colSpan="1" >用于腾讯云鉴权的票据。请注意:<br>- 开发环境:您可以采用本地 `GenerateTestUserSig.genTestSig` 函数生成 userSig 或者 通过 [UserSig 辅助工具](https://console.cloud.tencent.com/im/tool-usersig) 生成临时的 UserSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 UserSig 的方式。详细信息请参考 [服务端生成 UserSig](https://cloud.tencent.com/document/product/647/17275)。<br>更多信息请参见 [如何计算及使用 UserSig](https://cloud.tencent.com/document/product/647/17275)。</td>
89
- </tr>
90
- </table>
91
-
92
-
93
- ## 搭建语音聊天室
94
-
95
- ### 步骤1:实现房主创建语聊房
96
-
97
- 房主开播流程如下,您只需执行以下几步操作,即可快速搭建一个语聊房。
98
-
99
- #### **1. 初始化麦位 **`State`
100
-
101
- 在您的房主页面中,创建一个 `LiveSeatState` 实例。您需要监听响应式数据的变化,以实时获取麦位数据来渲染您的 `UI`。
102
- ``` typescript
103
- import { watch } from 'vue';
104
- import { useLiveSeatState } from '@/uni_modules/tuikit-atomic-x/state/LiveSeatState';
105
-
106
- // 定义直播间 ID(需要与后续 createLive 中使用的 liveID 保持一致)
107
- const liveID = 'your_live_room_id'; // 替换为您的直播间 ID
108
-
109
- // 使用 liveID 获取 LiveSeatState 实例
110
- const { seatList } = useLiveSeatState(liveID);
111
- ```
112
-
113
- #### **2. 打开麦克风**
114
-
115
- 通过调用 `DeviceState` 的 `openLocalMicrophone` 接口打开麦克风,示例代码如下:
116
- ``` typescript
117
- import { useDeviceState } from "@/uni_modules/tuikit-atomic-x/state/DeviceState";
118
-
119
- const { openLocalMicrophone } = useDeviceState();
120
-
121
- const openMic = () => {
122
- openLocalMicrophone()
123
- }
124
- ```
125
-
126
- #### **3. 开始语聊**
127
-
128
- 通过调用 `LiveListState` 的 `createLive` 接口开始语聊房直播,完整示例代码如下:
129
- ``` typescript
130
- import { useLiveListState } from '@/uni_modules/tuikit-atomic-x/state/LiveListState';
131
-
132
- // 获取 LiveListState 实例
133
- const { createLive } = useLiveListState();
134
-
135
- // 开始直播
136
- const startLive = () => {
137
- createLive({
138
- liveInfo: {
139
- liveID: 'xxx', // 设置直播的房间 id
140
- liveName: 'text', // 设置直播的房间名称
141
- keepOwnerOnSeat: true, // 配置主播始终在麦位上
142
- isSeatEnabled: true,
143
- seatLayoutTemplateID: 70, // 麦位布局模板(例如 70 为 10 麦位模板)
144
- seatMode: 'APPLY' // 上麦模式,例如申请上麦
145
- maxSeatCount: 10 // 最大麦位数
146
- },
147
- success: () => {
148
- console.log('创建直播间成功')
149
- //您可以在这里进行页面的跳转
150
- },
151
- fail: (error) => {
152
- console.log('创建直播间失败', error)
153
- }
154
- });
155
- };
156
- ```
157
-
158
- `LiveInfo`**参数说明:**
159
- <table>
160
- <tr>
161
- <td rowspan="1" colSpan="1" >**参数名**</td>
162
-
163
- <td rowspan="1" colSpan="1" >**类型**</td>
164
-
165
- <td rowspan="1" colSpan="1" >**属性**</td>
166
-
167
- <td rowspan="1" colSpan="1" >**描述**</td>
168
- </tr>
169
-
170
- <tr>
171
- <td rowspan="1" colSpan="1" >`liveID`</td>
172
-
173
- <td rowspan="1" colSpan="1" >`string`</td>
174
-
175
- <td rowspan="1" colSpan="1" >必填</td>
176
-
177
- <td rowspan="1" colSpan="1" >直播间的唯一标识符</td>
178
- </tr>
179
-
180
- <tr>
181
- <td rowspan="1" colSpan="1" >`liveName`</td>
182
-
183
- <td rowspan="1" colSpan="1" >`string`</td>
184
-
185
- <td rowspan="1" colSpan="1" >选填</td>
186
-
187
- <td rowspan="1" colSpan="1" >直播间的标题</td>
188
- </tr>
189
-
190
- <tr>
191
- <td rowspan="1" colSpan="1" >`notice`</td>
192
-
193
- <td rowspan="1" colSpan="1" >`string`</td>
194
-
195
- <td rowspan="1" colSpan="1" >选填</td>
196
-
197
- <td rowspan="1" colSpan="1" >直播间的公告信息</td>
198
- </tr>
199
-
200
- <tr>
201
- <td rowspan="1" colSpan="1" >`isMessageDisable`</td>
202
-
203
- <td rowspan="1" colSpan="1" >`boolean`</td>
204
-
205
- <td rowspan="1" colSpan="1" >选填</td>
206
-
207
- <td rowspan="1" colSpan="1" >是否禁言(`true`:是,`false`:否)</td>
208
- </tr>
209
-
210
- <tr>
211
- <td rowspan="1" colSpan="1" >`isPublicVisible`</td>
212
-
213
- <td rowspan="1" colSpan="1" >`boolean`</td>
214
-
215
- <td rowspan="1" colSpan="1" >选填</td>
216
-
217
- <td rowspan="1" colSpan="1" >是否公开可见(`true`:是,`false`:否)</td>
218
- </tr>
219
-
220
- <tr>
221
- <td rowspan="1" colSpan="1" >`isSeatEnabled`</td>
222
-
223
- <td rowspan="1" colSpan="1" >`boolean`</td>
224
-
225
- <td rowspan="1" colSpan="1" >选填</td>
226
-
227
- <td rowspan="1" colSpan="1" >是否启用麦位功能(`true`:是,`false`:否)</td>
228
- </tr>
229
-
230
- <tr>
231
- <td rowspan="1" colSpan="1" >`keepOwnerOnSeat`</td>
232
-
233
- <td rowspan="1" colSpan="1" >`boolean`</td>
234
-
235
- <td rowspan="1" colSpan="1" >选填</td>
236
-
237
- <td rowspan="1" colSpan="1" >是否保持房主在麦位上</td>
238
- </tr>
239
-
240
- <tr>
241
- <td rowspan="1" colSpan="1" >`maxSeatCount`</td>
242
-
243
- <td rowspan="1" colSpan="1" >`number`</td>
244
-
245
- <td rowspan="1" colSpan="1" >必填</td>
246
-
247
- <td rowspan="1" colSpan="1" >最大麦位数量</td>
248
- </tr>
249
-
250
- <tr>
251
- <td rowspan="1" colSpan="1" >`seatMode`</td>
252
-
253
- <td rowspan="1" colSpan="1" >`string`</td>
254
-
255
- <td rowspan="1" colSpan="1" >选填</td>
256
-
257
- <td rowspan="1" colSpan="1" >上麦模式(`'FREE'`:自由上麦,`'APPLY'`:申请上麦)</td>
258
- </tr>
259
-
260
- <tr>
261
- <td rowspan="1" colSpan="1" >`seatLayoutTemplateID`</td>
262
-
263
- <td rowspan="1" colSpan="1" >`number`</td>
264
-
265
- <td rowspan="1" colSpan="1" >必填</td>
266
-
267
- <td rowspan="1" colSpan="1" >麦位布局模板 `ID`</td>
268
- </tr>
269
-
270
- <tr>
271
- <td rowspan="1" colSpan="1" >`coverURL`</td>
272
-
273
- <td rowspan="1" colSpan="1" >`string`</td>
274
-
275
- <td rowspan="1" colSpan="1" >选填</td>
276
-
277
- <td rowspan="1" colSpan="1" >直播间的封面图片地址</td>
278
- </tr>
279
-
280
- <tr>
281
- <td rowspan="1" colSpan="1" >`backgroundURL`</td>
282
-
283
- <td rowspan="1" colSpan="1" >`string`</td>
284
-
285
- <td rowspan="1" colSpan="1" >选填</td>
286
-
287
- <td rowspan="1" colSpan="1" >直播间的背景图片地址</td>
288
- </tr>
289
-
290
- <tr>
291
- <td rowspan="1" colSpan="1" >`activityStatus`</td>
292
-
293
- <td rowspan="1" colSpan="1" >`number`</td>
294
-
295
- <td rowspan="1" colSpan="1" >选填</td>
296
-
297
- <td rowspan="1" colSpan="1" >直播活动状态</td>
298
- </tr>
299
-
300
- <tr>
301
- <td rowspan="1" colSpan="1" >`isGiftEnabled`</td>
302
-
303
- <td rowspan="1" colSpan="1" >`boolean`</td>
304
-
305
- <td rowspan="1" colSpan="1" >选填</td>
306
-
307
- <td rowspan="1" colSpan="1" >是否启用礼物功能(`true`:是,`false`:否)</td>
308
- </tr>
309
- </table>
310
-
311
-
312
- #### **4. 构建麦位 UI 界面**
313
-
314
- 通过 `LiveSeatState` 实例,监听 `seatList` 的变化,以实时获取麦位数据来渲染您的界面 UI 。您可以在主播页通过以下方式监听数据:
315
- ``` typescript
316
- import { watch } from 'vue';
317
- import { useLiveSeatState } from '@/uni_modules/tuikit-atomic-x/state/LiveSeatState';
318
-
319
- // 使用 liveID 获取 LiveSeatState 实例
320
- const { seatList } = useLiveSeatState(liveID);
321
-
322
- watch( seatList ,(newSeatList) => {
323
- console.log('新的麦位列表', newSeatList)
324
- // 用这个数据来维护您的 UI
325
- })
326
- ```
327
-
328
- #### **5. 结束语聊**
329
-
330
- 语聊结束后,房主可以调用 `LiveListState` 的 `endLive` 接口结束语聊,`SDK` 会处理停止推流和销毁房间的逻辑。
331
- ``` typescript
332
- import { useLiveListState } from '@/uni_modules/tuikit-atomic-x/state/LiveListState';
333
-
334
- // 获取 LiveListState 实例
335
- const { endLive } = useLiveListState();
336
-
337
- // 结束直播
338
- const handleEndLive = () => {
339
- endLive({
340
- success: () => {
341
- console.log('结束直播成功')
342
- //您可以在这里进行页面的跳转
343
- },
344
- fail: (error) => {
345
- console.log('结束直播失败', error)
346
- }
347
- });
348
- }
349
- ```
350
-
351
- ### 步骤2:实现观众进入语聊房
352
-
353
- 观众进房流程如下,通过简单几步操作,即可实现观众进入语聊房
354
-
355
- #### **1. 初始化麦位 **`State`
356
-
357
- 在您的观众页面 中,创建 `LiveSeatState` 实例,并监听 `seatList` 的变化,以渲染麦位 `UI` 。
358
- ``` typescript
359
- import { watch } from 'vue';
360
- import { useLiveSeatState } from '@/uni_modules/tuikit-atomic-x/state/LiveSeatState';
361
-
362
- // 观众进房前,需要先获取要加入的直播间 ID(liveID)。通常有以下几种方式:
363
- // 通过房间列表选择(可从 LiveListState 的 liveList 数据中获取)
364
- // 使用 liveID 获取 LiveSeatState 实例
365
- const { seatList } = useLiveSeatState(liveID);
366
-
367
- watch(seatList,(newSeatList) => {
368
- console.log('新的麦位列表', newSeatList)
369
- // 用这个数据来维护您的 UI
370
- })
371
- ```
372
-
373
- #### **2. 进入语聊房**
374
-
375
- 通过调用 `LiveListState` 的 `joinLive` 接口加入语聊房,完整示例代码如下:
376
- ``` typescript
377
- import { useLiveListState } from '@/uni_modules/tuikit-atomic-x/state/LiveListState';
378
-
379
- // 获取 LiveListState 实例
380
- const { joinLive } = useLiveListState();
381
-
382
- // 加入直播
383
- const handleJoinLive = () => {
384
- joinLive({
385
- liveID: 'xxx', // 想要加入语聊房的 liveID
386
- success: () => {
387
- console.log('成功进入语聊房')
388
- //您可以在这里进行页面的跳转
389
- },
390
- fail: (error) => {
391
- console.log('进入语聊房失败', error)
392
- }
393
- });
394
- }
395
- ```
396
-
397
- #### **3. 构建麦位 UI 界面**
398
-
399
- 观众构建麦位 UI的流程与主播完全一致,请参考主播 [构建麦位 UI 界面](https://write.woa.com/#**4.-.E6.9E.84.E5.BB.BA.E9.BA.A6.E4.BD.8D-ui-.E7.95.8C.E9.9D.A2**)
400
-
401
- #### **4. 退出语聊房**
402
-
403
- 观众退出语聊房时,需要调用 `LiveListState` 的 `leaveLive` 接口来退出。
404
- ``` typescript
405
-
406
- import { useLiveListState } from '@/uni_modules/tuikit-atomic-x/state/LiveListState';
407
-
408
- // 获取 LiveListState 实例
409
- const { leaveLive } = useLiveListState();
410
-
411
- // 退出语聊房
412
- const handleLeaveLive = () => {
413
- leaveLive({
414
- liveID: 'xxx', // 您当前加入语聊房的 liveID
415
- success: () => {
416
- console.log('退出语聊房成功')
417
- //您可以在这里进行页面的跳转
418
- },
419
- fail: (error) => {
420
- console.log('退出语聊房失败', error)
421
- }
422
- });
423
- }
424
- ```
425
-
426
- ### 运行效果
427
-
428
- 完成上述步骤后,即可完成一个最基础的语聊直播场景。您可以参考 [丰富语聊场景](https://write.woa.com/#82dbc44c-8a8e-40e2-89b9-66070f4beb72) 来完善语聊场景。
429
-
430
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/0d6ebdebbbb711f0b9945254005ef0f7.png)
431
-
432
-
433
- ## 功能进阶
434
-
435
- ### **实现麦上用户说话音浪**
436
-
437
- 在语聊房场景中,一个常见的需求是当麦上用户说话时,在其头像上显示一个波浪动画,以提示全房间用户“谁在说话”,`LiveSeatState` 提供了 `speakingUsers` 数据流,专门用于实现此功能。
438
-
439
- #### 实现效果
440
-
441
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/35399d8dbbb711f0a6c652540044a08e.png)
442
-
443
-
444
- 在您构建的麦位 UI 界面中监听 `speakingUsers` 变化,并更新“正在说话”状态,代码示例如下
445
- ``` typescript
446
- import { watch } from 'vue';
447
- import { useLiveSeatState } from '@/uni_modules/tuikit-atomic-x/state/LiveSeatState';
448
-
449
- // 使用 liveID 获取 LiveSeatState 实例
450
- const { speakingUsers } = useLiveSeatState(liveID);
451
-
452
- watch(speakingUsers,(newSpeaker) => {
453
- console.log('正在说话的人', newSpeaker)
454
- // 用这个数据和之前监听的 seatList 进行匹配来更新 UI
455
- })
456
- ```
457
-
458
- ## 丰富语音聊天室场景
459
-
460
- 当您完成了基础的语音聊天室功能后,您可以参考以下功能指南来为语音聊天室添加丰富的互动玩法。
461
- <table>
462
- <tr>
463
- <td rowspan="1" colSpan="1" >**语音聊天室功能**</td>
464
-
465
- <td rowspan="1" colSpan="1" >**功能介绍**</td>
466
-
467
- <td rowspan="1" colSpan="1" >**功能 State**</td>
468
-
469
- <td rowspan="1" colSpan="1" >**实现指南**</td>
470
- </tr>
471
-
472
- <tr>
473
- <td rowspan="1" colSpan="1" >**实现观众音频连麦**</td>
474
-
475
- <td rowspan="1" colSpan="1" >观众申请上麦,与主播进行实时音频互动。</td>
476
-
477
- <td rowspan="1" colSpan="1" >[CoGuestState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState)</td>
478
-
479
- <td rowspan="1" colSpan="1" >[实现观众连麦](https://write.woa.com/document/191656302875648000)</td>
480
- </tr>
481
-
482
- <tr>
483
- <td rowspan="1" colSpan="1" >**添加弹幕聊天功能**</td>
484
-
485
- <td rowspan="1" colSpan="1" >观众可以在语音聊天室发送和接收实时文字消息。</td>
486
-
487
- <td rowspan="1" colSpan="1" >[BarrageState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState)</td>
488
-
489
- <td rowspan="1" colSpan="1" >[实现弹幕功能](https://write.woa.com/document/193556011837247488)</td>
490
- </tr>
491
-
492
- <tr>
493
- <td rowspan="1" colSpan="1" >**构建礼物赠送系统**</td>
494
-
495
- <td rowspan="1" colSpan="1" >观众可以向主播赠送虚拟礼物,增加互动和趣味性。</td>
496
-
497
- <td rowspan="1" colSpan="1" >[GiftState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState)</td>
498
-
499
- <td rowspan="1" colSpan="1" >[实现礼物功能](https://write.woa.com/document/193556022792466432)</td>
500
- </tr>
501
-
502
- <tr>
503
- <td rowspan="1" colSpan="1" >**添加设置音效功能**</td>
504
-
505
- <td rowspan="1" colSpan="1" >变声(童声 / 男声)、混响(KTV 等)、耳返调节,实时切换特效。</td>
506
-
507
- <td rowspan="1" colSpan="1" >[AudioEffectState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-AudioEffectState)</td>
508
-
509
- <td rowspan="1" colSpan="1" >[实现音效功能](https://write.woa.com/document/193586883758084096)</td>
510
- </tr>
511
- </table>
512
-
513
-
514
- ## API 文档
515
- <table>
516
- <tr>
517
- <td rowspan="1" colSpan="1" >**State**</td>
518
-
519
- <td rowspan="1" colSpan="1" >**功能描述**</td>
520
-
521
- <td rowspan="1" colSpan="1" >**API 文档**</td>
522
- </tr>
523
-
524
- <tr>
525
- <td rowspan="1" colSpan="1" >**LiveListState**</td>
526
-
527
- <td rowspan="1" colSpan="1" >语音聊天室全生命周期管理:创建 / 加入 / 离开 / 销毁房间,查询房间列表,修改语音聊天室信息(名称、公告等),监听语音聊天室状态(如被踢出、结束)。</td>
528
-
529
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveListState)</td>
530
- </tr>
531
-
532
- <tr>
533
- <td rowspan="1" colSpan="1" >**DeviceState**</td>
534
-
535
- <td rowspan="1" colSpan="1" >音视频设备控制:麦克风(开关 / 音量),设备状态实时监听。</td>
536
-
537
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-DeviceState)</td>
538
- </tr>
539
-
540
- <tr>
541
- <td rowspan="1" colSpan="1" >**CoGuestState**</td>
542
-
543
- <td rowspan="1" colSpan="1" >观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风),状态同步。</td>
544
-
545
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState)</td>
546
- </tr>
547
-
548
- <tr>
549
- <td rowspan="1" colSpan="1" >**CoHostState**</td>
550
-
551
- <td rowspan="1" colSpan="1" >主播跨房连线:支持多布局模板(动态网格等),发起 / 接受 / 拒绝连线,连麦主播互动管理。</td>
552
-
553
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoHostState)</td>
554
- </tr>
555
-
556
- <tr>
557
- <td rowspan="1" colSpan="1" >**GiftState**</td>
558
-
559
- <td rowspan="1" colSpan="1" >礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。</td>
560
-
561
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState)</td>
562
- </tr>
563
-
564
- <tr>
565
- <td rowspan="1" colSpan="1" >**BarrageState**</td>
566
-
567
- <td rowspan="1" colSpan="1" >弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。</td>
568
-
569
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState)</td>
570
- </tr>
571
-
572
- <tr>
573
- <td rowspan="1" colSpan="1" >**LikeState**</td>
574
-
575
- <td rowspan="1" colSpan="1" >点赞互动:发送点赞,监听点赞事件,同步总点赞数。</td>
576
-
577
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LikeState)</td>
578
- </tr>
579
-
580
- <tr>
581
- <td rowspan="1" colSpan="1" >**LiveAudienceState**</td>
582
-
583
- <td rowspan="1" colSpan="1" >观众管理:获取实时观众列表( ID / 名称 / 头像),统计观众数量,监听观众进出事件。</td>
584
-
585
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveAudienceState)</td>
586
- </tr>
587
-
588
- <tr>
589
- <td rowspan="1" colSpan="1" >**AudioEffectState**</td>
590
-
591
- <td rowspan="1" colSpan="1" >音频特效:变声(童声 / 男声)、混响( KTV 等)、耳返调节,实时切换特效。</td>
592
-
593
- <td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-AudioEffectState)</td>
594
- </tr>
595
- </table>
596
-
597
-
598
- ## 常见问题
599
-
600
- ### 代码变更后,没有效果或者编译报错?
601
-
602
- 引入 uni_modules 后,需要重新制作自定义基座,详情参见 [制作自定义基座流程](https://write.woa.com/document/187305564150689792)。
603
-
604
- ### 原生能力集成问题
605
- - 问题:插件调用失败或无响应。
606
-
607
- - 解决方案:
608
-
609
- - 必须打包自定义基座:在开发调试原生插件时,不能使用标准基座,必须通过 `HBuilderX` > 运行 > 运行到手机或模拟器 > 制作自定义基座,然后选择这个自定义基座来运行。
610
-
611
- - 检查权限:如本文档“准备工作”中所述,`manifest.json` manifest.json必须声明相机、麦克风等权限。
612
-
613
- - 查看原生日志:这是终极调试手段。通过 `Android Studio (Logcat)` 或 `Xcode (Console)` 查看设备的原生日志,通常能发现最直接的错误信息。