@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

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 (514) 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/common/record_skill_session.js +58 -0
  275. package/tools/common/record_skill_session.js.map +1 -0
  276. package/tools/definitions/get_callkit_api_def.js +28 -0
  277. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  278. package/tools/definitions/get_faq_def.js +18 -19
  279. package/tools/definitions/get_faq_def.js.map +1 -1
  280. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  281. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  282. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  283. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  284. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  285. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  286. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  288. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  289. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  290. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  291. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  292. package/tools/definitions/get_usersig_def.js +17 -24
  293. package/tools/definitions/get_usersig_def.js.map +1 -1
  294. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  295. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  297. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  298. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  299. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  301. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  302. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  303. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  304. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  305. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  306. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  307. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  308. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  309. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  314. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  315. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  316. package/tools/definitions/present_framework_choice_def.js +23 -12
  317. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  318. package/tools/definitions/record_skill_session_def.js +31 -0
  319. package/tools/definitions/record_skill_session_def.js.map +1 -0
  320. package/tools/index.js +49 -61
  321. package/tools/index.js.map +1 -1
  322. package/tools/live/get_native_livekit_core_features.js +65 -0
  323. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  324. package/tools/live/get_native_livekit_core_integration.js +59 -0
  325. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  326. package/tools/live/get_web_live_uikit_integration.js +48 -0
  327. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  328. package/tools/live/get_web_livekit_api.js +32 -0
  329. package/tools/live/get_web_livekit_api.js.map +1 -0
  330. package/tools/live/get_web_livekit_component_detail.js +34 -0
  331. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  332. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  333. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  334. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  335. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  338. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  339. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  340. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  341. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  342. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  343. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  344. package/utils/generate-structured-result.js +61 -17
  345. package/utils/generate-structured-result.js.map +1 -1
  346. package/utils/report-cls-client.js +21 -1
  347. package/utils/report-cls-client.js.map +1 -1
  348. package/utils/report-es-client.js +1 -1
  349. package/resource/doc/chatuikit/android/workflow.md +0 -713
  350. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  351. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  352. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  353. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  354. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  355. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  356. package/resource/doc/chatuikit/react/components/search.md +0 -885
  357. package/resource/doc/chatuikit/react/create-group.md +0 -22
  358. package/resource/doc/chatuikit/react/init.md +0 -25
  359. package/resource/doc/chatuikit/react/workflow.md +0 -254
  360. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  361. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  362. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  363. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  364. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  365. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  366. package/resource/doc/chatuikit/vue/init.md +0 -35
  367. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  368. package/resource/doc/livekit/live/android/workflow.md +0 -322
  369. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  370. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  371. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  372. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  373. package/resource/doc/livekit/live/vue/faq.md +0 -0
  374. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  375. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  376. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  377. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  378. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  379. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  380. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  381. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  382. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  383. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  384. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  385. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  386. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  387. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  388. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  389. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  390. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  391. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  392. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  393. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  394. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  395. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  396. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  397. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  398. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  399. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  400. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  401. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  402. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  403. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  404. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  405. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  406. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  407. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  408. package/resource/doc/roomkit/vue/workflow.md +0 -733
  409. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  410. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  411. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  412. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  413. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  414. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  415. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  416. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  417. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  418. package/resource/doc/tuicallkit/react/api.md +0 -1512
  419. package/resource/doc/tuicallkit/react/faq.md +0 -986
  420. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  421. package/tools/call/get-native-call-integration.js +0 -43
  422. package/tools/call/get-native-call-integration.js.map +0 -1
  423. package/tools/call/get-web-call-api.js +0 -27
  424. package/tools/call/get-web-call-api.js.map +0 -1
  425. package/tools/call/get-web-call-integration.js.map +0 -1
  426. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  427. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  428. package/tools/chat/get-native-chat-integration.js +0 -45
  429. package/tools/chat/get-native-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-component-detail.js +0 -31
  431. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  432. package/tools/chat/get-web-chat-integration.js +0 -45
  433. package/tools/chat/get-web-chat-integration.js.map +0 -1
  434. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  435. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  436. package/tools/chat/get-web-create-group-doc.js +0 -28
  437. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  438. package/tools/common/get-faq.js +0 -91
  439. package/tools/common/get-faq.js.map +0 -1
  440. package/tools/common/get-usersig.js.map +0 -1
  441. package/tools/common/present-framework-choice.js +0 -16
  442. package/tools/common/present-framework-choice.js.map +0 -1
  443. package/tools/common/present-scenario-choice.js +0 -16
  444. package/tools/common/present-scenario-choice.js.map +0 -1
  445. package/tools/common/record-prompt.js +0 -55
  446. package/tools/common/record-prompt.js.map +0 -1
  447. package/tools/common/record-result.js +0 -60
  448. package/tools/common/record-result.js.map +0 -1
  449. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  450. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_api_def.js +0 -22
  452. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  454. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  455. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  456. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  457. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  458. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  459. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  460. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  461. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  462. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  463. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  464. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  465. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  466. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  467. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  468. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  469. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  470. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  471. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  472. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  473. package/tools/definitions/present_scenario_choice_def.js +0 -53
  474. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  475. package/tools/definitions/record_prompt_def.js +0 -58
  476. package/tools/definitions/record_prompt_def.js.map +0 -1
  477. package/tools/definitions/record_result_def.js +0 -46
  478. package/tools/definitions/record_result_def.js.map +0 -1
  479. package/tools/live/get-native-live-uikit-integration.js +0 -177
  480. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  481. package/tools/live/get-web-live-component-detail.js +0 -31
  482. package/tools/live/get-web-live-component-detail.js.map +0 -1
  483. package/tools/live/get-web-live-state-detail.js +0 -31
  484. package/tools/live/get-web-live-state-detail.js.map +0 -1
  485. package/tools/live/get-web-live-uikit-integration.js +0 -52
  486. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  487. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  488. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  489. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  490. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  491. package/tools/native_live/get-native-live-api.js +0 -31
  492. package/tools/native_live/get-native-live-api.js.map +0 -1
  493. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  494. package/tools/room/get-web-room-integration.js.map +0 -1
  495. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  496. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  498. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  500. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  502. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  503. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  504. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  505. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  506. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  507. package/tools/trtc/get-trtc-native-api.js +0 -31
  508. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  509. package/utils/handle-component-name.js +0 -33
  510. package/utils/handle-component-name.js.map +0 -1
  511. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  512. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  513. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  514. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -1,293 +0,0 @@
1
- 本文对 TUILiveKit Demo 中的**观看页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的观看页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
2
-
3
- ## 功能展示
4
-
5
- 观看页面提供默认行为和风格,但如果默认行为和样式不能完全满足您的需求,您也可以对 UI 进行自定义。图中显示的数字与特定功能列表中的类别相对应。其中主要包含直播**信息展示、视频直播区域、在线观众、音视频操作、直播时长、画面分辨率切换、全屏功能、聊天互动、消息列表等。**
6
- - **直播视频播放**:高清流畅的直播体验。
7
-
8
- - **弹幕互动**:实时弹幕交流。
9
-
10
- - **观众列表**:查看在线观众信息。
11
-
12
- - **全屏播放**:沉浸式观看体验。
13
-
14
- - **H5 移动平台支持**:跨平台兼容。
15
-
16
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/99721fcb8c8611f0814e525400bf7822.png)
17
-
18
-
19
- ## 快速接入
20
-
21
- ### 步骤1:环境配置及开通服务
22
-
23
- 在进行快速接入之前,您需要参见 [准备工作](https://write.woa.com/document/188228825253294080),满足相关环境配置及开通对应服务。
24
-
25
- ### 步骤2:安装依赖
26
-
27
- 您可以选择以下任一方式安装依赖:
28
-
29
-
30
-
31
-
32
- 【npm】
33
- ``` bash
34
- npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
35
- ```
36
-
37
-
38
- 【pnpm】
39
- ``` bash
40
- pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
41
- ```
42
-
43
-
44
- 【yarn】
45
- ``` bash
46
- yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
47
- ```
48
-
49
- ### 步骤3:观看页面接入
50
-
51
- 在您的项目下创建 **live-player.vue **文件,可直接复制如下代码至您的项目中集成**观看页面**。
52
- ``` java
53
- <template>
54
- <UIKitProvider language="zh-CN">
55
- <div class="container">
56
- <!-- 直播核心区域 -->
57
- <section class="live">
58
- <header class="header">
59
- <IconArrowStrokeBack class="back-btn" size="20" />
60
- <Avatar :src="currentLive?.liveOwner.avatarUrl" :size="32" class="avatar" />
61
- <span class="user-name">{{ currentLive?.liveOwner.userName || currentLive?.liveOwner.userId }}</span>
62
- </header>
63
- <LiveCoreView class="player" />
64
- </section>
65
-
66
- <div class="sidebar">
67
- <!-- 在线观众列表 -->
68
- <section class="audience">
69
- <header class="section-header">
70
- <h3> 在线观众 <span>({{ audienceList.length }})</span></h3>
71
- </header>
72
- <LiveAudienceList class="list" />
73
- </section>
74
-
75
- <!-- 消息列表 & 消息输入框 -->
76
- <section class="barrage">
77
- <header class="section-header">
78
- <h3>消息列表</h3>
79
- </header>
80
- <BarrageList class="list" />
81
- <BarrageInput class="input" height="48px" />
82
- </section>
83
- </div>
84
- </div>
85
- </UIKitProvider>
86
- </template>
87
-
88
- <script setup lang="ts">
89
- import { onMounted } from 'vue';
90
- import { LiveAudienceList, BarrageList, BarrageInput, useLiveAudienceState, LiveCoreView, useLiveListState, Avatar, useLoginState } from 'tuikit-atomicx-vue3';
91
- import { UIKitProvider, IconArrowStrokeBack } from '@tencentcloud/uikit-base-component-vue3';
92
-
93
- const { audienceList } = useLiveAudienceState();
94
- const { currentLive } = useLiveListState();
95
- const { login } = useLoginState();
96
-
97
- const liveId = 'live_xxxx' // 填入您要观看的直播间的ID
98
-
99
- async function initLogin() {
100
- try {
101
- await login({
102
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
103
- userId: 'xxx', // UserID, 可以参考步骤 1 获取
104
- userSig: 'xxx', // userSig, 可以参考步骤 1 获取
105
- });
106
- } catch (error) {
107
- console.error('登录失败:', error);
108
- }
109
- }
110
-
111
- onMounted(async () => {
112
- await initLogin();
113
- });
114
-
115
- </script>
116
-
117
- <style>:global(body){height:100vh;width:100vw;margin:0;padding:0;overflow:hidden;font-size:15px;line-height:1.6;text-rendering:optimizeLegibility;}:global(*),:global(*::before),:global(*::after){box-sizing:border-box;margin:0;}.container{display:grid;grid-template-columns:70% 30%;height:100vh;width:100vw;gap:16px;padding:16px;background:var(--bg-color-default);box-sizing:border-box;overflow:hidden;}.live{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);}.header{display:flex;align-items:center;gap:12px;padding:16px;border-bottom:1px solid var(--stroke-color-primary);}.back-btn{cursor:pointer;color:var(--text-color-tertiary);transition:color 0.2s;}.back-btn:hover{color:var(--text-color-link-hover);}.avatar{border:1px solid var(--uikit-color-white-7);}.user-name{color:var(--text-color-primary);font-weight:500;}.player{flex:1;background:var(--uikit-color-black-1);}.sidebar{display:flex;flex-direction:column;gap:16px;height:100%;overflow:hidden;}.audience{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);flex:1;min-height:0;}.barrage{display:flex;flex-direction:column;background:var(--bg-color-operate);border-radius:12px;overflow:hidden;box-shadow:0 2px 8px var(--shadow-color);flex:1;min-height:0;}.section-header{padding:16px;border-bottom:1px solid var(--stroke-color-primary);background:var(--bg-color-operate);}.section-header h3{margin:0;font-size:16px;font-weight:600;color:var(--text-color-primary);}.section-header span{font-weight:400;color:var(--text-color-secondary);font-size:14px;}.list{flex:1;min-height:0;overflow-y:auto;}.input{border-top:1px solid var(--stroke-color-primary);flex-shrink:0;height:48px;}@media (max-width:1200px){.container{grid-template-columns:1fr;grid-template-rows:60% 20% 20%;gap:12px;}.sidebar{gap:12px;}.audience,.barrage{min-height:200px;}}@media (max-width:768px){.container{padding:8px;gap:8px;grid-template-rows:50% 25% 25%;}.header,.section-header{padding:12px;}.sidebar{gap:8px;}}</style>
118
-
119
- ```
120
-
121
- ### 步骤4:启动项目
122
-
123
- 打开终端,进入项目目录,执行以下命令启动项目后,您就可以观看直播了。
124
- ``` bash
125
- npm run dev
126
- ```
127
-
128
- ## 播放直播流
129
-
130
- ### 步骤1:开启一场直播
131
- - **方式一(推荐):**
132
-
133
-
134
- 使用我们提供的 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html) ,开启一场直播来观看,开启后获取直播间 ID
135
-
136
- - **方式二:**
137
-
138
-
139
- 集成我们提供的 [主播开播(Web 桌面浏览器)](https://write.woa.com/document/188483825115738112),开启一场直播来观看,开启后获取直播间 ID。
140
-
141
-
142
- > **重要提示:**
143
- >
144
-
145
- > 请使用不同的 **用户 ID** 开播和观看,否则后登录的设备会强制先登录的设备下线(即“被踢下线”)。
146
- >
147
-
148
-
149
- ### 步骤2:观看直播
150
-
151
- 在上述**快速接入步骤 3 **的代码基础上增加如下内容,进入直播间观看:
152
- ``` java
153
- // live-player.vue
154
- import { onMounted } from 'vue';
155
- import { useLiveListState } from 'tuikit-atomicx-vue3';
156
-
157
- const { joinLive } = useLiveListState();
158
-
159
- onMounted(async () => {
160
- await joinLive({ liveId: 'xxx' }); // 输入 liveId 加入直播间,具体参数含义可参考步骤 1 中的准备工作
161
- });
162
- ```
163
-
164
- 观看效果如下图所示:
165
-
166
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027339142/3b82b1dcbf6911f0b4c35254001c06ec.gif)
167
-
168
-
169
- ### 步骤3:路由配置
170
-
171
- 由于涉及到直播列表(或首页)到直播间的跳转逻辑,您需要配置 Vue Router。在项目 **src** 目录下新建 **router **文件夹,并创建 **index.ts **文件。然后,在您的主文件(例如 **main.ts** 或 **index.ts**)中引入并使用路由。可参见 [GitHub 代码示例](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts),如果需要直播列表,可参见文档 [直播列表](https://write.woa.com/document/185968224430342144)。
172
- ``` typescript
173
- // src/router/index.ts
174
- import { createRouter, createWebHistory } from 'vue-router';
175
-
176
- const routes = [
177
- {
178
- path: '/live-player',
179
- component: () => import('../views/live-player.vue'),
180
- },
181
- // 如果需要直播列表功能,可添加如下路由
182
- // {
183
- // path: '/live-list',
184
- // component: () => import('../views/live-list.vue'),
185
- // },
186
- ];
187
-
188
- const router = createRouter({
189
- history: createWebHistory(),
190
- routes,
191
- });
192
- export default router;
193
-
194
- // src/main.ts
195
- import { createApp } from 'vue';
196
- import App from './App.vue';
197
- import router from './router';
198
-
199
- const app = createApp(App);
200
- app.use(router);
201
- app.mount('#app');
202
- ```
203
-
204
- ## 自由定制
205
-
206
- 根据上述功能展示图,我们也支持您根据项目需求对观看页面进行 UI 定制。主要可供定制的能力如下表所示。
207
- <table>
208
- <tr>
209
- <td rowspan="1" colSpan="1" >**类别**</td>
210
-
211
- <td rowspan="1" colSpan="1" >**功能**</td>
212
-
213
- <td rowspan="1" colSpan="1" >**描述**</td>
214
- </tr>
215
-
216
- <tr>
217
- <td rowspan="1" colSpan="1" >**直播信息展示**</td>
218
-
219
- <td rowspan="1" colSpan="1" >自定义观看页面信息区域展示</td>
220
-
221
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏 Logo,替换为您需要的 Logo**<br>- **UI 定制、展示/隐藏关注按钮,替换为您需要的按钮风格**</td>
222
- </tr>
223
-
224
- <tr>
225
- <td rowspan="1" colSpan="1" >**在线观众**</td>
226
-
227
- <td rowspan="1" colSpan="1" >自定义观众信息展示</td>
228
-
229
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏观众等级**<br>- **观众信息字体、颜色 UI 自定义设置**<br>- **替换为您需要的 Icon 风格**</td>
230
- </tr>
231
-
232
- <tr>
233
- <td rowspan="1" colSpan="1" >**消息列表**</td>
234
-
235
- <td rowspan="1" colSpan="1" >自定义消息弹幕区域展示</td>
236
-
237
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏聊天输入区域**<br>- **支持 UI 定制聊天气泡风格、定制观众等级等内容**</td>
238
- </tr>
239
- </table>
240
-
241
-
242
- ### 颜色主题
243
-
244
- 参见**步骤3**中代码示例,您可以操作 theme 的值来满足您切换颜色主题的需求。
245
- ``` java
246
- <UIKitProvider theme="dark"> // theme 传入 dark 时,界面整体颜色主题为黑色主题
247
- xxx // theme 传入 light 时,界面整体颜色主题为白色主题
248
- </UIKitProvider>
249
- ```
250
-
251
- ### 按钮 Button / 图标 Icon
252
-
253
- 若您需要对按钮 Button 或者图标 Icon 进行新增或替换等 UI 定制,您可以通过如下方式进行实现,以观看页面操作的 Icon 为例。参考下图,您可以找到对应 Button / Icon 指定位置的源码,对当前部分的按钮进行**增加、删除、替换**等 UI 定制操作。
254
-
255
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027339142/94af15a6bf6911f0b4c35254001c06ec.png)
256
-
257
-
258
- ## 下一步
259
-
260
- 恭喜您,现在您已经成功集成了观众观看。接下来,您可以继续接入 **直播列表、UI 自定义、监播 **等功能:
261
- <table>
262
- <tr>
263
- <td rowspan="1" colSpan="1" >**功能**</td>
264
-
265
- <td rowspan="1" colSpan="1" >**描述**</td>
266
-
267
- <td rowspan="1" colSpan="1" >**集成指引**</td>
268
- </tr>
269
-
270
- <tr>
271
- <td rowspan="1" colSpan="1" >直播列表</td>
272
-
273
- <td rowspan="1" colSpan="1" >展示直播列表界面和功能,包含直播列表,房间信息展示功能</td>
274
-
275
- <td rowspan="1" colSpan="1" >[直播列表](https://write.woa.com/document/185968224430342144)</td>
276
- </tr>
277
-
278
- <tr>
279
- <td rowspan="1" colSpan="1" >UI 自定义</td>
280
-
281
- <td rowspan="1" colSpan="1" >更详细的 UI 组件自定义指引。</td>
282
-
283
- <td rowspan="1" colSpan="1" >[概述](https://write.woa.com/document/177815913198854144)</td>
284
- </tr>
285
-
286
- <tr>
287
- <td rowspan="1" colSpan="1" >Web 监播</td>
288
-
289
- <td rowspan="1" colSpan="1" >运营平台,支持直播间管控。</td>
290
-
291
- <td rowspan="1" colSpan="1" >[Web 监播页](https://write.woa.com/document/185222048061181952)</td>
292
- </tr>
293
- </table>
@@ -1,381 +0,0 @@
1
- 本文对 TUILiveKit Demo 中的**观看页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的观看页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
2
-
3
- ## 功能展示
4
-
5
- 观看页面提供默认行为和风格,但如果默认行为和样式不能完全满足您的需求,您也可以对 UI 进行自定义。图中显示的数字与特定功能列表中的类别相对应。其中主要包含直播**信息展示、视频直播区域、在线观众、音视频操作、直播时长、画面分辨率切换、全屏功能、聊天互动、消息列表等。**
6
- - **直播视频播放:**高清流畅的直播体验。
7
-
8
- - **弹幕互动:**实时弹幕交流。
9
-
10
- - **观众列表:**查看在线观众信息。
11
-
12
- - **关注主播:**一键关注喜欢的主播。
13
-
14
- - **全屏播放:**沉浸式观看体验。
15
-
16
- - **Web 桌面浏览器支持:**跨平台兼容。
17
-
18
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027339142/1cd04be2bf6511f0a5e052540099c741.png)
19
-
20
-
21
- ## 快速接入
22
-
23
- ### 步骤1:环境配置及开通服务
24
-
25
- 在进行快速接入之前,您需要参见 [准备工作](https://write.woa.com/document/185222107981008896),满足相关环境配置及开通对应服务。
26
-
27
- ### 步骤2:安装依赖
28
-
29
-
30
-
31
-
32
- 【npm】
33
- ``` bash
34
- npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
35
- ```
36
-
37
-
38
- 【pnpm】
39
- ``` bash
40
- pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
41
- ```
42
-
43
-
44
- 【yarn】
45
- ``` bash
46
- yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
47
- ```
48
-
49
- ### 步骤3:观看页面接入
50
-
51
- 在您的项目下创建 `live-player.vue` 文件,可直接复制如下代码至您的项目中集成**观看页面**。
52
- ``` typescript
53
-
54
- <template>
55
- <UIKitProvider language="zh-CN" theme="dark">
56
- <div class="live-container">
57
- <!-- 直播核心区域 -->
58
- <section class="live-main">
59
- <!-- 顶部信息栏 -->
60
- <div class="top-bar">
61
- <div class="top-left">
62
- <Avatar
63
- :src="currentLive?.liveOwner.avatarUrl"
64
- :size="24"
65
- class="avatar"
66
- />
67
- <span class="user-name">
68
- {{ currentLive?.liveOwner.userName || currentLive?.liveOwner.userId }}
69
- </span>
70
- <div class="follow-btn" @click="handleFollow">
71
- <span>关注</span>
72
- </div>
73
- </div>
74
- <div class="top-right">
75
- <div class="audience-preview" @click="showAudienceDrawer">
76
- <Avatar
77
- v-for="(user, index) in audienceList.slice(0, 3)"
78
- :key="user.userId || index"
79
- :src="user.avatarUrl"
80
- :size="24"
81
- class="audience-avatar"
82
- />
83
- <div class="audience-count">
84
- <span>{{ audienceList.length }}</span>
85
- </div>
86
- </div>
87
- <IconClose class="back-btn" size="20" @click="handleBack" />
88
- </div>
89
- </div>
90
-
91
- <!-- 直播播放器 -->
92
- <div class="stream-container">
93
- <LiveCoreView class="player" />
94
- </div>
95
-
96
- <!-- 悬浮消息列表 -->
97
- <div class="floating-message-list">
98
- <BarrageList class="message-list" />
99
- </div>
100
-
101
- <!-- 底部消息输入 -->
102
- <div class="bottom-input">
103
- <div class="message-input-wrapper">
104
- <BarrageInput
105
- :width="inputWidth"
106
- height="44px"
107
- :placeholder="'说点什么...'"
108
- :autoFocus="false"
109
- :disabled="!isLiveActive"
110
- />
111
- </div>
112
- </div>
113
- </section>
114
-
115
- <!-- 观众列表抽屉 -->
116
- <div v-if="audienceDrawerVisible" class="audience-drawer-overlay" @click="closeAudienceDrawer">
117
- <div class="audience-drawer" @click.stop>
118
- <div class="drawer-header">
119
- <h3>在线观众 ({{ audienceList.length }})</h3>
120
- </div>
121
- <div class="drawer-content">
122
- <LiveAudienceList class="audience-list" />
123
- <div v-if="audienceList.length === 0" class="empty-audience">
124
- <p>暂无观众在线</p>
125
- </div>
126
- </div>
127
- </div>
128
- </div>
129
-
130
- <!-- 直播结束遮罩 -->
131
- <div v-if="liveEndVisible" class="live-end-overlay">
132
- <div class="live-end-content">
133
- <div class="end-title">
134
- <span>直播已结束</span>
135
- </div>
136
- <Avatar
137
- :src="currentLive?.liveOwner.avatarUrl"
138
- :size="85"
139
- class="end-avatar"
140
- />
141
- <span class="end-name">{{ currentLive?.liveOwner.userName || currentLive?.liveOwner.userId }}</span>
142
- </div>
143
- </div>
144
- </div>
145
- </UIKitProvider>
146
- </template>
147
-
148
- <script setup lang="ts">
149
- import { onMounted, ref, computed, watch } from 'vue';
150
- import {
151
- LiveAudienceList,
152
- BarrageList,
153
- BarrageInput,
154
- useLiveAudienceState,
155
- LiveCoreView,
156
- useLiveListState,
157
- Avatar,
158
- useLoginState
159
- } from 'tuikit-atomicx-vue3';
160
- import { UIKitProvider, IconClose } from '@tencentcloud/uikit-base-component-vue3';
161
-
162
- const { audienceList, fetchAudienceList } = useLiveAudienceState();
163
- const { currentLive } = useLiveListState();
164
- const { login } = useLoginState();
165
-
166
- const audienceDrawerVisible = ref(false);
167
- const liveEndVisible = ref(false);
168
- const isLiveActive = ref(true);
169
-
170
- const inputWidth = computed(() => {
171
- return window.innerWidth > 768 ? '200px' : '158px';
172
- });
173
-
174
- async function initLogin() {
175
- try {
176
- await login({
177
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
178
- userId: '', // UserID, 可以参考步骤 1 获取
179
- userSig: '', // userSig, 可以参考步骤 1 获取
180
- });
181
- } catch (error) {
182
- console.error('登录失败:', error);
183
- }
184
- }
185
-
186
- function handleBack() {
187
- console.log('返回上一页');
188
- }
189
-
190
- function handleFollow() {
191
- console.log('关注主播');
192
- }
193
-
194
- async function showAudienceDrawer() {
195
- await fetchAudienceList();
196
- audienceDrawerVisible.value = true;
197
- }
198
-
199
- function closeAudienceDrawer() {
200
- audienceDrawerVisible.value = false;
201
- }
202
-
203
- onMounted(async () => {
204
- await initLogin();
205
- });
206
- </script>
207
-
208
- <style scoped>
209
- :global(body){height:100vh;width:100vw;margin:0;padding:0;overflow:hidden;font-size:14px;line-height:1.6;text-rendering:optimizeLegibility;}:global(*),:global(*::before),:global(*::after){box-sizing:border-box;margin:0;}.live-container{position:fixed;display:flex;justify-content:center;align-items:center;width:100%;height:100%;background-color:black;color:var(--text-color1,#fff);}.live-main{width:100%;height:100%;position:relative;background-color:var(--uikit-color-bg-color-dialog);}.top-bar{position:absolute;top:10px;left:0;right:0;display:flex;justify-content:space-between;align-items:center;z-index:100;height:50px;padding:0 10px;}.top-left{display:flex;align-items:center;gap:5px;max-width:55%;padding:5px;background-color:var(--uikit-color-black-6);border-radius:25px;backdrop-filter:blur(10px);overflow:hidden;}.back-btn{cursor:pointer;color:var(--text-color1,#fff);transition:color 0.2s;flex-shrink:0;}.back-btn:hover{color:#4086FF;}.avatar{border:1px solid var(--uikit-color-white-7);flex-shrink:0;}.user-name{color:var(--text-color1,#fff);font-weight:500;font-size:14px;max-width:60%;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;}.follow-btn{display:flex;align-items:center;justify-content:center;width:50px;max-width:100px;height:24px;background-color:#4086FF;border-radius:12px;cursor:pointer;transition:background-color 0.2s;flex-shrink:0;overflow:hidden;}.follow-btn:hover{background-color:#2B6AD6;}.follow-btn span{font-size:14px;color:var(--text-color1,#fff);}.top-right{display:flex;align-items:center;gap:5px;overflow:hidden;}.audience-preview{display:flex;align-items:center;gap:1px;cursor:pointer;}.audience-avatar{border:1px solid var(--uikit-color-white-7);}.audience-count{display:flex;align-items:center;justify-content:center;width:24px;height:24px;background-color:var(--uikit-color-black-6);border-radius:50%;text-align:center;color:var(--text-color1,#fff);overflow:hidden;}.audience-count span{flex:1;font-size:12px;}.close-btn{display:flex;align-items:center;justify-content:center;width:32px;height:32px;background-color:var(--uikit-color-black-6);border-radius:50%;cursor:pointer;color:var(--text-color1,#fff);transition:background-color 0.2s;}.close-btn:hover{background-color:rgba(255,255,255,0.2);}.stream-container{width:100%;height:100%;display:flex;align-items:center;justify-content:center;}.player{width:100%;height:100%;background-color:black;}.floating-message-list{position:absolute;left:0;bottom:60px;z-index:99;pointer-events:none;}.message-list{width:100%;height:100%;overflow-y:auto;padding:8px;}.bottom-input{position:absolute;bottom:10px;left:0;right:0;display:flex;align-items:center;justify-content:space-between;height:48px;padding:0 10px;z-index:100;}.message-input-wrapper{display:flex;align-items:center;gap:8px;}.input-actions{display:flex;align-items:center;gap:4px;}.emoji-btn,.gift-btn{display:flex;align-items:center;justify-content:center;width:36px;height:36px;background-color:var(--uikit-color-black-6);border:none;border-radius:18px;color:var(--text-color1,#fff);cursor:pointer;transition:all 0.2s;font-size:16px;backdrop-filter:blur(10px);}.emoji-btn:hover,.gift-btn:hover{background-color:#4086FF;transform:scale(1.05);}.audience-drawer-overlay{position:fixed;top:0;left:0;right:0;bottom:0;background-color:rgba(0,0,0,0.5);z-index:1000;display:flex;align-items:flex-end;justify-content:center;}.audience-drawer{width:100%;max-width:500px;height:90%;background-color:rgb(31,32,36);border-radius:20px 20px 0 0;display:flex;flex-direction:column;animation:slideUp 0.3s ease-out;}@keyframes slideUp{from{transform:translateY(100%);}to{transform:translateY(0);}}.drawer-header{display:flex;align-items:center;justify-content:space-between;padding:20px;border-bottom:1px solid #333;}.drawer-header h3{margin:0;font-size:18px;font-weight:600;color:var(--text-color1,#fff);}.close-drawer-btn{display:flex;align-items:center;justify-content:center;width:32px;height:32px;background-color:transparent;border:none;border-radius:50%;color:#999;cursor:pointer;transition:all 0.2s;}.close-drawer-btn:hover{background-color:#333;color:var(--text-color1,#fff);}.drawer-content{flex:1;overflow:hidden;position:relative;}.audience-list{height:100%;overflow-y:auto;padding:16px;}.empty-audience{display:flex;flex-direction:column;align-items:center;justify-content:center;height:100%;color:#666;text-align:center;padding:40px 20px;}.empty-icon{font-size:48px;margin-bottom:16px;opacity:0.5;}.empty-audience p{font-size:16px;margin:0;}.live-end-overlay{position:absolute;top:0;left:0;right:0;bottom:0;background-color:rgba(31,32,36,0.95);z-index:1000;display:flex;align-items:center;justify-content:center;}.live-end-content{display:flex;flex-direction:column;align-items:center;gap:20px;text-align:center;padding:40px;}.close-icon{position:absolute;top:20px;right:20px;display:flex;align-items:center;justify-content:center;width:40px;height:40px;background-color:rgba(255,255,255,0.1);border-radius:50%;cursor:pointer;color:#fff;transition:background-color 0.2s;}.close-icon:hover{background-color:rgba(255,255,255,0.2);}.end-title{padding-top:60px;padding-bottom:30px;}.end-title span{font-size:24px;font-weight:600;color:var(--text-color1,#fff);}.end-avatar{border:1px solid var(--uikit-color-white-7);}.end-name{font-size:16px;color:var(--text-color1,#fff);}@media screen and (orientation:landscape){.floating-message-list{width:400px;height:100px;}}@media screen and (orientation:portrait){.floating-message-list{width:260px;height:180px;}.bottom-input{padding:0 20px;}}@media (max-width:768px){.top-bar{padding:0 8px;}.top-left{max-width:70%;padding:6px 10px;}.user-name{max-width:80px;}}
210
- </style>
211
-
212
- ```
213
-
214
- ### 步骤4:启动项目
215
-
216
- 打开终端,进入项目目录,执行以下命令启动项目后,您就可以观看直播了。
217
- ``` bash
218
- npm run dev
219
- ```
220
-
221
- ## 播放直播流
222
-
223
- ### 步骤1:开启一场直播
224
- - **方式一(推荐):**
225
-
226
-
227
- 使用我们提供的 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html) ,开启一场直播来观看,开启后获取直播间 ID
228
-
229
- - **方式二:**
230
-
231
-
232
- 集成我们提供的 [主播开播(Web 桌面浏览器)](https://write.woa.com/document/188483825115738112),开启一场直播来观看,开启后获取直播间 ID。
233
-
234
-
235
- > **重要提示:**
236
- >
237
-
238
- > 请使用不同的 **用户 ID** 开播和观看,否则后登录的设备会强制先登录的设备下线(即“被踢下线”)。
239
- >
240
-
241
-
242
- ### 步骤2:观看直播
243
-
244
- 在上述**快速接入步骤 3 **的代码基础上增加如下内容,进入直播间观看:
245
- ``` java
246
- // live-player.vue
247
- import { onMounted } from 'vue';
248
- import { useLiveListState } from 'tuikit-atomicx-vue3';
249
-
250
- const { joinLive } = useLiveListState();
251
-
252
- onMounted(async () => {
253
- await joinLive({ liveId: 'xxx' }); // 输入 liveId 加入直播间,具体参数含义可参考步骤 1 中的准备工作
254
- });
255
- ```
256
-
257
- ### 步骤3:路由配置
258
-
259
- 由于涉及到直播列表(或首页)到直播间的跳转逻辑,您需要配置 Vue Router。在项目 `src` 目录下新建 `router` 文件夹,并创建 `index.ts` 文件。然后,在您的主文件(例如 `main.ts` 或 `index.ts`)中引入并使用路由。可参考 GitHub [代码示例](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts), 如需要直播列表,可参考文档 [直播列表](https://write.woa.com/document/185968224430342144)。
260
- ``` typescript
261
- // src/router/index.ts
262
- import { createRouter, createWebHistory } from 'vue-router';
263
-
264
- const routes = [
265
- {
266
- path: '/live-player',
267
- component: () => import('../views/live-player.vue'),
268
- },
269
- // 如果需要直播列表功能,可添加如下路由
270
- // {
271
- // path: '/live-list',
272
- // component: () => import('../views/live-list.vue'),
273
- // },
274
- ];
275
-
276
- const router = createRouter({
277
- history: createWebHistory(),
278
- routes,
279
- });
280
- export default router;
281
-
282
- // src/main.ts
283
- import { createApp } from 'vue';
284
- import App from './App.vue';
285
- import router from './router';
286
-
287
- const app = createApp(App);
288
- app.use(router);
289
- app.mount('#app');
290
- ```
291
-
292
- ## 自由定制
293
-
294
- 另外,我们也支持您根据项目需求对观看页面进行 UI 定制能力。主要可供定制的能力如下表所示。可供定制内容包括但不限于对源码中的**颜色主题、字体、圆角、按钮、图标、输入框、弹框等**内容,都可以进行**增加、删除、修改**等定制操作,下列分别给出颜色主题、按钮以及图标的定制示例,您可以参考实现方式通用到其他组件,满足您的 UI 定制需要。
295
- <table>
296
- <tr>
297
- <td rowspan="1" colSpan="1" >**类别**</td>
298
-
299
- <td rowspan="1" colSpan="1" >**功能**</td>
300
-
301
- <td rowspan="1" colSpan="1" >**描述**</td>
302
- </tr>
303
-
304
- <tr>
305
- <td rowspan="1" colSpan="1" >**直播信息展示**</td>
306
-
307
- <td rowspan="1" colSpan="1" >自定义观看页面信息区域展示</td>
308
-
309
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏 Logo,替换为您需要的 Logo**<br>- **UI 定制、展示/隐藏关注按钮,替换为您需要的按钮风格**</td>
310
- </tr>
311
-
312
- <tr>
313
- <td rowspan="1" colSpan="1" >**在线观众**</td>
314
-
315
- <td rowspan="1" colSpan="1" >自定义观众信息展示</td>
316
-
317
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏观众等级**<br>- **观众信息字体、颜色 UI 自定义设置**<br>- **替换为您需要的 Icon 风格**</td>
318
- </tr>
319
-
320
- <tr>
321
- <td rowspan="1" colSpan="1" >**消息列表**</td>
322
-
323
- <td rowspan="1" colSpan="1" >自定义消息弹幕区域展示</td>
324
-
325
- <td rowspan="1" colSpan="1" >**支持:**<br>- **展示/隐藏聊天输入区域**<br>- **支持 UI 定制聊天气泡风格、定制观众等级等内容**</td>
326
- </tr>
327
- </table>
328
-
329
-
330
- ### 颜色主题
331
-
332
- 参见**步骤3**中代码示例,您可以操作 theme 的值来满足您切换颜色主题。
333
- ``` java
334
- <UIKitProvider theme="dark"> // theme 传入 dark 时,界面整体颜色主题为黑色主题
335
- xxx // theme 传入 light 时,界面整体颜色主题为白色主题
336
- </UIKitProvider>
337
- ```
338
-
339
- ### 按钮 Button / 图标 Icon
340
-
341
- 若您需要对按钮 Button 或者图标 Icon 进行新增或替换等 UI 定制,您可以通过如下方式进行实现,以观看页面操作的 Icon 为例。参考下图,您可以找到对应 Button / Icon 指定位置的源码,对当前部分的按钮进行**增加、删除、替换**等 UI 定制操作。
342
-
343
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/dd256f268ebd11f088af5254005ef0f7.png)
344
-
345
-
346
- ## 下一步
347
-
348
- 恭喜您,现在您已经成功集成了观众观看。接下来,您可以继续接入 **直播列表、UI 自定义、监播 **等功能:
349
- <table>
350
- <tr>
351
- <td rowspan="1" colSpan="1" >**功能**</td>
352
-
353
- <td rowspan="1" colSpan="1" >**描述**</td>
354
-
355
- <td rowspan="1" colSpan="1" >**集成指引**</td>
356
- </tr>
357
-
358
- <tr>
359
- <td rowspan="1" colSpan="1" >**直播列表**</td>
360
-
361
- <td rowspan="1" colSpan="1" >展示直播列表界面和功能,包含直播列表,房间信息展示功能</td>
362
-
363
- <td rowspan="1" colSpan="1" >[直播列表](https://write.woa.com/document/185968224430342144)</td>
364
- </tr>
365
-
366
- <tr>
367
- <td rowspan="1" colSpan="1" >**UI 自定义**</td>
368
-
369
- <td rowspan="1" colSpan="1" >更详细的 UI 组件自定义指引。</td>
370
-
371
- <td rowspan="1" colSpan="1" >[概述](https://write.woa.com/document/177815913198854144)</td>
372
- </tr>
373
-
374
- <tr>
375
- <td rowspan="1" colSpan="1" >**Web 监播**</td>
376
-
377
- <td rowspan="1" colSpan="1" >运营平台,支持直播间管控。</td>
378
-
379
- <td rowspan="1" colSpan="1" >[Web 监播页](https://write.woa.com/document/185222048061181952)</td>
380
- </tr>
381
- </table>