@tencent-rtc/mcp 1.3.9 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
- package/resource/doc/callkit/preset/android/api.md +296 -0
- package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
- package/resource/doc/callkit/preset/flutter/api.md +410 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
- package/resource/doc/callkit/preset/ios/api.md +80 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
- package/resource/doc/callkit/preset/react/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
- package/resource/doc/callkit/preset/vue/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
- package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
- 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 +118 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
- package/resource/doc/chatkit/react/components/search.md +243 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
- package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
- 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 -492
- 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 +2 -223
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
- 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 +28 -141
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
- 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 +94 -344
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
- 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 +10 -49
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -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 -34
- package/resource/doc/roomkit/vue/features/room-view.md +30 -125
- 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 -29
- package/resource/doc/roomkit/vue/integration.md +21 -76
- package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
- package/resource/doc/rtcengine/faq/web/web.md +14 -24
- package/resource/doc/rtcengine/web/api.md +1 -3
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
- 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 -5
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
- package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
- package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
- package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
- package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
- package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
- 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 +114 -892
- package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
- 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/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 +29 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +17 -18
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
- 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 -41
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +34 -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 -22
- 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 +15 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +30 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +24 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -61
- 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 +2 -2
- package/resource/doc/chatuikit/android/workflow.md +0 -713
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
- package/resource/doc/chatuikit/flutter/workflow.md +0 -941
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
- package/resource/doc/chatuikit/react/components/search.md +0 -745
- package/resource/doc/chatuikit/react/create-group.md +0 -23
- package/resource/doc/chatuikit/react/init.md +0 -26
- package/resource/doc/chatuikit/react/workflow.md +0 -258
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/create-group.md +0 -25
- package/resource/doc/chatuikit/vue/init.md +0 -40
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -320
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -454
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
- package/resource/doc/livekit/live/vue/workflow.md +0 -218
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
- 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 -865
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -733
- package/resource/doc/tuicallkit/android/workflow.md +0 -441
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1404
- package/resource/doc/tuicallkit/vue/api.md +0 -1406
- package/resource/doc/tuicallkit/vue/faq.md +0 -36
- 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/present-scenario-choice.js +0 -16
- package/tools/common/present-scenario-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 -23
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
- 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 -75
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -16
- 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 -92
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_state_detail_def.js +0 -19
- package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
- package/tools/definitions/present_scenario_choice_def.js +0 -53
- package/tools/definitions/present_scenario_choice_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -58
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -46
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -177
- 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 -194
- 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/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
- /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
- /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/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
- /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
This document aims to guide you on how to use the `AtomicXCore` framework's `AudioEffectStore` and `DeviceStore` modules to quickly integrate audio effect control features for your live stream app, including Microphone Volume, listen, and add multiple fun voice-changing effects and reverb effects.
|
|
2
2
|
|
|
3
|
-

|
|
4
|
-
|
|
5
|
-
|
|
6
3
|
## Core Features
|
|
7
4
|
|
|
8
5
|
By combining `AudioEffectStore` and `DeviceStore`, you can implement the following core features:
|
|
@@ -14,58 +11,20 @@ By combining `AudioEffectStore` and `DeviceStore`, you can implement the followi
|
|
|
14
11
|
|
|
15
12
|
- **Reverb effect**: Simulates sound field effects in different environments, such as KTV, metallic sound, deep, and resonant.
|
|
16
13
|
|
|
17
|
-
|
|
18
14
|
## Conceptual Introduction
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
<td rowspan="1" colSpan="1" >**Core Responsibilities and Description**</td>
|
|
26
|
-
</tr>
|
|
27
|
-
|
|
28
|
-
<tr>
|
|
29
|
-
<td rowspan="1" colSpan="1" >[AudioEffectState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectState-class.html)</td>
|
|
30
|
-
|
|
31
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
32
|
-
|
|
33
|
-
<td rowspan="1" colSpan="1" >Represents the current status of the audio effect module, usually used for UI rendering. Includes voice-changing status, reverberation status, ear return enabled status, ear return volume. All attributes are `ValueListenable` data type, support subscription listen.</td>
|
|
34
|
-
</tr>
|
|
35
|
-
|
|
36
|
-
<tr>
|
|
37
|
-
<td rowspan="1" colSpan="1" >[AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html)</td>
|
|
38
|
-
|
|
39
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
40
|
-
|
|
41
|
-
<td rowspan="1" colSpan="1" >Represents the **singleton data management class** of the audio effect module. Through it you can call the audio effect API to modify sound effects. When you call the API, the appropriate `audioEffectState` property will auto-update. You can subscribe to this state's responsive data to receive and listen for status updates.</td>
|
|
42
|
-
</tr>
|
|
43
|
-
|
|
44
|
-
<tr>
|
|
45
|
-
<td rowspan="1" colSpan="1" >[DeviceState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceState-class.html)</td>
|
|
46
|
-
|
|
47
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
48
|
-
|
|
49
|
-
<td rowspan="1" colSpan="1" >Represents the current status of the device module, usually used for UI rendering. Core attributes include device status of camera, microphone, capturing volume. All attributes are `ValueListenable` data type, support subscription listen.</td>
|
|
50
|
-
</tr>
|
|
51
|
-
|
|
52
|
-
<tr>
|
|
53
|
-
<td rowspan="1" colSpan="1" >[DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html)</td>
|
|
54
|
-
|
|
55
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
56
|
-
|
|
57
|
-
<td rowspan="1" colSpan="1" >Represents the **singleton data management class** of the device module. Through it you can call the API to operate camera and microphone. When you call the API, the appropriate `state` property will auto-update. You can subscribe to this state's responsive data to receive and listen for status updates.</td>
|
|
58
|
-
</tr>
|
|
59
|
-
</table>
|
|
60
|
-
|
|
15
|
+
| **Core Concept** | **Type** | **Core Responsibilities and Description** |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| [AudioEffectState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectState-class.html) | `class` | Represents the current status of the audio effect module, usually used for UI rendering. Includes voice-changing status, reverberation status, ear return enabled status, ear return volume. All attributes are `ValueListenable` data type, support subscription listen. |
|
|
18
|
+
| [AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html) | `class` | Represents the **singleton data management class** of the audio effect module. Through it you can call the audio effect API to modify sound effects. When you call the API, the appropriate `audioEffectState` property will auto-update. You can subscribe to this state's responsive data to receive and listen for status updates. |
|
|
19
|
+
| [DeviceState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceState-class.html) | `class` | Represents the current status of the device module, usually used for UI rendering. Core attributes include device status of camera, microphone, capturing volume. All attributes are `ValueListenable` data type, support subscription listen. |
|
|
20
|
+
| [DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html) | `class` | Represents the **singleton data management class** of the device module. Through it you can call the API to operate camera and microphone. When you call the API, the appropriate `state` property will auto-update. You can subscribe to this state's responsive data to receive and listen for status updates. |
|
|
61
21
|
|
|
62
22
|
## Implementation Steps
|
|
63
23
|
|
|
64
24
|
### Step 1: Integrating the Component
|
|
65
|
-
- **Live streaming**: Refer to
|
|
66
|
-
|
|
67
|
-
- **Voice chat room**: Refer to [quick integration](https://write.woa.com/document/200555778169073664) to integrate **AtomicXCore** and complete service access.
|
|
25
|
+
- **Live streaming**: Refer to quick integration to integrate **AtomicXCore** and complete service access.
|
|
68
26
|
|
|
27
|
+
- **Voice chat room**: Refer to quick integration to integrate **AtomicXCore** and complete service access.
|
|
69
28
|
|
|
70
29
|
### Step 2: Obtain a Store Instance
|
|
71
30
|
|
|
@@ -85,11 +44,10 @@ class _AudioEffectPanelWidgetState {
|
|
|
85
44
|
Ear monitoring function allows users to monitor their own microphone sound in real time. Calling the API introduced in this section can manage the ear monitoring function.
|
|
86
45
|
|
|
87
46
|
> **Note:**
|
|
88
|
-
>
|
|
47
|
+
>
|
|
89
48
|
|
|
90
49
|
> The in-ear monitoring feature typically needs to connect to headphones to work properly.
|
|
91
|
-
>
|
|
92
|
-
|
|
50
|
+
>
|
|
93
51
|
|
|
94
52
|
#### Implementation Method
|
|
95
53
|
1. **Enable/Disable Ear Monitoring**: You can use the `Switch` control to implement the ear monitoring function.
|
|
@@ -98,7 +56,6 @@ Ear monitoring function allows users to monitor their own microphone sound in re
|
|
|
98
56
|
|
|
99
57
|
3. **Listen for Status Updates to Update UI**: You can subscribe to real-time ear monitoring status value updates to refresh the UI.
|
|
100
58
|
|
|
101
|
-
|
|
102
59
|
#### Sample Code
|
|
103
60
|
``` java
|
|
104
61
|
import 'package:flutter/material.dart';
|
|
@@ -155,44 +112,14 @@ class EarMonitorWidget extends StatelessWidget {
|
|
|
155
112
|
```
|
|
156
113
|
|
|
157
114
|
#### SetVoiceEarMonitorEnable API Parameter
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
163
|
-
|
|
164
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
165
|
-
</tr>
|
|
166
|
-
|
|
167
|
-
<tr>
|
|
168
|
-
<td rowspan="1" colSpan="1" >`enable`</td>
|
|
169
|
-
|
|
170
|
-
<td rowspan="1" colSpan="1" >`bool`</td>
|
|
171
|
-
|
|
172
|
-
<td rowspan="1" colSpan="1" >Enable earpiece feedback.<br>- true: Enable<br>- false: Disable</td>
|
|
173
|
-
</tr>
|
|
174
|
-
</table>
|
|
175
|
-
|
|
115
|
+
| **Parameter Name** | **Type** | **Description** |
|
|
116
|
+
| --- | --- | --- |
|
|
117
|
+
| `enable` | `bool` | Enable earpiece feedback.<br>- true: Enable<br>- false: Disable |
|
|
176
118
|
|
|
177
119
|
#### SetVoiceEarMonitorVolume API Parameter
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
183
|
-
|
|
184
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
185
|
-
</tr>
|
|
186
|
-
|
|
187
|
-
<tr>
|
|
188
|
-
<td rowspan="1" colSpan="1" >`volume`</td>
|
|
189
|
-
|
|
190
|
-
<td rowspan="1" colSpan="1" >`int`</td>
|
|
191
|
-
|
|
192
|
-
<td rowspan="1" colSpan="1" >Ear return volume.<br>- Value ranges from 0 to 150.<br>- Default value: 100.</td>
|
|
193
|
-
</tr>
|
|
194
|
-
</table>
|
|
195
|
-
|
|
120
|
+
| **Parameter Name** | **Type** | **Description** |
|
|
121
|
+
| --- | --- | --- |
|
|
122
|
+
| `volume` | `int` | Ear return volume.<br>- Value ranges from 0 to 150.<br>- Default value: 100. |
|
|
196
123
|
|
|
197
124
|
### Step 4: Implement Vocal Volume Adjustment
|
|
198
125
|
|
|
@@ -203,7 +130,6 @@ When the Anchor hopes to adjust their own uplink capturing volume, call the `Dev
|
|
|
203
130
|
|
|
204
131
|
2. **Listen for Status Updates to Update UI**: You can subscribe to real-time volume level status value updates to refresh the UI.
|
|
205
132
|
|
|
206
|
-
|
|
207
133
|
#### Sample Code
|
|
208
134
|
``` java
|
|
209
135
|
import 'package:flutter/material.dart';
|
|
@@ -240,24 +166,9 @@ class CaptureVolumeWidget extends StatelessWidget {
|
|
|
240
166
|
```
|
|
241
167
|
|
|
242
168
|
#### SetCaptureVolume API Parameter
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
248
|
-
|
|
249
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
250
|
-
</tr>
|
|
251
|
-
|
|
252
|
-
<tr>
|
|
253
|
-
<td rowspan="1" colSpan="1" >`volume`</td>
|
|
254
|
-
|
|
255
|
-
<td rowspan="1" colSpan="1" >`int`</td>
|
|
256
|
-
|
|
257
|
-
<td rowspan="1" colSpan="1" >Capture volume size.<br>- Value ranges from 0 to 150.<br>- Default value: 100.</td>
|
|
258
|
-
</tr>
|
|
259
|
-
</table>
|
|
260
|
-
|
|
169
|
+
| **Parameter Name** | **Type** | **Description** |
|
|
170
|
+
| --- | --- | --- |
|
|
171
|
+
| `volume` | `int` | Capture volume size.<br>- Value ranges from 0 to 150.<br>- Default value: 100. |
|
|
261
172
|
|
|
262
173
|
### Step 5: Implement Voice-Changing Effects
|
|
263
174
|
|
|
@@ -328,24 +239,9 @@ class VoiceChangerWidget extends StatelessWidget {
|
|
|
328
239
|
```
|
|
329
240
|
|
|
330
241
|
#### SetAudioChangerType API Parameter
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
336
|
-
|
|
337
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
338
|
-
</tr>
|
|
339
|
-
|
|
340
|
-
<tr>
|
|
341
|
-
<td rowspan="1" colSpan="1" >`type`</td>
|
|
342
|
-
|
|
343
|
-
<td rowspan="1" colSpan="1" >[AudioChangerType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioChangerType.html)</td>
|
|
344
|
-
|
|
345
|
-
<td rowspan="1" colSpan="1" >Voice-changing effects enumeration.</td>
|
|
346
|
-
</tr>
|
|
347
|
-
</table>
|
|
348
|
-
|
|
242
|
+
| **Parameter Name** | **Type** | **Description** |
|
|
243
|
+
| --- | --- | --- |
|
|
244
|
+
| `type` | [AudioChangerType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioChangerType.html) | Voice-changing effects enumeration. |
|
|
349
245
|
|
|
350
246
|
### Step 6: Implement Reverb Effect
|
|
351
247
|
|
|
@@ -424,33 +320,17 @@ class ReverbWidget extends StatelessWidget {
|
|
|
424
320
|
```
|
|
425
321
|
|
|
426
322
|
#### SetAudioReverbType API Parameter
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
432
|
-
|
|
433
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
434
|
-
</tr>
|
|
435
|
-
|
|
436
|
-
<tr>
|
|
437
|
-
<td rowspan="1" colSpan="1" >`type`</td>
|
|
438
|
-
|
|
439
|
-
<td rowspan="1" colSpan="1" >[AudioReverbType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioReverbType.html)</td>
|
|
440
|
-
|
|
441
|
-
<td rowspan="1" colSpan="1" >Reverb effects enumeration.</td>
|
|
442
|
-
</tr>
|
|
443
|
-
</table>
|
|
444
|
-
|
|
323
|
+
| **Parameter Name** | **Type** | **Description** |
|
|
324
|
+
| --- | --- | --- |
|
|
325
|
+
| `type` | [AudioReverbType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioReverbType.html) | Reverb effects enumeration. |
|
|
445
326
|
|
|
446
327
|
### Step 7: Reset Sound Effect Settings
|
|
447
328
|
|
|
448
329
|
> **Important:**
|
|
449
|
-
>
|
|
330
|
+
>
|
|
450
331
|
|
|
451
332
|
> AudioEffectStore and DeviceStore are singletons, so audio effects and device settings take effect globally. If you do not want the settings of the current live streaming room to affect other live streaming rooms created later, you need to reset the audio effects and device settings when the current live streaming room ends.
|
|
452
|
-
>
|
|
453
|
-
|
|
333
|
+
>
|
|
454
334
|
|
|
455
335
|
You may need to reset sound effect settings in the following two scenarios:
|
|
456
336
|
1. **When the current live streaming room ends**, call the `store`'s `reset()` method to reset sound effects.
|
|
@@ -460,16 +340,16 @@ You may need to reset sound effect settings in the following two scenarios:
|
|
|
460
340
|
``` java
|
|
461
341
|
import 'package:flutter/material.dart';
|
|
462
342
|
import 'package:atomic_x_core/atomicxcore.dart';
|
|
463
|
-
|
|
343
|
+
|
|
464
344
|
/// Sound effect reset component
|
|
465
345
|
class AudioEffectResetWidget extends StatelessWidget {
|
|
466
346
|
const AudioEffectResetWidget({super.key});
|
|
467
|
-
|
|
347
|
+
|
|
468
348
|
void _resetAudioEffect() {
|
|
469
349
|
AudioEffectStore.shared.reset();
|
|
470
350
|
DeviceStore.shared.reset();
|
|
471
351
|
}
|
|
472
|
-
|
|
352
|
+
|
|
473
353
|
@override
|
|
474
354
|
Widget build(BuildContext context) {
|
|
475
355
|
return ElevatedButton(
|
|
@@ -681,32 +561,10 @@ class AudioEffectPage extends StatelessWidget {
|
|
|
681
561
|
## API documentation
|
|
682
562
|
|
|
683
563
|
For detailed information about all public interfaces and attributes of [AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html), [DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html) and its related classes, see the official API documentation of the [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Flutter/index.html) framework.
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
<td rowspan="1" colSpan="1" >**Feature Description**</td>
|
|
689
|
-
|
|
690
|
-
<td rowspan="1" colSpan="1" >**API Reference**</td>
|
|
691
|
-
</tr>
|
|
692
|
-
|
|
693
|
-
<tr>
|
|
694
|
-
<td rowspan="1" colSpan="1" >**AudioEffectStore**</td>
|
|
695
|
-
|
|
696
|
-
<td rowspan="1" colSpan="1" >Audio effect management: Perform audio effect settings and obtain real-time audio effect status.</td>
|
|
697
|
-
|
|
698
|
-
<td rowspan="1" colSpan="1" >[API documentation](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html)</td>
|
|
699
|
-
</tr>
|
|
700
|
-
|
|
701
|
-
<tr>
|
|
702
|
-
<td rowspan="1" colSpan="1" >**DeviceStore**</td>
|
|
703
|
-
|
|
704
|
-
<td rowspan="1" colSpan="1" >Device management: perform camera and microphone operations and obtain real-time device status.</td>
|
|
705
|
-
|
|
706
|
-
<td rowspan="1" colSpan="1" >[API documentation](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html)</td>
|
|
707
|
-
</tr>
|
|
708
|
-
</table>
|
|
709
|
-
|
|
564
|
+
| **Store/Component** | **Feature Description** | **API Reference** |
|
|
565
|
+
| --- | --- | --- |
|
|
566
|
+
| **AudioEffectStore** | Audio effect management: Perform audio effect settings and obtain real-time audio effect status. | [API documentation](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html) |
|
|
567
|
+
| **DeviceStore** | Device management: perform camera and microphone operations and obtain real-time device status. | [API documentation](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html) |
|
|
710
568
|
|
|
711
569
|
## FAQs
|
|
712
570
|
|
|
@@ -721,7 +579,6 @@ This is a very important and confusing concept. The difference is as follows:
|
|
|
721
579
|
|
|
722
580
|
- **Ear Return Volume (EarMonitorVolume):** Set via `AudioEffectStore.shared.setVoiceEarMonitorVolume()`. It only determines the Anchor's headphone monitoring volume and **does not** impact the audience.
|
|
723
581
|
|
|
724
|
-
|
|
725
582
|
### Why Does a Newly Created Live Streaming Room Have Sound Effects Directly or Issues Like Very High or Low Volume?
|
|
726
583
|
|
|
727
584
|
`AudioEffectStore` and `DeviceStore` are singletons, which means audio effects and device settings take effect globally. This situation probably occurs because you set audio effects earlier but did not reset them. You need to call the `reset()` method in an appropriate place.
|
|
@@ -735,8 +592,6 @@ Please check by the following steps:
|
|
|
735
592
|
|
|
736
593
|
3. **Is the microphone enabled**: Confirm that the microphone in `DeviceStore` is enabled (the `openLocalMicrophone()` call has been made).
|
|
737
594
|
|
|
738
|
-
|
|
739
595
|
### Can Voice-Changing Effects and Reverb Effects Take Effect at the Same Time?
|
|
740
596
|
|
|
741
597
|
Yes. `AudioChangerType` and `AudioReverbType` can take effect in superposition. For example, you can simultaneously set `AudioChangerType.girl` voice-changing and `AudioReverbType.ktv` reverb.
|
|
742
|
-
|
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
This document aims to guide Flutter developers on how to use the `BarrageStore` module in the `AtomicXCore` framework to quickly integrate a bullet screen system with various features and outstanding performance for your live stream app.
|
|
2
2
|
|
|
3
|
-

|
|
4
|
-
|
|
5
|
-
|
|
6
3
|
## Core Features
|
|
7
4
|
|
|
8
5
|
`BarrageStore` provides a complete bullet screen solution for your live stream app. Core features include:
|
|
@@ -14,54 +11,22 @@ This document aims to guide Flutter developers on how to use the `BarrageStore`
|
|
|
14
11
|
|
|
15
12
|
- Insert a system prompt in the local message list (for example, "Welcome XX to enter live room").
|
|
16
13
|
|
|
17
|
-
|
|
18
14
|
## Core Concept Analysis
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
<td rowspan="1" colSpan="1" >**Core Responsibility and Description**</td>
|
|
26
|
-
</tr>
|
|
27
|
-
|
|
28
|
-
<tr>
|
|
29
|
-
<td rowspan="1" colSpan="1" >[Barrage](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/Barrage-class.html)</td>
|
|
30
|
-
|
|
31
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
32
|
-
|
|
33
|
-
<td rowspan="1" colSpan="1" >Represents a data model for a Danmu Message. It contains all key information such as sender information (`sender`), message content (`textContent` or `data`), and message type (`messageType`).</td>
|
|
34
|
-
</tr>
|
|
35
|
-
|
|
36
|
-
<tr>
|
|
37
|
-
<td rowspan="1" colSpan="1" >[BarrageState](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageState-class.html)</td>
|
|
38
|
-
|
|
39
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
40
|
-
|
|
41
|
-
<td rowspan="1" colSpan="1" >Represents the current status of the bullet screen module. Its core attribute `messageList` is a `ValueListenable<List<Barrage>>`, storing all Danmu messages in the live streaming room in chronological order, serving as the data source for UI rendering.</td>
|
|
42
|
-
</tr>
|
|
43
|
-
|
|
44
|
-
<tr>
|
|
45
|
-
<td rowspan="1" colSpan="1" >[BarrageStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageStore-class.html)</td>
|
|
46
|
-
|
|
47
|
-
<td rowspan="1" colSpan="1" >`class`</td>
|
|
48
|
-
|
|
49
|
-
<td rowspan="1" colSpan="1" >This is the core management class for danmu function interaction. Through it, you can send messages (`sendTextMessage`, `sendCustomMessage`) and receive and listen to ALL Danmu Message updates by listening to its `barrageState.messageList` property.</td>
|
|
50
|
-
</tr>
|
|
51
|
-
</table>
|
|
52
|
-
|
|
15
|
+
| **Core Concept** | **Type** | **Core Responsibility and Description** |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| [Barrage](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/Barrage-class.html) | `class` | Represents a data model for a Danmu Message. It contains all key information such as sender information (`sender`), message content (`textContent` or `data`), and message type (`messageType`). |
|
|
18
|
+
| [BarrageState](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageState-class.html) | `class` | Represents the current status of the bullet screen module. Its core attribute `messageList` is a `ValueListenable<List<Barrage>>`, storing all Danmu messages in the live streaming room in chronological order, serving as the data source for UI rendering. |
|
|
19
|
+
| [BarrageStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageStore-class.html) | `class` | This is the core management class for danmu function interaction. Through it, you can send messages (`sendTextMessage`, `sendCustomMessage`) and receive and listen to ALL Danmu Message updates by listening to its `barrageState.messageList` property. |
|
|
53
20
|
|
|
54
21
|
## Implementation Steps
|
|
55
22
|
|
|
56
23
|
### Step 1: Integrating the Component
|
|
57
|
-
- **Live streaming**: Refer to
|
|
58
|
-
|
|
59
|
-
- **Voice chat room**: Refer to [quick integration](https://write.woa.com/document/200555778169073664) for seamless integration with **AtomicXCore** and service access.
|
|
24
|
+
- **Live streaming**: Refer to quick integration for seamless integration with **AtomicXCore** and service access.
|
|
60
25
|
|
|
26
|
+
- **Voice chat room**: Refer to quick integration for seamless integration with **AtomicXCore** and service access.
|
|
61
27
|
|
|
62
28
|
Return to the current project after integration.
|
|
63
29
|
|
|
64
|
-
|
|
65
30
|
### Step 2: Initialize and Listen to the Bullet Screen
|
|
66
31
|
|
|
67
32
|
Retrieve a `BarrageStore` instance bound to the current live streaming room `liveId`, and set a listener to receive the latest **Full** barrage message list in real time.
|
|
@@ -75,7 +40,7 @@ class BarrageManager {
|
|
|
75
40
|
late final VoidCallback _messageListChangedListener = _onMessageListChanged;
|
|
76
41
|
|
|
77
42
|
// Expose message list change notification to the public
|
|
78
|
-
final ValueNotifier<List<Barrage>> messagesNotifier =
|
|
43
|
+
final ValueNotifier<List<Barrage>> messagesNotifier =
|
|
79
44
|
ValueNotifier<List<Barrage>>([]);
|
|
80
45
|
|
|
81
46
|
BarrageManager({required this.liveId}) {
|
|
@@ -134,32 +99,10 @@ extension BarrageManagerSend on BarrageManager {
|
|
|
134
99
|
```
|
|
135
100
|
|
|
136
101
|
**API parameter:**
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
142
|
-
|
|
143
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
144
|
-
</tr>
|
|
145
|
-
|
|
146
|
-
<tr>
|
|
147
|
-
<td rowspan="1" colSpan="1" >`text`</td>
|
|
148
|
-
|
|
149
|
-
<td rowspan="1" colSpan="1" >`String`</td>
|
|
150
|
-
|
|
151
|
-
<td rowspan="1" colSpan="1" >The text content to be sent.</td>
|
|
152
|
-
</tr>
|
|
153
|
-
|
|
154
|
-
<tr>
|
|
155
|
-
<td rowspan="1" colSpan="1" >`extensionInfo`</td>
|
|
156
|
-
|
|
157
|
-
<td rowspan="1" colSpan="1" >`Map<String, String>?`</td>
|
|
158
|
-
|
|
159
|
-
<td rowspan="1" colSpan="1" >Attach extra extended information applicable to business customization.</td>
|
|
160
|
-
</tr>
|
|
161
|
-
</table>
|
|
162
|
-
|
|
102
|
+
| **Parameter** | **Type** | **Description** |
|
|
103
|
+
| --- | --- | --- |
|
|
104
|
+
| `text` | `String` | The text content to be sent. |
|
|
105
|
+
| `extensionInfo` | `Map<String, String>?` | Attach extra extended information applicable to business customization. |
|
|
163
106
|
|
|
164
107
|
### Step 4: Send Custom Barrage Item
|
|
165
108
|
|
|
@@ -196,32 +139,10 @@ extension BarrageManagerCustom on BarrageManager {
|
|
|
196
139
|
```
|
|
197
140
|
|
|
198
141
|
**API parameter:**
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
<td rowspan="1" colSpan="1" >**Type**</td>
|
|
204
|
-
|
|
205
|
-
<td rowspan="1" colSpan="1" >**Description**</td>
|
|
206
|
-
</tr>
|
|
207
|
-
|
|
208
|
-
<tr>
|
|
209
|
-
<td rowspan="1" colSpan="1" >`businessID`</td>
|
|
210
|
-
|
|
211
|
-
<td rowspan="1" colSpan="1" >`String`</td>
|
|
212
|
-
|
|
213
|
-
<td rowspan="1" colSpan="1" >Business unique identifier, such as "live_gift", used for recipient to distinguish different custom messages.</td>
|
|
214
|
-
</tr>
|
|
215
|
-
|
|
216
|
-
<tr>
|
|
217
|
-
<td rowspan="1" colSpan="1" >`data`</td>
|
|
218
|
-
|
|
219
|
-
<td rowspan="1" colSpan="1" >`String`</td>
|
|
220
|
-
|
|
221
|
-
<td rowspan="1" colSpan="1" >Business data, typically strings in JSON format.</td>
|
|
222
|
-
</tr>
|
|
223
|
-
</table>
|
|
224
|
-
|
|
142
|
+
| **Parameter** | **Type** | **Description** |
|
|
143
|
+
| --- | --- | --- |
|
|
144
|
+
| `businessID` | `String` | Business unique identifier, such as "live_gift", used for recipient to distinguish different custom messages. |
|
|
145
|
+
| `data` | `String` | Business data, typically strings in JSON format. |
|
|
225
146
|
|
|
226
147
|
### Step 5: Insert Prompt Message Locally
|
|
227
148
|
|
|
@@ -480,7 +401,7 @@ class BarrageUIManager {
|
|
|
480
401
|
if (newList == null) return;
|
|
481
402
|
|
|
482
403
|
_latestMessageList = null; // Clear flags to avoid repeated refresh
|
|
483
|
-
|
|
404
|
+
|
|
484
405
|
// Update data source and refresh UI
|
|
485
406
|
onUpdate(newList);
|
|
486
407
|
}
|
|
@@ -513,7 +434,7 @@ void _refreshUIIfNeeded() {
|
|
|
513
434
|
|
|
514
435
|
// Key point: Take the latest N messages
|
|
515
436
|
const capacity = 500; // The client keeps the latest 500 messages only
|
|
516
|
-
final cappedList = fullList.length > capacity
|
|
437
|
+
final cappedList = fullList.length > capacity
|
|
517
438
|
? fullList.sublist(fullList.length - capacity)
|
|
518
439
|
: fullList;
|
|
519
440
|
|
|
@@ -541,7 +462,6 @@ This is actually achieved by the custom message `sendCustomMessage`. `BarrageSto
|
|
|
541
462
|
|
|
542
463
|
3. **Receiver**: After receiving the Danmu Message, check whether its `messageType` is `.custom` and whether `businessId` matches. If matched, parse the `data` string (usually parsing JSON), and render your custom UI style based on the parsed data (such as `color, text`).
|
|
543
464
|
|
|
544
|
-
|
|
545
465
|
### Different Classes and Files Call `BarrageStore.create("some_id")`. Will This Create Multiple Instances and Cause Chaos?
|
|
546
466
|
|
|
547
467
|
No worries at all. `AtomicXCore`'s internal mechanism will underwrite that as long as the `liveId` passed in is identical, the `BarrageStore` instance obtained will always be the same one bound to the live streaming room. You can use it wherever required without manually managing the singleton.
|
|
@@ -557,7 +477,6 @@ No worries at all. `AtomicXCore`'s internal mechanism will underwrite that as lo
|
|
|
557
477
|
|
|
558
478
|
4. **Network issue**: Check whether the current network connection of the device is normal. Sending messages depends on the network.
|
|
559
479
|
|
|
560
|
-
|
|
561
480
|
### How to Show New Audience the History Danmu Messages When They Enter the Live Room
|
|
562
481
|
|
|
563
482
|
`AtomicXCore` supports pulling history Danmu Messages, but this requires you to perform one simple configuration in the **server console**. Once configured, the SDK will automatically handle everything subsequently with no need to write additional code.
|
|
@@ -567,15 +486,8 @@ No worries at all. `AtomicXCore`'s internal mechanism will underwrite that as lo
|
|
|
567
486
|
|
|
568
487
|
2. On the Live configuration page, select **new member pull historical messages**, modify **new member viewable latest message count**, supports a maximum of **50**.
|
|
569
488
|
|
|
570
|
-

|
|
571
|
-
|
|
572
|
-
|
|
573
489
|
**Step 2: Client Seamless Retrieval**
|
|
574
490
|
|
|
575
|
-
|
|
576
|
-
After completing the above configuration, your client-side code **requires no modification**.
|
|
577
|
-
|
|
491
|
+
After completing the above configuration, your client-side code **requires no modification**.
|
|
578
492
|
|
|
579
493
|
When a new user joins the live room, the `AtomicXCore` underlying layer will automatically pull your configuration history message count. These historical messages will be pushed to your UI layer through your realized `BarrageStore.barrageState` subscription channel, just like real-time messages. Your application will naturally receive and show these historical bullet screens, same as receiving real-time bullet screens.
|
|
580
|
-
|
|
581
|
-
|