@tencentcloud/sdk-mcp 1.3.8 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
- package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
- package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +78 -311
- package/resource/doc/callkit/preset/android/api.md +330 -0
- package/resource/doc/callkit/preset/android/integration.md +530 -0
- package/resource/doc/callkit/preset/flutter/api.md +401 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
- package/resource/doc/callkit/preset/ios/api.md +282 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
- package/resource/doc/callkit/preset/react/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
- package/resource/doc/callkit/preset/vue/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/chatkit/android/integration.md +498 -0
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
- package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
- package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
- package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
- package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
- package/resource/doc/chatkit/react/components/search.md +282 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
- package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
- package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
- package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
- package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
- package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
- package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/core-sdk/live/flutter/live-integration.md +687 -0
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
- package/resource/doc/livekit/core-sdk/voice/android/voice-audience-list.md +264 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +226 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +456 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +539 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +453 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +516 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +509 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +365 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-audience-list.md +259 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-audio-effect.md +596 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-barrage.md +494 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-gift.md +418 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +563 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-room-list.md +709 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +262 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +211 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +414 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +492 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +405 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +611 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +336 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audience-list.md +234 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +218 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-barrage.md +376 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +648 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-gift.md +362 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-room-list.md +470 -0
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
- package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
- package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
- package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
- package/resource/doc/roomkit/android/features/room-state.md +358 -0
- package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
- package/resource/doc/roomkit/android/integration.md +433 -0
- package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
- package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
- package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
- package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
- package/resource/doc/roomkit/flutter/integration.md +405 -0
- package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
- package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
- package/resource/doc/roomkit/ios/features/room-state.md +320 -0
- package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
- package/resource/doc/roomkit/ios/integration.md +384 -0
- package/resource/doc/roomkit/vue/faq.md +1 -0
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
- package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
- package/resource/doc/roomkit/vue/features/device-state.md +24 -44
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
- package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
- package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
- package/resource/doc/roomkit/vue/features/room-state.md +25 -36
- package/resource/doc/roomkit/vue/features/room-view.md +30 -127
- package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
- package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
- package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
- package/resource/doc/roomkit/vue/integration.md +118 -282
- package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
- package/resource/doc/rtcengine/faq/web/web.md +15 -22
- package/resource/doc/rtcengine/web/api.md +17 -21
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
- package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
- package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
- package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
- package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
- package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
- package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
- package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
- package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
- package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
- package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
- package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
- package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
- package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
- package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
- package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
- package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
- package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
- package/server.js +1 -5
- package/server.js.map +1 -1
- package/tools/call/get_callkit_api.js +32 -0
- package/tools/call/get_callkit_api.js.map +1 -0
- package/tools/call/get_native_call_uikit_integration.js +34 -0
- package/tools/call/get_native_call_uikit_integration.js.map +1 -0
- package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
- package/tools/call/get_web_call_uikit_integration.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_integration.js +45 -0
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_integration.js +45 -0
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
- package/tools/common/get_faq.js +265 -0
- package/tools/common/get_faq.js.map +1 -0
- package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
- package/tools/common/get_usersig.js.map +1 -0
- package/tools/common/present_framework_choice.js +63 -0
- package/tools/common/present_framework_choice.js.map +1 -0
- package/tools/definitions/get_callkit_api_def.js +28 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +18 -19
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -18
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
- package/tools/definitions/get_usersig_def.js +17 -24
- package/tools/definitions/get_usersig_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +27 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +13 -30
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +23 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -59
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_features.js +65 -0
- package/tools/live/get_native_livekit_core_features.js.map +1 -0
- package/tools/live/get_native_livekit_core_integration.js +59 -0
- package/tools/live/get_native_livekit_core_integration.js.map +1 -0
- package/tools/live/get_web_live_uikit_integration.js +48 -0
- package/tools/live/get_web_live_uikit_integration.js.map +1 -0
- package/tools/live/get_web_livekit_api.js +32 -0
- package/tools/live/get_web_livekit_api.js.map +1 -0
- package/tools/live/get_web_livekit_component_detail.js +34 -0
- package/tools/live/get_web_livekit_component_detail.js.map +1 -0
- package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
- package/tools/room/get_web_room_uikit_integration.js.map +1 -0
- package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
- package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
- package/utils/generate-structured-result.js +61 -17
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/report-cls-client.js +12 -1
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/doc/chatuikit/android/integration.md +0 -612
- package/resource/doc/chatuikit/android/workflow.md +0 -0
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/flutter/workflow.md +0 -816
- package/resource/doc/chatuikit/iOS/workflow.md +0 -0
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
- package/resource/doc/chatuikit/react/components/search.md +0 -885
- package/resource/doc/chatuikit/react/create-group.md +0 -22
- package/resource/doc/chatuikit/react/init.md +0 -25
- package/resource/doc/chatuikit/react/workflow.md +0 -254
- package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
- package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
- package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
- package/resource/doc/chatuikit/vue/create-group.md +0 -26
- package/resource/doc/chatuikit/vue/init.md +0 -35
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -322
- package/resource/doc/livekit/live/flutter/live-integration.md +0 -1029
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -352
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
- package/resource/doc/livekit/live/vue/workflow.md +0 -219
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -487
- package/resource/doc/tuicallkit/android/integration.md +0 -302
- package/resource/doc/tuicallkit/android/workflow.md +0 -0
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1512
- package/resource/doc/tuicallkit/vue/api.md +0 -1512
- package/resource/doc/tuicallkit/vue/faq.md +0 -986
- package/tools/call/get-native-call-integration.js +0 -43
- package/tools/call/get-native-call-integration.js.map +0 -1
- package/tools/call/get-web-call-api.js +0 -27
- package/tools/call/get-web-call-api.js.map +0 -1
- package/tools/call/get-web-call-integration.js.map +0 -1
- package/tools/chat/get-native-chat-feature-detail.js +0 -30
- package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
- package/tools/chat/get-native-chat-integration.js +0 -45
- package/tools/chat/get-native-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-component-detail.js +0 -31
- package/tools/chat/get-web-chat-component-detail.js.map +0 -1
- package/tools/chat/get-web-chat-integration.js +0 -45
- package/tools/chat/get-web-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-uikit-init.js +0 -28
- package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
- package/tools/chat/get-web-create-group-doc.js +0 -28
- package/tools/chat/get-web-create-group-doc.js.map +0 -1
- package/tools/common/get-faq.js +0 -91
- package/tools/common/get-faq.js.map +0 -1
- package/tools/common/get-usersig.js.map +0 -1
- package/tools/common/present-framework-choice.js +0 -16
- package/tools/common/present-framework-choice.js.map +0 -1
- package/tools/common/record-prompt.js +0 -55
- package/tools/common/record-prompt.js.map +0 -1
- package/tools/common/record-result.js +0 -60
- package/tools/common/record-result.js.map +0 -1
- package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
- package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_live_api_def.js +0 -22
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
- package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +0 -50
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -115
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -17
- package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
- package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
- package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
- package/tools/definitions/get_web_create_group_doc_def.js +0 -18
- package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
- package/tools/definitions/get_web_live_state_detail_def.js +0 -19
- package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
- package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_feature_detail_def.js +0 -95
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -53
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -30
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -101
- package/tools/live/get-native-live-uikit-integration.js.map +0 -1
- package/tools/live/get-web-live-component-detail.js +0 -31
- package/tools/live/get-web-live-component-detail.js.map +0 -1
- package/tools/live/get-web-live-state-detail.js +0 -31
- package/tools/live/get-web-live-state-detail.js.map +0 -1
- package/tools/live/get-web-live-uikit-integration.js +0 -52
- package/tools/live/get-web-live-uikit-integration.js.map +0 -1
- package/tools/live/get_native_live_uikit_extra_features.js +0 -105
- package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
- package/tools/live/get_native_live_uikit_interaction.js +0 -101
- package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
- package/tools/native_live/get-native-live-api.js +0 -31
- package/tools/native_live/get-native-live-api.js.map +0 -1
- package/tools/room/get-web-room-feature-detail.js.map +0 -1
- package/tools/room/get-web-room-integration.js.map +0 -1
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
- package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
- package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
- package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
- package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
- package/tools/trtc/get-trtc-native-api.js +0 -31
- package/tools/trtc/get-trtc-native-api.js.map +0 -1
- package/utils/handle-component-name.js +0 -33
- package/utils/handle-component-name.js.map +0 -1
- /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
|
@@ -3,355 +3,105 @@
|
|
|
3
3
|
## 概述
|
|
4
4
|
`TXAudioEffectManager.java` 是腾讯云实时音视频(TRTC SDK ) Android 平台的背景音乐、短音效和人声特效的管理类文档,用于对背景音乐、短音效和人声特效进行设置的管理类。
|
|
5
5
|
|
|
6
|
-
|
|
7
6
|
## TXMusicPreloadObserver
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
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/87029952305344512)</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/87029952305344512)</td>
|
|
23
|
-
|
|
24
|
-
<td rowspan="1" colSpan="1" >背景音乐预加载出错</td>
|
|
25
|
-
</tr>
|
|
26
|
-
</table>
|
|
27
|
-
|
|
7
|
+
| 函数列表 | 描述 |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| onLoadProgress | 背景音乐预加载进度 |
|
|
10
|
+
| onLoadError | 背景音乐预加载出错 |
|
|
28
11
|
|
|
29
12
|
## TXMusicPlayObserver
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</tr>
|
|
36
|
-
|
|
37
|
-
<tr>
|
|
38
|
-
<td rowspan="1" colSpan="1" >[onStart](https://write.woa.com/document/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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
|
## TXAudioEffectManager
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
<td rowspan="1" colSpan="1" >[setVoiceChangerType](https://write.woa.com/document/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</td>
|
|
169
|
-
|
|
170
|
-
<td rowspan="1" colSpan="1" >获取背景音乐的总时长(单位:毫秒)。</td>
|
|
171
|
-
</tr>
|
|
172
|
-
|
|
173
|
-
<tr>
|
|
174
|
-
<td rowspan="1" colSpan="1" >[seekMusicToPosInMS](https://write.woa.com/document/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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/87029952305344512)</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
|
+
| seekMusicToPosInMS | 设置背景音乐的播放进度(单位:毫秒)。 |
|
|
41
|
+
| setMusicScratchSpeedRate | 调整搓碟的变速效果。 |
|
|
42
|
+
| setPreloadObserver | 设置预加载事件回调。 |
|
|
43
|
+
| preloadMusic | 预加载背景音乐。 |
|
|
44
|
+
| getMusicTrackCount | 获取背景音乐的音轨数量。 |
|
|
45
|
+
| setMusicTrack | 指定背景音乐的播放音轨。 |
|
|
210
46
|
|
|
211
47
|
## 结构体类型
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
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/87029952305344512)</td>
|
|
221
|
-
|
|
222
|
-
<td rowspan="1" colSpan="1" >背景音乐的播放控制信息</td>
|
|
223
|
-
</tr>
|
|
224
|
-
</table>
|
|
225
|
-
|
|
48
|
+
| 函数列表 | 描述 |
|
|
49
|
+
| --- | --- |
|
|
50
|
+
| AudioMusicParam | 背景音乐的播放控制信息 |
|
|
226
51
|
|
|
227
52
|
## 枚举类型
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
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/87029952305344512)</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/87029952305344512)</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
|
-
|
|
261
|
-
|
|
262
|
-
|
|
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
|
-
|
|
283
|
-
|
|
284
|
-
|
|
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
|
-
|
|
317
|
-
|
|
318
|
-
|
|
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
|
同时也需要注意,并非所有的手机开启此特效后都能达到优秀的耳返效果,我们已经对部分耳返效果不佳的手机屏蔽了该特效。目前 12.2 及其以上的版本针对硬件耳返的支持扩展到了荣耀、OPPO/一加、小米/红米等主流的机型。
|
|
350
102
|
|
|
351
103
|
全新的耳返效果可以在 [Demo 体验](https://cloud.tencent.com/document/product/647/17021) 中的 KTV 合唱场景来体验。
|
|
352
104
|
|
|
353
|
-
|
|
354
|
-
|
|
355
105
|
**OPPO**
|
|
356
106
|
|
|
357
107
|
在 12.6 及其以上的版本,使用 OPPO 硬件耳返的客户需要在 [OPPO 开放平台](https://open.oppomobile.com/new/developmentDoc/info?id=10889) 中申请开通耳返的授权码,将自己应用的授权码配置到 ` AndroidManifest.xml ` 中。
|
|
@@ -363,12 +113,8 @@
|
|
|
363
113
|
|
|
364
114
|
这个文档中其他的配置如 ` 环境准备中 ` 的 ` build.gradle ` 配置、` 修改 Module 的 build.gradle 文件 `中的 ` build.gradle `修改 以及 ` 权限添加 ` 都不需要配置。配置完成后,此时打开耳返时会弹出悬浮球,关闭耳返后悬浮球消失,耳返的音量以及音效可以通过悬浮球来调节。
|
|
365
115
|
|
|
366
|
-
|
|
367
|
-
|
|
368
116
|
否则在打开耳返时会因为服务鉴权失败而自动切换为软件耳返。
|
|
369
117
|
|
|
370
|
-
|
|
371
|
-
|
|
372
118
|
**荣耀**
|
|
373
119
|
|
|
374
120
|
在 12.2 及其以上的版本,使用荣耀硬件耳返的客户需要在 ` AndroidManifest.xml ` 中配置如下字段。
|
|
@@ -380,277 +126,142 @@
|
|
|
380
126
|
|
|
381
127
|
否则在打开耳返的时候会偶现耳返无声现象,可能需要用户重新开关下硬件耳返才能正常听到耳返的声音。
|
|
382
128
|
|
|
383
|
-
|
|
384
|
-
|
|
385
129
|
**VIVO**
|
|
386
130
|
|
|
387
131
|
部分 VIVO 手机在使用 USB 数字耳机的时候,会出现硬件耳返无声的问题,这里可以将耳机更换为 3.5mm 的圆孔耳机来进行体验,目前 VIVO 厂商没有对 USB 的耳机全部适配,建议首选 VIVO 品牌的耳机进行 K 歌体验。
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
393
|
-
</tr>
|
|
394
|
-
|
|
395
|
-
<tr>
|
|
396
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
397
|
-
|
|
398
|
-
<td rowspan="1" colSpan="1" >true:开启;false:关闭。</td>
|
|
399
|
-
</tr>
|
|
400
|
-
</table>
|
|
401
|
-
|
|
132
|
+
| 参数 | 描述 |
|
|
133
|
+
| --- | --- |
|
|
134
|
+
| enable | true:开启;false:关闭。 |
|
|
402
135
|
|
|
403
136
|
> **注意**
|
|
404
|
-
>
|
|
137
|
+
>
|
|
405
138
|
|
|
406
139
|
> 仅在主播佩戴耳机时才能开启此特效,同时请您提示主播佩戴有线耳机。
|
|
407
|
-
>
|
|
408
|
-
|
|
140
|
+
>
|
|
409
141
|
|
|
410
142
|
## setVoiceEarMonitorVolume
|
|
411
143
|
|
|
412
|
-
|
|
413
|
-
|
|
414
144
|
#### 设置耳返音量。
|
|
415
145
|
|
|
416
146
|
通过该接口您可以设置耳返特效中声音的音量大小。
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
422
|
-
</tr>
|
|
423
|
-
|
|
424
|
-
<tr>
|
|
425
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
426
|
-
|
|
427
|
-
<td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:100。</td>
|
|
428
|
-
</tr>
|
|
429
|
-
</table>
|
|
430
|
-
|
|
147
|
+
| 参数 | 描述 |
|
|
148
|
+
| --- | --- |
|
|
149
|
+
| volume | 音量大小,取值范围为 [0, 150],默认值:100。 |
|
|
431
150
|
|
|
432
151
|
> **注意**
|
|
433
|
-
>
|
|
152
|
+
>
|
|
434
153
|
|
|
435
154
|
> 耳返的音量大小是影响用户耳返体验的重要因素之一,考虑到不同用户对音量的敏感度不同,强烈建议您在 UI 界面上开放耳返音量的调节滑杆,调节范围建议在 0~150 之间,其中 100~150 的增益效果对于部分采集音量较小的 Android 手机很有帮助。
|
|
436
|
-
>
|
|
437
|
-
|
|
155
|
+
>
|
|
438
156
|
|
|
439
157
|
## setVoiceReverbType
|
|
440
158
|
|
|
441
|
-
|
|
442
|
-
|
|
443
159
|
#### 设置人声的混响效果。
|
|
444
160
|
|
|
445
|
-
通过该接口您可以设置人声的混响效果,具体特效请参见枚举定义
|
|
161
|
+
通过该接口您可以设置人声的混响效果,具体特效请参见枚举定义 TXVoiceReverbType。
|
|
446
162
|
|
|
447
163
|
> **注意**
|
|
448
|
-
>
|
|
164
|
+
>
|
|
449
165
|
|
|
450
166
|
> 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
|
|
451
|
-
>
|
|
452
|
-
|
|
167
|
+
>
|
|
453
168
|
|
|
454
169
|
## setVoiceChangerType
|
|
455
170
|
|
|
456
|
-
|
|
457
|
-
|
|
458
171
|
#### 设置人声的变声特效。
|
|
459
172
|
|
|
460
|
-
通过该接口您可以设置人声的变声特效,具体特效请参见枚举定义
|
|
173
|
+
通过该接口您可以设置人声的变声特效,具体特效请参见枚举定义 TXVoiceChangeType。
|
|
461
174
|
|
|
462
175
|
> **注意**
|
|
463
|
-
>
|
|
176
|
+
>
|
|
464
177
|
|
|
465
178
|
> 设置的效果在退出房间后会自动失效,如果下次进房还需要对应特效,需要调用此接口再次进行设置。
|
|
466
|
-
>
|
|
467
|
-
|
|
179
|
+
>
|
|
468
180
|
|
|
469
181
|
## setVoiceCaptureVolume
|
|
470
182
|
|
|
471
|
-
|
|
472
|
-
|
|
473
183
|
#### 设置语音音量。
|
|
474
184
|
|
|
475
|
-
该接口可以设置语音音量的大小,一般配合音乐音量的设置接口
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
481
|
-
</tr>
|
|
482
|
-
|
|
483
|
-
<tr>
|
|
484
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
485
|
-
|
|
486
|
-
<td rowspan="1" colSpan="1" >音量大小,取值范围为 [0 - 150],默认值:100。</td>
|
|
487
|
-
</tr>
|
|
488
|
-
</table>
|
|
489
|
-
|
|
185
|
+
该接口可以设置语音音量的大小,一般配合音乐音量的设置接口 setAllMusicVolume 协同使用,用于调谐语音和音乐在混音前各自的音量占比。
|
|
186
|
+
| 参数 | 描述 |
|
|
187
|
+
| --- | --- |
|
|
188
|
+
| volume | 音量大小,取值范围为 [0 - 150],默认值:100。 |
|
|
490
189
|
|
|
491
190
|
> **注意**
|
|
492
|
-
>
|
|
191
|
+
>
|
|
493
192
|
|
|
494
193
|
> 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
495
|
-
>
|
|
496
|
-
|
|
194
|
+
>
|
|
497
195
|
|
|
498
196
|
## setVoicePitch
|
|
499
197
|
|
|
500
|
-
|
|
501
|
-
|
|
502
198
|
#### 设置语音音调。
|
|
503
199
|
|
|
504
200
|
该接口可以设置语音音调,用于实现变调不变速的目的。
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
510
|
-
</tr>
|
|
511
|
-
|
|
512
|
-
<tr>
|
|
513
|
-
<td rowspan="1" colSpan="1" >pitch</td>
|
|
514
|
-
|
|
515
|
-
<td rowspan="1" colSpan="1" >音调,取值范围[-1.0f, 1.0f],默认值:0.0f。</td>
|
|
516
|
-
</tr>
|
|
517
|
-
</table>
|
|
518
|
-
|
|
201
|
+
| 参数 | 描述 |
|
|
202
|
+
| --- | --- |
|
|
203
|
+
| pitch | 音调,取值范围[-1.0f, 1.0f],默认值:0.0f。 |
|
|
519
204
|
|
|
520
205
|
## setMusicObserver
|
|
521
206
|
|
|
522
|
-
|
|
523
|
-
|
|
524
207
|
#### 设置背景音乐的事件回调接口。
|
|
525
208
|
|
|
526
209
|
请在播放背景音乐之前使用该接口设置播放事件回调,以便感知背景音乐的播放进度。
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
532
|
-
</tr>
|
|
533
|
-
|
|
534
|
-
<tr>
|
|
535
|
-
<td rowspan="1" colSpan="1" >musicId</td>
|
|
536
|
-
|
|
537
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
538
|
-
</tr>
|
|
539
|
-
|
|
540
|
-
<tr>
|
|
541
|
-
<td rowspan="1" colSpan="1" >observer</td>
|
|
542
|
-
|
|
543
|
-
<td rowspan="1" colSpan="1" >具体参考 [TXMusicPlayObserver](https://write.woa.com/document/87029952305344512) 中定义接口。</td>
|
|
544
|
-
</tr>
|
|
545
|
-
</table>
|
|
546
|
-
|
|
210
|
+
| 参数 | 描述 |
|
|
211
|
+
| --- | --- |
|
|
212
|
+
| musicId | 音乐 ID。 |
|
|
213
|
+
| observer | 具体参考 TXMusicPlayObserver 中定义接口。 |
|
|
547
214
|
|
|
548
215
|
> **注意**
|
|
549
|
-
>
|
|
216
|
+
>
|
|
550
217
|
|
|
551
218
|
> 1. 如果该 ID 不需要使用,observer 可设置为 NULL 彻底释放。
|
|
552
|
-
>
|
|
553
|
-
|
|
219
|
+
>
|
|
554
220
|
|
|
555
221
|
## startPlayMusic
|
|
556
222
|
|
|
557
|
-
|
|
558
|
-
|
|
559
223
|
#### 开始播放背景音乐。
|
|
560
224
|
|
|
561
225
|
每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
567
|
-
</tr>
|
|
568
|
-
|
|
569
|
-
<tr>
|
|
570
|
-
<td rowspan="1" colSpan="1" >musicParam</td>
|
|
571
|
-
|
|
572
|
-
<td rowspan="1" colSpan="1" >音乐参数。</td>
|
|
573
|
-
</tr>
|
|
574
|
-
</table>
|
|
575
|
-
|
|
226
|
+
| 参数 | 描述 |
|
|
227
|
+
| --- | --- |
|
|
228
|
+
| musicParam | 音乐参数。 |
|
|
576
229
|
|
|
577
230
|
> **注意**
|
|
578
|
-
>
|
|
231
|
+
>
|
|
579
232
|
|
|
580
233
|
> 1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
|
|
581
|
-
>
|
|
234
|
+
>
|
|
582
235
|
|
|
583
236
|
> 2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
|
|
584
|
-
>
|
|
237
|
+
>
|
|
585
238
|
|
|
586
239
|
> 3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
|
|
587
|
-
>
|
|
588
|
-
|
|
240
|
+
>
|
|
589
241
|
|
|
590
242
|
## stopPlayMusic
|
|
591
243
|
|
|
592
|
-
|
|
593
|
-
|
|
594
244
|
#### 停止播放背景音乐。
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
600
|
-
</tr>
|
|
601
|
-
|
|
602
|
-
<tr>
|
|
603
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
604
|
-
|
|
605
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
606
|
-
</tr>
|
|
607
|
-
</table>
|
|
608
|
-
|
|
245
|
+
| 参数 | 描述 |
|
|
246
|
+
| --- | --- |
|
|
247
|
+
| id | 音乐 ID。 |
|
|
609
248
|
|
|
610
249
|
## pausePlayMusic
|
|
611
250
|
|
|
612
|
-
|
|
613
|
-
|
|
614
251
|
#### 暂停播放背景音乐。
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
620
|
-
</tr>
|
|
621
|
-
|
|
622
|
-
<tr>
|
|
623
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
624
|
-
|
|
625
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
626
|
-
</tr>
|
|
627
|
-
</table>
|
|
628
|
-
|
|
252
|
+
| 参数 | 描述 |
|
|
253
|
+
| --- | --- |
|
|
254
|
+
| id | 音乐 ID。 |
|
|
629
255
|
|
|
630
256
|
## resumePlayMusic
|
|
631
257
|
|
|
632
|
-
|
|
633
|
-
|
|
634
258
|
#### 恢复播放背景音乐。
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
640
|
-
</tr>
|
|
641
|
-
|
|
642
|
-
<tr>
|
|
643
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
644
|
-
|
|
645
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
646
|
-
</tr>
|
|
647
|
-
</table>
|
|
648
|
-
|
|
259
|
+
| 参数 | 描述 |
|
|
260
|
+
| --- | --- |
|
|
261
|
+
| id | 音乐 ID。 |
|
|
649
262
|
|
|
650
263
|
## setAllMusicVolume
|
|
651
264
|
|
|
652
|
-
|
|
653
|
-
|
|
654
265
|
#### 设置所有背景音乐的本地音量和远端音量的大小。
|
|
655
266
|
|
|
656
267
|
该接口可以设置所有背景音乐的本地音量和远端音量。
|
|
@@ -658,169 +269,70 @@
|
|
|
658
269
|
|
|
659
270
|
- 远端音量:即观众端可以听到的背景音乐的音量大小。
|
|
660
271
|
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
666
|
-
</tr>
|
|
667
|
-
|
|
668
|
-
<tr>
|
|
669
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
670
|
-
|
|
671
|
-
<td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:60。</td>
|
|
672
|
-
</tr>
|
|
673
|
-
</table>
|
|
674
|
-
|
|
272
|
+
| 参数 | 描述 |
|
|
273
|
+
| --- | --- |
|
|
274
|
+
| volume | 音量大小,取值范围为 [0, 150],默认值:60。 |
|
|
675
275
|
|
|
676
276
|
> **注意**
|
|
677
|
-
>
|
|
277
|
+
>
|
|
678
278
|
|
|
679
279
|
> 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
680
|
-
>
|
|
681
|
-
|
|
280
|
+
>
|
|
682
281
|
|
|
683
282
|
## setMusicPublishVolume
|
|
684
283
|
|
|
685
|
-
|
|
686
|
-
|
|
687
284
|
#### 设置某一首背景音乐的远端音量的大小。
|
|
688
285
|
|
|
689
286
|
该接口可以细粒度地控制每一首背景音乐的远端音量,也就是观众端可听到的背景音乐的音量大小。
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
695
|
-
</tr>
|
|
696
|
-
|
|
697
|
-
<tr>
|
|
698
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
699
|
-
|
|
700
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
701
|
-
</tr>
|
|
702
|
-
|
|
703
|
-
<tr>
|
|
704
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
705
|
-
|
|
706
|
-
<td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150];默认值:60。</td>
|
|
707
|
-
</tr>
|
|
708
|
-
</table>
|
|
709
|
-
|
|
287
|
+
| 参数 | 描述 |
|
|
288
|
+
| --- | --- |
|
|
289
|
+
| id | 音乐 ID。 |
|
|
290
|
+
| volume | 音量大小,取值范围为 [0, 150];默认值:60。 |
|
|
710
291
|
|
|
711
292
|
> **注意**
|
|
712
|
-
>
|
|
293
|
+
>
|
|
713
294
|
|
|
714
295
|
> 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
715
|
-
>
|
|
716
|
-
|
|
296
|
+
>
|
|
717
297
|
|
|
718
298
|
## setMusicPlayoutVolume
|
|
719
299
|
|
|
720
|
-
|
|
721
|
-
|
|
722
300
|
#### 设置某一首背景音乐的本地音量的大小。
|
|
723
301
|
|
|
724
302
|
该接口可以细粒度地控制每一首背景音乐的本地音量,也就是主播本地可以听到的背景音乐的音量大小。
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
730
|
-
</tr>
|
|
731
|
-
|
|
732
|
-
<tr>
|
|
733
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
734
|
-
|
|
735
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
736
|
-
</tr>
|
|
737
|
-
|
|
738
|
-
<tr>
|
|
739
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
740
|
-
|
|
741
|
-
<td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 150],默认值:60。</td>
|
|
742
|
-
</tr>
|
|
743
|
-
</table>
|
|
744
|
-
|
|
303
|
+
| 参数 | 描述 |
|
|
304
|
+
| --- | --- |
|
|
305
|
+
| id | 音乐 ID。 |
|
|
306
|
+
| volume | 音量大小,取值范围为 [0, 150],默认值:60。 |
|
|
745
307
|
|
|
746
308
|
> **注意**
|
|
747
|
-
>
|
|
309
|
+
>
|
|
748
310
|
|
|
749
311
|
> 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
750
|
-
>
|
|
751
|
-
|
|
312
|
+
>
|
|
752
313
|
|
|
753
314
|
## setMusicPitch
|
|
754
315
|
|
|
755
|
-
|
|
756
|
-
|
|
757
316
|
#### 调整背景音乐的音调高低。
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
763
|
-
</tr>
|
|
764
|
-
|
|
765
|
-
<tr>
|
|
766
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
767
|
-
|
|
768
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
769
|
-
</tr>
|
|
770
|
-
|
|
771
|
-
<tr>
|
|
772
|
-
<td rowspan="1" colSpan="1" >pitch</td>
|
|
773
|
-
|
|
774
|
-
<td rowspan="1" colSpan="1" >音调,取值范围为 [-1.0f, 1.0f] 之间的浮点数,默认值:0.0f。</td>
|
|
775
|
-
</tr>
|
|
776
|
-
</table>
|
|
777
|
-
|
|
317
|
+
| 参数 | 描述 |
|
|
318
|
+
| --- | --- |
|
|
319
|
+
| id | 音乐 ID。 |
|
|
320
|
+
| pitch | 音调,取值范围为 [-1.0f, 1.0f] 之间的浮点数,默认值:0.0f。 |
|
|
778
321
|
|
|
779
322
|
## setMusicSpeedRate
|
|
780
323
|
|
|
781
|
-
|
|
782
|
-
|
|
783
324
|
#### 调整背景音乐的变速效果。
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
789
|
-
</tr>
|
|
790
|
-
|
|
791
|
-
<tr>
|
|
792
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
793
|
-
|
|
794
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
795
|
-
</tr>
|
|
796
|
-
|
|
797
|
-
<tr>
|
|
798
|
-
<td rowspan="1" colSpan="1" >speedRate</td>
|
|
799
|
-
|
|
800
|
-
<td rowspan="1" colSpan="1" >速度,取值范围为 [0.5f, 2.0f] 之间的浮点数,默认值:1.0f。</td>
|
|
801
|
-
</tr>
|
|
802
|
-
</table>
|
|
803
|
-
|
|
325
|
+
| 参数 | 描述 |
|
|
326
|
+
| --- | --- |
|
|
327
|
+
| id | 音乐 ID。 |
|
|
328
|
+
| speedRate | 速度,取值范围为 [0.5f, 2.0f] 之间的浮点数,默认值:1.0f。 |
|
|
804
329
|
|
|
805
330
|
## getMusicCurrentPosInMS
|
|
806
331
|
|
|
807
|
-
|
|
808
|
-
|
|
809
332
|
#### 获取背景音乐的播放进度(单位:毫秒)。
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
815
|
-
</tr>
|
|
816
|
-
|
|
817
|
-
<tr>
|
|
818
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
819
|
-
|
|
820
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
821
|
-
</tr>
|
|
822
|
-
</table>
|
|
823
|
-
|
|
333
|
+
| 参数 | 描述 |
|
|
334
|
+
| --- | --- |
|
|
335
|
+
| id | 音乐 ID。 |
|
|
824
336
|
|
|
825
337
|
#### 返回值说明:
|
|
826
338
|
|
|
@@ -828,23 +340,10 @@
|
|
|
828
340
|
|
|
829
341
|
## getMusicDurationInMS
|
|
830
342
|
|
|
831
|
-
|
|
832
|
-
|
|
833
343
|
#### 获取背景音乐的总时长(单位:毫秒)。
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
839
|
-
</tr>
|
|
840
|
-
|
|
841
|
-
<tr>
|
|
842
|
-
<td rowspan="1" colSpan="1" >path</td>
|
|
843
|
-
|
|
844
|
-
<td rowspan="1" colSpan="1" >音乐文件路径。</td>
|
|
845
|
-
</tr>
|
|
846
|
-
</table>
|
|
847
|
-
|
|
344
|
+
| 参数 | 描述 |
|
|
345
|
+
| --- | --- |
|
|
346
|
+
| path | 音乐文件路径。 |
|
|
848
347
|
|
|
849
348
|
#### 返回值说明:
|
|
850
349
|
|
|
@@ -852,493 +351,152 @@
|
|
|
852
351
|
|
|
853
352
|
## seekMusicToPosInMS
|
|
854
353
|
|
|
855
|
-
|
|
856
|
-
|
|
857
354
|
#### 设置背景音乐的播放进度(单位:毫秒)。
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
863
|
-
</tr>
|
|
864
|
-
|
|
865
|
-
<tr>
|
|
866
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
867
|
-
|
|
868
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
869
|
-
</tr>
|
|
870
|
-
|
|
871
|
-
<tr>
|
|
872
|
-
<td rowspan="1" colSpan="1" >pts</td>
|
|
873
|
-
|
|
874
|
-
<td rowspan="1" colSpan="1" >单位: 毫秒。</td>
|
|
875
|
-
</tr>
|
|
876
|
-
</table>
|
|
877
|
-
|
|
355
|
+
| 参数 | 描述 |
|
|
356
|
+
| --- | --- |
|
|
357
|
+
| id | 音乐 ID。 |
|
|
358
|
+
| pts | 单位: 毫秒。 |
|
|
878
359
|
|
|
879
360
|
> **注意**
|
|
880
|
-
>
|
|
361
|
+
>
|
|
881
362
|
|
|
882
363
|
> 请尽量避免过度频繁地调用该接口,因为该接口可能会再次读写音乐文件,耗时稍高。
|
|
883
|
-
>
|
|
364
|
+
>
|
|
884
365
|
|
|
885
366
|
> 因此,当用户拖拽音乐的播放进度条时,请在用户完成拖拽操作后再调用本接口。
|
|
886
|
-
>
|
|
367
|
+
>
|
|
887
368
|
|
|
888
369
|
> 因为 UI 上的进度条控件往往会以很高的频率反馈用户的拖拽进度,如不做频率限制,会导致较差的用户体验。
|
|
889
|
-
>
|
|
890
|
-
|
|
370
|
+
>
|
|
891
371
|
|
|
892
372
|
## setMusicScratchSpeedRate
|
|
893
373
|
|
|
894
|
-
|
|
895
|
-
|
|
896
374
|
#### 调整搓碟的变速效果。
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
902
|
-
</tr>
|
|
903
|
-
|
|
904
|
-
<tr>
|
|
905
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
906
|
-
|
|
907
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
908
|
-
</tr>
|
|
909
|
-
|
|
910
|
-
<tr>
|
|
911
|
-
<td rowspan="1" colSpan="1" >scratchSpeedRate</td>
|
|
912
|
-
|
|
913
|
-
<td rowspan="1" colSpan="1" >搓碟速度,取值范围为 [-12.0, 12.0] 之间的浮点数,默认值是 1.0f,速度值正/负表示方向正/反,绝对值大小表示速度快慢。</td>
|
|
914
|
-
</tr>
|
|
915
|
-
</table>
|
|
916
|
-
|
|
375
|
+
| 参数 | 描述 |
|
|
376
|
+
| --- | --- |
|
|
377
|
+
| id | 音乐 ID。 |
|
|
378
|
+
| scratchSpeedRate | 搓碟速度,取值范围为 [-12.0, 12.0] 之间的浮点数,默认值是 1.0f,速度值正/负表示方向正/反,绝对值大小表示速度快慢。 |
|
|
917
379
|
|
|
918
380
|
> **注意**
|
|
919
|
-
>
|
|
381
|
+
>
|
|
920
382
|
|
|
921
383
|
> 前置条件 preloadMusic 成功。
|
|
922
|
-
>
|
|
923
|
-
|
|
384
|
+
>
|
|
924
385
|
|
|
925
386
|
## setPreloadObserver
|
|
926
387
|
|
|
927
|
-
|
|
928
|
-
|
|
929
388
|
#### 设置预加载事件回调。
|
|
930
389
|
|
|
931
390
|
请在预加载背景音乐之前使用该接口设置回调,以便感知背景音乐的预加载进度。
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
937
|
-
</tr>
|
|
938
|
-
|
|
939
|
-
<tr>
|
|
940
|
-
<td rowspan="1" colSpan="1" >observer</td>
|
|
941
|
-
|
|
942
|
-
<td rowspan="1" colSpan="1" >具体参考 [TXMusicPreloadObserver](https://write.woa.com/document/87029952305344512) 中定义接口。</td>
|
|
943
|
-
</tr>
|
|
944
|
-
</table>
|
|
945
|
-
|
|
391
|
+
| 参数 | 描述 |
|
|
392
|
+
| --- | --- |
|
|
393
|
+
| observer | 具体参考 TXMusicPreloadObserver 中定义接口。 |
|
|
946
394
|
|
|
947
395
|
## preloadMusic
|
|
948
396
|
|
|
949
|
-
|
|
950
|
-
|
|
951
397
|
#### 预加载背景音乐。
|
|
952
398
|
|
|
953
399
|
每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
959
|
-
</tr>
|
|
960
|
-
|
|
961
|
-
<tr>
|
|
962
|
-
<td rowspan="1" colSpan="1" >preloadParam</td>
|
|
963
|
-
|
|
964
|
-
<td rowspan="1" colSpan="1" >预加载音乐参数。</td>
|
|
965
|
-
</tr>
|
|
966
|
-
</table>
|
|
967
|
-
|
|
400
|
+
| 参数 | 描述 |
|
|
401
|
+
| --- | --- |
|
|
402
|
+
| preloadParam | 预加载音乐参数。 |
|
|
968
403
|
|
|
969
404
|
> **注意**
|
|
970
|
-
>
|
|
971
|
-
|
|
972
|
-
> 1. 预先加载最多同时支持2个不同 ID 的预加载,且预加载时长不超过10分钟,使用完需调用 [stopPlayMusic](https://write.woa.com/document/87029952305344512),否则内存不释放。
|
|
973
|
-
>
|
|
405
|
+
>
|
|
974
406
|
|
|
975
|
-
>
|
|
976
|
-
>
|
|
407
|
+
> 1. 预先加载最多同时支持2个不同 ID 的预加载,且预加载时长不超过10分钟,使用完需调用 stopPlayMusic,否则内存不释放。
|
|
408
|
+
>
|
|
977
409
|
|
|
978
|
-
>
|
|
979
|
-
>
|
|
410
|
+
> 2. 若该ID对应的音乐正在播放中,预加载会失败,需先调用 stopPlayMusic。
|
|
411
|
+
>
|
|
980
412
|
|
|
413
|
+
> 3. 当 ` musicParam ` 和传入 startPlayMusic 的 ` musicParam ` 完全相同时,预加载有效。
|
|
414
|
+
>
|
|
981
415
|
|
|
982
416
|
## getMusicTrackCount
|
|
983
417
|
|
|
984
|
-
|
|
985
|
-
|
|
986
418
|
#### 获取背景音乐的音轨数量。
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
992
|
-
</tr>
|
|
993
|
-
|
|
994
|
-
<tr>
|
|
995
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
996
|
-
|
|
997
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
998
|
-
</tr>
|
|
999
|
-
</table>
|
|
1000
|
-
|
|
419
|
+
| 参数 | 描述 |
|
|
420
|
+
| --- | --- |
|
|
421
|
+
| id | 音乐 ID。 |
|
|
1001
422
|
|
|
1002
423
|
## setMusicTrack
|
|
1003
424
|
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
425
|
#### 指定背景音乐的播放音轨。
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1012
|
-
</tr>
|
|
1013
|
-
|
|
1014
|
-
<tr>
|
|
1015
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
1016
|
-
|
|
1017
|
-
<td rowspan="1" colSpan="1" >音乐 ID。</td>
|
|
1018
|
-
</tr>
|
|
1019
|
-
|
|
1020
|
-
<tr>
|
|
1021
|
-
<td rowspan="1" colSpan="1" >index</td>
|
|
1022
|
-
|
|
1023
|
-
<td rowspan="1" colSpan="1" >默认播放第一个音轨。取值范围[0, 音轨总数)。</td>
|
|
1024
|
-
</tr>
|
|
1025
|
-
</table>
|
|
1026
|
-
|
|
426
|
+
| 参数 | 描述 |
|
|
427
|
+
| --- | --- |
|
|
428
|
+
| id | 音乐 ID。 |
|
|
429
|
+
| index | 默认播放第一个音轨。取值范围0, 音轨总数)。 |
|
|
1027
430
|
|
|
1028
431
|
> **注意**
|
|
1029
|
-
>
|
|
432
|
+
>
|
|
1030
433
|
|
|
1031
434
|
> 音轨总数量可通过 getMusicTrackCount 接口获取。
|
|
1032
|
-
>
|
|
1033
|
-
|
|
435
|
+
>
|
|
1034
436
|
|
|
1035
437
|
## TXVoiceReverbType
|
|
1036
438
|
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
439
|
#### 混响特效
|
|
1040
440
|
|
|
1041
441
|
混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果:
|
|
1042
442
|
|
|
1043
443
|
0:关闭;1:KTV;2:小房间;3:大会堂;4:低沉;5:洪亮;6:金属声;7:磁性;8:空灵;9:录音棚;10:悠扬 11:录音棚2。
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
<td rowspan="1" colSpan="1" >关闭特效</td>
|
|
1059
|
-
</tr>
|
|
1060
|
-
|
|
1061
|
-
<tr>
|
|
1062
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_1</td>
|
|
1063
|
-
|
|
1064
|
-
<td rowspan="1" colSpan="1" >1</td>
|
|
1065
|
-
|
|
1066
|
-
<td rowspan="1" colSpan="1" >KTV</td>
|
|
1067
|
-
</tr>
|
|
1068
|
-
|
|
1069
|
-
<tr>
|
|
1070
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_2</td>
|
|
1071
|
-
|
|
1072
|
-
<td rowspan="1" colSpan="1" >2</td>
|
|
1073
|
-
|
|
1074
|
-
<td rowspan="1" colSpan="1" >小房间</td>
|
|
1075
|
-
</tr>
|
|
1076
|
-
|
|
1077
|
-
<tr>
|
|
1078
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_3</td>
|
|
1079
|
-
|
|
1080
|
-
<td rowspan="1" colSpan="1" >3</td>
|
|
1081
|
-
|
|
1082
|
-
<td rowspan="1" colSpan="1" >大会堂</td>
|
|
1083
|
-
</tr>
|
|
1084
|
-
|
|
1085
|
-
<tr>
|
|
1086
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_4</td>
|
|
1087
|
-
|
|
1088
|
-
<td rowspan="1" colSpan="1" >4</td>
|
|
1089
|
-
|
|
1090
|
-
<td rowspan="1" colSpan="1" >低沉</td>
|
|
1091
|
-
</tr>
|
|
1092
|
-
|
|
1093
|
-
<tr>
|
|
1094
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_5</td>
|
|
1095
|
-
|
|
1096
|
-
<td rowspan="1" colSpan="1" >5</td>
|
|
1097
|
-
|
|
1098
|
-
<td rowspan="1" colSpan="1" >洪亮</td>
|
|
1099
|
-
</tr>
|
|
1100
|
-
|
|
1101
|
-
<tr>
|
|
1102
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_6</td>
|
|
1103
|
-
|
|
1104
|
-
<td rowspan="1" colSpan="1" >6</td>
|
|
1105
|
-
|
|
1106
|
-
<td rowspan="1" colSpan="1" >金属声</td>
|
|
1107
|
-
</tr>
|
|
1108
|
-
|
|
1109
|
-
<tr>
|
|
1110
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_7</td>
|
|
1111
|
-
|
|
1112
|
-
<td rowspan="1" colSpan="1" >7</td>
|
|
1113
|
-
|
|
1114
|
-
<td rowspan="1" colSpan="1" >磁性</td>
|
|
1115
|
-
</tr>
|
|
1116
|
-
|
|
1117
|
-
<tr>
|
|
1118
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_8</td>
|
|
1119
|
-
|
|
1120
|
-
<td rowspan="1" colSpan="1" >8</td>
|
|
1121
|
-
|
|
1122
|
-
<td rowspan="1" colSpan="1" >空灵</td>
|
|
1123
|
-
</tr>
|
|
1124
|
-
|
|
1125
|
-
<tr>
|
|
1126
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_9</td>
|
|
1127
|
-
|
|
1128
|
-
<td rowspan="1" colSpan="1" >9</td>
|
|
1129
|
-
|
|
1130
|
-
<td rowspan="1" colSpan="1" >录音棚</td>
|
|
1131
|
-
</tr>
|
|
1132
|
-
|
|
1133
|
-
<tr>
|
|
1134
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_10</td>
|
|
1135
|
-
|
|
1136
|
-
<td rowspan="1" colSpan="1" >10</td>
|
|
1137
|
-
|
|
1138
|
-
<td rowspan="1" colSpan="1" >悠扬</td>
|
|
1139
|
-
</tr>
|
|
1140
|
-
|
|
1141
|
-
<tr>
|
|
1142
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceReverbType_11</td>
|
|
1143
|
-
|
|
1144
|
-
<td rowspan="1" colSpan="1" >11</td>
|
|
1145
|
-
|
|
1146
|
-
<td rowspan="1" colSpan="1" >录音棚2</td>
|
|
1147
|
-
</tr>
|
|
1148
|
-
</table>
|
|
1149
|
-
|
|
444
|
+
| 枚举 | 取值 | 描述 |
|
|
445
|
+
| --- | --- | --- |
|
|
446
|
+
| TXLiveVoiceReverbType_0 | 0 | 关闭特效 |
|
|
447
|
+
| TXLiveVoiceReverbType_1 | 1 | KTV |
|
|
448
|
+
| TXLiveVoiceReverbType_2 | 2 | 小房间 |
|
|
449
|
+
| TXLiveVoiceReverbType_3 | 3 | 大会堂 |
|
|
450
|
+
| TXLiveVoiceReverbType_4 | 4 | 低沉 |
|
|
451
|
+
| TXLiveVoiceReverbType_5 | 5 | 洪亮 |
|
|
452
|
+
| TXLiveVoiceReverbType_6 | 6 | 金属声 |
|
|
453
|
+
| TXLiveVoiceReverbType_7 | 7 | 磁性 |
|
|
454
|
+
| TXLiveVoiceReverbType_8 | 8 | 空灵 |
|
|
455
|
+
| TXLiveVoiceReverbType_9 | 9 | 录音棚 |
|
|
456
|
+
| TXLiveVoiceReverbType_10 | 10 | 悠扬 |
|
|
457
|
+
| TXLiveVoiceReverbType_11 | 11 | 录音棚2 |
|
|
1150
458
|
|
|
1151
459
|
## TXVoiceChangeType
|
|
1152
460
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
461
|
#### 变声特效
|
|
1156
462
|
|
|
1157
463
|
变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色,目前支持如下几种变声特效:
|
|
1158
464
|
|
|
1159
465
|
0:关闭;1:熊孩子;2:萝莉;3:大叔;4:重金属;5:感冒;6:外语腔;7:困兽;8:肥宅;9:强电流;10:重机械;11:空灵;12:猪八戒;13:绿巨人。
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
<tr>
|
|
1178
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_1</td>
|
|
1179
|
-
|
|
1180
|
-
<td rowspan="1" colSpan="1" >1</td>
|
|
1181
|
-
|
|
1182
|
-
<td rowspan="1" colSpan="1" >熊孩子</td>
|
|
1183
|
-
</tr>
|
|
1184
|
-
|
|
1185
|
-
<tr>
|
|
1186
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_2</td>
|
|
1187
|
-
|
|
1188
|
-
<td rowspan="1" colSpan="1" >2</td>
|
|
1189
|
-
|
|
1190
|
-
<td rowspan="1" colSpan="1" >萝莉</td>
|
|
1191
|
-
</tr>
|
|
1192
|
-
|
|
1193
|
-
<tr>
|
|
1194
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_3</td>
|
|
1195
|
-
|
|
1196
|
-
<td rowspan="1" colSpan="1" >3</td>
|
|
1197
|
-
|
|
1198
|
-
<td rowspan="1" colSpan="1" >大叔</td>
|
|
1199
|
-
</tr>
|
|
1200
|
-
|
|
1201
|
-
<tr>
|
|
1202
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_4</td>
|
|
1203
|
-
|
|
1204
|
-
<td rowspan="1" colSpan="1" >4</td>
|
|
1205
|
-
|
|
1206
|
-
<td rowspan="1" colSpan="1" >重金属</td>
|
|
1207
|
-
</tr>
|
|
1208
|
-
|
|
1209
|
-
<tr>
|
|
1210
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_5</td>
|
|
1211
|
-
|
|
1212
|
-
<td rowspan="1" colSpan="1" >5</td>
|
|
1213
|
-
|
|
1214
|
-
<td rowspan="1" colSpan="1" >感冒</td>
|
|
1215
|
-
</tr>
|
|
1216
|
-
|
|
1217
|
-
<tr>
|
|
1218
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_6</td>
|
|
1219
|
-
|
|
1220
|
-
<td rowspan="1" colSpan="1" >6</td>
|
|
1221
|
-
|
|
1222
|
-
<td rowspan="1" colSpan="1" >外语腔</td>
|
|
1223
|
-
</tr>
|
|
1224
|
-
|
|
1225
|
-
<tr>
|
|
1226
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_7</td>
|
|
1227
|
-
|
|
1228
|
-
<td rowspan="1" colSpan="1" >7</td>
|
|
1229
|
-
|
|
1230
|
-
<td rowspan="1" colSpan="1" >困兽</td>
|
|
1231
|
-
</tr>
|
|
1232
|
-
|
|
1233
|
-
<tr>
|
|
1234
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_8</td>
|
|
1235
|
-
|
|
1236
|
-
<td rowspan="1" colSpan="1" >8</td>
|
|
1237
|
-
|
|
1238
|
-
<td rowspan="1" colSpan="1" >肥宅</td>
|
|
1239
|
-
</tr>
|
|
1240
|
-
|
|
1241
|
-
<tr>
|
|
1242
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_9</td>
|
|
1243
|
-
|
|
1244
|
-
<td rowspan="1" colSpan="1" >9</td>
|
|
1245
|
-
|
|
1246
|
-
<td rowspan="1" colSpan="1" >强电流</td>
|
|
1247
|
-
</tr>
|
|
1248
|
-
|
|
1249
|
-
<tr>
|
|
1250
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_10</td>
|
|
1251
|
-
|
|
1252
|
-
<td rowspan="1" colSpan="1" >10</td>
|
|
1253
|
-
|
|
1254
|
-
<td rowspan="1" colSpan="1" >重机械</td>
|
|
1255
|
-
</tr>
|
|
1256
|
-
|
|
1257
|
-
<tr>
|
|
1258
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_11</td>
|
|
1259
|
-
|
|
1260
|
-
<td rowspan="1" colSpan="1" >11</td>
|
|
1261
|
-
|
|
1262
|
-
<td rowspan="1" colSpan="1" >空灵</td>
|
|
1263
|
-
</tr>
|
|
1264
|
-
|
|
1265
|
-
<tr>
|
|
1266
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_12</td>
|
|
1267
|
-
|
|
1268
|
-
<td rowspan="1" colSpan="1" >12</td>
|
|
1269
|
-
|
|
1270
|
-
<td rowspan="1" colSpan="1" >猪八戒</td>
|
|
1271
|
-
</tr>
|
|
1272
|
-
|
|
1273
|
-
<tr>
|
|
1274
|
-
<td rowspan="1" colSpan="1" >TXLiveVoiceChangerType_13</td>
|
|
1275
|
-
|
|
1276
|
-
<td rowspan="1" colSpan="1" >13</td>
|
|
1277
|
-
|
|
1278
|
-
<td rowspan="1" colSpan="1" >绿巨人</td>
|
|
1279
|
-
</tr>
|
|
1280
|
-
</table>
|
|
1281
|
-
|
|
466
|
+
| 枚举 | 取值 | 描述 |
|
|
467
|
+
| --- | --- | --- |
|
|
468
|
+
| TXLiveVoiceChangerType_0 | 0 | 关闭 |
|
|
469
|
+
| TXLiveVoiceChangerType_1 | 1 | 熊孩子 |
|
|
470
|
+
| TXLiveVoiceChangerType_2 | 2 | 萝莉 |
|
|
471
|
+
| TXLiveVoiceChangerType_3 | 3 | 大叔 |
|
|
472
|
+
| TXLiveVoiceChangerType_4 | 4 | 重金属 |
|
|
473
|
+
| TXLiveVoiceChangerType_5 | 5 | 感冒 |
|
|
474
|
+
| TXLiveVoiceChangerType_6 | 6 | 外语腔 |
|
|
475
|
+
| TXLiveVoiceChangerType_7 | 7 | 困兽 |
|
|
476
|
+
| TXLiveVoiceChangerType_8 | 8 | 肥宅 |
|
|
477
|
+
| TXLiveVoiceChangerType_9 | 9 | 强电流 |
|
|
478
|
+
| TXLiveVoiceChangerType_10 | 10 | 重机械 |
|
|
479
|
+
| TXLiveVoiceChangerType_11 | 11 | 空灵 |
|
|
480
|
+
| TXLiveVoiceChangerType_12 | 12 | 猪八戒 |
|
|
481
|
+
| TXLiveVoiceChangerType_13 | 13 | 绿巨人 |
|
|
1282
482
|
|
|
1283
483
|
## TXAudioMusicParam
|
|
1284
484
|
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
485
|
#### 背景音乐的播放控制信息
|
|
1288
486
|
|
|
1289
|
-
该信息用于在接口 [startPlayMusic
|
|
487
|
+
该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
|
|
1290
488
|
|
|
1291
489
|
1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
|
|
1292
490
|
|
|
1293
491
|
2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
|
|
1294
492
|
|
|
1295
493
|
3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
<td rowspan="1" colSpan="1" >【字段含义】音乐结束播放时间点,单位毫秒,0表示播放至文件结尾。</td>
|
|
1307
|
-
</tr>
|
|
1308
|
-
|
|
1309
|
-
<tr>
|
|
1310
|
-
<td rowspan="1" colSpan="1" >id</td>
|
|
1311
|
-
|
|
1312
|
-
<td rowspan="1" colSpan="1" >【字段含义】音乐 ID。<br>【特殊说明】SDK 允许播放多路音乐,因此需要使用 ID 进行标记,用于控制音乐的开始、停止、音量等。</td>
|
|
1313
|
-
</tr>
|
|
1314
|
-
|
|
1315
|
-
<tr>
|
|
1316
|
-
<td rowspan="1" colSpan="1" >isShortFile</td>
|
|
1317
|
-
|
|
1318
|
-
<td rowspan="1" colSpan="1" >【字段含义】播放的是否为短音乐文件。<br>【推荐取值】true:需要重复播放的短音乐文件;false:正常的音乐文件。默认值:false。</td>
|
|
1319
|
-
</tr>
|
|
1320
|
-
|
|
1321
|
-
<tr>
|
|
1322
|
-
<td rowspan="1" colSpan="1" >loopCount</td>
|
|
1323
|
-
|
|
1324
|
-
<td rowspan="1" colSpan="1" >【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数],默认值:0。0 表示播放音乐一次;1 表示播放音乐两次;以此类推。</td>
|
|
1325
|
-
</tr>
|
|
1326
|
-
|
|
1327
|
-
<tr>
|
|
1328
|
-
<td rowspan="1" colSpan="1" >path</td>
|
|
1329
|
-
|
|
1330
|
-
<td rowspan="1" colSpan="1" >【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。</td>
|
|
1331
|
-
</tr>
|
|
1332
|
-
|
|
1333
|
-
<tr>
|
|
1334
|
-
<td rowspan="1" colSpan="1" >publish</td>
|
|
1335
|
-
|
|
1336
|
-
<td rowspan="1" colSpan="1" >【字段含义】是否将音乐传到远端。<br>【推荐取值】true:音乐在本地播放的同时,远端用户也能听到该音乐;false:主播只能在本地听到该音乐,远端观众听不到。默认值:false。</td>
|
|
1337
|
-
</tr>
|
|
1338
|
-
|
|
1339
|
-
<tr>
|
|
1340
|
-
<td rowspan="1" colSpan="1" >startTimeMS</td>
|
|
1341
|
-
|
|
1342
|
-
<td rowspan="1" colSpan="1" >【字段含义】音乐开始播放时间点,单位:毫秒。</td>
|
|
1343
|
-
</tr>
|
|
1344
|
-
</table>
|
|
494
|
+
| 枚举类型 | 描述 |
|
|
495
|
+
| --- | --- |
|
|
496
|
+
| endTimeMS | 【字段含义】音乐结束播放时间点,单位毫秒,0表示播放至文件结尾。 |
|
|
497
|
+
| id | 【字段含义】音乐 ID。<br>【特殊说明】SDK 允许播放多路音乐,因此需要使用 ID 进行标记,用于控制音乐的开始、停止、音量等。 |
|
|
498
|
+
| isShortFile | 【字段含义】播放的是否为短音乐文件。<br>【推荐取值】true:需要重复播放的短音乐文件;false:正常的音乐文件。默认值:false。 |
|
|
499
|
+
| loopCount | 【字段含义】音乐循环播放的次数。<br>【推荐取值】取值范围为 [0, 任意正整数],默认值:0。0 表示播放音乐一次;1 表示播放音乐两次;以此类推。 |
|
|
500
|
+
| path | 【字段含义】音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。 |
|
|
501
|
+
| publish | 【字段含义】是否将音乐传到远端。<br>【推荐取值】true:音乐在本地播放的同时,远端用户也能听到该音乐;false:主播只能在本地听到该音乐,远端观众听不到。默认值:false。 |
|
|
502
|
+
| startTimeMS | 【字段含义】音乐开始播放时间点,单位:毫秒。 |
|