@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
@@ -3,616 +3,235 @@
3
3
  ## 概述
4
4
  `ITXAudioEffectManager.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的背景音乐、短音效和人声特效的管理类文档,用于对背景音乐、短音效和人声特效进行设置的管理类。
5
5
 
6
-
7
6
  ## ITXMusicPreloadObserver
8
- <table>
9
- <tr>
10
- <td rowspan="1" colSpan="1" >函数列表</td>
11
-
12
- <td rowspan="1" colSpan="1" >描述</td>
13
- </tr>
14
-
15
- <tr>
16
- <td rowspan="1" colSpan="1" >[onLoadProgress](https://write.woa.com/document/87030074293530624)</td>
17
-
18
- <td rowspan="1" colSpan="1" >背景音乐预加载进度</td>
19
- </tr>
20
-
21
- <tr>
22
- <td rowspan="1" colSpan="1" >[onLoadError](https://write.woa.com/document/87030074293530624)</td>
23
-
24
- <td rowspan="1" colSpan="1" >背景音乐预加载出错</td>
25
- </tr>
26
- </table>
27
-
7
+ | 函数列表 | 描述 |
8
+ | --- | --- |
9
+ | onLoadProgress | 背景音乐预加载进度 |
10
+ | onLoadError | 背景音乐预加载出错 |
28
11
 
29
12
  ## ITXMusicPlayObserver
30
- <table>
31
- <tr>
32
- <td rowspan="1" colSpan="1" >函数列表</td>
33
-
34
- <td rowspan="1" colSpan="1" >描述</td>
35
- </tr>
36
-
37
- <tr>
38
- <td rowspan="1" colSpan="1" >[onStart](https://write.woa.com/document/87030074293530624)</td>
39
-
40
- <td rowspan="1" colSpan="1" >背景音乐开始播放</td>
41
- </tr>
42
-
43
- <tr>
44
- <td rowspan="1" colSpan="1" >[onPlayProgress](https://write.woa.com/document/87030074293530624)</td>
45
-
46
- <td rowspan="1" colSpan="1" >背景音乐的播放进度</td>
47
- </tr>
48
-
49
- <tr>
50
- <td rowspan="1" colSpan="1" >[onComplete](https://write.woa.com/document/87030074293530624)</td>
51
-
52
- <td rowspan="1" colSpan="1" >背景音乐已经播放完毕</td>
53
- </tr>
54
- </table>
55
-
13
+ | 函数列表 | 描述 |
14
+ | --- | --- |
15
+ | onStart | 背景音乐开始播放 |
16
+ | onPlayProgress | 背景音乐的播放进度 |
17
+ | onComplete | 背景音乐已经播放完毕 |
56
18
 
57
19
  ## ITXAudioEffectManager
58
- <table>
59
- <tr>
60
- <td rowspan="1" colSpan="1" >函数列表</td>
61
-
62
- <td rowspan="1" colSpan="1" >描述</td>
63
- </tr>
64
-
65
- <tr>
66
- <td rowspan="1" colSpan="1" >[enableVoiceEarMonitor](https://write.woa.com/document/87030074293530624)</td>
67
-
68
- <td rowspan="1" colSpan="1" >开启耳返。</td>
69
- </tr>
70
-
71
- <tr>
72
- <td rowspan="1" colSpan="1" >[setVoiceEarMonitorVolume](https://write.woa.com/document/87030074293530624)</td>
73
-
74
- <td rowspan="1" colSpan="1" >设置耳返音量。</td>
75
- </tr>
76
-
77
- <tr>
78
- <td rowspan="1" colSpan="1" >[setVoiceReverbType](https://write.woa.com/document/87030074293530624)</td>
79
-
80
- <td rowspan="1" colSpan="1" >设置人声的混响效果。</td>
81
- </tr>
82
-
83
- <tr>
84
- <td rowspan="1" colSpan="1" >[setVoiceChangerType](https://write.woa.com/document/87030074293530624)</td>
85
-
86
- <td rowspan="1" colSpan="1" >设置人声的变声特效。</td>
87
- </tr>
88
-
89
- <tr>
90
- <td rowspan="1" colSpan="1" >[setVoiceCaptureVolume](https://write.woa.com/document/87030074293530624)</td>
91
-
92
- <td rowspan="1" colSpan="1" >设置语音音量。</td>
93
- </tr>
94
-
95
- <tr>
96
- <td rowspan="1" colSpan="1" >[setVoicePitch](https://write.woa.com/document/87030074293530624)</td>
97
-
98
- <td rowspan="1" colSpan="1" >设置语音音调。</td>
99
- </tr>
100
-
101
- <tr>
102
- <td rowspan="1" colSpan="1" >[setMusicObserver](https://write.woa.com/document/87030074293530624)</td>
103
-
104
- <td rowspan="1" colSpan="1" >设置背景音乐的事件回调接口。</td>
105
- </tr>
106
-
107
- <tr>
108
- <td rowspan="1" colSpan="1" >[startPlayMusic](https://write.woa.com/document/87030074293530624)</td>
109
-
110
- <td rowspan="1" colSpan="1" >开始播放背景音乐。</td>
111
- </tr>
112
-
113
- <tr>
114
- <td rowspan="1" colSpan="1" >[stopPlayMusic](https://write.woa.com/document/87030074293530624)</td>
115
-
116
- <td rowspan="1" colSpan="1" >停止播放背景音乐。</td>
117
- </tr>
118
-
119
- <tr>
120
- <td rowspan="1" colSpan="1" >[pausePlayMusic](https://write.woa.com/document/87030074293530624)</td>
121
-
122
- <td rowspan="1" colSpan="1" >暂停播放背景音乐。</td>
123
- </tr>
124
-
125
- <tr>
126
- <td rowspan="1" colSpan="1" >[resumePlayMusic](https://write.woa.com/document/87030074293530624)</td>
127
-
128
- <td rowspan="1" colSpan="1" >恢复播放背景音乐。</td>
129
- </tr>
130
-
131
- <tr>
132
- <td rowspan="1" colSpan="1" >[setAllMusicVolume](https://write.woa.com/document/87030074293530624)</td>
133
-
134
- <td rowspan="1" colSpan="1" >设置所有背景音乐的本地音量和远端音量的大小。</td>
135
- </tr>
136
-
137
- <tr>
138
- <td rowspan="1" colSpan="1" >[setMusicPublishVolume](https://write.woa.com/document/87030074293530624)</td>
139
-
140
- <td rowspan="1" colSpan="1" >设置某一首背景音乐的远端音量的大小。</td>
141
- </tr>
142
-
143
- <tr>
144
- <td rowspan="1" colSpan="1" >[setMusicPlayoutVolume](https://write.woa.com/document/87030074293530624)</td>
145
-
146
- <td rowspan="1" colSpan="1" >设置某一首背景音乐的本地音量的大小。</td>
147
- </tr>
148
-
149
- <tr>
150
- <td rowspan="1" colSpan="1" >[setMusicPitch](https://write.woa.com/document/87030074293530624)</td>
151
-
152
- <td rowspan="1" colSpan="1" >调整背景音乐的音调高低。</td>
153
- </tr>
154
-
155
- <tr>
156
- <td rowspan="1" colSpan="1" >[setMusicSpeedRate](https://write.woa.com/document/87030074293530624)</td>
157
-
158
- <td rowspan="1" colSpan="1" >调整背景音乐的变速效果。</td>
159
- </tr>
160
-
161
- <tr>
162
- <td rowspan="1" colSpan="1" >[getMusicCurrentPosInMS](https://write.woa.com/document/87030074293530624)</td>
163
-
164
- <td rowspan="1" colSpan="1" >获取背景音乐的播放进度(单位:毫秒)。</td>
165
- </tr>
166
-
167
- <tr>
168
- <td rowspan="1" colSpan="1" >[getMusicDurationInMS](https://write.woa.com/document/87030074293530624)</td>
169
-
170
- <td rowspan="1" colSpan="1" >获取背景音乐的总时长(单位:毫秒)。</td>
171
- </tr>
172
-
173
- <tr>
174
- <td rowspan="1" colSpan="1" >[seekMusicToPosInTime](https://write.woa.com/document/87030074293530624)</td>
175
-
176
- <td rowspan="1" colSpan="1" >设置背景音乐的播放进度(单位:毫秒)。</td>
177
- </tr>
178
-
179
- <tr>
180
- <td rowspan="1" colSpan="1" >[setMusicScratchSpeedRate](https://write.woa.com/document/87030074293530624)</td>
181
-
182
- <td rowspan="1" colSpan="1" >调整搓碟的变速效果。</td>
183
- </tr>
184
-
185
- <tr>
186
- <td rowspan="1" colSpan="1" >[setPreloadObserver](https://write.woa.com/document/87030074293530624)</td>
187
-
188
- <td rowspan="1" colSpan="1" >设置预加载事件回调。</td>
189
- </tr>
190
-
191
- <tr>
192
- <td rowspan="1" colSpan="1" >[preloadMusic](https://write.woa.com/document/87030074293530624)</td>
193
-
194
- <td rowspan="1" colSpan="1" >预加载背景音乐。</td>
195
- </tr>
196
-
197
- <tr>
198
- <td rowspan="1" colSpan="1" >[getMusicTrackCount](https://write.woa.com/document/87030074293530624)</td>
199
-
200
- <td rowspan="1" colSpan="1" >获取背景音乐的音轨数量。</td>
201
- </tr>
202
-
203
- <tr>
204
- <td rowspan="1" colSpan="1" >[setMusicTrack](https://write.woa.com/document/87030074293530624)</td>
205
-
206
- <td rowspan="1" colSpan="1" >指定背景音乐的播放音轨。</td>
207
- </tr>
208
- </table>
209
-
20
+ | 函数列表 | 描述 |
21
+ | --- | --- |
22
+ | enableVoiceEarMonitor | 开启耳返。 |
23
+ | setVoiceEarMonitorVolume | 设置耳返音量。 |
24
+ | setVoiceReverbType | 设置人声的混响效果。 |
25
+ | setVoiceChangerType | 设置人声的变声特效。 |
26
+ | setVoiceCaptureVolume | 设置语音音量。 |
27
+ | setVoicePitch | 设置语音音调。 |
28
+ | setMusicObserver | 设置背景音乐的事件回调接口。 |
29
+ | startPlayMusic | 开始播放背景音乐。 |
30
+ | stopPlayMusic | 停止播放背景音乐。 |
31
+ | pausePlayMusic | 暂停播放背景音乐。 |
32
+ | resumePlayMusic | 恢复播放背景音乐。 |
33
+ | setAllMusicVolume | 设置所有背景音乐的本地音量和远端音量的大小。 |
34
+ | setMusicPublishVolume | 设置某一首背景音乐的远端音量的大小。 |
35
+ | setMusicPlayoutVolume | 设置某一首背景音乐的本地音量的大小。 |
36
+ | setMusicPitch | 调整背景音乐的音调高低。 |
37
+ | setMusicSpeedRate | 调整背景音乐的变速效果。 |
38
+ | getMusicCurrentPosInMS | 获取背景音乐的播放进度(单位:毫秒)。 |
39
+ | getMusicDurationInMS | 获取背景音乐的总时长(单位:毫秒)。 |
40
+ | seekMusicToPosInTime | 设置背景音乐的播放进度(单位:毫秒)。 |
41
+ | setMusicScratchSpeedRate | 调整搓碟的变速效果。 |
42
+ | setPreloadObserver | 设置预加载事件回调。 |
43
+ | preloadMusic | 预加载背景音乐。 |
44
+ | getMusicTrackCount | 获取背景音乐的音轨数量。 |
45
+ | setMusicTrack | 指定背景音乐的播放音轨。 |
210
46
 
211
47
  ## 结构体类型
212
- <table>
213
- <tr>
214
- <td rowspan="1" colSpan="1" >函数列表</td>
215
-
216
- <td rowspan="1" colSpan="1" >描述</td>
217
- </tr>
218
-
219
- <tr>
220
- <td rowspan="1" colSpan="1" >[AudioMusicParam](https://write.woa.com/document/87030074293530624)</td>
221
-
222
- <td rowspan="1" colSpan="1" >背景音乐的播放控制信息</td>
223
- </tr>
224
- </table>
225
-
48
+ | 函数列表 | 描述 |
49
+ | --- | --- |
50
+ | AudioMusicParam | 背景音乐的播放控制信息 |
226
51
 
227
52
  ## 枚举类型
228
- <table>
229
- <tr>
230
- <td rowspan="1" colSpan="1" >枚举类型</td>
231
-
232
- <td rowspan="1" colSpan="1" >描述</td>
233
- </tr>
234
-
235
- <tr>
236
- <td rowspan="1" colSpan="1" >[TXVoiceReverbType](https://write.woa.com/document/87030074293530624)</td>
237
-
238
- <td rowspan="1" colSpan="1" >混响特效</td>
239
- </tr>
240
-
241
- <tr>
242
- <td rowspan="1" colSpan="1" >[TXVoiceChangerType](https://write.woa.com/document/87030074293530624)</td>
243
-
244
- <td rowspan="1" colSpan="1" >变声特效</td>
245
- </tr>
246
- </table>
247
-
53
+ | 枚举类型 | 描述 |
54
+ | --- | --- |
55
+ | TXVoiceReverbType | 混响特效 |
56
+ | TXVoiceChangerType | 变声特效 |
248
57
 
249
58
  ## onLoadProgress
250
59
 
251
-
252
-
253
60
  #### 背景音乐预加载进度
254
61
 
255
62
  ## onLoadError
256
63
 
257
-
258
-
259
64
  #### 背景音乐预加载出错
260
- <table>
261
- <tr>
262
- <td rowspan="1" colSpan="1" >参数</td>
263
-
264
- <td rowspan="1" colSpan="1" >描述</td>
265
- </tr>
266
-
267
- <tr>
268
- <td rowspan="1" colSpan="1" >errorCode</td>
269
-
270
- <td rowspan="1" colSpan="1" >-4001:打开文件失败,如音频数据无效,FFMPEG 协议未找到等;-4002:解码失败,如音频文件损坏,网络音频文件服务器无法访问等;-4003:预加载数量超上限,请先调用 stopPlayMusic 释放无用的预加载;-4005:非法路径导致打开文件失败,请检查您传入的路径参数是否指向一个合法的音乐文件;-4006:非法URL导致打开文件失败,请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件;-4007:无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏;-4008:格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3,aac,m4a,wav,ogg,mp4,mkv】,桌面端支持 【mp3,aac,m4a,wav,mp4,mkv】。</td>
271
- </tr>
272
- </table>
273
-
65
+ | 参数 | 描述 |
66
+ | --- | --- |
67
+ | errorCode | -4001:打开文件失败,如音频数据无效,FFMPEG 协议未找到等;-4002:解码失败,如音频文件损坏,网络音频文件服务器无法访问等;-4003:预加载数量超上限,请先调用 stopPlayMusic 释放无用的预加载;-4005:非法路径导致打开文件失败,请检查您传入的路径参数是否指向一个合法的音乐文件;-4006:非法URL导致打开文件失败,请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件;-4007:无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏;-4008:格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3,aac,m4a,wav,ogg,mp4,mkv】,桌面端支持 【mp3,aac,m4a,wav,mp4,mkv】。 |
274
68
 
275
69
  ## onStart
276
70
 
277
-
278
-
279
71
  #### 背景音乐开始播放
280
72
 
281
73
  在背景音乐开始播放成功或者失败时调用。
282
- <table>
283
- <tr>
284
- <td rowspan="1" colSpan="1" >参数</td>
285
-
286
- <td rowspan="1" colSpan="1" >描述</td>
287
- </tr>
288
-
289
- <tr>
290
- <td rowspan="1" colSpan="1" >errCode</td>
291
-
292
- <td rowspan="1" colSpan="1" >错误码。0: 开始播放成功;-4001:打开文件失败,如音频数据无效,FFMPEG 协议未找到等;-4005:非法路径导致打开文件失败,请检查您传入的路径参数是否指向一个合法的音乐文件;-4006:非法URL导致打开文件失败,请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件,如果操作系统为 iOS 或 MacOS 请确保使用 https 链接;-4007:无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏;-4008:格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3,aac,m4a,wav,ogg,mp4,mkv】,桌面端支持 【mp3,aac,m4a,wav,mp4,mkv】;-4009:同时播放 bgm 数量超过限定值,如当前同时播放 bgm 数量超过 10 后提示该错误,请检查并发播放 bgm 数量。</td>
293
- </tr>
294
-
295
- <tr>
296
- <td rowspan="1" colSpan="1" >id</td>
297
-
298
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
299
- </tr>
300
- </table>
301
-
74
+ | 参数 | 描述 |
75
+ | --- | --- |
76
+ | errCode | 错误码。0: 开始播放成功;-4001:打开文件失败,如音频数据无效,FFMPEG 协议未找到等;-4005:非法路径导致打开文件失败,请检查您传入的路径参数是否指向一个合法的音乐文件;-4006:非法URL导致打开文件失败,请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件,如果操作系统为 iOS 或 MacOS 请确保使用 https 链接;-4007:无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏;-4008:格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3,aac,m4a,wav,ogg,mp4,mkv】,桌面端支持 【mp3,aac,m4a,wav,mp4,mkv】;-4009:同时播放 bgm 数量超过限定值,如当前同时播放 bgm 数量超过 10 后提示该错误,请检查并发播放 bgm 数量。 |
77
+ | id | 音乐 ID。 |
302
78
 
303
79
  ## onPlayProgress
304
80
 
305
-
306
-
307
81
  #### 背景音乐的播放进度
308
82
 
309
83
  ## onComplete
310
84
 
311
-
312
-
313
85
  #### 背景音乐已经播放完毕
314
86
 
315
87
  在背景音乐播放完毕或播放错误时调用。
316
- <table>
317
- <tr>
318
- <td rowspan="1" colSpan="1" >参数</td>
319
-
320
- <td rowspan="1" colSpan="1" >描述</td>
321
- </tr>
322
-
323
- <tr>
324
- <td rowspan="1" colSpan="1" >errCode</td>
325
-
326
- <td rowspan="1" colSpan="1" >错误码。0: 播放结束;-4002: 解码失败,如音频文件损坏,网络音频文件服务器无法访问等。</td>
327
- </tr>
328
-
329
- <tr>
330
- <td rowspan="1" colSpan="1" >id</td>
331
-
332
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
333
- </tr>
334
- </table>
335
-
88
+ | 参数 | 描述 |
89
+ | --- | --- |
90
+ | errCode | 错误码。0: 播放结束;-4002: 解码失败,如音频文件损坏,网络音频文件服务器无法访问等。 |
91
+ | id | 音乐 ID。 |
336
92
 
337
93
  ## enableVoiceEarMonitor
338
94
 
339
-
340
-
341
95
  #### 开启耳返。
342
96
 
343
97
  主播开启耳返后,可以在耳机里听到麦克风采集到的自己发出的声音,该特效适用于主播唱歌的应用场景中。
344
98
 
345
-
346
-
347
99
  需要您注意的是,由于蓝牙耳机的硬件延迟非常高,所以在主播佩戴蓝牙耳机时无法开启此特效,请尽量在用户界面上提示主播佩戴有线耳机。
348
100
 
349
101
  同时也需要注意,并非所有的手机开启此特效后都能达到优秀的耳返效果,我们已经对部分耳返效果不佳的手机屏蔽了该特效。
350
- <table>
351
- <tr>
352
- <td rowspan="1" colSpan="1" >参数</td>
353
-
354
- <td rowspan="1" colSpan="1" >描述</td>
355
- </tr>
356
-
357
- <tr>
358
- <td rowspan="1" colSpan="1" >enable</td>
359
-
360
- <td rowspan="1" colSpan="1" >true:开启;false:关闭。</td>
361
- </tr>
362
- </table>
363
-
102
+ | 参数 | 描述 |
103
+ | --- | --- |
104
+ | enable | true:开启;false:关闭。 |
364
105
 
365
106
  > **注意**
366
- >
107
+ >
367
108
 
368
109
  > 仅在主播佩戴耳机时才能开启此特效,同时请您提示主播佩戴有线耳机。
369
- >
370
-
110
+ >
371
111
 
372
112
  ## setVoiceEarMonitorVolume
373
113
 
374
-
375
-
376
114
  #### 设置耳返音量。
377
115
 
378
116
  通过该接口您可以设置耳返特效中声音的音量大小。
379
- <table>
380
- <tr>
381
- <td rowspan="1" colSpan="1" >参数</td>
382
-
383
- <td rowspan="1" colSpan="1" >描述</td>
384
- </tr>
385
-
386
- <tr>
387
- <td rowspan="1" colSpan="1" >volume</td>
388
-
389
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:100。</td>
390
- </tr>
391
- </table>
392
-
117
+ | 参数 | 描述 |
118
+ | --- | --- |
119
+ | volume | 音量大小,取值范围为 [0, 150],默认值:100。 |
393
120
 
394
121
  > **注意**
395
- >
122
+ >
396
123
 
397
124
  > 耳返的音量大小是影响用户耳返体验的重要因素之一,考虑到不同用户对音量的敏感度不同,强烈建议您在 UI 界面上开放耳返音量的调节滑杆,调节范围建议在 0~150 之间,其中 100~150 的增益效果对于部分采集音量较小的 Android 手机很有帮助。
398
- >
399
-
125
+ >
400
126
 
401
127
  ## setVoiceReverbType
402
128
 
403
-
404
-
405
129
  #### 设置人声的混响效果。
406
130
 
407
- 通过该接口您可以设置人声的混响效果,具体特效请参见枚举定义 [TXVoiceReverbType](https://write.woa.com/document/87030074293530624)。
131
+ 通过该接口您可以设置人声的混响效果,具体特效请参见枚举定义 TXVoiceReverbType。
408
132
 
409
133
  > **注意**
410
- >
134
+ >
411
135
 
412
136
  > 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
413
- >
414
-
137
+ >
415
138
 
416
139
  ## setVoiceChangerType
417
140
 
418
-
419
-
420
141
  #### 设置人声的变声特效。
421
142
 
422
- 通过该接口您可以设置人声的变声特效,具体特效请参见枚举定义 [TXVoiceChangeType](https://write.woa.com/document/87030074293530624)。
143
+ 通过该接口您可以设置人声的变声特效,具体特效请参见枚举定义 TXVoiceChangeType。
423
144
 
424
145
  > **注意**
425
- >
146
+ >
426
147
 
427
148
  > 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
428
- >
429
-
149
+ >
430
150
 
431
151
  ## setVoiceCaptureVolume
432
152
 
433
-
434
-
435
153
  #### 设置语音音量。
436
154
 
437
- 该接口可以设置语音音量的大小,一般配合音乐音量的设置接口 [setAllMusicVolume](https://write.woa.com/document/87030074293530624) 协同使用,用于调谐语音和音乐在混音前各自的音量占比。
438
- <table>
439
- <tr>
440
- <td rowspan="1" colSpan="1" >参数</td>
441
-
442
- <td rowspan="1" colSpan="1" >描述</td>
443
- </tr>
444
-
445
- <tr>
446
- <td rowspan="1" colSpan="1" >volume</td>
447
-
448
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0 - 150],默认值:100。</td>
449
- </tr>
450
- </table>
451
-
155
+ 该接口可以设置语音音量的大小,一般配合音乐音量的设置接口 setAllMusicVolume 协同使用,用于调谐语音和音乐在混音前各自的音量占比。
156
+ | 参数 | 描述 |
157
+ | --- | --- |
158
+ | volume | 音量大小,取值范围为 [0 - 150],默认值:100。 |
452
159
 
453
160
  > **注意**
454
- >
161
+ >
455
162
 
456
163
  > 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
457
- >
458
-
164
+ >
459
165
 
460
166
  ## setVoicePitch
461
167
 
462
-
463
-
464
168
  #### 设置语音音调。
465
169
 
466
170
  该接口可以设置语音音调,用于实现变调不变速的目的。
467
- <table>
468
- <tr>
469
- <td rowspan="1" colSpan="1" >参数</td>
470
-
471
- <td rowspan="1" colSpan="1" >描述</td>
472
- </tr>
473
-
474
- <tr>
475
- <td rowspan="1" colSpan="1" >pitch</td>
476
-
477
- <td rowspan="1" colSpan="1" >音调,取值范围[-1.0f, 1.0f],默认值:0.0f。</td>
478
- </tr>
479
- </table>
480
-
171
+ | 参数 | 描述 |
172
+ | --- | --- |
173
+ | pitch | 音调,取值范围[-1.0f, 1.0f],默认值:0.0f。 |
481
174
 
482
175
  ## setMusicObserver
483
176
 
484
-
485
-
486
177
  #### 设置背景音乐的事件回调接口。
487
178
 
488
179
  请在播放背景音乐之前使用该接口设置播放事件回调,以便感知背景音乐的播放进度。
489
- <table>
490
- <tr>
491
- <td rowspan="1" colSpan="1" >参数</td>
492
-
493
- <td rowspan="1" colSpan="1" >描述</td>
494
- </tr>
495
-
496
- <tr>
497
- <td rowspan="1" colSpan="1" >musicId</td>
498
-
499
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
500
- </tr>
501
-
502
- <tr>
503
- <td rowspan="1" colSpan="1" >observer</td>
504
-
505
- <td rowspan="1" colSpan="1" >具体参考 TXMusicPlayObserver 中定义接口。</td>
506
- </tr>
507
- </table>
508
-
180
+ | 参数 | 描述 |
181
+ | --- | --- |
182
+ | musicId | 音乐 ID。 |
183
+ | observer | 具体参考 TXMusicPlayObserver 中定义接口。 |
509
184
 
510
185
  > **注意**
511
- >
186
+ >
512
187
 
513
188
  > 1. 如果该 ID 不需要使用,observer 可设置为 NULL 彻底释放。
514
- >
515
-
189
+ >
516
190
 
517
191
  ## startPlayMusic
518
192
 
519
-
520
-
521
193
  #### 开始播放背景音乐。
522
194
 
523
195
  每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
524
- <table>
525
- <tr>
526
- <td rowspan="1" colSpan="1" >参数</td>
527
-
528
- <td rowspan="1" colSpan="1" >描述</td>
529
- </tr>
530
-
531
- <tr>
532
- <td rowspan="1" colSpan="1" >musicParam</td>
533
-
534
- <td rowspan="1" colSpan="1" >音乐参数。</td>
535
- </tr>
536
- </table>
537
-
196
+ | 参数 | 描述 |
197
+ | --- | --- |
198
+ | musicParam | 音乐参数。 |
538
199
 
539
200
  > **注意**
540
- >
201
+ >
541
202
 
542
203
  > 1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
543
- >
204
+ >
544
205
 
545
206
  > 2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
546
- >
207
+ >
547
208
 
548
209
  > 3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
549
- >
550
-
210
+ >
551
211
 
552
212
  ## stopPlayMusic
553
213
 
554
-
555
-
556
214
  #### 停止播放背景音乐。
557
- <table>
558
- <tr>
559
- <td rowspan="1" colSpan="1" >参数</td>
560
-
561
- <td rowspan="1" colSpan="1" >描述</td>
562
- </tr>
563
-
564
- <tr>
565
- <td rowspan="1" colSpan="1" >id</td>
566
-
567
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
568
- </tr>
569
- </table>
570
-
215
+ | 参数 | 描述 |
216
+ | --- | --- |
217
+ | id | 音乐 ID。 |
571
218
 
572
219
  ## pausePlayMusic
573
220
 
574
-
575
-
576
221
  #### 暂停播放背景音乐。
577
- <table>
578
- <tr>
579
- <td rowspan="1" colSpan="1" >参数</td>
580
-
581
- <td rowspan="1" colSpan="1" >描述</td>
582
- </tr>
583
-
584
- <tr>
585
- <td rowspan="1" colSpan="1" >id</td>
586
-
587
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
588
- </tr>
589
- </table>
590
-
222
+ | 参数 | 描述 |
223
+ | --- | --- |
224
+ | id | 音乐 ID。 |
591
225
 
592
226
  ## resumePlayMusic
593
227
 
594
-
595
-
596
228
  #### 恢复播放背景音乐。
597
- <table>
598
- <tr>
599
- <td rowspan="1" colSpan="1" >参数</td>
600
-
601
- <td rowspan="1" colSpan="1" >描述</td>
602
- </tr>
603
-
604
- <tr>
605
- <td rowspan="1" colSpan="1" >id</td>
606
-
607
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
608
- </tr>
609
- </table>
610
-
229
+ | 参数 | 描述 |
230
+ | --- | --- |
231
+ | id | 音乐 ID。 |
611
232
 
612
233
  ## setAllMusicVolume
613
234
 
614
-
615
-
616
235
  #### 设置所有背景音乐的本地音量和远端音量的大小。
617
236
 
618
237
  该接口可以设置所有背景音乐的本地音量和远端音量。
@@ -620,169 +239,70 @@
620
239
 
621
240
  - 远端音量:即观众端可以听到的背景音乐的音量大小。
622
241
 
623
- <table>
624
- <tr>
625
- <td rowspan="1" colSpan="1" >参数</td>
626
-
627
- <td rowspan="1" colSpan="1" >描述</td>
628
- </tr>
629
-
630
- <tr>
631
- <td rowspan="1" colSpan="1" >volume</td>
632
-
633
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:60。</td>
634
- </tr>
635
- </table>
636
-
242
+ | 参数 | 描述 |
243
+ | --- | --- |
244
+ | volume | 音量大小,取值范围为 [0, 150],默认值:60。 |
637
245
 
638
246
  > **注意**
639
- >
247
+ >
640
248
 
641
249
  > 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
642
- >
643
-
250
+ >
644
251
 
645
252
  ## setMusicPublishVolume
646
253
 
647
-
648
-
649
254
  #### 设置某一首背景音乐的远端音量的大小。
650
255
 
651
256
  该接口可以细粒度地控制每一首背景音乐的远端音量,也就是观众端可听到的背景音乐的音量大小。
652
- <table>
653
- <tr>
654
- <td rowspan="1" colSpan="1" >参数</td>
655
-
656
- <td rowspan="1" colSpan="1" >描述</td>
657
- </tr>
658
-
659
- <tr>
660
- <td rowspan="1" colSpan="1" >id</td>
661
-
662
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
663
- </tr>
664
-
665
- <tr>
666
- <td rowspan="1" colSpan="1" >volume</td>
667
-
668
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150];默认值:60。</td>
669
- </tr>
670
- </table>
671
-
257
+ | 参数 | 描述 |
258
+ | --- | --- |
259
+ | id | 音乐 ID。 |
260
+ | volume | 音量大小,取值范围为 [0, 150];默认值:60。 |
672
261
 
673
262
  > **注意**
674
- >
263
+ >
675
264
 
676
265
  > 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
677
- >
678
-
266
+ >
679
267
 
680
268
  ## setMusicPlayoutVolume
681
269
 
682
-
683
-
684
270
  #### 设置某一首背景音乐的本地音量的大小。
685
271
 
686
272
  该接口可以细粒度地控制每一首背景音乐的本地音量,也就是主播本地可以听到的背景音乐的音量大小。
687
- <table>
688
- <tr>
689
- <td rowspan="1" colSpan="1" >参数</td>
690
-
691
- <td rowspan="1" colSpan="1" >描述</td>
692
- </tr>
693
-
694
- <tr>
695
- <td rowspan="1" colSpan="1" >id</td>
696
-
697
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
698
- </tr>
699
-
700
- <tr>
701
- <td rowspan="1" colSpan="1" >volume</td>
702
-
703
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:60。</td>
704
- </tr>
705
- </table>
706
-
273
+ | 参数 | 描述 |
274
+ | --- | --- |
275
+ | id | 音乐 ID。 |
276
+ | volume | 音量大小,取值范围为 [0, 150],默认值:60。 |
707
277
 
708
278
  > **注意**
709
- >
279
+ >
710
280
 
711
281
  > 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
712
- >
713
-
282
+ >
714
283
 
715
284
  ## setMusicPitch
716
285
 
717
-
718
-
719
286
  #### 调整背景音乐的音调高低。
720
- <table>
721
- <tr>
722
- <td rowspan="1" colSpan="1" >参数</td>
723
-
724
- <td rowspan="1" colSpan="1" >描述</td>
725
- </tr>
726
-
727
- <tr>
728
- <td rowspan="1" colSpan="1" >id</td>
729
-
730
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
731
- </tr>
732
-
733
- <tr>
734
- <td rowspan="1" colSpan="1" >pitch</td>
735
-
736
- <td rowspan="1" colSpan="1" >音调,取值范围为 [-1.0f, 1.0f] 之间的浮点数,默认值:0.0f。</td>
737
- </tr>
738
- </table>
739
-
287
+ | 参数 | 描述 |
288
+ | --- | --- |
289
+ | id | 音乐 ID。 |
290
+ | pitch | 音调,取值范围为 [-1.0f, 1.0f] 之间的浮点数,默认值:0.0f。 |
740
291
 
741
292
  ## setMusicSpeedRate
742
293
 
743
-
744
-
745
294
  #### 调整背景音乐的变速效果。
746
- <table>
747
- <tr>
748
- <td rowspan="1" colSpan="1" >参数</td>
749
-
750
- <td rowspan="1" colSpan="1" >描述</td>
751
- </tr>
752
-
753
- <tr>
754
- <td rowspan="1" colSpan="1" >id</td>
755
-
756
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
757
- </tr>
758
-
759
- <tr>
760
- <td rowspan="1" colSpan="1" >speedRate</td>
761
-
762
- <td rowspan="1" colSpan="1" >速度,取值范围为 [0.5f, 2.0f] 之间的浮点数,默认值:1.0f。</td>
763
- </tr>
764
- </table>
765
-
295
+ | 参数 | 描述 |
296
+ | --- | --- |
297
+ | id | 音乐 ID。 |
298
+ | speedRate | 速度,取值范围为 [0.5f, 2.0f] 之间的浮点数,默认值:1.0f。 |
766
299
 
767
300
  ## getMusicCurrentPosInMS
768
301
 
769
-
770
-
771
302
  #### 获取背景音乐的播放进度(单位:毫秒)。
772
- <table>
773
- <tr>
774
- <td rowspan="1" colSpan="1" >参数</td>
775
-
776
- <td rowspan="1" colSpan="1" >描述</td>
777
- </tr>
778
-
779
- <tr>
780
- <td rowspan="1" colSpan="1" >id</td>
781
-
782
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
783
- </tr>
784
- </table>
785
-
303
+ | 参数 | 描述 |
304
+ | --- | --- |
305
+ | id | 音乐 ID。 |
786
306
 
787
307
  #### 返回值说明:
788
308
 
@@ -790,23 +310,10 @@
790
310
 
791
311
  ## getMusicDurationInMS
792
312
 
793
-
794
-
795
313
  #### 获取背景音乐的总时长(单位:毫秒)。
796
- <table>
797
- <tr>
798
- <td rowspan="1" colSpan="1" >参数</td>
799
-
800
- <td rowspan="1" colSpan="1" >描述</td>
801
- </tr>
802
-
803
- <tr>
804
- <td rowspan="1" colSpan="1" >path</td>
805
-
806
- <td rowspan="1" colSpan="1" >音乐文件路径。</td>
807
- </tr>
808
- </table>
809
-
314
+ | 参数 | 描述 |
315
+ | --- | --- |
316
+ | path | 音乐文件路径。 |
810
317
 
811
318
  #### 返回值说明:
812
319
 
@@ -814,493 +321,152 @@
814
321
 
815
322
  ## seekMusicToPosInTime
816
323
 
817
-
818
-
819
324
  #### 设置背景音乐的播放进度(单位:毫秒)。
820
- <table>
821
- <tr>
822
- <td rowspan="1" colSpan="1" >参数</td>
823
-
824
- <td rowspan="1" colSpan="1" >描述</td>
825
- </tr>
826
-
827
- <tr>
828
- <td rowspan="1" colSpan="1" >id</td>
829
-
830
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
831
- </tr>
832
-
833
- <tr>
834
- <td rowspan="1" colSpan="1" >pts</td>
835
-
836
- <td rowspan="1" colSpan="1" >单位: 毫秒。</td>
837
- </tr>
838
- </table>
839
-
325
+ | 参数 | 描述 |
326
+ | --- | --- |
327
+ | id | 音乐 ID。 |
328
+ | pts | 单位: 毫秒。 |
840
329
 
841
330
  > **注意**
842
- >
331
+ >
843
332
 
844
333
  > 请尽量避免过度频繁地调用该接口,因为该接口可能会再次读写音乐文件,耗时稍高。
845
- >
334
+ >
846
335
 
847
336
  > 因此,当用户拖拽音乐的播放进度条时,请在用户完成拖拽操作后再调用本接口。
848
- >
337
+ >
849
338
 
850
339
  > 因为 UI 上的进度条控件往往会以很高的频率反馈用户的拖拽进度,如不做频率限制,会导致较差的用户体验。
851
- >
852
-
340
+ >
853
341
 
854
342
  ## setMusicScratchSpeedRate
855
343
 
856
-
857
-
858
344
  #### 调整搓碟的变速效果。
859
- <table>
860
- <tr>
861
- <td rowspan="1" colSpan="1" >参数</td>
862
-
863
- <td rowspan="1" colSpan="1" >描述</td>
864
- </tr>
865
-
866
- <tr>
867
- <td rowspan="1" colSpan="1" >id</td>
868
-
869
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
870
- </tr>
871
-
872
- <tr>
873
- <td rowspan="1" colSpan="1" >scratchSpeedRate</td>
874
-
875
- <td rowspan="1" colSpan="1" >搓碟速度,取值范围为 [-12.0, 12.0] 之间的浮点数,默认值是 1.0f,速度值正/负表示方向正/反,绝对值大小表示速度快慢。</td>
876
- </tr>
877
- </table>
878
-
345
+ | 参数 | 描述 |
346
+ | --- | --- |
347
+ | id | 音乐 ID。 |
348
+ | scratchSpeedRate | 搓碟速度,取值范围为 [-12.0, 12.0] 之间的浮点数,默认值是 1.0f,速度值正/负表示方向正/反,绝对值大小表示速度快慢。 |
879
349
 
880
350
  > **注意**
881
- >
351
+ >
882
352
 
883
353
  > 前置条件 preloadMusic 成功。
884
- >
885
-
354
+ >
886
355
 
887
356
  ## setPreloadObserver
888
357
 
889
-
890
-
891
358
  #### 设置预加载事件回调。
892
359
 
893
360
  请在预加载背景音乐之前使用该接口设置回调,以便感知背景音乐的预加载进度。
894
- <table>
895
- <tr>
896
- <td rowspan="1" colSpan="1" >参数</td>
897
-
898
- <td rowspan="1" colSpan="1" >描述</td>
899
- </tr>
900
-
901
- <tr>
902
- <td rowspan="1" colSpan="1" >observer</td>
903
-
904
- <td rowspan="1" colSpan="1" >具体参考 TXMusicPreloadObserver 中定义接口。</td>
905
- </tr>
906
- </table>
907
-
361
+ | 参数 | 描述 |
362
+ | --- | --- |
363
+ | observer | 具体参考 TXMusicPreloadObserver 中定义接口。 |
908
364
 
909
365
  ## preloadMusic
910
366
 
911
-
912
-
913
367
  #### 预加载背景音乐。
914
368
 
915
369
  每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
916
- <table>
917
- <tr>
918
- <td rowspan="1" colSpan="1" >参数</td>
919
-
920
- <td rowspan="1" colSpan="1" >描述</td>
921
- </tr>
922
-
923
- <tr>
924
- <td rowspan="1" colSpan="1" >preloadParam</td>
925
-
926
- <td rowspan="1" colSpan="1" >预加载音乐参数。</td>
927
- </tr>
928
- </table>
929
-
370
+ | 参数 | 描述 |
371
+ | --- | --- |
372
+ | preloadParam | 预加载音乐参数。 |
930
373
 
931
374
  > **注意**
932
- >
933
-
934
- > 1. 预先加载最多同时支持2个不同 ID 的预加载,且预加载时长不超过10分钟,使用完需调用 [stopPlayMusic](https://write.woa.com/document/87030074293530624),否则内存不释放。
935
- >
375
+ >
936
376
 
937
- > 2. 若该ID对应的音乐正在播放中,预加载会失败,需先调用 [stopPlayMusic](https://write.woa.com/document/87030074293530624)。
938
- >
377
+ > 1. 预先加载最多同时支持2个不同 ID 的预加载,且预加载时长不超过10分钟,使用完需调用 stopPlayMusic,否则内存不释放。
378
+ >
939
379
 
940
- > 3. 当 ` musicParam ` 和传入 [startPlayMusic](https://write.woa.com/document/87030074293530624) 的 ` musicParam ` 完全相同时,预加载有效。
941
- >
380
+ > 2. 若该ID对应的音乐正在播放中,预加载会失败,需先调用 stopPlayMusic。
381
+ >
942
382
 
383
+ > 3. 当 ` musicParam ` 和传入 startPlayMusic 的 ` musicParam ` 完全相同时,预加载有效。
384
+ >
943
385
 
944
386
  ## getMusicTrackCount
945
387
 
946
-
947
-
948
388
  #### 获取背景音乐的音轨数量。
949
- <table>
950
- <tr>
951
- <td rowspan="1" colSpan="1" >参数</td>
952
-
953
- <td rowspan="1" colSpan="1" >描述</td>
954
- </tr>
955
-
956
- <tr>
957
- <td rowspan="1" colSpan="1" >id</td>
958
-
959
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
960
- </tr>
961
- </table>
962
-
389
+ | 参数 | 描述 |
390
+ | --- | --- |
391
+ | id | 音乐 ID。 |
963
392
 
964
393
  ## setMusicTrack
965
394
 
966
-
967
-
968
395
  #### 指定背景音乐的播放音轨。
969
- <table>
970
- <tr>
971
- <td rowspan="1" colSpan="1" >参数</td>
972
-
973
- <td rowspan="1" colSpan="1" >描述</td>
974
- </tr>
975
-
976
- <tr>
977
- <td rowspan="1" colSpan="1" >id</td>
978
-
979
- <td rowspan="1" colSpan="1" >音乐 ID。</td>
980
- </tr>
981
-
982
- <tr>
983
- <td rowspan="1" colSpan="1" >index</td>
984
-
985
- <td rowspan="1" colSpan="1" >默认播放第一个音轨。取值范围[0, 音轨总数)。</td>
986
- </tr>
987
- </table>
988
-
396
+ | 参数 | 描述 |
397
+ | --- | --- |
398
+ | id | 音乐 ID。 |
399
+ | index | 默认播放第一个音轨。取值范围0, 音轨总数)。 |
989
400
 
990
401
  > **注意**
991
- >
402
+ >
992
403
 
993
404
  > 音轨总数量可通过 getMusicTrackCount 接口获取。
994
- >
995
-
405
+ >
996
406
 
997
407
  ## TXVoiceReverbType
998
408
 
999
-
1000
-
1001
409
  #### 混响特效
1002
410
 
1003
411
  混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果:
1004
412
 
1005
413
  0:关闭;1:KTV;2:小房间;3:大会堂;4:低沉;5:洪亮;6:金属声;7:磁性;8:空灵;9:录音棚;10:悠扬 11:录音棚2。
1006
- <table>
1007
- <tr>
1008
- <td rowspan="1" colSpan="1" >枚举</td>
1009
-
1010
- <td rowspan="1" colSpan="1" >取值</td>
1011
-
1012
- <td rowspan="1" colSpan="1" >描述</td>
1013
- </tr>
1014
-
1015
- <tr>
1016
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_0</td>
1017
-
1018
- <td rowspan="1" colSpan="1" >0</td>
1019
-
1020
- <td rowspan="1" colSpan="1" >关闭特效</td>
1021
- </tr>
1022
-
1023
- <tr>
1024
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_1</td>
1025
-
1026
- <td rowspan="1" colSpan="1" >1</td>
1027
-
1028
- <td rowspan="1" colSpan="1" >KTV</td>
1029
- </tr>
1030
-
1031
- <tr>
1032
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_2</td>
1033
-
1034
- <td rowspan="1" colSpan="1" >2</td>
1035
-
1036
- <td rowspan="1" colSpan="1" >小房间</td>
1037
- </tr>
1038
-
1039
- <tr>
1040
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_3</td>
1041
-
1042
- <td rowspan="1" colSpan="1" >3</td>
1043
-
1044
- <td rowspan="1" colSpan="1" >大会堂</td>
1045
- </tr>
1046
-
1047
- <tr>
1048
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_4</td>
1049
-
1050
- <td rowspan="1" colSpan="1" >4</td>
1051
-
1052
- <td rowspan="1" colSpan="1" >低沉</td>
1053
- </tr>
1054
-
1055
- <tr>
1056
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_5</td>
1057
-
1058
- <td rowspan="1" colSpan="1" >5</td>
1059
-
1060
- <td rowspan="1" colSpan="1" >洪亮</td>
1061
- </tr>
1062
-
1063
- <tr>
1064
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_6</td>
1065
-
1066
- <td rowspan="1" colSpan="1" >6</td>
1067
-
1068
- <td rowspan="1" colSpan="1" >金属声</td>
1069
- </tr>
1070
-
1071
- <tr>
1072
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_7</td>
1073
-
1074
- <td rowspan="1" colSpan="1" >7</td>
1075
-
1076
- <td rowspan="1" colSpan="1" >磁性</td>
1077
- </tr>
1078
-
1079
- <tr>
1080
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_8</td>
1081
-
1082
- <td rowspan="1" colSpan="1" >8</td>
1083
-
1084
- <td rowspan="1" colSpan="1" >空灵</td>
1085
- </tr>
1086
-
1087
- <tr>
1088
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_9</td>
1089
-
1090
- <td rowspan="1" colSpan="1" >9</td>
1091
-
1092
- <td rowspan="1" colSpan="1" >录音棚</td>
1093
- </tr>
1094
-
1095
- <tr>
1096
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_10</td>
1097
-
1098
- <td rowspan="1" colSpan="1" >10</td>
1099
-
1100
- <td rowspan="1" colSpan="1" >悠扬</td>
1101
- </tr>
1102
-
1103
- <tr>
1104
- <td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_11</td>
1105
-
1106
- <td rowspan="1" colSpan="1" >11</td>
1107
-
1108
- <td rowspan="1" colSpan="1" >录音棚2</td>
1109
- </tr>
1110
- </table>
1111
-
414
+ | 枚举 | 取值 | 描述 |
415
+ | --- | --- | --- |
416
+ | TXLiveVoiceReverbType_0 | 0 | 关闭特效 |
417
+ | TXLiveVoiceReverbType_1 | 1 | KTV |
418
+ | TXLiveVoiceReverbType_2 | 2 | 小房间 |
419
+ | TXLiveVoiceReverbType_3 | 3 | 大会堂 |
420
+ | TXLiveVoiceReverbType_4 | 4 | 低沉 |
421
+ | TXLiveVoiceReverbType_5 | 5 | 洪亮 |
422
+ | TXLiveVoiceReverbType_6 | 6 | 金属声 |
423
+ | TXLiveVoiceReverbType_7 | 7 | 磁性 |
424
+ | TXLiveVoiceReverbType_8 | 8 | 空灵 |
425
+ | TXLiveVoiceReverbType_9 | 9 | 录音棚 |
426
+ | TXLiveVoiceReverbType_10 | 10 | 悠扬 |
427
+ | TXLiveVoiceReverbType_11 | 11 | 录音棚2 |
1112
428
 
1113
429
  ## TXVoiceChangeType
1114
430
 
1115
-
1116
-
1117
431
  #### 变声特效
1118
432
 
1119
433
  变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色,目前支持如下几种变声特效:
1120
434
 
1121
435
  0:关闭;1:熊孩子;2:萝莉;3:大叔;4:重金属;5:感冒;6:外语腔;7:困兽;8:肥宅;9:强电流;10:重机械;11:空灵;12:猪八戒;13:绿巨人。
1122
- <table>
1123
- <tr>
1124
- <td rowspan="1" colSpan="1" >枚举</td>
1125
-
1126
- <td rowspan="1" colSpan="1" >取值</td>
1127
-
1128
- <td rowspan="1" colSpan="1" >描述</td>
1129
- </tr>
1130
-
1131
- <tr>
1132
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_0</td>
1133
-
1134
- <td rowspan="1" colSpan="1" >0</td>
1135
-
1136
- <td rowspan="1" colSpan="1" >关闭</td>
1137
- </tr>
1138
-
1139
- <tr>
1140
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_1</td>
1141
-
1142
- <td rowspan="1" colSpan="1" >1</td>
1143
-
1144
- <td rowspan="1" colSpan="1" >熊孩子</td>
1145
- </tr>
1146
-
1147
- <tr>
1148
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_2</td>
1149
-
1150
- <td rowspan="1" colSpan="1" >2</td>
1151
-
1152
- <td rowspan="1" colSpan="1" >萝莉</td>
1153
- </tr>
1154
-
1155
- <tr>
1156
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_3</td>
1157
-
1158
- <td rowspan="1" colSpan="1" >3</td>
1159
-
1160
- <td rowspan="1" colSpan="1" >大叔</td>
1161
- </tr>
1162
-
1163
- <tr>
1164
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_4</td>
1165
-
1166
- <td rowspan="1" colSpan="1" >4</td>
1167
-
1168
- <td rowspan="1" colSpan="1" >重金属</td>
1169
- </tr>
1170
-
1171
- <tr>
1172
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_5</td>
1173
-
1174
- <td rowspan="1" colSpan="1" >5</td>
1175
-
1176
- <td rowspan="1" colSpan="1" >感冒</td>
1177
- </tr>
1178
-
1179
- <tr>
1180
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_6</td>
1181
-
1182
- <td rowspan="1" colSpan="1" >6</td>
1183
-
1184
- <td rowspan="1" colSpan="1" >外语腔</td>
1185
- </tr>
1186
-
1187
- <tr>
1188
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_7</td>
1189
-
1190
- <td rowspan="1" colSpan="1" >7</td>
1191
-
1192
- <td rowspan="1" colSpan="1" >困兽</td>
1193
- </tr>
1194
-
1195
- <tr>
1196
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_8</td>
1197
-
1198
- <td rowspan="1" colSpan="1" >8</td>
1199
-
1200
- <td rowspan="1" colSpan="1" >肥宅</td>
1201
- </tr>
1202
-
1203
- <tr>
1204
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_9</td>
1205
-
1206
- <td rowspan="1" colSpan="1" >9</td>
1207
-
1208
- <td rowspan="1" colSpan="1" >强电流</td>
1209
- </tr>
1210
-
1211
- <tr>
1212
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_10</td>
1213
-
1214
- <td rowspan="1" colSpan="1" >10</td>
1215
-
1216
- <td rowspan="1" colSpan="1" >重机械</td>
1217
- </tr>
1218
-
1219
- <tr>
1220
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_11</td>
1221
-
1222
- <td rowspan="1" colSpan="1" >11</td>
1223
-
1224
- <td rowspan="1" colSpan="1" >空灵</td>
1225
- </tr>
1226
-
1227
- <tr>
1228
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_12</td>
1229
-
1230
- <td rowspan="1" colSpan="1" >12</td>
1231
-
1232
- <td rowspan="1" colSpan="1" >猪八戒</td>
1233
- </tr>
1234
-
1235
- <tr>
1236
- <td rowspan="1" colSpan="1" >TXVoiceChangerType_13</td>
1237
-
1238
- <td rowspan="1" colSpan="1" >13</td>
1239
-
1240
- <td rowspan="1" colSpan="1" >绿巨人</td>
1241
- </tr>
1242
- </table>
1243
-
436
+ | 枚举 | 取值 | 描述 |
437
+ | --- | --- | --- |
438
+ | TXVoiceChangerType_0 | 0 | 关闭 |
439
+ | TXVoiceChangerType_1 | 1 | 熊孩子 |
440
+ | TXVoiceChangerType_2 | 2 | 萝莉 |
441
+ | TXVoiceChangerType_3 | 3 | 大叔 |
442
+ | TXVoiceChangerType_4 | 4 | 重金属 |
443
+ | TXVoiceChangerType_5 | 5 | 感冒 |
444
+ | TXVoiceChangerType_6 | 6 | 外语腔 |
445
+ | TXVoiceChangerType_7 | 7 | 困兽 |
446
+ | TXVoiceChangerType_8 | 8 | 肥宅 |
447
+ | TXVoiceChangerType_9 | 9 | 强电流 |
448
+ | TXVoiceChangerType_10 | 10 | 重机械 |
449
+ | TXVoiceChangerType_11 | 11 | 空灵 |
450
+ | TXVoiceChangerType_12 | 12 | 猪八戒 |
451
+ | TXVoiceChangerType_13 | 13 | 绿巨人 |
1244
452
 
1245
453
  ## TXAudioMusicParam
1246
454
 
1247
-
1248
-
1249
455
  #### 背景音乐的播放控制信息
1250
456
 
1251
- 该信息用于在接口 [startPlayMusic](https://write.woa.com/document/87030074293530624) 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
457
+ 该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
1252
458
 
1253
459
  1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
1254
460
 
1255
461
  2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
1256
462
 
1257
463
  3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
1258
- <table>
1259
- <tr>
1260
- <td rowspan="1" colSpan="1" >枚举类型</td>
1261
-
1262
- <td rowspan="1" colSpan="1" >描述</td>
1263
- </tr>
1264
-
1265
- <tr>
1266
- <td rowspan="1" colSpan="1" >endTimeMS</td>
1267
-
1268
- <td rowspan="1" colSpan="1" >【字段含义】音乐结束播放时间点,单位毫秒,0表示播放至文件结尾。</td>
1269
- </tr>
1270
-
1271
- <tr>
1272
- <td rowspan="1" colSpan="1" >id</td>
1273
-
1274
- <td rowspan="1" colSpan="1" >【字段含义】音乐 ID。<br>【特殊说明】SDK 允许播放多路音乐,因此需要使用 ID 进行标记,用于控制音乐的开始、停止、音量等。</td>
1275
- </tr>
1276
-
1277
- <tr>
1278
- <td rowspan="1" colSpan="1" >isShortFile</td>
1279
-
1280
- <td rowspan="1" colSpan="1" >【字段含义】播放的是否为短音乐文件。<br>【推荐取值】true:需要重复播放的短音乐文件;false:正常的音乐文件。默认值:false。</td>
1281
- </tr>
1282
-
1283
- <tr>
1284
- <td rowspan="1" colSpan="1" >loopCount</td>
1285
-
1286
- <td rowspan="1" colSpan="1" >【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数],默认值:0。0 表示播放音乐一次;1 表示播放音乐两次;以此类推。</td>
1287
- </tr>
1288
-
1289
- <tr>
1290
- <td rowspan="1" colSpan="1" >path</td>
1291
-
1292
- <td rowspan="1" colSpan="1" >【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。</td>
1293
- </tr>
1294
-
1295
- <tr>
1296
- <td rowspan="1" colSpan="1" >publish</td>
1297
-
1298
- <td rowspan="1" colSpan="1" >【字段含义】是否将音乐传到远端。<br>【推荐取值】true:音乐在本地播放的同时,远端用户也能听到该音乐;false:主播只能在本地听到该音乐,远端观众听不到。默认值:false。</td>
1299
- </tr>
1300
-
1301
- <tr>
1302
- <td rowspan="1" colSpan="1" >startTimeMS</td>
1303
-
1304
- <td rowspan="1" colSpan="1" >【字段含义】音乐开始播放时间点,单位:毫秒。</td>
1305
- </tr>
1306
- </table>
464
+ | 枚举类型 | 描述 |
465
+ | --- | --- |
466
+ | endTimeMS | 【字段含义】音乐结束播放时间点,单位毫秒,0表示播放至文件结尾。 |
467
+ | id | 【字段含义】音乐 ID。<br>【特殊说明】SDK 允许播放多路音乐,因此需要使用 ID 进行标记,用于控制音乐的开始、停止、音量等。 |
468
+ | isShortFile | 【字段含义】播放的是否为短音乐文件。<br>【推荐取值】true:需要重复播放的短音乐文件;false:正常的音乐文件。默认值:false。 |
469
+ | loopCount | 【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数],默认值:0。0 表示播放音乐一次;1 表示播放音乐两次;以此类推。 |
470
+ | path | 【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。 |
471
+ | publish | 【字段含义】是否将音乐传到远端。<br>【推荐取值】true:音乐在本地播放的同时,远端用户也能听到该音乐;false:主播只能在本地听到该音乐,远端观众听不到。默认值:false。 |
472
+ | startTimeMS | 【字段含义】音乐开始播放时间点,单位:毫秒。 |