@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,1512 +0,0 @@
1
- ## 重要提醒
2
- **文档内容说明:**
3
- - 文档涉及到 `TUICallEngine` API 和 `TUICallKit` 含 UI 组件 API 两部分
4
- - `TUICallEngine` API 文档请参考 **Part One**
5
- - `TUICallKit`含 UI 组件 API 文档请参考 **Part Two**
6
-
7
- ## Part One
8
- **TUICallEngine API 文档**
9
- - TUICallEngine API 涉及到 web 和 小程序。
10
- - 当用户查询 `TUICallEngine` API 时,必须先查阅 TUICallEngine 的官方 API 文档,然后再给出 API 的正确用法示例, 禁止自己推测 API 的用法。
11
- - 以下是各平台 API 的文档链接,请直接访问文档链接获取 API 用法:
12
- - [TUICallEngine Web API 列表文档](https://cloud.tencent.com/document/product/647/78757)
13
- - [TUICallEngine Web API 使用示例文档](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html)
14
- - [TUICallEngine 小程序 API 文档](https://cloud.tencent.com/document/product/647/78761)
15
-
16
- ## Part Two
17
- TUICallKit 是音视频通话组件的**含 UI 接口**,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景;更详细的接入步骤,详见:[快速接入 TUICallKit](https://write.woa.com/document/130513425899630592)。
18
-
19
- > **说明:**
20
- >
21
- > - 为提供更优质的音视频通信能力, TUICallKit npm 包 [@trtc/calls-uikit-react](https://www.npmjs.com/package/@trtc/calls-uikit-react)、[@trtc/calls-uikit-vue](https://www.npmjs.com/package/@trtc/calls-uikit-vue)、[@trtc/calls-uikit-vue2](https://www.npmjs.com/package/@trtc/calls-uikit-vue2)、[@trtc/calls-uikit-vue2.6](https://www.npmjs.com/package/@trtc/calls-uikit-vue2.6) 在 4.0.0 版本进行了重大升级。
22
-
23
-
24
- ## API 概览
25
- <table>
26
- <tr>
27
- <td rowspan="1" colSpan="1" ><br>API</td>
28
-
29
- <td rowspan="1" colSpan="1" >描述</td>
30
- </tr>
31
-
32
- <tr>
33
- <td rowspan="1" colSpan="1" >[<TUICallKit />](https://cloud.tencent.com/document/product/647/81015#TUICallKit)</td>
34
-
35
- <td rowspan="1" colSpan="1" >TUICallKit 通话 UI 组件。</td>
36
- </tr>
37
-
38
- <tr>
39
- <td rowspan="1" colSpan="1" >[init](https://cloud.tencent.com/document/product/647/81015#init)</td>
40
-
41
- <td rowspan="1" colSpan="1" >初始化 TUICallKit 组件实例。</td>
42
- </tr>
43
-
44
- <tr>
45
- <td rowspan="1" colSpan="1" >[calls](https://cloud.tencent.com/document/product/647/81015#calls)</td>
46
-
47
- <td rowspan="1" colSpan="1" >发起单人或多人通话。</td>
48
- </tr>
49
-
50
- <tr>
51
- <td rowspan="1" colSpan="1" >[join](https://cloud.tencent.com/document/product/647/81015#join)</td>
52
-
53
- <td rowspan="1" colSpan="1" >主动加入通话。</td>
54
- </tr>
55
-
56
- <tr>
57
- <td rowspan="1" colSpan="1" >[setCallingBell](https://cloud.tencent.com/document/product/647/81015#setCallingBell)</td>
58
-
59
- <td rowspan="1" colSpan="1" >设置自定义来电铃音。</td>
60
- </tr>
61
-
62
- <tr>
63
- <td rowspan="1" colSpan="1" >[setSelfInfo](https://cloud.tencent.com/document/product/647/81015#setSelfInfo)</td>
64
-
65
- <td rowspan="1" colSpan="1" >设置用户昵称和头像。</td>
66
- </tr>
67
-
68
- <tr>
69
- <td rowspan="1" colSpan="1" >[enableMuteMode](https://cloud.tencent.com/document/product/647/81015#enableMuteMode)</td>
70
-
71
- <td rowspan="1" colSpan="1" >开启/关闭来电铃声。</td>
72
- </tr>
73
-
74
- <tr>
75
- <td rowspan="1" colSpan="1" >[enableFloatWindow](https://cloud.tencent.com/document/product/647/81015#enableFloatWindow)</td>
76
-
77
- <td rowspan="1" colSpan="1" >开启/关闭悬浮窗功能。</td>
78
- </tr>
79
-
80
- <tr>
81
- <td rowspan="1" colSpan="1" >[enableVirtualBackground](https://cloud.tencent.com/document/product/647/81015#enableVirtualBackground)</td>
82
-
83
- <td rowspan="1" colSpan="1" >开启/关闭模糊背景的功能按钮。</td>
84
- </tr>
85
-
86
- <tr>
87
- <td rowspan="1" colSpan="1" >[setLanguage](https://cloud.tencent.com/document/product/647/81015#setLanguage)</td>
88
-
89
- <td rowspan="1" colSpan="1" >设置 TUICallKit 组件通话语言。</td>
90
- </tr>
91
-
92
- <tr>
93
- <td rowspan="1" colSpan="1" >[hideFeatureButton](https://cloud.tencent.com/document/product/647/81015#hideFeatureButton)</td>
94
-
95
- <td rowspan="1" colSpan="1" >隐藏按钮。</td>
96
- </tr>
97
-
98
- <tr>
99
- <td rowspan="1" colSpan="1" >[setLocalViewBackgroundImage](https://cloud.tencent.com/document/product/647/81015#setLocalViewBackgroundImage)</td>
100
-
101
- <td rowspan="1" colSpan="1" >设置本地用户通话界面背景图。</td>
102
- </tr>
103
-
104
- <tr>
105
- <td rowspan="1" colSpan="1" >[setRemoteViewBackgroundImage](https://cloud.tencent.com/document/product/647/81015#setRemoteViewBackgroundImage)</td>
106
-
107
- <td rowspan="1" colSpan="1" >设置远端用户通话界面背景图。</td>
108
- </tr>
109
-
110
- <tr>
111
- <td rowspan="1" colSpan="1" >[setLayoutMode](https://cloud.tencent.com/document/product/647/81015#setLayoutMode)</td>
112
-
113
- <td rowspan="1" colSpan="1" >设置通话界面布局模式。</td>
114
- </tr>
115
-
116
- <tr>
117
- <td rowspan="1" colSpan="1" >[setCameraDefaultState](https://cloud.tencent.com/document/product/647/81015#setCameraDefaultState)</td>
118
-
119
- <td rowspan="1" colSpan="1" >设置摄像头是否默认打开。</td>
120
- </tr>
121
-
122
- <tr>
123
- <td rowspan="1" colSpan="1" >[destroyed](https://cloud.tencent.com/document/product/647/81015#destroyed)</td>
124
-
125
- <td rowspan="1" colSpan="1" >销毁 TUICallKit 组件实例。</td>
126
- </tr>
127
-
128
- <tr>
129
- <td rowspan="1" colSpan="1" >[getTUICallEngineInstance](https://cloud.tencent.com/document/product/647/81015#getTUICallEngineInstance)</td>
130
-
131
- <td rowspan="1" colSpan="1" >获取 TUICallEngine 实例。</td>
132
- </tr>
133
- </table>
134
-
135
-
136
- ## <`TUICallKit />` 组件
137
-
138
- ### 属性概览
139
- <table>
140
- <tr>
141
- <td rowspan="1" colSpan="1" >属性</td>
142
-
143
- <td rowspan="1" colSpan="1" >描述</td>
144
-
145
- <td rowspan="1" colSpan="1" >类型</td>
146
-
147
- <td rowspan="1" colSpan="1" >是否必填</td>
148
-
149
- <td rowspan="1" colSpan="1" >默认值</td>
150
-
151
- <td rowspan="1" colSpan="1" >支持 vue</td>
152
-
153
- <td rowspan="1" colSpan="1" >支持 react</td>
154
- </tr>
155
-
156
- <tr>
157
- <td rowspan="1" colSpan="1" >allowedMinimized</td>
158
-
159
- <td rowspan="1" colSpan="1" >是否允许悬浮窗</td>
160
-
161
- <td rowspan="1" colSpan="1" >boolean</td>
162
-
163
- <td rowspan="1" colSpan="1" >否</td>
164
-
165
- <td rowspan="1" colSpan="1" >false</td>
166
-
167
- <td rowspan="1" colSpan="1" ><br>√<br></td>
168
-
169
- <td rowspan="1" colSpan="1" >√</td>
170
- </tr>
171
-
172
- <tr>
173
- <td rowspan="1" colSpan="1" >allowedFullScreen</td>
174
-
175
- <td rowspan="1" colSpan="1" >是否允许通话界面全屏</td>
176
-
177
- <td rowspan="1" colSpan="1" >boolean</td>
178
-
179
- <td rowspan="1" colSpan="1" >否</td>
180
-
181
- <td rowspan="1" colSpan="1" >true</td>
182
-
183
- <td rowspan="1" colSpan="1" >√</td>
184
-
185
- <td rowspan="1" colSpan="1" >√</td>
186
- </tr>
187
-
188
- <tr>
189
- <td rowspan="1" colSpan="1" >[videoDisplayMode](https://cloud.tencent.com/document/product/647/81015#videoDisplayMode)</td>
190
-
191
- <td rowspan="1" colSpan="1" >通话界面显示模式</td>
192
-
193
- <td rowspan="1" colSpan="1" >VideoDisplayMode</td>
194
-
195
- <td rowspan="1" colSpan="1" >否</td>
196
-
197
- <td rowspan="1" colSpan="1" >VideoDisplayMode.COVER</td>
198
-
199
- <td rowspan="1" colSpan="1" >√</td>
200
-
201
- <td rowspan="1" colSpan="1" >√</td>
202
- </tr>
203
-
204
- <tr>
205
- <td rowspan="1" colSpan="1" >[videoResolution](https://cloud.tencent.com/document/product/647/81015#videoResolution)</td>
206
-
207
- <td rowspan="1" colSpan="1" >通话分辨率</td>
208
-
209
- <td rowspan="1" colSpan="1" >VideoResolution</td>
210
-
211
- <td rowspan="1" colSpan="1" >否</td>
212
-
213
- <td rowspan="1" colSpan="1" >VideoResolution.RESOLUTION_480P</td>
214
-
215
- <td rowspan="1" colSpan="1" >√</td>
216
-
217
- <td rowspan="1" colSpan="1" >√</td>
218
- </tr>
219
-
220
- <tr>
221
- <td rowspan="1" colSpan="1" >beforeCalling</td>
222
-
223
- <td rowspan="1" colSpan="1" >拨打电话前与收到通话邀请前会执行此函数</td>
224
-
225
- <td rowspan="1" colSpan="1" >function(type, error)</td>
226
-
227
- <td rowspan="1" colSpan="1" >否</td>
228
-
229
- <td rowspan="1" colSpan="1" >-</td>
230
-
231
- <td rowspan="1" colSpan="1" >√</td>
232
-
233
- <td rowspan="1" colSpan="1" >√</td>
234
- </tr>
235
-
236
- <tr>
237
- <td rowspan="1" colSpan="1" >afterCalling</td>
238
-
239
- <td rowspan="1" colSpan="1" >结束通话后会执行此函数</td>
240
-
241
- <td rowspan="1" colSpan="1" >function()</td>
242
-
243
- <td rowspan="1" colSpan="1" >否</td>
244
-
245
- <td rowspan="1" colSpan="1" >-</td>
246
-
247
- <td rowspan="1" colSpan="1" >√</td>
248
-
249
- <td rowspan="1" colSpan="1" >√</td>
250
- </tr>
251
-
252
- <tr>
253
- <td rowspan="1" colSpan="1" ><br>onMinimized</td>
254
-
255
- <td rowspan="1" colSpan="1" >组件切换最小化状态时会执行此函数,[STATUS 值说明](https://cloud.tencent.com/document/product/647/81015#STATUS)</td>
256
-
257
- <td rowspan="1" colSpan="1" >function(oldStatus, newStatus)</td>
258
-
259
- <td rowspan="1" colSpan="1" >否</td>
260
-
261
- <td rowspan="1" colSpan="1" >-</td>
262
-
263
- <td rowspan="1" colSpan="1" >√</td>
264
-
265
- <td rowspan="1" colSpan="1" >√</td>
266
- </tr>
267
-
268
- <tr>
269
- <td rowspan="1" colSpan="1" ><br>kickedOut</td>
270
-
271
- <td rowspan="1" colSpan="1" >组件抛出的事件,当前登录用户被踢出登录时会触发该事件,通话也会自动结束</td>
272
-
273
- <td rowspan="1" colSpan="1" >function()</td>
274
-
275
- <td rowspan="1" colSpan="1" >否</td>
276
-
277
- <td rowspan="1" colSpan="1" >-</td>
278
-
279
- <td rowspan="1" colSpan="1" >√</td>
280
-
281
- <td rowspan="1" colSpan="1" >×</td>
282
- </tr>
283
-
284
- <tr>
285
- <td rowspan="1" colSpan="1" ><br>statusChanged</td>
286
-
287
- <td rowspan="1" colSpan="1" >组件抛出的事件,当通话状态发生变化时,会触发该事件,通话状态种类详见,[STATUS 值说明](https://cloud.tencent.com/document/product/647/81015#STATUS)</td>
288
-
289
- <td rowspan="1" colSpan="1" >function({oldStatus, newStatus})</td>
290
-
291
- <td rowspan="1" colSpan="1" >否</td>
292
-
293
- <td rowspan="1" colSpan="1" >-</td>
294
-
295
- <td rowspan="1" colSpan="1" >√</td>
296
-
297
- <td rowspan="1" colSpan="1" >×</td>
298
- </tr>
299
- </table>
300
-
301
-
302
- ### 示例代码
303
-
304
-
305
-
306
-
307
- 【React】
308
- ``` bash
309
- import { TUICallKit, VideoDisplayMode, VideoResolution } from "@trtc/calls-uikit-react";
310
-
311
- <TUICallKit
312
- videoDisplayMode={VideoDisplayMode.CONTAIN}
313
- videoResolution={VideoResolution.RESOLUTION_1080P}
314
- beforeCalling={handleBeforeCalling}
315
- afterCalling={handleAfterCalling}
316
- />
317
-
318
- function handleBeforeCalling(type: string, error: any) {
319
- console.log("[TUICallkit Demo] handleBeforeCalling:", type, error);
320
- }
321
- function handleAfterCalling() {
322
- console.log("[TUICallkit Demo] handleAfterCalling");
323
- }
324
- ```
325
-
326
-
327
- 【Vue3】
328
- ``` bash
329
- <template>
330
- <TUICallKit
331
- :allowedMinimized="true"
332
- :allowedFullScreen="true"
333
- :videoDisplayMode="VideoDisplayMode.CONTAIN"
334
- :videoResolution="VideoResolution.RESOLUTION_1080P"
335
- :beforeCalling="beforeCalling"
336
- :afterCalling="afterCalling"
337
- :onMinimized="onMinimized"
338
- :kickedOut="handleKickedOut"
339
- :statusChanged="handleStatusChanged"
340
- />
341
- </template>
342
-
343
- <script lang="ts" setup>
344
- import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue";
345
-
346
- function beforeCalling(type: string, error: any) {
347
- console.log("[TUICallkit Demo] beforeCalling:", type, error);
348
- }
349
- function afterCalling() {
350
- console.log("[TUICallkit Demo] afterCalling");
351
- }
352
- function onMinimized(oldStatus: string, newStatus: string) {
353
- console.log("[TUICallkit Demo] onMinimized: " + oldStatus + " -> " + newStatus);
354
- }
355
- function kickedOut() {
356
- console.log("[TUICallkit Demo] kickedOut");
357
- }
358
- function statusChanged(args: { oldStatus: string; newStatus: string; }) {
359
- const { oldStatus, newStatus } = args;
360
- if (newStatus === STATUS.CALLING_C2C_VIDEO) {
361
- console.log(`[TUICallkit Demo] statusChanged: ${oldStatus} -> ${newStatus}`);
362
- }
363
- }
364
- </script>
365
-
366
- ```
367
-
368
-
369
- 【Vue2.7】
370
- ``` javascript
371
- <template>
372
- <TUICallKit
373
- :allowedMinimized="true"
374
- :allowedFullScreen="true"
375
- :videoDisplayMode="VideoDisplayMode.CONTAIN"
376
- :videoResolution="VideoResolution.RESOLUTION_1080P"
377
- :beforeCalling="beforeCalling"
378
- :afterCalling="afterCalling"
379
- :onMinimized="onMinimized"
380
- :kickedOut="handleKickedOut"
381
- :statusChanged="handleStatusChanged"
382
- />
383
- </template>
384
-
385
- <script lang="ts" setup>
386
- import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue2";
387
-
388
- function beforeCalling(type: string, error: any) {
389
- console.log("[TUICallkit Demo] beforeCalling:", type, error);
390
- }
391
- function afterCalling() {
392
- console.log("[TUICallkit Demo] afterCalling");
393
- }
394
- function onMinimized(oldStatus: string, newStatus: string) {
395
- console.log("[TUICallkit Demo] onMinimized: " + oldStatus + " -> " + newStatus);
396
- }
397
- function kickedOut() {
398
- console.log("[TUICallkit Demo] kickedOut");
399
- }
400
- function statusChanged(args: { oldStatus: string; newStatus: string; }) {
401
- const { oldStatus, newStatus } = args;
402
- if (newStatus === STATUS.CALLING_C2C_VIDEO) {
403
- console.log(`[TUICallkit Demo] statusChanged: ${oldStatus} -> ${newStatus}`);
404
- }
405
- }
406
- </script>
407
- ```
408
-
409
-
410
- 【Vue2.6】
411
- ``` javascript
412
- <template>
413
- <TUICallKit
414
- :allowedMinimized="true"
415
- :allowedFullScreen="true"
416
- :videoDisplayMode="VideoDisplayMode.CONTAIN"
417
- :videoResolution="VideoResolution.RESOLUTION_1080P"
418
- :beforeCalling="beforeCalling"
419
- :afterCalling="afterCalling"
420
- :onMinimized="onMinimized"
421
- :kickedOut="handleKickedOut"
422
- :statusChanged="handleStatusChanged"
423
- />
424
- </template>
425
-
426
- <script lang="ts" setup>
427
- import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue2.6";
428
-
429
- function beforeCalling(type: string, error: any) {
430
- console.log("[TUICallkit Demo] beforeCalling:", type, error);
431
- }
432
- function afterCalling() {
433
- console.log("[TUICallkit Demo] afterCalling");
434
- }
435
- function onMinimized(oldStatus: string, newStatus: string) {
436
- console.log("[TUICallkit Demo] onMinimized: " + oldStatus + " -> " + newStatus);
437
- }
438
- function kickedOut() {
439
- console.log("[TUICallkit Demo] kickedOut");
440
- }
441
- function statusChanged(args: { oldStatus: string; newStatus: string; }) {
442
- const { oldStatus, newStatus } = args;
443
- if (newStatus === STATUS.CALLING_C2C_VIDEO) {
444
- console.log(`[TUICallkit Demo] statusChanged: ${oldStatus} -> ${newStatus}`);
445
- }
446
- }
447
- </script>
448
- ```
449
-
450
- ## TUICallKitAPI API 详情
451
-
452
-
453
-
454
-
455
- 【React】
456
- ``` javascript
457
- import { TUICallKitAPI } from "@trtc/calls-uikit-react";
458
- ```
459
-
460
-
461
- 【Vue3】
462
- ``` javascript
463
- import { TUICallKitAPI } from "@trtc/calls-uikit-vue";
464
- ```
465
-
466
-
467
- 【Vue2.7】
468
- ``` javascript
469
- import { TUICallKitAPI } from "@trtc/calls-uikit-vue2";
470
- ```
471
-
472
-
473
- 【Vue2.6】
474
- ``` javascript
475
- import { TUICallKitAPI } from "@trtc/calls-uikit-vue2.6";
476
- ```
477
-
478
- ### init
479
-
480
- 初始化 TUICallKit。
481
- ``` javascript
482
- try {
483
- await TUICallKitAPI.init({ SDKAppID, userID, userSig });
484
- // If you already have a tim instance in your project, you need to pass it in here.
485
- // await TUICallKitAPI.init({ tim, SDKAppID, userID, userSig});
486
- console.log("[TUICallKit] init succeeds.");
487
- } catch (error: any) {
488
- console.error(`[TUICallKit] init failed. Reason: ${error}`);
489
- }
490
- ```
491
-
492
- 参数如下表所示:
493
- <table>
494
- <tr>
495
- <td rowspan="1" colSpan="1" >参数</td>
496
-
497
- <td rowspan="1" colSpan="1" >类型</td>
498
-
499
- <td rowspan="1" colSpan="1" >是否必填</td>
500
-
501
- <td rowspan="1" colSpan="1" >含义</td>
502
- </tr>
503
-
504
- <tr>
505
- <td rowspan="1" colSpan="1" >SDKAppID</td>
506
-
507
- <td rowspan="1" colSpan="1" >Number</td>
508
-
509
- <td rowspan="1" colSpan="1" >是</td>
510
-
511
- <td rowspan="1" colSpan="1" >应用的 SDKAppID,您可以在实时音视频控制台中找到您的 SDKAppID。具体详见:[开通服务](https://write.woa.com/document/139743928960860160)</td>
512
- </tr>
513
-
514
- <tr>
515
- <td rowspan="1" colSpan="1" >userID</td>
516
-
517
- <td rowspan="1" colSpan="1" >String</td>
518
-
519
- <td rowspan="1" colSpan="1" >是</td>
520
-
521
- <td rowspan="1" colSpan="1" >即用户名,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。<br>**注意:**不支持同一个 userID 在两台不同的设备上同时进入同一个房间通话,否则会相互干扰。</td>
522
- </tr>
523
-
524
- <tr>
525
- <td rowspan="1" colSpan="1" >userSig</td>
526
-
527
- <td rowspan="1" colSpan="1" >String</td>
528
-
529
- <td rowspan="1" colSpan="1" >是</td>
530
-
531
- <td rowspan="1" colSpan="1" >使用 SecretKey 对 SDKAppID、UserID 等信息进行加密,就可以得到 userSig。<br>它是一个鉴权用的票据,用于腾讯云识别当前用户是否能够使用 TRTC 的服务,获取方式请参见 [UserSig](https://cloud.tencent.com/document/product/647/17275)</td>
532
- </tr>
533
-
534
- <tr>
535
- <td rowspan="1" colSpan="1" >tim</td>
536
-
537
- <td rowspan="1" colSpan="1" >TencentCloudChat</td>
538
-
539
- <td rowspan="1" colSpan="1" >否</td>
540
-
541
- <td rowspan="1" colSpan="1" >tim 是 [TencentCloudChat](https://www.npmjs.com/package/@tencentcloud/chat) SDK 的实例</td>
542
- </tr>
543
- </table>
544
-
545
-
546
- ### calls
547
-
548
- 发起单人或多人通话。
549
- ``` javascript
550
- try {
551
- await TUICallKitAPI.calls({
552
- userIDList: ['jack', 'tom'],
553
- type: CallMediaType.VIDEO_CALL
554
- });
555
- } catch (error: any) {
556
- console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
557
- }
558
- ```
559
-
560
- 参数如下表所示:
561
- <table>
562
- <tr>
563
- <td rowspan="1" colSpan="1" >参数</td>
564
-
565
- <td rowspan="1" colSpan="1" >类型</td>
566
-
567
- <td rowspan="1" colSpan="1" >是否必填</td>
568
-
569
- <td rowspan="1" colSpan="1" >含义</td>
570
- </tr>
571
-
572
- <tr>
573
- <td rowspan="1" colSpan="1" >userIDList</td>
574
-
575
- <td rowspan="1" colSpan="1" >Array<String></td>
576
-
577
- <td rowspan="1" colSpan="1" >是</td>
578
-
579
- <td rowspan="1" colSpan="1" >被呼叫的用户列表</td>
580
- </tr>
581
-
582
- <tr>
583
- <td rowspan="1" colSpan="1" >type</td>
584
-
585
- <td rowspan="1" colSpan="1" >[CallMediaType](https://cloud.tencent.com/document/product/647/81015#TUICallType)</td>
586
-
587
- <td rowspan="1" colSpan="1" >是</td>
588
-
589
- <td rowspan="1" colSpan="1" >通话的媒体类型,参数值说明参见 [CallMediaType 通话类型](https://cloud.tencent.com/document/product/647/81015#TUICallType)<br>兼容旧版本:语音通话(type = 1)、视频通话(type = 2)</td>
590
- </tr>
591
-
592
- <tr>
593
- <td rowspan="1" colSpan="1" >chatGroupID</td>
594
-
595
- <td rowspan="1" colSpan="1" >String</td>
596
-
597
- <td rowspan="1" colSpan="1" >是</td>
598
-
599
- <td rowspan="1" colSpan="1" >与 chat 结合使用时, chat 群组的群 ID</td>
600
- </tr>
601
-
602
- <tr>
603
- <td rowspan="1" colSpan="1" >roomID</td>
604
-
605
- <td rowspan="1" colSpan="1" >Number</td>
606
-
607
- <td rowspan="1" colSpan="1" >否</td>
608
-
609
- <td rowspan="1" colSpan="1" >数字房间号,范围 [1, 2147483647]</td>
610
- </tr>
611
-
612
- <tr>
613
- <td rowspan="1" colSpan="1" >strRoomID</td>
614
-
615
- <td rowspan="1" colSpan="1" >String</td>
616
-
617
- <td rowspan="1" colSpan="1" >否</td>
618
-
619
- <td rowspan="1" colSpan="1" >字符串房间号。**v3.3.1+ 支持**<br>1. roomID 与 strRoomID 是互斥的,若您选用 strRoomID,则 roomID 需要填写为 0。若两者都填,SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID,因为它们之间是不互通的,例如数字 123 和字符串 "123" 是两个完全不同的房间。</td>
620
- </tr>
621
-
622
- <tr>
623
- <td rowspan="1" colSpan="1" >timeout</td>
624
-
625
- <td rowspan="1" colSpan="1" >Number</td>
626
-
627
- <td rowspan="1" colSpan="1" >否</td>
628
-
629
- <td rowspan="1" colSpan="1" >通话超时时间,默认:30s,单位:秒。设置范围:10s ~ 600s。如果传入0,默认30s。</td>
630
- </tr>
631
-
632
- <tr>
633
- <td rowspan="1" colSpan="1" >userData</td>
634
-
635
- <td rowspan="1" colSpan="1" >String</td>
636
-
637
- <td rowspan="1" colSpan="1" >否</td>
638
-
639
- <td rowspan="1" colSpan="1" >发起通话时自定义扩展字段,被呼叫用户在 [ON_CALL_RECEIVED](https://write.woa.com/document/86735802757361664) 事件中有该参数</td>
640
- </tr>
641
-
642
- <tr>
643
- <td rowspan="1" colSpan="1" >[offlinePushInfo](https://cloud.tencent.com/document/product/647/81015#offlinePushInfo)</td>
644
-
645
- <td rowspan="1" colSpan="1" >Object</td>
646
-
647
- <td rowspan="1" colSpan="1" >否</td>
648
-
649
- <td rowspan="1" colSpan="1" >自定义离线消息推送参数</td>
650
- </tr>
651
- </table>
652
-
653
-
654
- ### join
655
-
656
- 加入群组中已有的音视频通话。
657
- ``` javascript
658
- try {
659
- await TUICallKitAPI.join({callId: xx});
660
- } catch (error: any) {
661
- console.error(`[TUICallKit] Failed to call the join API. Reason: ${error}`);
662
- }
663
- ```
664
-
665
- 参数列表:
666
- <table>
667
- <tr>
668
- <td rowspan="1" colSpan="1" >参数</td>
669
-
670
- <td rowspan="1" colSpan="1" >类型</td>
671
-
672
- <td rowspan="1" colSpan="1" >是否必填</td>
673
-
674
- <td rowspan="1" colSpan="1" >含义</td>
675
- </tr>
676
-
677
- <tr>
678
- <td rowspan="1" colSpan="1" >callId</td>
679
-
680
- <td rowspan="1" colSpan="1" >string</td>
681
-
682
- <td rowspan="1" colSpan="1" >是</td>
683
-
684
- <td rowspan="1" colSpan="1" >此次通话的唯一 ID。</td>
685
- </tr>
686
- </table>
687
-
688
-
689
- ### setLanguage
690
-
691
- 设置语言,目前支持:中文、英文、日文。
692
- ``` javascript
693
- TUICallKitAPI.setLanguage("zh-cn"); // "en" | "zh-cn" | "ja_JP"
694
- ```
695
-
696
- 参数如下表所示:
697
- <table>
698
- <tr>
699
- <td rowspan="1" colSpan="1" >参数</td>
700
-
701
- <td rowspan="1" colSpan="1" >类型</td>
702
-
703
- <td rowspan="1" colSpan="1" >是否必填</td>
704
-
705
- <td rowspan="1" colSpan="1" >含义</td>
706
- </tr>
707
-
708
- <tr>
709
- <td rowspan="1" colSpan="1" >lang</td>
710
-
711
- <td rowspan="1" colSpan="1" >String</td>
712
-
713
- <td rowspan="1" colSpan="1" >是</td>
714
-
715
- <td rowspan="1" colSpan="1" >语言类型`en`、`zh-cn` 和 `ja_JP`。</td>
716
- </tr>
717
- </table>
718
-
719
-
720
- ### setSelfInfo
721
-
722
- 设置当前用户昵称和头像。
723
-
724
- > **注意:**
725
- >
726
-
727
- > **通话中使用该接口修改用户信息,UI 不会立即更新,需要等到下次通话才能看到变化**。
728
- >
729
-
730
- ``` javascript
731
- try {
732
- await TUICallKitAPI.setSelfInfo({ nickName: "xxx", avatar: "http://xxx" });
733
- } catch (error: any) {
734
- console.error(`[TUICallKit] Failed to call the setSelfInfo API. Reason: ${error}`;
735
- }
736
- ```
737
-
738
- 参数如下表所示:
739
- <table>
740
- <tr>
741
- <td rowspan="1" colSpan="1" >**参数**</td>
742
-
743
- <td rowspan="1" colSpan="1" >**类型**</td>
744
-
745
- <td rowspan="1" colSpan="1" >**是否必填**</td>
746
-
747
- <td rowspan="1" colSpan="1" >**含义**</td>
748
- </tr>
749
-
750
- <tr>
751
- <td rowspan="1" colSpan="1" >nickName</td>
752
-
753
- <td rowspan="1" colSpan="1" >String</td>
754
-
755
- <td rowspan="1" colSpan="1" >是</td>
756
-
757
- <td rowspan="1" colSpan="1" >自己的昵称</td>
758
- </tr>
759
-
760
- <tr>
761
- <td rowspan="1" colSpan="1" >avatar</td>
762
-
763
- <td rowspan="1" colSpan="1" >String</td>
764
-
765
- <td rowspan="1" colSpan="1" >是</td>
766
-
767
- <td rowspan="1" colSpan="1" >自己头像地址</td>
768
- </tr>
769
- </table>
770
-
771
-
772
- ### setCallingBell
773
- - 自定义用户的来电铃音。
774
-
775
- - 仅限传入本地 MP3 格式的文件地址,需要确保该文件目录是应用可以访问的。
776
-
777
- - 使用 import 方式引入铃声文件。
778
-
779
- - 如需恢复默认铃声,`filePath` 传空即可。
780
-
781
- ``` javascript
782
- try {
783
- await TUICallKitAPI.setCallingBell(filePath?: string)
784
- } catch (error: any) {
785
- console.error(`[TUICallKit] Failed to call the setCallingBell API. Reason: ${error}`);
786
- }
787
- ```
788
-
789
- 参数如下表所示:
790
-
791
- <table>
792
- <tr>
793
- <td rowspan="1" colSpan="1" >参数</td>
794
-
795
- <td rowspan="1" colSpan="1" >类型</td>
796
-
797
- <td rowspan="1" colSpan="1" >是否必填</td>
798
-
799
- <td rowspan="1" colSpan="1" >含义</td>
800
- </tr>
801
-
802
- <tr>
803
- <td rowspan="1" colSpan="1" >filePath</td>
804
-
805
- <td rowspan="1" colSpan="1" >String</td>
806
-
807
- <td rowspan="1" colSpan="1" >是</td>
808
-
809
- <td rowspan="1" colSpan="1" >铃声文件地址</td>
810
- </tr>
811
- </table>
812
-
813
-
814
- ### enableFloatWindow
815
-
816
- 开启/关闭悬浮窗功能。默认为 false,通话界面左上角的悬浮窗按钮隐藏,设置为 true 后显示。
817
- ``` javascript
818
- try {
819
- await TUICallKitAPI.enableFloatWindow(enable: Boolean)
820
- } catch (error: any) {
821
- console.error(`[TUICallKit] Failed to call the enableFloatWindow API. Reason: ${error}`);
822
- }
823
- ```
824
-
825
- ### enableMuteMode
826
-
827
- 开启/关闭来电铃声。开启后,收到通话请求时,不会播放来电铃声。
828
- ``` javascript
829
- try {
830
- await TUICallKitAPI.enableMuteMode(enable: boolean)
831
- } catch (error: any) {
832
- console.error(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);
833
- }
834
- ```
835
-
836
- 参数如下表所示:
837
- <table>
838
- <tr>
839
- <td rowspan="1" colSpan="1" >参数</td>
840
-
841
- <td rowspan="1" colSpan="1" >类型</td>
842
-
843
- <td rowspan="1" colSpan="1" >是否必填</td>
844
-
845
- <td rowspan="1" colSpan="1" >含义</td>
846
- </tr>
847
-
848
- <tr>
849
- <td rowspan="1" colSpan="1" >enable</td>
850
-
851
- <td rowspan="1" colSpan="1" >Boolean</td>
852
-
853
- <td rowspan="1" colSpan="1" >是</td>
854
-
855
- <td rowspan="1" colSpan="1" >开启/关闭来电铃声。默认 false。</td>
856
- </tr>
857
- </table>
858
-
859
-
860
- ### enableVirtualBackground
861
-
862
- 开启/关闭模糊背景功能。如果想设置图片背景模糊参见 [Web](https://cloud.tencent.com/document/product/647/106071)。通过调用接口,您可以在 UI 上显示模糊背景的功能按钮,点击按钮可直接启用模糊背景功能。
863
- ``` javascript
864
- import { TUICallKitAPI } from "@trtc/calls-uikit-react";
865
- const enable = true;
866
- TUICallKitAPI.enableVirtualBackground(enable);
867
- ```
868
-
869
- 参数列表:
870
- <table>
871
- <tr>
872
- <td rowspan="1" colSpan="1" >参数</td>
873
-
874
- <td rowspan="1" colSpan="1" >类型</td>
875
-
876
- <td rowspan="1" colSpan="1" >是否必填</td>
877
-
878
- <td rowspan="1" colSpan="1" >含义</td>
879
- </tr>
880
-
881
- <tr>
882
- <td rowspan="1" colSpan="1" >enable</td>
883
-
884
- <td rowspan="1" colSpan="1" >boolean</td>
885
-
886
- <td rowspan="1" colSpan="1" >是</td>
887
-
888
- <td rowspan="1" colSpan="1" >- enable = true 显示模糊背景按钮<br>- enable = false 不显示模糊背景按钮</td>
889
- </tr>
890
- </table>
891
-
892
-
893
- ### destroyed
894
-
895
- 销毁 TUICallKit 实例。
896
-
897
- 该方法不会自动退出`tim`,需要手动退出`tim.logout();`。
898
- ``` javascript
899
- try {
900
- await TUICallKitAPI.destroyed();
901
- } catch (error: any) {
902
- alert(`[TUICallKit] Failed to call the destroyed API. Reason: ${error}`);
903
- }
904
- ```
905
-
906
- ### hideFeatureButton
907
-
908
- 隐藏功能按钮,目前仅支持 摄像头,麦克风和切换前后置按钮。
909
-
910
-
911
-
912
-
913
- 【Vue】
914
- ``` javascript
915
- import { TUICallKitAPI, FeatureButton } from "@trtc/calls-uikit-vue";
916
-
917
- TUICallKitAPI.hideFeatureButton(FeatureButton.Camera);
918
- ```
919
-
920
-
921
- 【React】
922
- ``` javascript
923
- import { TUICallKitAPI, FeatureButton } from "@trtc/calls-uikit-react";
924
-
925
- TUICallKitAPI.hideFeatureButton(FeatureButton.Camera);
926
- ```
927
-
928
- 参数列表:
929
- <table>
930
- <tr>
931
- <td rowspan="1" colSpan="1" >参数</td>
932
-
933
- <td rowspan="1" colSpan="1" >类型</td>
934
-
935
- <td rowspan="1" colSpan="1" >是否必填</td>
936
-
937
- <td rowspan="1" colSpan="1" >含义</td>
938
- </tr>
939
-
940
- <tr>
941
- <td rowspan="1" colSpan="1" >buttonName</td>
942
-
943
- <td rowspan="1" colSpan="1" >[FeatureButton](https://cloud.tencent.com/document/product/647/81015#FeatureButton)</td>
944
-
945
- <td rowspan="1" colSpan="1" >是</td>
946
-
947
- <td rowspan="1" colSpan="1" >按钮名称</td>
948
- </tr>
949
- </table>
950
-
951
-
952
- ### setLocalViewBackgroundImage
953
-
954
- 设置本地用户通话背景。
955
- ``` typescript
956
- TUICallKitAPI.setLocalViewBackgroundImage('http://xxx.png');
957
- ```
958
-
959
- 参数列表:
960
- <table>
961
- <tr>
962
- <td rowspan="1" colSpan="1" >参数</td>
963
-
964
- <td rowspan="1" colSpan="1" >类型</td>
965
-
966
- <td rowspan="1" colSpan="1" >是否必填</td>
967
-
968
- <td rowspan="1" colSpan="1" >含义</td>
969
- </tr>
970
-
971
- <tr>
972
- <td rowspan="1" colSpan="1" >url</td>
973
-
974
- <td rowspan="1" colSpan="1" >string</td>
975
-
976
- <td rowspan="1" colSpan="1" >是</td>
977
-
978
- <td rowspan="1" colSpan="1" >图片地址(支持本地路径和网络地址)</td>
979
- </tr>
980
- </table>
981
-
982
-
983
- ### setRemoteViewBackgroundImage
984
-
985
- 设置远端用户通话背景。
986
- ``` javascript
987
- const userId = 'xxx';
988
- const url = 'http://xxx.png';
989
- TUICallKitAPI.setRemoteViewBackgroundImage(userId, url);
990
- ```
991
-
992
- 参数列表:
993
- <table>
994
- <tr>
995
- <td rowspan="1" colSpan="1" >参数</td>
996
-
997
- <td rowspan="1" colSpan="1" >类型</td>
998
-
999
- <td rowspan="1" colSpan="1" >是否必填</td>
1000
-
1001
- <td rowspan="1" colSpan="1" >含义</td>
1002
- </tr>
1003
-
1004
- <tr>
1005
- <td rowspan="1" colSpan="1" >userId</td>
1006
-
1007
- <td rowspan="1" colSpan="1" >string</td>
1008
-
1009
- <td rowspan="1" colSpan="1" >是</td>
1010
-
1011
- <td rowspan="1" colSpan="1" >远端用户 userId,设置为 '*' 表示对所有远端用户生效</td>
1012
- </tr>
1013
-
1014
- <tr>
1015
- <td rowspan="1" colSpan="1" >url</td>
1016
-
1017
- <td rowspan="1" colSpan="1" >string</td>
1018
-
1019
- <td rowspan="1" colSpan="1" >是</td>
1020
-
1021
- <td rowspan="1" colSpan="1" >图片地址(支持本地路径和网络地址)</td>
1022
- </tr>
1023
- </table>
1024
-
1025
-
1026
- ### setLayoutMode
1027
-
1028
- 设置通话界面布局模式。
1029
-
1030
-
1031
-
1032
-
1033
- 【Vue】
1034
- ``` javascript
1035
- import { TUICallKitAPI, LayoutMode } from "@trtc/calls-uikit-vue";
1036
- TUICallKitAPI.setLayoutMode(LayoutMode.LocalInLargeView);
1037
- ```
1038
-
1039
-
1040
- 【React】
1041
- ``` javascript
1042
- import { TUICallKitAPI, LayoutMode } from "@trtc/calls-uikit-react";
1043
- TUICallKitAPI.setLayoutMode(LayoutMode.LocalInLargeView);
1044
- ```
1045
-
1046
- 参数列表:
1047
- <table>
1048
- <tr>
1049
- <td rowspan="1" colSpan="1" >参数</td>
1050
-
1051
- <td rowspan="1" colSpan="1" >类型</td>
1052
-
1053
- <td rowspan="1" colSpan="1" >是否必填</td>
1054
-
1055
- <td rowspan="1" colSpan="1" >含义</td>
1056
- </tr>
1057
-
1058
- <tr>
1059
- <td rowspan="1" colSpan="1" >layoutMode</td>
1060
-
1061
- <td rowspan="1" colSpan="1" >[LayoutMode](https://cloud.tencent.com/document/product/647/81015#LayoutMode)</td>
1062
-
1063
- <td rowspan="1" colSpan="1" >是</td>
1064
-
1065
- <td rowspan="1" colSpan="1" >用户流的布局模式</td>
1066
- </tr>
1067
- </table>
1068
-
1069
-
1070
- ### setCameraDefaultState
1071
-
1072
- 设置摄像头是否默认打开。
1073
- ``` javascript
1074
- TUICallKitAPI.setCameraDefaultState(true);
1075
- ```
1076
-
1077
- 参数列表:
1078
- <table>
1079
- <tr>
1080
- <td rowspan="1" colSpan="1" >参数</td>
1081
-
1082
- <td rowspan="1" colSpan="1" >类型</td>
1083
-
1084
- <td rowspan="1" colSpan="1" >是否必填</td>
1085
-
1086
- <td rowspan="1" colSpan="1" >含义</td>
1087
- </tr>
1088
-
1089
- <tr>
1090
- <td rowspan="1" colSpan="1" >isOpen</td>
1091
-
1092
- <td rowspan="1" colSpan="1" >boolean</td>
1093
-
1094
- <td rowspan="1" colSpan="1" >是</td>
1095
-
1096
- <td rowspan="1" colSpan="1" >是否开启摄像头</td>
1097
- </tr>
1098
- </table>
1099
-
1100
-
1101
- ### getTUICallEngineInstance
1102
-
1103
- 获取 TUICallEngine 实例。
1104
- ``` javascript
1105
- TUICallKitAPI.getTUICallEngineInstance();
1106
- ```
1107
-
1108
- ## TUICallKit 类型定义
1109
-
1110
- ### videoDisplayMode
1111
-
1112
- 画面显示模式 `videoDisplayMode` 属性有三个值:
1113
- - `VideoDisplayMode.CONTAIN`
1114
-
1115
- - `VideoDisplayMode.COVER`
1116
-
1117
- - `VideoDisplayMode.FILL`,默认值是`VideoDisplayMode.COVER`。
1118
-
1119
- <table>
1120
- <tr>
1121
- <td rowspan="1" colSpan="1" >属性</td>
1122
-
1123
- <td rowspan="1" colSpan="1" >值</td>
1124
-
1125
- <td rowspan="1" colSpan="1" >描述</td>
1126
- </tr>
1127
-
1128
- <tr>
1129
- <td rowspan="3" colSpan="1" >videoDisplayMode</td>
1130
-
1131
- <td rowspan="1" colSpan="1" >VideoDisplayMode.CONTAIN</td>
1132
-
1133
- <td rowspan="1" colSpan="1" >- 优先保证视频内容全部显示。<br>- 视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。<br>- 如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。</td>
1134
- </tr>
1135
-
1136
- <tr>
1137
- <td rowspan="1" colSpan="1" >VideoDisplayMode.COVER</td>
1138
-
1139
- <td rowspan="1" colSpan="1" >- 优先保证视窗被填满。<br>- 视频尺寸等比缩放,直至整个视窗被视频填满。<br>- 如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。</td>
1140
- </tr>
1141
-
1142
- <tr>
1143
- <td rowspan="1" colSpan="1" >VideoDisplayMode.FILL</td>
1144
-
1145
- <td rowspan="1" colSpan="1" >- 保证视窗被填满的同时保证视频内容全部显示,但是不保证视频尺寸比例不变。<br>- 视频的宽高会被拉伸至和视窗尺寸一致。</td>
1146
- </tr>
1147
- </table>
1148
-
1149
-
1150
- ### videoResolution
1151
-
1152
- 分辨率 `videoResolution` 有三个值:
1153
- - `VideoResolution.RESOLUTION_480P`
1154
-
1155
- - `VideoResolution.RESOLUTION_720P`
1156
-
1157
- - `VideoResolution.RESOLUTION_1080P`,默认值是`VideoResolution.RESOLUTION_480P`。
1158
-
1159
-
1160
- **分辨率说明:**
1161
-
1162
- <table>
1163
- <tr>
1164
- <td rowspan="1" colSpan="1" >视频 Profile</td>
1165
-
1166
- <td rowspan="1" colSpan="1" >分辨率(宽 × 高)</td>
1167
-
1168
- <td rowspan="1" colSpan="1" >帧率(fps)</td>
1169
-
1170
- <td rowspan="1" colSpan="1" >码率(kbps)</td>
1171
- </tr>
1172
-
1173
- <tr>
1174
- <td rowspan="1" colSpan="1" >480p</td>
1175
-
1176
- <td rowspan="1" colSpan="1" >640 × 480</td>
1177
-
1178
- <td rowspan="1" colSpan="1" >15</td>
1179
-
1180
- <td rowspan="1" colSpan="1" >900</td>
1181
- </tr>
1182
-
1183
- <tr>
1184
- <td rowspan="1" colSpan="1" >720p</td>
1185
-
1186
- <td rowspan="1" colSpan="1" >1280 × 720</td>
1187
-
1188
- <td rowspan="1" colSpan="1" >15</td>
1189
-
1190
- <td rowspan="1" colSpan="1" >1500</td>
1191
- </tr>
1192
-
1193
- <tr>
1194
- <td rowspan="1" colSpan="1" >1080p</td>
1195
-
1196
- <td rowspan="1" colSpan="1" >1920 × 1080</td>
1197
-
1198
- <td rowspan="1" colSpan="1" >15</td>
1199
-
1200
- <td rowspan="1" colSpan="1" >2000</td>
1201
- </tr>
1202
- </table>
1203
-
1204
-
1205
- **常见问题:**
1206
-
1207
- - iOS 13&14不支持编码高于 720p 的视频,建议在这两个系统版本限制最高采集 720P。参见 [iOS Safari 已知问题 case 12](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-02-info-webrtc-issues.html#h2-4)。
1208
-
1209
- - Firefox 不支持自定义视频帧率(默认为 30fps)。
1210
-
1211
- - 受系统性能占用,摄像头采集能力和浏览器限制等因素的影响,视频分辨率、帧率、码率的实际值不一定能够完全匹配设定值,在这种情况下,浏览器会自动调整 Profile 尽可能匹配设定值。
1212
-
1213
-
1214
- ### STATUS
1215
- <table>
1216
- <tr>
1217
- <td rowspan="1" colSpan="1" >属性值</td>
1218
-
1219
- <td rowspan="1" colSpan="1" >描述</td>
1220
- </tr>
1221
-
1222
- <tr>
1223
- <td rowspan="1" colSpan="1" >STATUS.IDLE</td>
1224
-
1225
- <td rowspan="1" colSpan="1" >闲置状态</td>
1226
- </tr>
1227
-
1228
- <tr>
1229
- <td rowspan="1" colSpan="1" >STATUS.BE_INVITED</td>
1230
-
1231
- <td rowspan="1" colSpan="1" >收到通话邀请</td>
1232
- </tr>
1233
-
1234
- <tr>
1235
- <td rowspan="1" colSpan="1" >STATUS.DIALING_C2C</td>
1236
-
1237
- <td rowspan="1" colSpan="1" >正在 1v1 呼叫</td>
1238
- </tr>
1239
-
1240
- <tr>
1241
- <td rowspan="1" colSpan="1" >STATUS.DIALING_GROUP</td>
1242
-
1243
- <td rowspan="1" colSpan="1" >正在群组呼叫</td>
1244
- </tr>
1245
-
1246
- <tr>
1247
- <td rowspan="1" colSpan="1" >STATUS.CALLING_C2C_AUDIO</td>
1248
-
1249
- <td rowspan="1" colSpan="1" >正在 1v1 语音通话</td>
1250
- </tr>
1251
-
1252
- <tr>
1253
- <td rowspan="1" colSpan="1" >STATUS.CALLING_C2C_VIDEO</td>
1254
-
1255
- <td rowspan="1" colSpan="1" >正在 1v1 视频通话</td>
1256
- </tr>
1257
-
1258
- <tr>
1259
- <td rowspan="1" colSpan="1" >STATUS.CALLING_GROUP_AUDIO</td>
1260
-
1261
- <td rowspan="1" colSpan="1" >正在群组语音通话</td>
1262
- </tr>
1263
-
1264
- <tr>
1265
- <td rowspan="1" colSpan="1" >STATUS.CALLING_GROUP_VIDEO</td>
1266
-
1267
- <td rowspan="1" colSpan="1" >正在群组视频通话</td>
1268
- </tr>
1269
- </table>
1270
-
1271
-
1272
- ### **CallMediaType**
1273
- <table>
1274
- <tr>
1275
- <td rowspan="1" colSpan="1" >CallMediaType 类型</td>
1276
-
1277
- <td rowspan="1" colSpan="1" >描述</td>
1278
- </tr>
1279
-
1280
- <tr>
1281
- <td rowspan="1" colSpan="1" >CallMediaType.AUDIO</td>
1282
-
1283
- <td rowspan="1" colSpan="1" >语音通话</td>
1284
- </tr>
1285
-
1286
- <tr>
1287
- <td rowspan="1" colSpan="1" >CallMediaType.VIDEO</td>
1288
-
1289
- <td rowspan="1" colSpan="1" >视频通话</td>
1290
- </tr>
1291
- </table>
1292
-
1293
-
1294
- ### **offlinePushInfo**
1295
- <table>
1296
- <tr>
1297
- <td rowspan="1" colSpan="1" >参数</td>
1298
-
1299
- <td rowspan="1" colSpan="1" >类型</td>
1300
-
1301
- <td rowspan="1" colSpan="1" >是否必填</td>
1302
-
1303
- <td rowspan="1" colSpan="1" >含义</td>
1304
- </tr>
1305
-
1306
- <tr>
1307
- <td rowspan="1" colSpan="1" >offlinePushInfo.title</td>
1308
-
1309
- <td rowspan="1" colSpan="1" >String</td>
1310
-
1311
- <td rowspan="1" colSpan="1" >否</td>
1312
-
1313
- <td rowspan="1" colSpan="1" >离线推送标题(选填)</td>
1314
- </tr>
1315
-
1316
- <tr>
1317
- <td rowspan="1" colSpan="1" >offlinePushInfo.description</td>
1318
-
1319
- <td rowspan="1" colSpan="1" >String</td>
1320
-
1321
- <td rowspan="1" colSpan="1" >否</td>
1322
-
1323
- <td rowspan="1" colSpan="1" >离线推送内容(选填)</td>
1324
- </tr>
1325
-
1326
- <tr>
1327
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidOPPOChannelID</td>
1328
-
1329
- <td rowspan="1" colSpan="1" >String</td>
1330
-
1331
- <td rowspan="1" colSpan="1" >否</td>
1332
-
1333
- <td rowspan="1" colSpan="1" >离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(选填)</td>
1334
- </tr>
1335
-
1336
- <tr>
1337
- <td rowspan="1" colSpan="1" >offlinePushInfo.extension</td>
1338
-
1339
- <td rowspan="1" colSpan="1" >String</td>
1340
-
1341
- <td rowspan="1" colSpan="1" >否</td>
1342
-
1343
- <td rowspan="1" colSpan="1" >离线推送透传内容,可以用于设置 Android [Notification 模式](https://cloud.tencent.com/document/product/647/81015#Android Notification) 和 [VoIP 模式](https://cloud.tencent.com/document/product/647/81015#Android VoIP)。**默认:**Notification 模式,会是系统的通知;VoIP 模式是需要传字段。</td>
1344
- </tr>
1345
-
1346
- <tr>
1347
- <td rowspan="1" colSpan="1" >offlinePushInfo.ignoreIOSBadge</td>
1348
-
1349
- <td rowspan="1" colSpan="1" >Boolean</td>
1350
-
1351
- <td rowspan="1" colSpan="1" >否</td>
1352
-
1353
- <td rowspan="1" colSpan="1" >离线推送忽略 badge 计数(仅对 iOS 生效), 如果设置为 true,在 iOS 接收端,这条消息不会使 App 的应用图标未读计数增加。</td>
1354
- </tr>
1355
-
1356
- <tr>
1357
- <td rowspan="1" colSpan="1" >offlinePushInfo.iOSSound</td>
1358
-
1359
- <td rowspan="1" colSpan="1" >String</td>
1360
-
1361
- <td rowspan="1" colSpan="1" >否</td>
1362
-
1363
- <td rowspan="1" colSpan="1" >离线推送声音设置(仅对 iOS 生效)。</td>
1364
- </tr>
1365
-
1366
- <tr>
1367
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidSound</td>
1368
-
1369
- <td rowspan="1" colSpan="1" >String</td>
1370
-
1371
- <td rowspan="1" colSpan="1" >否</td>
1372
-
1373
- <td rowspan="1" colSpan="1" >离线推送声音设置(仅对 Android 生效)。</td>
1374
- </tr>
1375
-
1376
- <tr>
1377
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidVIVOClassification</td>
1378
-
1379
- <td rowspan="1" colSpan="1" >Number</td>
1380
-
1381
- <td rowspan="1" colSpan="1" >否</td>
1382
-
1383
- <td rowspan="1" colSpan="1" >VIVO 推送消息分类。</td>
1384
- </tr>
1385
-
1386
- <tr>
1387
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidXiaoMiChannelID</td>
1388
-
1389
- <td rowspan="1" colSpan="1" >String</td>
1390
-
1391
- <td rowspan="1" colSpan="1" >否</td>
1392
-
1393
- <td rowspan="1" colSpan="1" >小米手机 8.0 系统及以上的渠道 ID。</td>
1394
- </tr>
1395
-
1396
- <tr>
1397
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidFCMChannelID</td>
1398
-
1399
- <td rowspan="1" colSpan="1" >String</td>
1400
-
1401
- <td rowspan="1" colSpan="1" >否</td>
1402
-
1403
- <td rowspan="1" colSpan="1" >FCM 通道手机 8.0 系统及以上的渠道 ID。</td>
1404
- </tr>
1405
-
1406
- <tr>
1407
- <td rowspan="1" colSpan="1" >offlinePushInfo.androidHuaWeiCategory</td>
1408
-
1409
- <td rowspan="1" colSpan="1" >String</td>
1410
-
1411
- <td rowspan="1" colSpan="1" >否</td>
1412
-
1413
- <td rowspan="1" colSpan="1" >华为推送消息分类。</td>
1414
- </tr>
1415
-
1416
- <tr>
1417
- <td rowspan="1" colSpan="1" >offlinePushInfo.isDisablePush</td>
1418
-
1419
- <td rowspan="1" colSpan="1" >Boolean</td>
1420
-
1421
- <td rowspan="1" colSpan="1" >否</td>
1422
-
1423
- <td rowspan="1" colSpan="1" >是否关闭推送(默认开启推送)。</td>
1424
- </tr>
1425
-
1426
- <tr>
1427
- <td rowspan="1" colSpan="1" >offlinePushInfo.iOSPushType</td>
1428
-
1429
- <td rowspan="1" colSpan="1" >Number</td>
1430
-
1431
- <td rowspan="1" colSpan="1" >否</td>
1432
-
1433
- <td rowspan="1" colSpan="1" >iOS 离线推送类型。0-普通推送;1-VoIP推送。默认:0。</td>
1434
- </tr>
1435
- </table>
1436
-
1437
-
1438
- #### Android Notification 模式
1439
- ``` javascript
1440
- const extension = {
1441
- timPushFeatures: {
1442
- fcmPushType: 0, // 0, VoIP; 1, notification
1443
- }
1444
- };
1445
- offlinePushInfo.extension = JSON.stringify(extension);
1446
- ```
1447
-
1448
- #### Android VoIP 模式
1449
- ``` javascript
1450
- const extension = {
1451
- timPushFeatures: {
1452
- fcmPushType: 0, // 0, data; 1, notification
1453
- fcmNotificationType: 1, // 0, TIMPush implementation; 1, business implementation after transparent transmission
1454
- }
1455
- };
1456
- offlinePushInfo.extension = JSON.stringify(extension);
1457
- ```
1458
-
1459
- ### FeatureButton
1460
- <table>
1461
- <tr>
1462
- <td rowspan="1" colSpan="1" >FeatureButton 类型</td>
1463
-
1464
- <td rowspan="1" colSpan="1" >描述</td>
1465
- </tr>
1466
-
1467
- <tr>
1468
- <td rowspan="1" colSpan="1" >FeatureButton.Camera</td>
1469
-
1470
- <td rowspan="1" colSpan="1" >摄像头按钮</td>
1471
- </tr>
1472
-
1473
- <tr>
1474
- <td rowspan="1" colSpan="1" >FeatureButton.Microphone</td>
1475
-
1476
- <td rowspan="1" colSpan="1" >麦克风按钮</td>
1477
- </tr>
1478
-
1479
- <tr>
1480
- <td rowspan="1" colSpan="1" >FeatureButton.SwitchCamera</td>
1481
-
1482
- <td rowspan="1" colSpan="1" >切换前后置摄像头按钮</td>
1483
- </tr>
1484
-
1485
- <tr>
1486
- <td rowspan="1" colSpan="1" >FeatureButton.InviteUser</td>
1487
-
1488
- <td rowspan="1" colSpan="1" >邀请他人按钮</td>
1489
- </tr>
1490
- </table>
1491
-
1492
-
1493
- ### LayoutMode
1494
- <table>
1495
- <tr>
1496
- <td rowspan="1" colSpan="1" >LayoutMode 类型</td>
1497
-
1498
- <td rowspan="1" colSpan="1" >描述</td>
1499
- </tr>
1500
-
1501
- <tr>
1502
- <td rowspan="1" colSpan="1" >LayoutMode.LocalInLargeView</td>
1503
-
1504
- <td rowspan="1" colSpan="1" >本地用户在大窗显示</td>
1505
- </tr>
1506
-
1507
- <tr>
1508
- <td rowspan="1" colSpan="1" >LayoutMode.RemoteInLargeView</td>
1509
-
1510
- <td rowspan="1" colSpan="1" >远端用户在大窗显示</td>
1511
- </tr>
1512
- </table>