@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
@@ -9,9 +9,8 @@
9
9
 
10
10
  - **趣味互动:** 社交场景下,用户更换有趣的背景图片,增加互动乐趣。
11
11
 
12
-
13
12
  ## 前提条件
14
- - **用户状态:** 用户已经通过 useLoginState 完成登录鉴权,参考 [接入概览](https://write.woa.com/document/197379797539790848),处于**已登录**状态。
13
+ - **用户状态:** 用户已经通过 useLoginState 完成登录鉴权,参考 接入概览,处于**已登录**状态。
15
14
 
16
15
  - **环境依赖:** 项目已引入 `tuikit-atomicx-vue3`。
17
16
 
@@ -21,10 +20,9 @@
21
20
 
22
21
  - 将 `node_modules/trtc-sdk-v5/assets` 目录发布至 CDN 或者静态资源服务器中,详情可见 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html)。
23
22
 
24
- - 若选择 [方案一:使用 UI 组件快速集成](https://write.woa.com/#1362aad9-2836-4931-b947-2f0f7836d284),在使用 [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) 组件时,需要通过 props 传入 `assetsPath` 静态资源地址。
25
-
26
- - 若选择 [方案二:使用底层 API 自定义集成](https://write.woa.com/#b941dd3e-0f43-48af-8aa4-8818ab74a80e),在使用 [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) 接口时,需要传入 `assetsPath` 静态资源地址。
23
+ - 若选择 方案一:使用 UI 组件快速集成,在使用 [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) 组件时,需要通过 props 传入 `assetsPath` 静态资源地址。
27
24
 
25
+ - 若选择 方案二:使用底层 API 自定义集成,在使用 [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) 接口时,需要传入 `assetsPath` 静态资源地址。
28
26
 
29
27
  ## 实现虚拟背景功能
30
28
 
@@ -33,17 +31,13 @@
33
31
 
34
32
  - **方案二(高级):** 使用底层 API 自定义集成。基于 atomicx-core SDK API [useVirtualBackgroundState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState) 状态钩子自行实现 UI 和交互逻辑,灵活度最高。
35
33
 
36
- ![虚拟背景](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027160512/1d881d05dee711f09143525400bf7822.png)
37
-
38
34
  虚拟背景
39
35
 
40
-
41
36
  ## 方案一:使用 UI 组件快速集成
42
37
 
43
38
  `tuikit-atomicx-vue3` 提供了核心设置面板组件:
44
39
  - [**VirtualBackgroundPanel**](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel)**:** 虚拟背景的配置面板,包含背景虚化、图片选择和预览功能。
45
40
 
46
-
47
41
  ### 步骤1:引入组件
48
42
  ``` typescript
49
43
  import { VirtualBackgroundPanel } from 'tuikit-atomicx-vue3/room';
@@ -56,10 +50,10 @@ import { VirtualBackgroundPanel } from 'tuikit-atomicx-vue3/room';
56
50
  **以下示例展示了如何实现一个点击按钮弹出虚拟背景设置的完整交互:**
57
51
 
58
52
  > **注意:**
59
- >
53
+ >
60
54
  > - 将 `node_modules/trtc-sdk-v5/assets` 目录发布至 CDN 或者静态资源服务器中,详情可见 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html)。
61
55
  > - 在使用 [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) 组件时,通过 props 传入 `assetsPath` 静态资源地址。
62
- > - 所有 TUIKit 组件必须包裹在 [UIKitProvider](https://write.woa.com/document/197379797539790848) 内部,否则将无法获取上下文依赖,导致样式异常。
56
+ > - 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
63
57
 
64
58
  ``` typescript
65
59
  <template>
@@ -75,7 +69,7 @@ import { VirtualBackgroundPanel } from 'tuikit-atomicx-vue3/room';
75
69
  <span>虚拟背景</span>
76
70
  <button @click="showSettings = false">关闭</button>
77
71
  </div>
78
-
72
+
79
73
  <div class="modal-body">
80
74
  <!-- 3. 引入面板组件 -->
81
75
  <!-- @close 事件:当用户点击面板内的关闭按钮(如有)时触发 -->
@@ -102,7 +96,7 @@ const openSettings = () => {
102
96
  alert('当前浏览器不支持虚拟背景');
103
97
  return;
104
98
  }
105
-
99
+
106
100
  // 2. 检查是否有可用摄像头
107
101
  if (cameraList.value.length === 0) {
108
102
  alert('未检测到摄像头,无法设置虚拟背景');
@@ -128,7 +122,7 @@ const openSettings = () => {
128
122
  在调用虚拟背景功能前,必须先检查浏览器是否支持,并初始化资源路径。
129
123
 
130
124
  > **注意:**
131
- >
125
+ >
132
126
  > - 将 node_modules/trtc-sdk-v5/assets 目录发布至 CDN 或者静态资源服务器中,详情可见 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html)。
133
127
  > - 在使用 [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) 接口时,传入 assetsPath 静态资源地址。
134
128
  > - 虚拟背景功能依赖摄像头设备。可使用 [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) 检查设备状态。
@@ -162,10 +156,10 @@ onMounted(async () => {
162
156
  在用户确认应用背景前,通常需要先预览效果。使用 [setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground) 方法可以设置预览效果,此时不会应用到远端可见的视频流中。
163
157
 
164
158
  > **说明:**
165
- >
159
+ >
166
160
 
167
161
  > 调用 `setVirtualBackground` 仅在本地预览画面生效,远端用户不会看到虚拟背景效果,需调用 `saveVirtualBackground` 后才会同步到远端视频流。
168
- >
162
+ >
169
163
 
170
164
  ``` typescript
171
165
  import { useVirtualBackgroundState } from 'tuikit-atomicx-vue3/room';
@@ -234,7 +228,6 @@ const disableVirtualBackground = async () => {
234
228
 
235
229
  - **图片格式:** 自定义背景图片建议使用 `jpg` 或 `png` 格式,且分辨率不宜过大(建议 1920x1080 以内),以免影响加载速度和内存占用。
236
230
 
237
-
238
231
  ## 常见问题
239
232
 
240
233
  ### **在 Chrome 中运行 Demo 发现画面颠倒且卡顿?**
@@ -262,20 +255,6 @@ WebRTC 相关功能通常要求在 HTTPS 环境下运行,或者是 `localhost`
262
255
  腾讯云在 GitHub 上提供了示例项目 [atomicx-vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/atomicx-vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
263
256
 
264
257
  ## API 文档
265
- <table>
266
- <tr>
267
- <td rowspan="1" colSpan="1" >**State/Component**</td>
268
-
269
- <td rowspan="1" colSpan="1" >**功能描述**</td>
270
-
271
- <td rowspan="1" colSpan="1" >**API 文档**</td>
272
- </tr>
273
-
274
- <tr>
275
- <td rowspan="1" colSpan="1" >**useVirtualBackgroundState**</td>
276
-
277
- <td rowspan="1" colSpan="1" >虚拟背景管理</td>
278
-
279
- <td rowspan="1" colSpan="1" >[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState)</td>
280
- </tr>
281
- </table>
258
+ | **State/Component** | **功能描述** | **API 文档** |
259
+ | --- | --- | --- |
260
+ | **useVirtualBackgroundState** | 虚拟背景管理 | [API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState) |
@@ -1,25 +1,19 @@
1
1
  TUIRoomKit 是腾讯云推出的音视频房间 UI 应用。本次升级引入了全新的原子化组件接入方案,开发者可以灵活组合这些原子化组件,以构建个性化的音视频房间界面。
2
2
 
3
3
  > **推荐使用更高效的 AI 集成助手**
4
- >
4
+ >
5
5
 
6
6
  > 我们为您提供了全新的 AI 集成方式,只需要描述您的需求,即可自动生成集成代码,大幅提升开发效率。
7
- >
7
+ >
8
8
 
9
9
  > [点击这里,立即体验 AI 集成](https://cloud.tencent.com/document/product/647/127873)
10
- >
11
-
10
+ >
12
11
 
13
12
  本文档介绍如何将 TUIRoomKit 集成到现有的 Vue3 项目中,同时介绍如何对 TUIRoomKit 的样式、布局及功能进行自定义修改。
14
13
  - 桌面端多人会议
15
14
 
16
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/31045da2d73111f097cb5254005ef0f7.png)
17
-
18
15
  - H5 多人会议
19
16
 
20
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/1d8af2f1fd3611f0b5c0525400380f7d.png)
21
-
22
-
23
17
  ## 前提条件
24
18
 
25
19
  ### 开通服务
@@ -29,7 +23,6 @@ TUIRoomKit 是腾讯云推出的音视频房间 UI 应用。本次升级引入
29
23
 
30
24
  - **SDKSecretKey**: 应用密钥,用于初始化配置文件的密钥信息。
31
25
 
32
-
33
26
  ### 环境准备
34
27
  - **Node.js**: ≥ 18.19.1 (推荐使用官方 LTS 版本)。
35
28
 
@@ -39,28 +32,22 @@ TUIRoomKit 是腾讯云推出的音视频房间 UI 应用。本次升级引入
39
32
 
40
33
  - **设备**:摄像头、麦克风、扬声器。
41
34
 
42
-
43
35
  ## 源码接入
44
36
 
45
37
  ### 步骤1:安装项目依赖
46
38
 
47
39
  在您的业务项目中安装以下依赖。
48
40
 
49
-
50
-
51
-
52
41
  【npm】
53
42
  ``` bash
54
- npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
43
+ npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
55
44
  ```
56
45
 
57
-
58
46
  【pnpm】
59
47
  ``` bash
60
48
  pnpm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
61
49
  ```
62
50
 
63
-
64
51
  【yarn】
65
52
  ``` bash
66
53
  yarn add @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
@@ -96,12 +83,12 @@ const isPC = ref(getPlatform() === 'pc');
96
83
  <!-- 您包含 ConferenceMainView 的业务组件 -->
97
84
  </UIKitProvider>
98
85
  </template>
99
-
86
+
100
87
  <script setup>
101
88
  import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
102
89
  import { onMounted } from 'vue';
103
90
  import { useLoginState } from 'tuikit-atomicx-vue3/room';
104
-
91
+
105
92
  // step 2: 用户登陆
106
93
  const { login, setSelfInfo } = useLoginState();
107
94
  const SDKAppID = 0; // 注意:请替换为实时音视频控制台获取的 SDKAppID 信息
@@ -124,14 +111,14 @@ const isPC = ref(getPlatform() === 'pc');
124
111
  }
125
112
  });
126
113
  </script>
127
-
114
+
128
115
  <!-- Step 3: 配置全局样式(此样式用来覆盖脚手架搭建的新项目的默认样式,可按需配置)-->
129
116
  <style>
130
117
  html, body {
131
118
  padding: 0 !important;
132
119
  margin: 0 !important;
133
120
  }
134
-
121
+
135
122
  #app {
136
123
  width: 100% !important;
137
124
  height: 100% !important;
@@ -147,17 +134,17 @@ const isPC = ref(getPlatform() === 'pc');
147
134
 
148
135
  ### 步骤4:发起新的会议
149
136
 
150
- 会议主持人可以通过调用 `conference.start` 接口来发起一场新的会议,其他参会者可以参见 [步骤6](https://write.woa.com/#061c9593-1112-4763-aff2-7289b3af0c41) 的描述,调用 `conference.join` 接口加入该会议。
137
+ 会议主持人可以通过调用 `conference.start` 接口来发起一场新的会议,其他参会者可以参见 步骤6 的描述,调用 `conference.join` 接口加入该会议。
151
138
 
152
139
  > **注意:**
153
- >
140
+ >
154
141
 
155
142
  > 请参考步骤 3 在用户登录成功后调用 `conference.start `接口发起会议。
156
- >
143
+ >
157
144
 
158
145
  ``` typescript
159
146
  import { conference } from '@tencentcloud/roomkit-web-vue3';
160
- const startConference = async () => {
147
+ const startConference = async () => {
161
148
  await conference.start({
162
149
  roomId: '123456', // 请替换为您真实的 roomId
163
150
  options: {
@@ -170,13 +157,13 @@ startConference();
170
157
 
171
158
  ### 步骤5:进入已有会议
172
159
 
173
- 参与者可以通过调用 `conference.join` 接口,填写对应的 roomId 参数,来加入由会议主持人在 [步骤4](https://write.woa.com/#7e2fb3c2-2b17-4445-985d-4af641ff66be) 中发起的会议。
160
+ 参与者可以通过调用 `conference.join` 接口,填写对应的 roomId 参数,来加入由会议主持人在 步骤4 中发起的会议。
174
161
 
175
162
  > **注意:**
176
- >
163
+ >
177
164
 
178
165
  > 请参考步骤 3 在用户登录成功后调用 `conference.join `接口加入会议。
179
- >
166
+ >
180
167
 
181
168
  ``` typescript
182
169
  import { conference } from '@tencentcloud/roomkit-web-vue3';
@@ -190,21 +177,16 @@ joinConference();
190
177
 
191
178
  ## 启动项目
192
179
 
193
-
194
-
195
-
196
180
  【npm】
197
181
  ``` bash
198
182
  npm run dev
199
183
  ```
200
184
 
201
-
202
185
  【pnpm】
203
186
  ``` bash
204
187
  pnpm run dev
205
188
  ```
206
189
 
207
-
208
190
  【yarn】
209
191
  ``` bash
210
192
  yarn run dev
@@ -212,45 +194,21 @@ yarn run dev
212
194
 
213
195
  启动成功后,请在浏览器中打开调试地址(通常为 http://localhost:5173)访问应用。您将看到如下所示的会议界面:
214
196
 
215
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/7986ed3bfd3711f098c8525400370dda.png)
216
-
217
-
218
197
  ## UI 快速自定义
219
198
 
220
199
  ### 主题及语言
221
200
 
222
201
  通过配置 App.vue 中 `UIKitProvider` 的入参,修改主题及语言的默认值。
223
- <table>
224
- <tr>
225
- <td rowspan="1" colSpan="1" >UIKitProvider 参数</td>
226
-
227
- <td rowspan="1" colSpan="1" >可选值</td>
228
-
229
- <td rowspan="1" colSpan="1" >默认值</td>
230
- </tr>
231
-
232
- <tr>
233
- <td rowspan="1" colSpan="1" >theme</td>
234
-
235
- <td rowspan="1" colSpan="1" >"light" \| "dark"</td>
236
-
237
- <td rowspan="1" colSpan="1" >"light"</td>
238
- </tr>
239
-
240
- <tr>
241
- <td rowspan="1" colSpan="1" >language</td>
242
-
243
- <td rowspan="1" colSpan="1" >"zh-CN" \| "en-US"</td>
244
-
245
- <td rowspan="1" colSpan="1" >"en-US"</td>
246
- </tr>
247
- </table>
202
+ | UIKitProvider 参数 | 可选值 | 默认值 |
203
+ | --- | --- | --- |
204
+ | theme | "light" \\| "dark" | "light" |
205
+ | language | "zh-CN" \\| "en-US" | "en-US" |
248
206
 
249
207
  ``` typescript
250
208
  <UIKitProvider theme="light" language="zh-CN">
251
209
  <router-view />
252
210
  </UIKitProvider>
253
-
211
+
254
212
  <script setup lang="ts">
255
213
  import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
256
214
  ```
@@ -263,15 +221,10 @@ TUIRoomKit 预定会议用户选择列表和会中呼叫用户选择列表默认
263
221
 
264
222
  步骤2:使用 [好友管理 > 导入好友](https://cloud.tencent.com/document/product/269/8301) REST API 接口批量导入用户关系链;
265
223
 
266
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/c8e55003fd8611f08080525400074c32.png)
267
-
268
-
269
224
  ## TUIRoomKit 界面定制
270
225
 
271
226
  ### 源码导出
272
227
 
273
-
274
-
275
228
  【Vue3】
276
229
  1. 执行源码导出脚本,默认拷贝路径为 `./src/components/RoomKit`
277
230
 
@@ -280,9 +233,6 @@ TUIRoomKit 预定会议用户选择列表和会中呼叫用户选择列表默认
280
233
  ```
281
234
  2. 根据脚本提示确认是否要将 TUIRoomKit 源码拷贝到 `./src/components/RoomKit` 目录。如您需要自定义拷贝目录请输入 'y', 否则输入'n'。
282
235
 
283
-
284
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/05a672b6fd8711f0a1eb52540073fd3b.png)
285
-
286
236
  3. 源码导出后,在您指定的项目路径中会新增 TUIRoomKit 源码。此时,您需要手动将 ConferenceMainView 组件,ConferenceMainViewH5 组件的 conference 对象的引用从 npm 包地址更改为 TUIRoom 源码的相对路径地址。
287
237
 
288
238
  ``` typescript
@@ -292,7 +242,6 @@ TUIRoomKit 预定会议用户选择列表和会中呼叫用户选择列表默认
292
242
  ```
293
243
  4. 配置 ESLint 校验
294
244
 
295
-
296
245
  如果您导出 TUIRoomKit 源码后运行项目出现 ESLint 报错,您可以在`.eslintignore`文件中添加 RoomKit 文件夹忽略 ESLint 检测。
297
246
  ``` javascript
298
247
  // 请替换为 TUIRoomKit 源码真实路径
@@ -322,9 +271,6 @@ function handleLayoutUpdate(layout: RoomLayoutTemplate) {
322
271
 
323
272
  TUIRoomKit 默认视频流挂件如图所示,如需自定义视频流挂件请修改 `RoomKit/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue` 组件。
324
273
 
325
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027337918/2fab38f2d73111f0929b525400bf7822.png)
326
-
327
-
328
274
  ## 常见问题
329
275
 
330
276
  #### **TUIRoomKit 在本地开发时使用正常,但部署到线上环境后无法**正常采集用户的摄像头或麦克风设备**?**
@@ -334,10 +280,9 @@ TUIRoomKit 默认视频流挂件如图所示,如需自定义视频流挂件请
334
280
 
335
281
  - **相关资源:**更多关于 URL 域名及协议的限制详情,请参见 [URL 域名及协议限制说明](https://cloud.tencent.com/document/product/647/17249#URL-.E5.9F.9F.E5.90.8D.E5.8D.8F.E8.AE.AE.E9.99.90.E5.88.B6)。
336
282
 
337
-
338
283
  #### **TUIRoomKit 是否支持使用 iframe 集成?**
339
284
 
340
- 支持。使用 iframe 集成 TUIRoomKit 时, 需要在 iframe 标签中配置 allow 属性以授予必要的浏览器权限(麦克风、摄像头、屏幕共享、全屏等),示例如下:
285
+ 支持。使用 iframe 集成 TUIRoomKit 时, 需要在 iframe 标签中配置 allow 属性以授予必要的浏览器权限(麦克风、摄像头、屏幕共享、全屏等),示例如下:
341
286
  ``` typescript
342
287
  // 开启麦克风、摄像头、屏幕分享、全屏权限
343
288
  <iframe allow="microphone; camera; display-capture; display; fullscreen;">
@@ -368,7 +313,3 @@ TUIRoomEngine.once('ready', () => {
368
313
  }));
369
314
  });
370
315
  ```
371
-
372
- ## 联系我们
373
-
374
- 如果您在接入或使用过程有任何疑问或者建议,欢迎 [联系我们](https://cloud.tencent.com/document/product/269/59590) 提交反馈。
@@ -7,17 +7,15 @@
7
7
 
8
8
  - UserSig 则是基于前两者计算出的安全签名,它由 **HMAC SHA256** 加密算法计算得出。只要攻击者不能伪造 UserSig,就无法盗用您的云服务流量。
9
9
 
10
-
11
10
  ## 在调试阶段如何计算 UserSig?
12
11
 
13
- 如果您希望快速跑通 Demo,了解 TRTC SDK 相关能力,您可以通过 [客户端示例代码](https://write.woa.com/#client) 和 [控制台](https://write.woa.com/#console) 两种方法计算获取 UserSig,具体请参见以下介绍。
12
+ 如果您希望快速跑通 Demo,了解 TRTC SDK 相关能力,您可以通过 客户端示例代码 和 控制台 两种方法计算获取 UserSig,具体请参见以下介绍。
14
13
 
15
14
  > **不安全:**
16
- >
15
+ >
17
16
 
18
17
  > 注意,如下两种 UserSig 获取计算方案仅适用于调试,如果产品要正式上线,**不推荐**采用这种方案,因为客户端代码(尤其是 Web 端)中的 SECRETKEY 很容易被反编译逆向破解。一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量。
19
- >
20
-
18
+ >
21
19
 
22
20
  ### 客户端计算 UserSig
23
21
 
@@ -30,56 +28,15 @@
30
28
 
31
29
  - 单击**复制密钥**,可将密钥拷贝到剪贴板中。
32
30
 
33
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/6db784719d3211f091df5254005ef0f7.png)
34
-
35
-
36
31
  #### **2. 计算 UserSig:**
37
32
 
38
33
  为了方便客户端使用,我们提供各平台计算 UserSig 的源码文件,您可直接下载使用:
39
- <table>
40
- <tr>
41
- <td rowspan="1" colSpan="1" >Android</td>
42
-
43
- <td rowspan="1" colSpan="1" >iOS</td>
44
-
45
- <td rowspan="1" colSpan="1" >Web</td>
46
-
47
- <td rowspan="1" colSpan="1" >微信小程序</td>
48
-
49
- <td rowspan="1" colSpan="1" >Windows(C++)</td>
50
-
51
- <td rowspan="1" colSpan="1" >Windows(C#)</td>
52
-
53
- <td rowspan="1" colSpan="1" >Flutter</td>
54
-
55
- <td rowspan="1" colSpan="1" >Mac</td>
56
- </tr>
57
-
58
- <tr>
59
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Android/tree/main/TRTC-API-Example/Debug/src/main/java/com/tencent/trtc/debug/GenerateTestUserSig.java)</td>
60
-
61
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_iOS/tree/main/TRTC-API-Example-OC/Debug/GenerateTestUserSig.h)</td>
62
-
63
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Web/blob/main/quick-demo-js/js/libs/generateTestUserSig.js)</td>
64
-
65
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/Live_WXMini/blob/main/TRTCScenesDemo/TUICallKit-WX-Demo/debug/GenerateTestUserSig.js)</td>
66
-
67
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-C%2B%2B/TRTC-API-Example-Qt/src/Util/defs.h)</td>
68
-
69
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-CSharp/TRTC-API-Example-CSharp/GenerateTestUserSig.cs)</td>
70
-
71
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/Tencent-RTC/TRTC_Flutter/blob/master/TRTC-API-Example/lib/debug/generate_test_user_sig.dart)</td>
72
-
73
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Mac/tree/main/OCDemo/TRTCDemo/TRTC/GenerateTestUserSig.h)</td>
74
- </tr>
75
- </table>
76
-
34
+ | Android | iOS | Web | 微信小程序 | Windows(C++) | Windows(C#) | Flutter | Mac |
35
+ | --- | --- | --- | --- | --- | --- | --- | --- |
36
+ | [GitHub](https://github.com/LiteAVSDK/TRTC_Android/tree/main/TRTC-API-Example/Debug/src/main/java/com/tencent/trtc/debug/GenerateTestUserSig.java) | [GitHub](https://github.com/LiteAVSDK/TRTC_iOS/tree/main/TRTC-API-Example-OC/Debug/GenerateTestUserSig.h) | [GitHub](https://github.com/LiteAVSDK/TRTC_Web/blob/main/quick-demo-js/js/libs/generateTestUserSig.js) | [GitHub](https://github.com/LiteAVSDK/Live_WXMini/blob/main/TRTCScenesDemo/TUICallKit-WX-Demo/debug/GenerateTestUserSig.js) | [GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-C%2B%2B/TRTC-API-Example-Qt/src/Util/defs.h) | [GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-CSharp/TRTC-API-Example-CSharp/GenerateTestUserSig.cs) | [GitHub](https://github.com/Tencent-RTC/TRTC_Flutter/blob/master/TRTC-API-Example/lib/debug/generate_test_user_sig.dart) | [GitHub](https://github.com/LiteAVSDK/TRTC_Mac/tree/main/OCDemo/TRTCDemo/TRTC/GenerateTestUserSig.h) |
77
37
 
78
38
  示例代码如下(当然您也可以参考我们各产品的 Demo 工程,详见各产品的开发文档):
79
39
 
80
-
81
-
82
-
83
40
  【Android】
84
41
  ``` java
85
42
  // Step1: 导入源码文件
@@ -93,7 +50,6 @@ GenerateTestUserSig.SECRETKEY = "xxxxxx";
93
50
  String userSig = GenerateTestUserSig.genTestUserSig("userID");
94
51
  ```
95
52
 
96
-
97
53
  【iOS】
98
54
  ``` objectivec
99
55
  // Step1: 导入头文件
@@ -108,7 +64,6 @@ NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
108
64
 
109
65
  ```
110
66
 
111
-
112
67
  【Web】
113
68
  ``` javascript
114
69
  // Step1: 导入模块
@@ -117,13 +72,12 @@ NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
117
72
 
118
73
  // Step2:填写上一步骤中获取到的 SDKAppID,SDK 密钥、输入自定义的userID,生成 userSig
119
74
  const {sdkAppId, userSig } = genTestUserSig({
120
- sdkAppId: xxxxxx,
75
+ sdkAppId: xxxxxx,
121
76
  userId: 'xxxxxx',
122
77
  sdkSecretKey: 'xxxxxx',
123
78
  }
124
79
  ```
125
80
 
126
-
127
81
  【微信小程序】
128
82
  ``` javascript
129
83
  // Step1: 导入模块
@@ -131,13 +85,12 @@ import { genTestUserSig } from 'GenerateTestUserSig';
131
85
 
132
86
  // Step2:填写上一步骤中获取到的 SDKAppID,SDK 密钥、输入自定义的userID,生成 userSig
133
87
  const {userSig } = genTestUserSig({
134
- sdkAppId: xx,
88
+ sdkAppId: xx,
135
89
  userId: 'xxxxxx',
136
90
  sdkSecretKey: 'xxxxxx'
137
91
  })
138
92
  ```
139
93
 
140
-
141
94
  【Window(C++)】
142
95
  ``` cpp
143
96
  // Step1: 导入头文件
@@ -151,21 +104,19 @@ const char* SECRETKEY = "xxxxxx";
151
104
  const char* userSig = GenerateTestUserSig::genTestUserSig("userID", SDKAPPID, SECRETKEY);
152
105
  ```
153
106
 
154
-
155
107
  【Window(C#)】
156
108
  ``` csharp
157
109
  // Step1: 导入头文件
158
110
  using GenerateTestUserSig;
159
111
 
160
112
  // Step2: 填写上一步骤中获取到的 SDKAppID 和 SDK 密钥
161
- GenerateTestUserSig.SDKAPPID = xxxxxx;
113
+ GenerateTestUserSig.SDKAPPID = xxxxxx;
162
114
  GenerateTestUserSig.SECRETKEY = "xxxxxx";
163
115
 
164
116
  // Step3:根据 userID,生成 userSig
165
117
  string userSig = GenerateTestUserSig.GetInstance().GenTestUserSig("userID");
166
118
  ```
167
119
 
168
-
169
120
  【Flutter】
170
121
  ``` django
171
122
  // Step1: 导入源码文件
@@ -179,7 +130,6 @@ GenerateTestUserSig.SECRETKEY = "xxxxxx";
179
130
  String userSig = GenerateTestUserSig.genTestUserSig("userID");
180
131
  ```
181
132
 
182
-
183
133
  【Mac】
184
134
  ``` objectivec
185
135
  // Step1: 导入头文件
@@ -200,15 +150,10 @@ NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
200
150
 
201
151
  - 单击**生成签名(UserSig)**,即可计算得到对应的 UserSig。
202
152
 
203
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/5492b1619d3211f091df5254005ef0f7.png)
204
-
205
-
206
153
  ## 在正式运行阶段如何计算 UserSig?
207
154
 
208
155
  业务正式运行阶段,TRTC 提供安全等级更高的服务端计算 UserSig 的方案,可以最大限度地保障计算 UserSig 用的密钥不被泄露,因为攻破一台服务器的难度要高于逆向一款 App。具体的实现流程如下:
209
156
 
210
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100023397867/eeb64e021c6411ed9c01525400d6c3c4.png)
211
-
212
157
  1. 您的 App 在调用 SDK 的初始化函数之前,首先要向您的服务器请求 UserSig。
213
158
 
214
159
  2. 您的服务器根据 SDKAppID 和 UserID 计算 UserSig,计算源码见文档前半部分。
@@ -223,87 +168,18 @@ NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
223
168
 
224
169
  7. 校验通过后,会向 TRTCSDK 提供实时音视频服务。
225
170
 
226
-
227
-
228
-
229
171
  为了简化您的实现过程,我们提供了多个语言版本的 UserSig 计算源代码及其示例:
230
- <table>
231
- <tr>
232
- <td rowspan="1" colSpan="1" >语言版本</td>
233
-
234
- <td rowspan="1" colSpan="1" >签名算法</td>
235
-
236
- <td rowspan="1" colSpan="1" >源代码</td>
237
-
238
- <td rowspan="1" colSpan="1" >使用示例</td>
239
- </tr>
240
-
241
- <tr>
242
- <td rowspan="1" colSpan="1" >Java</td>
243
-
244
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
245
-
246
- <td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-java/blob/master/src/main/java/com/tencentyun/TLSSigAPIv2.java)</td>
247
-
248
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-java)</td>
249
- </tr>
250
-
251
- <tr>
252
- <td rowspan="1" colSpan="1" >GO</td>
253
-
254
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
255
-
256
- <td rowspan="1" colSpan="1" >[GenSig](https://github.com/tencentyun/tls-sig-api-v2-golang/blob/master/tencentyun/TLSSigAPI.go)</td>
257
-
258
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-golang)</td>
259
- </tr>
260
-
261
- <tr>
262
- <td rowspan="1" colSpan="1" >PHP</td>
263
-
264
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
265
-
266
- <td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-php/blob/master/src/TLSSigAPIv2.php)</td>
267
-
268
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-php)</td>
269
- </tr>
270
-
271
- <tr>
272
- <td rowspan="1" colSpan="1" >Node.js</td>
273
-
274
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
275
-
276
- <td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-node/blob/master/TLSSigAPIv2.js)</td>
277
-
278
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-node)</td>
279
- </tr>
280
-
281
- <tr>
282
- <td rowspan="1" colSpan="1" >Python</td>
283
-
284
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
285
-
286
- <td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-python/blob/master/TLSSigAPIv2.py)</td>
287
-
288
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-python)</td>
289
- </tr>
290
-
291
- <tr>
292
- <td rowspan="1" colSpan="1" >C#</td>
293
-
294
- <td rowspan="1" colSpan="1" >HMAC-SHA256</td>
295
-
296
- <td rowspan="1" colSpan="1" >[GenSig](https://github.com/tencentyun/tls-sig-api-v2-cs/blob/master/tls-sig-api-v2-cs/TLSSigAPIv2.cs)</td>
297
-
298
- <td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-cs)</td>
299
- </tr>
300
- </table>
301
-
172
+ | 语言版本 | 签名算法 | 源代码 | 使用示例 |
173
+ | --- | --- | --- | --- |
174
+ | Java | HMAC-SHA256 | [genSig](https://github.com/tencentyun/tls-sig-api-v2-java/blob/master/src/main/java/com/tencentyun/TLSSigAPIv2.java) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-java) |
175
+ | GO | HMAC-SHA256 | [GenSig](https://github.com/tencentyun/tls-sig-api-v2-golang/blob/master/tencentyun/TLSSigAPI.go) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-golang) |
176
+ | PHP | HMAC-SHA256 | [genSig](https://github.com/tencentyun/tls-sig-api-v2-php/blob/master/src/TLSSigAPIv2.php) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-php) |
177
+ | Node.js | HMAC-SHA256 | [genSig](https://github.com/tencentyun/tls-sig-api-v2-node/blob/master/TLSSigAPIv2.js) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-node) |
178
+ | Python | HMAC-SHA256 | [genSig](https://github.com/tencentyun/tls-sig-api-v2-python/blob/master/TLSSigAPIv2.py) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-python) |
179
+ | C# | HMAC-SHA256 | [GenSig](https://github.com/tencentyun/tls-sig-api-v2-cs/blob/master/tls-sig-api-v2-cs/TLSSigAPIv2.cs) | [GitHub](https://github.com/tencentyun/tls-sig-api-v2-cs) |
302
180
 
303
181
  ## 常见问题
304
182
 
305
183
  ### **SDK 密钥如何切换为非对称密钥?**
306
184
 
307
185
  若查看密钥时只能获取公钥和私钥信息,可点击下图所示位置切换为最新的非对称密钥,请注意:切换密钥前请确保线上业务已停用。
308
-
309
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/1ce5156f039e11f09c4a5254001c06ec.png)