@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,71 +1,32 @@
1
1
  本文对 TUILiveKit 组件中的**媒体源配置面板(LiveScenePanel)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
2
2
 
3
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/be6ef71a975411f093df52540099c741.png)
4
-
5
-
6
3
  ## 核心功能
7
- <table>
8
- <tr>
9
- <td rowspan="1" colSpan="1" >**功能分类**</td>
10
-
11
- <td rowspan="1" colSpan="1" >**具体能力**</td>
12
- </tr>
13
-
14
- <tr>
15
- <td rowspan="1" colSpan="1" >**多素材类型支持**</td>
16
-
17
- <td rowspan="1" colSpan="1" >摄像头、屏幕共享、图片、视频、文本等多种素材类型,支持设备选择和参数配置。</td>
18
- </tr>
19
-
20
- <tr>
21
- <td rowspan="1" colSpan="1" >**智能显示模式**</td>
22
-
23
- <td rowspan="1" colSpan="1" >无素材时显示完整面板,有素材时自动切换为紧凑按钮模式,响应式布局适配。</td>
24
- </tr>
25
-
26
- <tr>
27
- <td rowspan="1" colSpan="1" >**素材管理操作**</td>
28
-
29
- <td rowspan="1" colSpan="1" >添加、编辑、重命名、删除、排序等完整的素材管理功能,支持批量操作。</td>
30
- </tr>
31
-
32
- <tr>
33
- <td rowspan="1" colSpan="1" >**实时预览配置**</td>
34
-
35
- <td rowspan="1" colSpan="1" >摄像头配置弹窗提供实时预览,支持参数调整和设备测试。</td>
36
- </tr>
37
-
38
- <tr>
39
- <td rowspan="1" colSpan="1" >**权限与错误处理**</td>
40
-
41
- <td rowspan="1" colSpan="1" >自动权限检查,友好的错误提示和重试机制,保障用户体验。</td>
42
- </tr>
43
- </table>
44
-
4
+ | **功能分类** | **具体能力** |
5
+ | --- | --- |
6
+ | **多素材类型支持** | 摄像头、屏幕共享、图片、视频、文本等多种素材类型,支持设备选择和参数配置。 |
7
+ | **智能显示模式** | 无素材时显示完整面板,有素材时自动切换为紧凑按钮模式,响应式布局适配。 |
8
+ | **素材管理操作** | 添加、编辑、重命名、删除、排序等完整的素材管理功能,支持批量操作。 |
9
+ | **实时预览配置** | 摄像头配置弹窗提供实时预览,支持参数调整和设备测试。 |
10
+ | **权限与错误处理** | 自动权限检查,友好的错误提示和重试机制,保障用户体验。 |
45
11
 
46
12
  ## 组件接入
47
13
 
48
14
  ### 步骤1:环境配置及开通服务
49
15
 
50
- 在进行快速接入之前,您需要参考[准备工作](https://write.woa.com/document/185222107981008896),满足相关环境配置及开通对应服务。
16
+ 在进行快速接入之前,您需要参考准备工作,满足相关环境配置及开通对应服务。
51
17
 
52
18
  ### 步骤2:安装依赖
53
19
 
54
-
55
-
56
-
57
20
  【npm】
58
21
  ``` bash
59
22
  npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
60
23
  ```
61
24
 
62
-
63
25
  【pnpm】
64
26
  ``` bash
65
27
  pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
66
28
  ```
67
29
 
68
-
69
30
  【yarn】
70
31
  ``` bash
71
32
  yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
@@ -124,34 +85,10 @@ onMounted(async () => {
124
85
 
125
86
  <style>.app-container{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.custom-live-scene-panel{width:100%;max-width:300px;height:80vh;background:linear-gradient(135deg,#667eea 0%,#764ba2 100%);border:2px solid #4c63d2;border-radius:16px;padding:24px;box-shadow:0 8px 32px rgba(0,0,0,0.1);color:white}.custom-live-scene-panel .add-material-item{background-color:#147fcb!important;color:white;border:none;border-radius:0!important;padding:12px 24px;font-weight:600;transition:all 0.3s ease}.custom-live-scene-panel .materials-list{margin-top:20px;gap:16px;display:grid;grid-template-columns:repeat(auto-fill,minmax(200px,1fr))}.custom-live-scene-panel .material-item{background:rgba(255,255,255,0.1);border:1px solid rgba(255,255,255,0.2);border-radius:12px;padding:16px;backdrop-filter:blur(10px);transition:all 0.3s ease}.custom-live-scene-panel .material-item:hover{background:rgba(255,255,255,0.2);transform:scale(1.02)}</style>
126
87
  ```
127
- <table>
128
- <tr>
129
- <td rowspan="1" colSpan="2" >**修改前**</td>
130
-
131
- <td rowspan="1" colSpan="2" >**修改后**</td>
132
- </tr>
133
-
134
- <tr>
135
- <td rowspan="1" colSpan="1" >**添加媒体源界面**</td>
136
-
137
- <td rowspan="1" colSpan="1" >**媒体源设置界面**</td>
138
-
139
- <td rowspan="1" colSpan="1" >**添加媒体源界面**</td>
140
-
141
- <td rowspan="1" colSpan="1" >**媒体源设置界面**</td>
142
- </tr>
143
-
144
- <tr>
145
- <td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/be374b93975411f093df52540099c741.png)</td>
146
-
147
- <td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/be294e63975411f0a7c6525400e889b2.png)</td>
148
-
149
- <td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/be90885c975411f0af98525400454e06.png)</td>
150
-
151
- <td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/be5b3349975411f0b5725254001c06ec.png)</td>
152
- </tr>
153
- </table>
154
-
88
+ | **修改前** | **修改后** | | |
89
+ | --- | --- | --- | --- |
90
+ | **添加媒体源界面** | **媒体源设置界面** | **添加媒体源界面** | **媒体源设置界面** |
91
+ | | | | |
155
92
 
156
93
  ### 状态监听与扩展
157
94
 
@@ -190,4 +127,4 @@ watch(mediaSourceList, (newList, oldList) => {
190
127
  </script>
191
128
 
192
129
  <style>.status-info {display: flex; gap: 20px; padding: 12px; background: #f8f9fa;border-radius: 6px; margin-bottom: 16px;font-size: 14px;}</style>
193
- ```
130
+ ```
@@ -1,53 +1,29 @@
1
1
  本文对**直播视频组件(LiveView)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式,布局进行深度的定制。
2
2
 
3
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/1b766277b00211f09e195254007c27c5.png)
4
-
5
-
6
3
  ## 核心功能
7
- <table>
8
- <tr>
9
- <td rowspan="1" colSpan="1" >**功能分类**</td>
10
-
11
- <td rowspan="1" colSpan="1" >**具体能力**</td>
12
- </tr>
13
-
14
- <tr>
15
- <td rowspan="1" colSpan="1" >**智能流切换**</td>
16
-
17
- <td rowspan="1" colSpan="1" >LiveView 能够根据当前用户的身份(观众或连麦者)自动切换流类型。<br>- 观众模式: 组件将播放超低延迟视频流,确保数百万观众都能流畅观看,同时大幅节省流量成本。<br>- 连线模式: 组件会自动切换到实时音视频流,提供毫秒级的超低延迟,保证连线用户之间实时、清晰的互动体验。</td>
18
- </tr>
19
-
20
- <tr>
21
- <td rowspan="1" colSpan="1" >**可定制化 UI**</td>
22
-
23
- <td rowspan="1" colSpan="1" >为了满足多样化的业务场景,LiveView 提供组件 UI 自定义插槽,让您能够完全掌控连麦用户的视频流区域,重写其 UI 展示,灵活定义连麦用户的头像、昵称、状态等信息,轻松打造符合您品牌风格的独特视觉体验。</td>
24
- </tr>
25
- </table>
26
-
4
+ | **功能分类** | **具体能力** |
5
+ | --- | --- |
6
+ | **智能流切换** | LiveView 能够根据当前用户的身份(观众或连麦者)自动切换流类型。<br>- 观众模式: 组件将播放超低延迟视频流,确保数百万观众都能流畅观看,同时大幅节省流量成本。<br>- 连线模式: 组件会自动切换到实时音视频流,提供毫秒级的超低延迟,保证连线用户之间实时、清晰的互动体验。 |
7
+ | **可定制化 UI** | 为了满足多样化的业务场景,LiveView 提供组件 UI 自定义插槽,让您能够完全掌控连麦用户的视频流区域,重写其 UI 展示,灵活定义连麦用户的头像、昵称、状态等信息,轻松打造符合您品牌风格的独特视觉体验。 |
27
8
 
28
9
  ## 组件接入
29
10
 
30
11
  ### 步骤1:环境配置及开通服务
31
12
 
32
- 在进行快速接入之前,您需要参考 [准备工作](https://write.woa.com/document/185222107981008896),满足相关环境配置及开通对应服务。
13
+ 在进行快速接入之前,您需要参考 准备工作,满足相关环境配置及开通对应服务。
33
14
 
34
15
  ### 步骤2: 安装依赖
35
16
 
36
-
37
-
38
-
39
17
  【npm】
40
18
  ``` bash
41
19
  npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
42
20
  ```
43
21
 
44
-
45
22
  【pnpm】
46
23
  ``` bash
47
24
  pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
48
25
  ```
49
26
 
50
-
51
27
  【yarn】
52
28
  ``` bash
53
29
  yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
@@ -87,7 +63,7 @@ async function initLogin() {
87
63
  }
88
64
 
89
65
  onMounted(async () => {
90
- await initLogin();
66
+ await initLogin();
91
67
  await joinLive({
92
68
  liveId: '已经存在的直播间 Id', // 观众进入直播间之后, LiveView 自动播放超低延时流
93
69
  })
@@ -103,23 +79,9 @@ onMounted(async () => {
103
79
  LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自己需求调整头像、昵称、状态等元素的样式与布局,也支持定制视频流区域连麦 UI。下列分别给出插槽使用示例
104
80
 
105
81
  #### 组件插槽
106
- <table>
107
- <tr>
108
- <td rowspan="1" colSpan="1" >**名称**</td>
109
-
110
- <td rowspan="1" colSpan="1" >**参数**</td>
111
-
112
- <td rowspan="1" colSpan="1" >**说明**</td>
113
- </tr>
114
-
115
- <tr>
116
- <td rowspan="1" colSpan="1" >streamViewUI</td>
117
-
118
- <td rowspan="1" colSpan="1" >userInfo</td>
119
-
120
- <td rowspan="1" colSpan="1" >自定义麦位的显示 UI</td>
121
- </tr>
122
- </table>
82
+ | **名称** | **参数** | **说明** |
83
+ | --- | --- | --- |
84
+ | streamViewUI | userInfo | 自定义麦位的显示 UI |
123
85
 
124
86
  ``` java
125
87
  // streamViewUI 插槽使用示例
@@ -129,126 +91,27 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
129
91
  ```
130
92
  1. `userInfo` 定义了直播房间中每个麦位的基本信息和状态:
131
93
 
132
- <table>
133
- <tr>
134
- <td rowspan="1" colSpan="1" >参数</td>
135
-
136
- <td rowspan="1" colSpan="1" >类型</td>
137
-
138
- <td rowspan="1" colSpan="1" >属性</td>
139
-
140
- <td rowspan="1" colSpan="1" >说明</td>
141
- </tr>
142
-
143
- <tr>
144
- <td rowspan="1" colSpan="1" >userInfo</td>
145
-
146
- <td rowspan="1" colSpan="1" >userInfo</td>
147
-
148
- <td rowspan="1" colSpan="1" >非必填</td>
149
-
150
- <td rowspan="1" colSpan="1" >当前坐在该麦位上的用户信息,如果麦位为空则为 `undefined`。</td>
151
- </tr>
152
- </table>
94
+ | 参数 | 类型 | 属性 | 说明 |
95
+ | --- | --- | --- | --- |
96
+ | userInfo | userInfo | 非必填 | 当前坐在该麦位上的用户信息,如果麦位为空则为 `undefined`。 |
153
97
 
154
98
  ``` typescript
155
99
  interface userInfo {
156
100
  userInfo: userInfo; // 麦位上的用户信息
157
- }
101
+ }
158
102
  ```
159
103
  2. `userInfo` 定义了直播房间中每个麦位上的用户详细信息:
160
104
 
161
- <table>
162
- <tr>
163
- <td rowspan="1" colSpan="1" >参数</td>
164
-
165
- <td rowspan="1" colSpan="1" >类型</td>
166
-
167
- <td rowspan="1" colSpan="1" >属性</td>
168
-
169
- <td rowspan="1" colSpan="1" >说明</td>
170
- </tr>
171
-
172
- <tr>
173
- <td rowspan="1" colSpan="1" >roomId</td>
174
-
175
- <td rowspan="1" colSpan="1" >string</td>
176
-
177
- <td rowspan="1" colSpan="1" >必填</td>
178
-
179
- <td rowspan="1" colSpan="1" >当前直播房间的唯一标识符,用于区分不同的直播房间。</td>
180
- </tr>
181
-
182
- <tr>
183
- <td rowspan="1" colSpan="1" >userId</td>
184
-
185
- <td rowspan="1" colSpan="1" >string</td>
186
-
187
- <td rowspan="1" colSpan="1" >必填</td>
188
-
189
- <td rowspan="1" colSpan="1" >用户的唯一标识符,在整个系统中保持唯一性。</td>
190
- </tr>
191
-
192
- <tr>
193
- <td rowspan="1" colSpan="1" >userName</td>
194
-
195
- <td rowspan="1" colSpan="1" >string</td>
196
-
197
- <td rowspan="1" colSpan="1" >必填</td>
198
-
199
- <td rowspan="1" colSpan="1" >用户在直播中显示的名称,支持中文、英文等字符。</td>
200
- </tr>
201
-
202
- <tr>
203
- <td rowspan="1" colSpan="1" >avatarUrl</td>
204
-
205
- <td rowspan="1" colSpan="1" >string</td>
206
-
207
- <td rowspan="1" colSpan="1" >必填</td>
208
-
209
- <td rowspan="1" colSpan="1" >用户头像的完整URL地址,支持 HTTPS 协议。</td>
210
- </tr>
211
-
212
- <tr>
213
- <td rowspan="1" colSpan="1" >microphoneStatus</td>
214
-
215
- <td rowspan="1" colSpan="1" >DeviceStatus</td>
216
-
217
- <td rowspan="1" colSpan="1" >必填</td>
218
-
219
- <td rowspan="1" colSpan="1" >麦克风的当前状态。</td>
220
- </tr>
221
-
222
- <tr>
223
- <td rowspan="1" colSpan="1" >microphoneStatusReason</td>
224
-
225
- <td rowspan="1" colSpan="1" >DeviceStatusReason</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" >cameraStatus</td>
234
-
235
- <td rowspan="1" colSpan="1" >DeviceStatus</td>
236
-
237
- <td rowspan="1" colSpan="1" >必填</td>
238
-
239
- <td rowspan="1" colSpan="1" >摄像头的当前状态。</td>
240
- </tr>
241
-
242
- <tr>
243
- <td rowspan="1" colSpan="1" >cameraStatusReason</td>
244
-
245
- <td rowspan="1" colSpan="1" >DeviceStatusReason</td>
246
-
247
- <td rowspan="1" colSpan="1" >必填</td>
248
-
249
- <td rowspan="1" colSpan="1" >摄像头状态变更的原因,用于区分是用户主动操作还是管理员操作。</td>
250
- </tr>
251
- </table>
105
+ | 参数 | 类型 | 属性 | 说明 |
106
+ | --- | --- | --- | --- |
107
+ | roomId | string | 必填 | 当前直播房间的唯一标识符,用于区分不同的直播房间。 |
108
+ | userId | string | 必填 | 用户的唯一标识符,在整个系统中保持唯一性。 |
109
+ | userName | string | 必填 | 用户在直播中显示的名称,支持中文、英文等字符。 |
110
+ | avatarUrl | string | 必填 | 用户头像的完整URL地址,支持 HTTPS 协议。 |
111
+ | microphoneStatus | DeviceStatus | 必填 | 麦克风的当前状态。 |
112
+ | microphoneStatusReason | DeviceStatusReason | 必填 | 麦克风状态变更的原因,用于区分是用户主动操作还是管理员操作。 |
113
+ | cameraStatus | DeviceStatus | 必填 | 摄像头的当前状态。 |
114
+ | cameraStatusReason | DeviceStatusReason | 必填 | 摄像头状态变更的原因,用于区分是用户主动操作还是管理员操作。 |
252
115
 
253
116
  ``` typescript
254
117
  interface SeatUserInfo {
@@ -261,7 +124,7 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
261
124
  cameraStatus: DeviceStatus; // 摄像头状态
262
125
  allowOpenCamera: boolean; // 是否允许打开摄像头
263
126
  }
264
-
127
+
265
128
  export type SeatUserInfo = {
266
129
  liveId: string; // 直播房间ID
267
130
  userId: string; // 用户唯一标识
@@ -275,67 +138,13 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
275
138
  ```
276
139
  3. `RegionInfo` 定义了麦位在视频画布中的显示区域和层级信息:
277
140
 
278
- <table>
279
- <tr>
280
- <td rowspan="1" colSpan="1" >参数</td>
281
-
282
- <td rowspan="1" colSpan="1" >类型</td>
283
-
284
- <td rowspan="1" colSpan="1" >属性</td>
285
-
286
- <td rowspan="1" colSpan="1" >说明</td>
287
- </tr>
288
-
289
- <tr>
290
- <td rowspan="1" colSpan="1" >x</td>
291
-
292
- <td rowspan="1" colSpan="1" >number</td>
293
-
294
- <td rowspan="1" colSpan="1" >必填</td>
295
-
296
- <td rowspan="1" colSpan="1" >区域左上角相对于画布左上角的X坐标(像素值)。</td>
297
- </tr>
298
-
299
- <tr>
300
- <td rowspan="1" colSpan="1" >y</td>
301
-
302
- <td rowspan="1" colSpan="1" >number</td>
303
-
304
- <td rowspan="1" colSpan="1" >必填</td>
305
-
306
- <td rowspan="1" colSpan="1" >区域左上角相对于画布左上角的Y坐标(像素值)。</td>
307
- </tr>
308
-
309
- <tr>
310
- <td rowspan="1" colSpan="1" >w</td>
311
-
312
- <td rowspan="1" colSpan="1" >number</td>
313
-
314
- <td rowspan="1" colSpan="1" >必填</td>
315
-
316
- <td rowspan="1" colSpan="1" >区域的宽度(像素值),必须大于0。</td>
317
- </tr>
318
-
319
- <tr>
320
- <td rowspan="1" colSpan="1" >h</td>
321
-
322
- <td rowspan="1" colSpan="1" >number</td>
323
-
324
- <td rowspan="1" colSpan="1" >必填</td>
325
-
326
- <td rowspan="1" colSpan="1" >区域的高度(像素值),必须大于0。</td>
327
- </tr>
328
-
329
- <tr>
330
- <td rowspan="1" colSpan="1" >zOrder</td>
331
-
332
- <td rowspan="1" colSpan="1" >number</td>
333
-
334
- <td rowspan="1" colSpan="1" >必填</td>
335
-
336
- <td rowspan="1" colSpan="1" >层级顺序,数值越大越靠前显示,用于处理重叠区域的显示优先级。</td>
337
- </tr>
338
- </table>
141
+ | 参数 | 类型 | 属性 | 说明 |
142
+ | --- | --- | --- | --- |
143
+ | x | number | 必填 | 区域左上角相对于画布左上角的X坐标(像素值)。 |
144
+ | y | number | 必填 | 区域左上角相对于画布左上角的Y坐标(像素值)。 |
145
+ | w | number | 必填 | 区域的宽度(像素值),必须大于0。 |
146
+ | h | number | 必填 | 区域的高度(像素值),必须大于0。 |
147
+ | zOrder | number | 必填 | 层级顺序,数值越大越靠前显示,用于处理重叠区域的显示优先级。 |
339
148
 
340
149
  ``` typescript
341
150
  interface RegionInfo {
@@ -354,7 +163,7 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
354
163
  <template>
355
164
  <LiveView>
356
165
  <template #streamViewUI="{ userInfo }">
357
- <div
166
+ <div
358
167
  class="live-stream-view"
359
168
  :class="{ 'is-anchor': isAnchor(userInfo), 'is-guest': !isAnchor(userInfo) }"
360
169
  >
@@ -362,7 +171,7 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
362
171
  <div class="video-area">
363
172
  <!-- 视频流会自动渲染 -->
364
173
  </div>
365
-
174
+
366
175
  <!-- 用户信息覆盖层 -->
367
176
  <div class="user-overlay">
368
177
  <div class="user-badge" :class="{ 'anchor-badge': isAnchor(userInfo) }">
@@ -0,0 +1,211 @@
1
+ 本文对 TUILiveKit 组件中的**视频源编辑画板(StreamMixer)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式,布局进行深度的定制。
2
+
3
+ ## 核心功能
4
+ | **功能分类** | **具体能力** |
5
+ | --- | --- |
6
+ | **实时预览** | 提供所见即所得的编辑体验,主播可以直观地看到混流效果,支持对元素进行旋转、移动、缩放、镜像、层级调整等操作 |
7
+ | **模板布局** | 内置多种直播间布局模板,支持自动适配不同连麦场景,包括九宫格、1v6、浮窗等,帮助您快速切换不同风格的直播画面。 |
8
+ | **用户状态管理** | 智能感知连麦用户的加入和退出,自动调整布局,无需手动干预,确保了直播过程的流畅性,为主播提供无缝体验。 |
9
+ | **可定制化 UI** | 为了满足多样化的业务场景,视频源编辑画板提供组件 UI 自定义插槽,让您能够完全掌控连麦用户的视频流区域,重写其 UI 展示,灵活定义连麦用户的头像、昵称、状态等信息,轻松打造符合您 UI 风格的独特视觉体验。 |
10
+
11
+ ## 组件接入
12
+
13
+ ### 步骤1:环境配置及开通服务
14
+
15
+ 在进行快速接入之前,您需要参见 准备工作,满足相关环境配置及开通对应服务。
16
+
17
+ ### 步骤2: 安装依赖
18
+
19
+ 【npm】
20
+ ``` bash
21
+ npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
22
+ ```
23
+
24
+ 【pnpm】
25
+ ``` bash
26
+ pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
27
+ ```
28
+
29
+ 【yarn】
30
+ ``` bash
31
+ yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
32
+ ```
33
+
34
+ ### 步骤3:加入直播间
35
+
36
+ 在您的项目中引入并使用**视频源编辑画板**,可直接复制如下代码示例至您的项目中加入对应直播间。
37
+ ``` typescript
38
+ <template>
39
+ <UIKitProvider theme="dark" language="zh-CN">
40
+ <div class="app">
41
+ <LiveScenePanel class="live-scene-panel" />
42
+ <StreamMixer class="live-stream-mixer" />
43
+ </div>
44
+ </UIKitProvider>
45
+ </template>
46
+
47
+ <script setup lang="ts">
48
+ import { onMounted } from 'vue';
49
+ import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
50
+ import { LiveScenePanel, StreamMixer, useLoginState, useLiveState, useCoGuestState } from 'tuikit-atomicx-vue3';
51
+
52
+ const { login } = useLoginState();
53
+ const { createLive } = useLiveState();
54
+ const { sendCoGuestRequest } = useCoGuestState();
55
+
56
+ async function initLogin() {
57
+ try {
58
+ await login({
59
+ sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
60
+ userId: '', // UserID, 可以参考步骤 1 获取
61
+ userSig: '', // userSig, 可以参考步骤 1 获取
62
+ });
63
+ } catch (error) {
64
+ console.error('登录失败:', error);
65
+ }
66
+ }
67
+
68
+ onMounted(async () => {
69
+ await initLogin();
70
+ await createLive({ // 主播创建直播间之后, StreamMixer 自动将本地合图画面推流到直播间
71
+ liveId: `live_${loginUserInfo.value.userId}`,
72
+ liveName: `${loginUserInfo.value?.userName} 的直播间`,
73
+ });
74
+ await sendCoGuestRequest(); // 观众端通过调用相应方法即可加入直播间并根据需要上下麦,观众成功上麦之后,StreamMixer 自动播放实时音视频流
75
+ });
76
+ </script>
77
+
78
+ <style>.app {width: 100vw; height: 100vh; display: flex; justify-content: center; align-items: center}</style>
79
+ ```
80
+ ``` bash
81
+ npm run dev
82
+ ```
83
+
84
+ ## 组件定制化
85
+
86
+ **视频源编辑画板**提供了灵活的组件自定义插槽,该插槽支持您根据自己需求调整头像、昵称、状态等元素的样式与布局,也支持定制视频流区域连麦 UI。下列分别给出插槽使用示例
87
+
88
+ ### 组件插槽
89
+ | **名称** | **参数** | **说明** |
90
+ | --- | --- | --- |
91
+ | seatViewUI | seatInfo: SeatInfo | 自定义麦位的显示 UI |
92
+
93
+ ``` java
94
+ // seatViewUI 插槽使用示例
95
+ <StreamMixer>
96
+ <CustomSeatViewUI #seatViewUI></CustomSeatViewUI>
97
+ </StreamMixer>
98
+ ```
99
+ 1. `SeatInfo` 定义了直播房间中每个麦位的基本信息和状态:
100
+
101
+ | 参数 | 类型 | 属性 | 说明 |
102
+ | --- | --- | --- | --- |
103
+ | index | number | 必填 | 麦位的索引号,从0开始递增,用于标识麦位在房间中的位置。 |
104
+ | isLocked | boolean | 必填 | 麦位锁定状态,true 表示麦位被锁定,其他用户无法进入;false 表示麦位开放。 |
105
+ | userInfo | SeatUserInfo | 非必填 | 当前坐在该麦位上的用户信息,如果麦位为空则为 `undefined`。 |
106
+ | region | RegionInfo | 非必填 | 麦位在视频画布中的显示区域信息,用于多路视频布局。 |
107
+
108
+ ``` typescript
109
+ interface SeatInfo {
110
+ index: number; // 麦位索引
111
+ isLocked: boolean; // 麦位是否被锁定
112
+ userInfo?: SeatUserInfo; // 麦位上的用户信息(可选)
113
+ region?: RegionInfo; // 麦位在画布中的区域信息(可选)
114
+ }
115
+ ```
116
+ 2. `SeatUserInfo` 定义了直播房间中每个麦位上的用户详细信息:
117
+
118
+ | 参数 | 类型 | 属性 | 说明 |
119
+ | --- | --- | --- | --- |
120
+ | roomId | string | 必填 | 当前直播房间的唯一标识符,用于区分不同的直播房间。 |
121
+ | userId | string | 必填 | 用户的唯一标识符,在整个系统中保持唯一性。 |
122
+ | userName | string | 必填 | 用户在直播中显示的名称,支持中文、英文等字符。 |
123
+ | avatarUrl | string | 必填 | 用户头像的完整URL地址,支持 HTTPS 协议。 |
124
+ | microphoneStatus | DeviceStatus | 必填 | 麦克风的当前状态。 |
125
+ | microphoneStatusReason | DeviceStatusReason | 必填 | 麦克风状态变更的原因,用于区分是用户主动操作还是管理员操作。 |
126
+ | cameraStatus | DeviceStatus | 必填 | 摄像头的当前状态。 |
127
+ | cameraStatusReason | DeviceStatusReason | 必填 | 摄像头状态变更的原因,用于区分是用户主动操作还是管理员操作。 |
128
+
129
+ ``` typescript
130
+ interface SeatUserInfo {
131
+ roomId: string; // 直播房间ID
132
+ userId: string; // 用户唯一标识
133
+ userName: string; // 用户显示名称
134
+ avatarUrl: string; // 用户头像URL
135
+ microphoneStatus: DeviceStatus; // 麦克风状态
136
+ allowOpenMicrophone: boolean; // 是否允许打开麦克风
137
+ cameraStatus: DeviceStatus; // 摄像头状态
138
+ allowOpenCamera: boolean; // 是否允许打开摄像头
139
+ }
140
+
141
+ export type SeatUserInfo = {
142
+ liveId: string; // 直播房间ID
143
+ userId: string; // 用户唯一标识
144
+ userName: string; // 用户显示名称
145
+ avatarUrl: string; // 用户头像URL
146
+ microphoneStatus: DeviceStatus; // 麦克风状态
147
+ microphoneStatusReason: DeviceStatusReason; // 麦克风状态变更原因
148
+ cameraStatus: DeviceStatus; // 摄像头状态
149
+ cameraStatusReason: DeviceStatusReason; // 摄像头状态变更原因
150
+ }
151
+ ```
152
+ 3. `RegionInfo` 定义了麦位在视频画布中的显示区域和层级信息:
153
+
154
+ | 参数 | 类型 | 属性 | 说明 |
155
+ | --- | --- | --- | --- |
156
+ | x | number | 必填 | 区域左上角相对于画布左上角的X坐标(像素值)。 |
157
+ | y | number | 必填 | 区域左上角相对于画布左上角的Y坐标(像素值)。 |
158
+ | w | number | 必填 | 区域的宽度(像素值),必须大于0。 |
159
+ | h | number | 必填 | 区域的高度(像素值),必须大于0。 |
160
+ | zOrder | number | 必填 | 层级顺序,数值越大越靠前显示,用于处理重叠区域的显示优先级。 |
161
+
162
+ ``` typescript
163
+ interface RegionInfo {
164
+ x: number; // 区域左上角X坐标
165
+ y: number; // 区域左上角Y坐标
166
+ w: number; // 区域宽度
167
+ h: number; // 区域高度
168
+ zOrder: number; // 层级顺序
169
+ }
170
+ ```
171
+
172
+ ### 自定义插槽示例
173
+
174
+ 为了更好地让您体验及理解视频源编辑画板 组件的 seatViewUI 插槽定制化能力,我们提供了**直播连麦场景**示例场景供您参考,您可以参考上述**步骤3**将以下代码增量复制至您的项目中实现类似场景的效果。
175
+ ``` typescript
176
+ <template>
177
+ <StreamMixer>
178
+ <template #seatViewUI="{ userInfo }">
179
+ <div
180
+ class="live-stream-view"
181
+ :class="{ 'is-anchor': isAnchor(userInfo), 'is-guest': !isAnchor(userInfo) }"
182
+ >
183
+ <!-- 用户信息覆盖层 -->
184
+ <div class="user-overlay">
185
+ <div class="user-badge" :class="{ 'anchor-badge': isAnchor(userInfo) }">
186
+ {{ isAnchor(userInfo) ? '主播' : '观众' }}
187
+ </div>
188
+ <div class="user-name">{{ userInfo.userName }}</div>
189
+ <div class="device-status">
190
+ <span :class="['mic', userInfo.microphoneStatus]"></span>
191
+ <span :class="['camera', userInfo.cameraStatus]"></span>
192
+ </div>
193
+ </div>
194
+ </div>
195
+ </template>
196
+ </StreamMixer>
197
+ </template>
198
+
199
+ <script setup lang="ts">
200
+ import { StreamMixer } from 'tuikit-atomicx-vue3';
201
+ import type { SeatUserInfo } from 'tuikit-atomicx-vue3';
202
+
203
+ // 判断是否为主播(根据业务逻辑)
204
+ const isAnchor = (userInfo: SeatUserInfo) => {
205
+ // 这里可以根据用户ID、角色等判断
206
+ return userInfo.userId.includes('anchor') || userInfo.userName.includes('主播');
207
+ };
208
+ </script>
209
+
210
+ <style scoped>.live-stream-view{position:relative;width:100%;height:100%;border-radius:8px;overflow:hidden}.live-stream-view.is-anchor{border:3px solid #ff6b35;box-shadow:0 0 20px rgba(255,107,53,.3)}.live-stream-view.is-guest{border:1px solid #ddd}.video-area{width:100%;height:100%;background:#000}.user-overlay{position:absolute;bottom:0;left:0;right:0;background:linear-gradient(transparent,rgba(0,0,0,.8));padding:10px;color:#fff}.user-badge{display:inline-block;padding:2px 8px;border-radius:10px;font-size:12px;margin-bottom:5px;background:#666}.anchor-badge{background:#ff6b35;color:#fff}.user-name{font-weight:700;margin-bottom:5px}.device-status span{margin-right:5px;opacity:.8}.device-status .camera.Off,.device-status .mic.Off{opacity:.3}</style>
211
+ ```