@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -12
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +6 -5
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- 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.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -40
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -1,120 +1,125 @@
|
|
|
1
|
-
|
|
1
|
+
Copyright (c) 2021 Tencent. All rights reserved.
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Module: TRTCCloud @ TXLiteAVSDK
|
|
4
|
+
|
|
5
|
+
Function: 腾讯云 TRTC 主功能接口
|
|
6
|
+
|
|
7
|
+
Version: 13.3
|
|
5
8
|
|
|
6
9
|
## TRTCCloud
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
|
|
|
21
|
-
|
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
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
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
90
|
-
|
|
|
91
|
-
|
|
|
92
|
-
|
|
|
93
|
-
|
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
10
|
+
|
|
11
|
+
|函数列表|描述|
|
|
12
|
+
|---------|---------|
|
|
13
|
+
|sharedInstance|创建 TRTCCloud 实例(单例模式)。|
|
|
14
|
+
|destroySharedInstance|销毁 TRTCCloud 实例(单例模式)。|
|
|
15
|
+
|addListener|添加 TRTC 事件回调。|
|
|
16
|
+
|removeListener|移除 TRTC 事件回调。|
|
|
17
|
+
|setListenerHandler|设置驱动 TRTCCloudListener 事件回调的队列。|
|
|
18
|
+
|enterRoom|进入房间。|
|
|
19
|
+
|exitRoom|离开房间。|
|
|
20
|
+
|switchRole|切换角色。|
|
|
21
|
+
|switchRole|切换角色(支持设置权限位)。|
|
|
22
|
+
|switchRoom|切换房间。|
|
|
23
|
+
|ConnectOtherRoom|请求跨房通话。|
|
|
24
|
+
|DisconnectOtherRoom|退出跨房通话。|
|
|
25
|
+
|setDefaultStreamRecvMode|设置订阅模式(需要在进入房前设置才能生效)。|
|
|
26
|
+
|createSubCloud|创建子房间实例(用于多房间并发观看)。|
|
|
27
|
+
|destroySubCloud|销毁子房间实例。|
|
|
28
|
+
|updateOtherRoomForwardMode|更改跨房主播在本房间的上行能力。|
|
|
29
|
+
|startPublishMediaStream|开始发布媒体流。|
|
|
30
|
+
|updatePublishMediaStream|更新发布媒体流。|
|
|
31
|
+
|stopPublishMediaStream|停止发布媒体流。|
|
|
32
|
+
|startLocalPreview|开启本地摄像头的预览画面(移动端)。|
|
|
33
|
+
|updateLocalView|更新本地摄像头的预览画面。|
|
|
34
|
+
|stopLocalPreview|停止摄像头预览。|
|
|
35
|
+
|muteLocalVideo|暂停/恢复发布本地的视频流。|
|
|
36
|
+
|setVideoMuteImage|设置本地画面被暂停期间的替代图片。|
|
|
37
|
+
|startRemoteView|订阅远端用户的视频流,并绑定视频渲染控件。|
|
|
38
|
+
|updateRemoteView|更新远端用户的视频渲染控件。|
|
|
39
|
+
|stopRemoteView|停止订阅远端用户的视频流,并释放渲染控件。|
|
|
40
|
+
|stopAllRemoteView|停止订阅所有远端用户的视频流,并释放全部渲染资源。|
|
|
41
|
+
|muteRemoteVideoStream|暂停/恢复订阅远端用户的视频流。|
|
|
42
|
+
|muteAllRemoteVideoStreams|暂停/恢复订阅所有远端用户的视频流。|
|
|
43
|
+
|setVideoEncoderParam|设置视频编码器的编码参数。|
|
|
44
|
+
|setNetworkQosParam|设置网络质量控制的相关参数。|
|
|
45
|
+
|setLocalRenderParams|设置本地画面的渲染参数。|
|
|
46
|
+
|setRemoteRenderParams|设置远端画面的渲染模式。|
|
|
47
|
+
|enableEncSmallVideoStream|开启大小画面双路编码模式。|
|
|
48
|
+
|setRemoteVideoStreamType|切换指定远端用户的大小画面。|
|
|
49
|
+
|snapshotVideo|视频画面截图。|
|
|
50
|
+
|setPerspectiveCorrectionPoints|视频画面透视校正坐标设置。|
|
|
51
|
+
|setGravitySensorAdaptiveMode|设置重力感应的适配模式(11.7 及以上版本)。|
|
|
52
|
+
|startLocalAudio|开启本地音频的采集和发布。|
|
|
53
|
+
|stopLocalAudio|停止本地音频的采集和发布。|
|
|
54
|
+
|muteLocalAudio|暂停/恢复发布本地的音频流。|
|
|
55
|
+
|muteRemoteAudio|暂停/恢复播放远端的音频流。|
|
|
56
|
+
|muteAllRemoteAudio|暂停/恢复播放所有远端用户的音频流。|
|
|
57
|
+
|setAudioRoute|设置音频路由。|
|
|
58
|
+
|setRemoteAudioVolume|设定某一个远端用户的声音播放音量。|
|
|
59
|
+
|setAudioCaptureVolume|设定本地音频的采集音量。|
|
|
60
|
+
|getAudioCaptureVolume|获取本地音频的采集音量。|
|
|
61
|
+
|setAudioPlayoutVolume|设定远端音频的播放音量。|
|
|
62
|
+
|getAudioPlayoutVolume|获取远端音频的播放音量。|
|
|
63
|
+
|enableAudioVolumeEvaluation|启用音量大小提示。|
|
|
64
|
+
|startAudioRecording|开始录音。|
|
|
65
|
+
|stopAudioRecording|停止录音。|
|
|
66
|
+
|startLocalRecording|开启本地媒体录制。|
|
|
67
|
+
|stopLocalRecording|停止本地媒体录制。|
|
|
68
|
+
|setRemoteAudioParallelParams|设置远端音频流智能并发播放策略。|
|
|
69
|
+
|enable3DSpatialAudioEffect|启用 3D 音效。|
|
|
70
|
+
|updateSelf3DSpatialPosition|设置 3D 音效中自身坐标及朝向信息。|
|
|
71
|
+
|updateRemote3DSpatialPosition|设置 3D 音效中远端用户坐标信息。|
|
|
72
|
+
|set3DSpatialReceivingRange|设置指定用户所发出声音的可被接收范围。|
|
|
73
|
+
|getDeviceManager|获取设备管理类(TXDeviceManager)。|
|
|
74
|
+
|getBeautyManager|获取美颜管理类(TXBeautyManager)。|
|
|
75
|
+
|setWatermark|添加水印。|
|
|
76
|
+
|getAudioEffectManager|获取音效管理类(TXAudioEffectManager)。|
|
|
77
|
+
|startSystemAudioLoopback|开启系统声音采集。|
|
|
78
|
+
|stopSystemAudioLoopback|停止系统声音采集(iOS 端暂未支持)。|
|
|
79
|
+
|getAITranscriberManager|获取 AI 转录管理类(AITranscriberManager)。|
|
|
80
|
+
|startScreenCapture|启动屏幕分享。|
|
|
81
|
+
|stopScreenCapture|停止屏幕分享。|
|
|
82
|
+
|pauseScreenCapture|暂停屏幕分享。|
|
|
83
|
+
|resumeScreenCapture|恢复屏幕分享。|
|
|
84
|
+
|setSubStreamEncoderParam|设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。|
|
|
85
|
+
|enableCustomVideoCapture|启用/关闭视频自定义采集模式。|
|
|
86
|
+
|sendCustomVideoData|向 SDK 投送自己采集的视频帧。|
|
|
87
|
+
|enableCustomAudioCapture|启用音频自定义采集模式。|
|
|
88
|
+
|sendCustomAudioData|向 SDK 投送自己采集的音频数据。|
|
|
89
|
+
|enableMixExternalAudioFrame|启用/关闭自定义音轨。|
|
|
90
|
+
|mixExternalAudioFrame|向 SDK 混入自定义音轨。|
|
|
91
|
+
|setMixExternalAudioVolume|设置推流时混入外部音频的推流音量和播放音量。|
|
|
92
|
+
|generateCustomPTS|生成自定义采集时的时间戳。|
|
|
93
|
+
|setLocalVideoProcessListener|设置第三方美颜的视频数据回调。|
|
|
94
|
+
|setLocalVideoRenderListener|设置本地视频自定义渲染回调。|
|
|
95
|
+
|setRemoteVideoRenderListener|设置远端视频自定义渲染回调。|
|
|
96
|
+
|setAudioFrameListener|设置音频数据自定义回调。|
|
|
97
|
+
|setCapturedAudioFrameCallbackFormat|设置本地麦克风采集出的音频帧回调格式。|
|
|
98
|
+
|setLocalProcessedAudioFrameCallbackFormat|设置经过前处理后的本地音频帧回调格式。|
|
|
99
|
+
|setMixedPlayAudioFrameCallbackFormat|设置最终要由系统播放出的音频帧回调格式。|
|
|
100
|
+
|enableCustomAudioRendering|开启音频自定义播放。|
|
|
101
|
+
|getCustomAudioRenderingFrame|获取可播放的音频数据。|
|
|
102
|
+
|sendCustomCmdMsg|使用 UDP 通道发送自定义消息给房间内所有用户。|
|
|
103
|
+
|sendSEIMsg|使用 SEI 通道发送自定义消息给房间内所有用户。|
|
|
104
|
+
|startSpeedTest|开始进行网速测试(进入房间前使用)。|
|
|
105
|
+
|stopSpeedTest|停止网络测速。|
|
|
106
|
+
|getSDKVersion|获取 SDK 版本信息。|
|
|
107
|
+
|setLogLevel|设置 Log 输出级别。|
|
|
108
|
+
|setConsoleEnabled|启用/禁用控制台日志打印。|
|
|
109
|
+
|setLogCompressEnabled|启用/禁用日志的本地压缩。|
|
|
110
|
+
|setLogDirPath|设置本地日志的保存路径。|
|
|
111
|
+
|setLogListener|设置日志回调。|
|
|
112
|
+
|showDebugView|显示仪表盘。|
|
|
113
|
+
|TRTCViewMargin|设置仪表盘的边距。|
|
|
114
|
+
|callExperimentalAPI|调用实验性接口。|
|
|
115
|
+
|enablePayloadPrivateEncryption|开启或关闭媒体流私有加密。|
|
|
111
116
|
|
|
112
117
|
## sharedInstance
|
|
113
118
|
|
|
114
|
-
|
|
119
|
+
**创建 TRTCCloud 实例(单例模式)。**
|
|
115
120
|
| 参数 | 描述 |
|
|
116
121
|
| --- | --- |
|
|
117
|
-
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的
|
|
122
|
+
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 <code> context </code> 参数为空,SDK 内部会自动获取当前进程的 ApplicationContext。 |
|
|
118
123
|
|
|
119
124
|
> **注意**
|
|
120
125
|
>
|
|
@@ -124,28 +129,29 @@
|
|
|
124
129
|
|
|
125
130
|
## destroySharedInstance
|
|
126
131
|
|
|
127
|
-
|
|
132
|
+
**销毁 TRTCCloud 实例(单例模式)。**
|
|
128
133
|
|
|
129
134
|
## addListener
|
|
130
135
|
|
|
131
|
-
|
|
136
|
+
**添加 TRTC 事件回调。**
|
|
132
137
|
|
|
133
138
|
您可以通过 TRTCCloudListener 获得来自 SDK 的各类事件通知(例如:错误码,警告码,音视频状态参数等)。
|
|
134
139
|
|
|
135
140
|
## removeListener
|
|
136
141
|
|
|
137
|
-
|
|
142
|
+
**移除 TRTC 事件回调。**
|
|
138
143
|
|
|
139
144
|
## setListenerHandler
|
|
140
145
|
|
|
141
|
-
|
|
146
|
+
**设置驱动 TRTCCloudListener 事件回调的队列。**
|
|
142
147
|
|
|
143
148
|
如果您不指定自己的 ` listenerHandler ` 默认会采用 MainQueue 作为驱动 TRTCCloudListener 事件回调的队列。
|
|
144
149
|
|
|
145
150
|
也就是当您不设置 ` listenerHandler ` 属性时,TRTCCloudListener 中的所有回调函数都是由 MainQueue 来驱动的。
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
151
|
+
|
|
152
|
+
|参数|描述|
|
|
153
|
+
|---------|---------|
|
|
154
|
+
|listenerHandler|事件回调句柄|
|
|
149
155
|
|
|
150
156
|
> **注意**
|
|
151
157
|
>
|
|
@@ -155,7 +161,7 @@
|
|
|
155
161
|
|
|
156
162
|
## enterRoom
|
|
157
163
|
|
|
158
|
-
|
|
164
|
+
**进入房间。**
|
|
159
165
|
|
|
160
166
|
TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流,“发布”是指将自己的音频和视频推送到云端,“订阅”是指从云端拉取房间里其他用户的音视频流。
|
|
161
167
|
|
|
@@ -174,10 +180,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
174
180
|
|
|
175
181
|
- 如果进房失败,参数 ` result ` 会是一个负数(result < 0),表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
|
|
176
182
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
|
180
|
-
|
|
|
183
|
+
|参数|描述|
|
|
184
|
+
|---------|---------|
|
|
185
|
+
|param|进房参数,用于指定用户的身份、角色和安全票据等信息,详情请参见 TRTCParams 。|
|
|
186
|
+
|scene|应用场景,用于指定您的业务场景,同一个房间内的所有用户需要设定相同的 TRTCAppScene。|
|
|
181
187
|
|
|
182
188
|
> **注意**
|
|
183
189
|
>
|
|
@@ -193,7 +199,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
193
199
|
|
|
194
200
|
## exitRoom
|
|
195
201
|
|
|
196
|
-
|
|
202
|
+
**离开房间。**
|
|
197
203
|
|
|
198
204
|
调用该接口会让用户离开自己所在的音视频房间,并释放摄像头、麦克风、扬声器等设备资源。
|
|
199
205
|
|
|
@@ -203,7 +209,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
203
209
|
|
|
204
210
|
## switchRole
|
|
205
211
|
|
|
206
|
-
|
|
212
|
+
**切换角色。**
|
|
207
213
|
|
|
208
214
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
209
215
|
|
|
@@ -212,7 +218,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
212
218
|
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
213
219
|
| 参数 | 描述 |
|
|
214
220
|
| --- | --- |
|
|
215
|
-
| role | 角色,默认为
|
|
221
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
216
222
|
|
|
217
223
|
> **注意**
|
|
218
224
|
>
|
|
@@ -225,7 +231,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
225
231
|
|
|
226
232
|
## switchRole
|
|
227
233
|
|
|
228
|
-
|
|
234
|
+
**切换角色(支持设置权限位)。**
|
|
229
235
|
|
|
230
236
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
231
237
|
|
|
@@ -234,8 +240,8 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
234
240
|
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
235
241
|
| 参数 | 描述 |
|
|
236
242
|
| --- | --- |
|
|
237
|
-
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用
|
|
238
|
-
| role | 角色,默认为
|
|
243
|
+
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用 <code> privateMapKey </code> 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
|
|
244
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
239
245
|
|
|
240
246
|
> **注意**
|
|
241
247
|
>
|
|
@@ -248,7 +254,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
248
254
|
|
|
249
255
|
## switchRoom
|
|
250
256
|
|
|
251
|
-
|
|
257
|
+
**切换房间。**
|
|
252
258
|
|
|
253
259
|
使用该接口可以让用户快速从一个房间切换到另一个房间。
|
|
254
260
|
- 如果用户的身份是“观众”,该接口的调用效果等同于 ` exitRoom(当前房间) + enterRoom(新的房间) `。
|
|
@@ -258,9 +264,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
258
264
|
该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
|
|
259
265
|
|
|
260
266
|
接口调用结果会通过 TRTCCloudListener 中的 onSwitchRoom 回调。
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
267
|
+
|
|
268
|
+
|参数|描述|
|
|
269
|
+
|---------|---------|
|
|
270
|
+
|config|房间参数,详情请参见 TRTCSwitchRoomConfig。|
|
|
264
271
|
|
|
265
272
|
> **注意**
|
|
266
273
|
>
|
|
@@ -276,7 +283,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
276
283
|
|
|
277
284
|
## ConnectOtherRoom
|
|
278
285
|
|
|
279
|
-
|
|
286
|
+
**请求跨房通话。**
|
|
280
287
|
|
|
281
288
|
默认情况下,只有同一个房间中的用户之间可以进行音视频通话,不同的房间之间的音视频流是相互隔离的。
|
|
282
289
|
|
|
@@ -316,19 +323,20 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
316
323
|
jsonObj.put("userId", "userB");
|
|
317
324
|
trtc.ConnectOtherRoom(jsonObj.toString());
|
|
318
325
|
```
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
326
|
+
|
|
327
|
+
|参数|描述|
|
|
328
|
+
|---------|---------|
|
|
329
|
+
|param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID。|
|
|
322
330
|
|
|
323
331
|
## DisconnectOtherRoom
|
|
324
332
|
|
|
325
|
-
|
|
333
|
+
**退出跨房通话。**
|
|
326
334
|
|
|
327
335
|
退出结果会通过 TRTCCloudListener 中的 onDisconnectOtherRoom 回调通知给您。
|
|
328
336
|
|
|
329
337
|
## setDefaultStreamRecvMode
|
|
330
338
|
|
|
331
|
-
|
|
339
|
+
**设置订阅模式(需要在进入房前设置才能生效)。**
|
|
332
340
|
|
|
333
341
|
您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换:
|
|
334
342
|
- 自动订阅:默认模式,用户在进入房间后会立刻接收到该房间中的音视频流,音频会自动播放,视频会自动开始解码(依然需要您通过 startRemoteView 接口绑定渲染控件)。
|
|
@@ -338,10 +346,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
338
346
|
在绝大多数场景下,用户进入房间后都会订阅房间中所有主播的音视频流,因此 TRTC 默认采用了自动订阅模式,以求得最佳的“秒开体验”。
|
|
339
347
|
|
|
340
348
|
如果您的应用场景中每个房间同时会有很多路音视频流在发布,而每个用户只想选择性地订阅其中的 1-2 路,则推荐使用“手动订阅”模式以节省流量费用。
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
|
349
|
+
|
|
350
|
+
|参数|描述|
|
|
351
|
+
|---------|---------|
|
|
352
|
+
|autoRecvAudio|true:自动订阅音频;false:需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值:true。|
|
|
353
|
+
|autoRecvVideo|true:自动订阅视频;false:需手动调用 ` startRemoteView ` 订阅视频。默认值:true。|
|
|
345
354
|
|
|
346
355
|
> **注意**
|
|
347
356
|
>
|
|
@@ -354,7 +363,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
354
363
|
|
|
355
364
|
## createSubCloud
|
|
356
365
|
|
|
357
|
-
|
|
366
|
+
**创建子房间实例(用于多房间并发观看)。**
|
|
358
367
|
|
|
359
368
|
TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的能力。
|
|
360
369
|
|
|
@@ -406,21 +415,21 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
406
415
|
>
|
|
407
416
|
> - 多实例的音频需要同时为麦克风采集或自定义采集,而且与音频设备相关的接口调用会以最后一次为准;
|
|
408
417
|
> - 与摄像头相关的调用会以最后一次为准:startLocalPreview。
|
|
409
|
-
|
|
410
|
-
#### 返回值说明:
|
|
418
|
+
**返回值说明:**
|
|
411
419
|
|
|
412
420
|
子 TRTCCloud 实例
|
|
413
421
|
|
|
414
422
|
## destroySubCloud
|
|
415
423
|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
424
|
+
**销毁子房间实例。**
|
|
425
|
+
|
|
426
|
+
|参数|描述|
|
|
427
|
+
|---------|---------|
|
|
428
|
+
|subCloud|子房间实例|
|
|
420
429
|
|
|
421
430
|
## updateOtherRoomForwardMode
|
|
422
431
|
|
|
423
|
-
|
|
432
|
+
**更改跨房主播在本房间的上行能力。**
|
|
424
433
|
|
|
425
434
|
通常情况下,在调用 connectOtherRoom 接口与另一个房间的主播进行跨房通话后,本房间内的所有观众都将收到该主播发布的音视频流。
|
|
426
435
|
|
|
@@ -465,20 +474,22 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
465
474
|
"muteSubStream":false
|
|
466
475
|
}
|
|
467
476
|
```
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
477
|
+
|
|
478
|
+
|参数|描述|
|
|
479
|
+
|---------|---------|
|
|
480
|
+
|param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID,` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项,分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
|
|
471
481
|
|
|
472
482
|
## startPublishMediaStream
|
|
473
483
|
|
|
474
|
-
|
|
484
|
+
**开始发布媒体流。**
|
|
475
485
|
|
|
476
486
|
该接口会向 TRTC 服务器发送指令,要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 TRTCPublishTarget 配置中的 TRTCPublishMode 指定具体的发布模式
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
|
481
|
-
|
|
|
487
|
+
|
|
488
|
+
|参数|描述|
|
|
489
|
+
|---------|---------|
|
|
490
|
+
|config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
|
|
491
|
+
|params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
|
|
492
|
+
|target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
|
|
482
493
|
|
|
483
494
|
> **注意**
|
|
484
495
|
>
|
|
@@ -497,15 +508,16 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
497
508
|
|
|
498
509
|
## updatePublishMediaStream
|
|
499
510
|
|
|
500
|
-
|
|
511
|
+
**更新发布媒体流。**
|
|
501
512
|
|
|
502
513
|
该接口会向 TRTC 服务器发送指令,更新通过 startPublishMediaStream 启动的媒体流
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
|
507
|
-
|
|
|
508
|
-
|
|
|
514
|
+
|
|
515
|
+
|参数|描述|
|
|
516
|
+
|---------|---------|
|
|
517
|
+
|config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
|
|
518
|
+
|params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
|
|
519
|
+
|target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
|
|
520
|
+
|taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
|
|
509
521
|
|
|
510
522
|
> **注意**
|
|
511
523
|
>
|
|
@@ -521,12 +533,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
521
533
|
|
|
522
534
|
## stopPublishMediaStream
|
|
523
535
|
|
|
524
|
-
|
|
536
|
+
**停止发布媒体流。**
|
|
525
537
|
|
|
526
538
|
该接口会向 TRTC 服务器发送指令,停止通过 startPublishMediaStream 启动的媒体流
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
539
|
+
|
|
540
|
+
|参数|描述|
|
|
541
|
+
|---------|---------|
|
|
542
|
+
|taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
|
|
530
543
|
|
|
531
544
|
> **注意**
|
|
532
545
|
>
|
|
@@ -539,17 +552,18 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
539
552
|
|
|
540
553
|
## startLocalPreview
|
|
541
554
|
|
|
542
|
-
|
|
555
|
+
**开启本地摄像头的预览画面(移动端)。**
|
|
543
556
|
|
|
544
557
|
在 enterRoom 之前调用此函数,SDK 只会开启摄像头,并一直等到您调用 enterRoom 之后才开始推流。
|
|
545
558
|
|
|
546
559
|
在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。
|
|
547
560
|
|
|
548
561
|
当开始渲染首帧摄像头画面时,您会收到 TRTCCloudListener 中的 onCameraDidReady 回调通知。
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
|
562
|
+
|
|
563
|
+
|参数|描述|
|
|
564
|
+
|---------|---------|
|
|
565
|
+
|frontCamera|true:前置摄像头;false:后置摄像头。|
|
|
566
|
+
|view|承载视频画面的控件。|
|
|
553
567
|
|
|
554
568
|
> **注意**
|
|
555
569
|
>
|
|
@@ -561,15 +575,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
561
575
|
|
|
562
576
|
## updateLocalView
|
|
563
577
|
|
|
564
|
-
|
|
578
|
+
**更新本地摄像头的预览画面。**
|
|
565
579
|
|
|
566
580
|
## stopLocalPreview
|
|
567
581
|
|
|
568
|
-
|
|
582
|
+
**停止摄像头预览。**
|
|
569
583
|
|
|
570
584
|
## muteLocalVideo
|
|
571
585
|
|
|
572
|
-
|
|
586
|
+
**暂停/恢复发布本地的视频流。**
|
|
573
587
|
|
|
574
588
|
该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
|
|
575
589
|
|
|
@@ -582,24 +596,26 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
582
596
|
当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_BIG 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
|
|
583
597
|
|
|
584
598
|
当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_SUB 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
|
599
|
+
|
|
600
|
+
|参数|描述|
|
|
601
|
+
|---------|---------|
|
|
602
|
+
|mute|true:暂停;false:恢复。|
|
|
603
|
+
|streamType|要暂停/恢复的视频流类型(仅支持 TRTC_VIDEO_STREAM_TYPE_BIG 和 TRTC_VIDEO_STREAM_TYPE_SUB)。|
|
|
589
604
|
|
|
590
605
|
## setVideoMuteImage
|
|
591
606
|
|
|
592
|
-
|
|
607
|
+
**设置本地画面被暂停期间的替代图片。**
|
|
593
608
|
|
|
594
609
|
当您调用 ` muteLocalVideo(true) ` 暂停本地画面时,您可以通过调用本接口设置一张替代图片,设置后,房间中的其他用户会看到这张替代图片,而不是黑屏画面。
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
|
610
|
+
|
|
611
|
+
|参数|描述|
|
|
612
|
+
|---------|---------|
|
|
613
|
+
|fps|设置替代图片帧率,最小值为5,最大值为10,默认5。|
|
|
614
|
+
|image|设置替代图片,空值代表在 muteLocalVideo 之后不再发送视频流数据,默认值为空。|
|
|
599
615
|
|
|
600
616
|
## startRemoteView
|
|
601
617
|
|
|
602
|
-
|
|
618
|
+
**订阅远端用户的视频流,并绑定视频渲染控件。**
|
|
603
619
|
|
|
604
620
|
调用该接口可以让 SDK 拉取指定 userId 的视频流,并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
|
|
605
621
|
- 如果您已经知道房间中有视频流的用户的 userId,可以直接调用 ` startRemoteView ` 订阅该用户的画面。
|
|
@@ -630,18 +646,19 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
630
646
|
|
|
631
647
|
## updateRemoteView
|
|
632
648
|
|
|
633
|
-
|
|
649
|
+
**更新远端用户的视频渲染控件。**
|
|
634
650
|
|
|
635
651
|
该接口可用于更新远端视频画面的渲染控件,常被用于切换显示区域的交互场景中。
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
|
640
|
-
|
|
|
652
|
+
|
|
653
|
+
|参数|描述|
|
|
654
|
+
|---------|---------|
|
|
655
|
+
|streamType|要设置预览窗口的流类型(仅支持 TRTC_VIDEO_STREAM_TYPE_BIG 和 TRTC_VIDEO_STREAM_TYPE_SUB)。|
|
|
656
|
+
|userId|指定远端用户的 ID。|
|
|
657
|
+
|view|承载视频画面的控件。|
|
|
641
658
|
|
|
642
659
|
## stopRemoteView
|
|
643
660
|
|
|
644
|
-
|
|
661
|
+
**停止订阅远端用户的视频流,并释放渲染控件。**
|
|
645
662
|
|
|
646
663
|
调用此接口会让 SDK 停止接收该用户的视频流,并释放该路视频流的解码和渲染资源。
|
|
647
664
|
| 参数 | 描述 |
|
|
@@ -651,7 +668,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
651
668
|
|
|
652
669
|
## stopAllRemoteView
|
|
653
670
|
|
|
654
|
-
|
|
671
|
+
**停止订阅所有远端用户的视频流,并释放全部渲染资源。**
|
|
655
672
|
|
|
656
673
|
调用此接口会让 SDK 停止接收所有来自远端的视频流,并释放全部的解码和渲染资源。
|
|
657
674
|
|
|
@@ -663,7 +680,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
663
680
|
|
|
664
681
|
## muteRemoteVideoStream
|
|
665
682
|
|
|
666
|
-
|
|
683
|
+
**暂停/恢复订阅远端用户的视频流。**
|
|
667
684
|
|
|
668
685
|
该接口仅暂停/恢复接收指定用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
|
|
669
686
|
| 参数 | 描述 |
|
|
@@ -680,12 +697,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
680
697
|
|
|
681
698
|
## muteAllRemoteVideoStreams
|
|
682
699
|
|
|
683
|
-
|
|
700
|
+
**暂停/恢复订阅所有远端用户的视频流。**
|
|
684
701
|
|
|
685
702
|
该接口仅暂停/恢复接收所有用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
703
|
+
|
|
704
|
+
|参数|描述|
|
|
705
|
+
|---------|---------|
|
|
706
|
+
|mute|是否暂停接收。|
|
|
689
707
|
|
|
690
708
|
> **注意**
|
|
691
709
|
>
|
|
@@ -698,12 +716,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
698
716
|
|
|
699
717
|
## setVideoEncoderParam
|
|
700
718
|
|
|
701
|
-
|
|
719
|
+
**设置视频编码器的编码参数。**
|
|
702
720
|
|
|
703
721
|
该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
722
|
+
|
|
723
|
+
|参数|描述|
|
|
724
|
+
|---------|---------|
|
|
725
|
+
|param|用于设置视频编码器的相关参数,详情请参见 TRTCVideoEncParam。|
|
|
707
726
|
|
|
708
727
|
> **注意**
|
|
709
728
|
>
|
|
@@ -713,66 +732,70 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
713
732
|
|
|
714
733
|
## setNetworkQosParam
|
|
715
734
|
|
|
716
|
-
|
|
735
|
+
**设置网络质量控制的相关参数。**
|
|
717
736
|
|
|
718
737
|
该设置决定在差网络环境下的质量调控策略,如“画质优先”或“流畅优先”等策略。
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
738
|
+
|
|
739
|
+
|参数|描述|
|
|
740
|
+
|---------|---------|
|
|
741
|
+
|param|用于设置网络质量控制的相关参数,详情请参见 TRTCNetworkQosParam。|
|
|
722
742
|
|
|
723
743
|
## setLocalRenderParams
|
|
724
744
|
|
|
725
|
-
|
|
745
|
+
**设置本地画面的渲染参数。**
|
|
726
746
|
|
|
727
747
|
可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
748
|
+
|
|
749
|
+
|参数|描述|
|
|
750
|
+
|---------|---------|
|
|
751
|
+
|params|画面渲染参数,详情请参见 TRTCRenderParams。|
|
|
731
752
|
|
|
732
753
|
## setRemoteRenderParams
|
|
733
754
|
|
|
734
|
-
|
|
755
|
+
**设置远端画面的渲染模式。**
|
|
735
756
|
|
|
736
757
|
可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
|
741
|
-
|
|
|
758
|
+
|
|
759
|
+
|参数|描述|
|
|
760
|
+
|---------|---------|
|
|
761
|
+
|params|画面渲染参数,详情请参见 TRTCRenderParams。|
|
|
762
|
+
|streamType|可以设置为主路画面(TRTC_VIDEO_STREAM_TYPE_BIG)或辅路画面(TRTC_VIDEO_STREAM_TYPE_SUB)。|
|
|
763
|
+
|userId|指定远端用户的 ID。|
|
|
742
764
|
|
|
743
765
|
## enableEncSmallVideoStream
|
|
744
766
|
|
|
745
|
-
|
|
767
|
+
**开启大小画面双路编码模式。**
|
|
746
768
|
|
|
747
769
|
开启双路编码模式后,当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流(但只有一路音频流)。
|
|
748
770
|
|
|
749
771
|
如此以来,房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
|
772
|
+
|
|
773
|
+
|参数|描述|
|
|
774
|
+
|---------|---------|
|
|
775
|
+
|enable|是否开启小画面编码,默认值:false。|
|
|
776
|
+
|smallVideoEncParam|小流的视频参数。|
|
|
754
777
|
|
|
755
778
|
> **注意**
|
|
756
779
|
>
|
|
757
780
|
|
|
758
781
|
> 双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以 Mac、Windows 或者高性能 Pad 可以考虑开启,不建议手机端开启。
|
|
759
782
|
>
|
|
760
|
-
|
|
761
|
-
#### 返回值说明:
|
|
783
|
+
**返回值说明:**
|
|
762
784
|
|
|
763
785
|
0:成功;-1:当前大画面已被设置为较低画质,开启双路编码已无必要。
|
|
764
786
|
|
|
765
787
|
## setRemoteVideoStreamType
|
|
766
788
|
|
|
767
|
-
|
|
789
|
+
**切换指定远端用户的大小画面。**
|
|
768
790
|
|
|
769
791
|
当房间中某个主播开启了双路编码之后,房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。
|
|
770
792
|
|
|
771
793
|
您可以通过此接口选定希望订阅的画面是大画面还是小画面,该接口在 startRemoteView 之前和之后调用均可生效。
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
|
794
|
+
|
|
795
|
+
|参数|描述|
|
|
796
|
+
|---------|---------|
|
|
797
|
+
|streamType|视频流类型,即选择看大画面还是小画面,默认为大画面。|
|
|
798
|
+
|userId|指定远端用户的 ID。|
|
|
776
799
|
|
|
777
800
|
> **注意**
|
|
778
801
|
>
|
|
@@ -782,14 +805,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
782
805
|
|
|
783
806
|
## snapshotVideo
|
|
784
807
|
|
|
785
|
-
|
|
808
|
+
**视频画面截图。**
|
|
786
809
|
|
|
787
810
|
您可以通过本接口截取本地的视频画面,远端用户的主路画面以及远端用户的辅路(屏幕分享)画面。
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
|
792
|
-
|
|
|
811
|
+
|
|
812
|
+
|参数|描述|
|
|
813
|
+
|---------|---------|
|
|
814
|
+
|sourceType|画面来源,可选择截取视频流画面(TRTC_SNAPSHOT_SOURCE_TYPE_STREAM)、视频渲染画面(TRTC_SNAPSHOT_SOURCE_TYPE_VIEW)或 采集画面(TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE),采集画面截图更清晰。|
|
|
815
|
+
|streamType|视频流类型,可选择截取主路画面(TRTC_VIDEO_STREAM_TYPE_BIG,常用于摄像头)或辅路画面(TRTC_VIDEO_STREAM_TYPE_SUB,常用于屏幕分享)。|
|
|
816
|
+
|userId|用户 ID,如指定空置表示截取本地的视频画面。|
|
|
793
817
|
|
|
794
818
|
> **注意**
|
|
795
819
|
>
|
|
@@ -799,18 +823,19 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
799
823
|
|
|
800
824
|
## setPerspectiveCorrectionPoints
|
|
801
825
|
|
|
802
|
-
|
|
826
|
+
**视频画面透视校正坐标设置。**
|
|
803
827
|
|
|
804
828
|
您可以通过本接口指定渲染画面透视校正的坐标区域。
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
|
809
|
-
|
|
|
829
|
+
|
|
830
|
+
|参数|描述|
|
|
831
|
+
|---------|---------|
|
|
832
|
+
|dstPoints|期望校正到的目标坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化;传 null 则停止透视校正。|
|
|
833
|
+
|srcPoints|原始画面坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化; 传 null 则停止透视校正。|
|
|
834
|
+
|userId|用户 ID,如指定空值表示校正本地的视频画面。|
|
|
810
835
|
|
|
811
836
|
## setGravitySensorAdaptiveMode
|
|
812
837
|
|
|
813
|
-
|
|
838
|
+
**设置重力感应的适配模式(11.7 及以上版本)。**
|
|
814
839
|
|
|
815
840
|
开启重力感应后,如果采集端的设备发生旋转,采集端和观众端的画面都会进行相应地渲染以确保视野中的画面始终朝上。
|
|
816
841
|
|
|
@@ -819,13 +844,14 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
819
844
|
1. 该接口仅对采集端起作用,如果只是观看房间中的画面,开启此接口是无效的
|
|
820
845
|
|
|
821
846
|
2. 当采集端设备发生 90 度或 270 度旋转时,采集端或者观众看到的画面可能会被裁剪以保持比例的协调
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
847
|
+
|
|
848
|
+
|参数|描述|
|
|
849
|
+
|---------|---------|
|
|
850
|
+
|mode|重力感应模式,详情请参见 TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE、TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP 和 TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER 默认值:TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE。|
|
|
825
851
|
|
|
826
852
|
## startLocalAudio
|
|
827
853
|
|
|
828
|
-
|
|
854
|
+
**开启本地音频的采集和发布。**
|
|
829
855
|
|
|
830
856
|
SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调用该接口开启麦克风采集,并将音频编码并发布到当前的房间中。
|
|
831
857
|
|
|
@@ -842,13 +868,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
842
868
|
|
|
843
869
|
## stopLocalAudio
|
|
844
870
|
|
|
845
|
-
|
|
871
|
+
**停止本地音频的采集和发布。**
|
|
846
872
|
|
|
847
873
|
停止本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
848
874
|
|
|
849
875
|
## muteLocalAudio
|
|
850
876
|
|
|
851
|
-
|
|
877
|
+
**暂停/恢复发布本地的音频流。**
|
|
852
878
|
|
|
853
879
|
当您暂停发布本地音频流之后,房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
854
880
|
|
|
@@ -859,19 +885,21 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
859
885
|
这对于需要云端录制的场景非常适用,因为 MP4 等格式的视频文件,对于音频数据的连续性要求很高,使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
|
|
860
886
|
|
|
861
887
|
因此在对录制文件的质量要求较高的场景中,建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
888
|
+
|
|
889
|
+
|参数|描述|
|
|
890
|
+
|---------|---------|
|
|
891
|
+
|mute|true:静音;false:恢复。|
|
|
865
892
|
|
|
866
893
|
## muteRemoteAudio
|
|
867
894
|
|
|
868
|
-
|
|
895
|
+
**暂停/恢复播放远端的音频流。**
|
|
869
896
|
|
|
870
897
|
当您静音某用户的远端音频时,SDK 会停止播放指定用户的声音,同时也会停止拉取该用户的音频数据。
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
|
898
|
+
|
|
899
|
+
|参数|描述|
|
|
900
|
+
|---------|---------|
|
|
901
|
+
|mute|true:静音;false:取消静音。|
|
|
902
|
+
|userId|用于指定远端用户的 ID。|
|
|
875
903
|
|
|
876
904
|
> **注意**
|
|
877
905
|
>
|
|
@@ -881,12 +909,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
881
909
|
|
|
882
910
|
## muteAllRemoteAudio
|
|
883
911
|
|
|
884
|
-
|
|
912
|
+
**暂停/恢复播放所有远端用户的音频流。**
|
|
885
913
|
|
|
886
914
|
当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
915
|
+
|
|
916
|
+
|参数|描述|
|
|
917
|
+
|---------|---------|
|
|
918
|
+
|mute|true:静音;false:取消静音。|
|
|
890
919
|
|
|
891
920
|
> **注意**
|
|
892
921
|
>
|
|
@@ -896,7 +925,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
896
925
|
|
|
897
926
|
## setAudioRoute
|
|
898
927
|
|
|
899
|
-
|
|
928
|
+
**设置音频路由。**
|
|
900
929
|
|
|
901
930
|
设置“音频路由”,即设置声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
|
|
902
931
|
|
|
@@ -905,19 +934,21 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
905
934
|
设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
|
|
906
935
|
|
|
907
936
|
设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
937
|
+
|
|
938
|
+
|参数|描述|
|
|
939
|
+
|---------|---------|
|
|
940
|
+
|route|音频路由,即声音由哪里输出(扬声器、听筒),默认值:TRTC_AUDIO_ROUTE_SPEAKER。|
|
|
911
941
|
|
|
912
942
|
## setRemoteAudioVolume
|
|
913
943
|
|
|
914
|
-
|
|
944
|
+
**设定某一个远端用户的声音播放音量。**
|
|
915
945
|
|
|
916
946
|
您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
|
947
|
+
|
|
948
|
+
|参数|描述|
|
|
949
|
+
|---------|---------|
|
|
950
|
+
|userId|用于指定远端用户的 ID。|
|
|
951
|
+
|volume|音量大小,取值范围为 [0, 150],默认值:100。|
|
|
921
952
|
|
|
922
953
|
> **注意**
|
|
923
954
|
>
|
|
@@ -927,10 +958,11 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
927
958
|
|
|
928
959
|
## setAudioCaptureVolume
|
|
929
960
|
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
961
|
+
**设定本地音频的采集音量。**
|
|
962
|
+
|
|
963
|
+
|参数|描述|
|
|
964
|
+
|---------|---------|
|
|
965
|
+
|volume|音量大小,取值范围为 [0, 150];默认值:100。|
|
|
934
966
|
|
|
935
967
|
> **注意**
|
|
936
968
|
>
|
|
@@ -940,20 +972,19 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
940
972
|
|
|
941
973
|
## getAudioCaptureVolume
|
|
942
974
|
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
#### 返回值说明:
|
|
975
|
+
**获取本地音频的采集音量。****返回值说明:**
|
|
946
976
|
|
|
947
977
|
采集音量。
|
|
948
978
|
|
|
949
979
|
## setAudioPlayoutVolume
|
|
950
980
|
|
|
951
|
-
|
|
981
|
+
**设定远端音频的播放音量。**
|
|
952
982
|
|
|
953
983
|
该接口会控制 SDK 最终交给系统播放的声音音量,调节效果会影响到本地音频录制文件的音量大小,但不会影响到耳返的音量大小。
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
984
|
+
|
|
985
|
+
|参数|描述|
|
|
986
|
+
|---------|---------|
|
|
987
|
+
|volume|音量大小,取值范围为 [0, 150],默认值:100。|
|
|
957
988
|
|
|
958
989
|
> **注意**
|
|
959
990
|
>
|
|
@@ -963,17 +994,18 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
963
994
|
|
|
964
995
|
## getAudioPlayoutVolume
|
|
965
996
|
|
|
966
|
-
|
|
997
|
+
**获取远端音频的播放音量。**
|
|
967
998
|
|
|
968
999
|
## enableAudioVolumeEvaluation
|
|
969
1000
|
|
|
970
|
-
|
|
1001
|
+
**启用音量大小提示。**
|
|
971
1002
|
|
|
972
1003
|
开启此功能后,SDK 会在 TRTCCloudListener 中的 onUserVoiceVolume 回调中反馈本地和远端用户的音频音量评估信息,包括音量大小、人声检测、音频频谱等。
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
|
1004
|
+
|
|
1005
|
+
|参数|描述|
|
|
1006
|
+
|---------|---------|
|
|
1007
|
+
|enable|是否启用音量提示,默认为关闭状态。|
|
|
1008
|
+
|params|音量评估等相关参数,请参见 TRTCAudioVolumeEvaluateParams。|
|
|
977
1009
|
|
|
978
1010
|
> **注意**
|
|
979
1011
|
>
|
|
@@ -983,77 +1015,81 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
983
1015
|
|
|
984
1016
|
## startAudioRecording
|
|
985
1017
|
|
|
986
|
-
|
|
1018
|
+
**开始录音。**
|
|
987
1019
|
|
|
988
1020
|
当您调用该接口后, SDK 会将本地和远端的所有音频(包括本地音频,远端音频,背景音乐和音效等)混合并录制到一个本地文件中。
|
|
989
1021
|
|
|
990
1022
|
该接口在进入房间前后调用均可生效,如果录制任务在退出房间前尚未通过 stopAudioRecording 停止,则退出房间后录制任务会自动被停止。
|
|
991
1023
|
|
|
992
1024
|
本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 TRTCCloudListener 相关回调。
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
1025
|
+
|
|
1026
|
+
|参数|描述|
|
|
1027
|
+
|---------|---------|
|
|
1028
|
+
|param|录音参数,请参见 TRTCAudioRecordingParams。|
|
|
996
1029
|
|
|
997
1030
|
> **注意**
|
|
998
1031
|
>
|
|
999
1032
|
|
|
1000
1033
|
> 自 v11.5 版本,音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 TRTCCloudListener 相关回调。
|
|
1001
1034
|
>
|
|
1002
|
-
|
|
1003
|
-
#### 返回值说明:
|
|
1035
|
+
**返回值说明:**
|
|
1004
1036
|
|
|
1005
1037
|
0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持。
|
|
1006
1038
|
|
|
1007
1039
|
## stopAudioRecording
|
|
1008
1040
|
|
|
1009
|
-
|
|
1041
|
+
**停止录音。**
|
|
1010
1042
|
|
|
1011
1043
|
如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
|
|
1012
1044
|
|
|
1013
1045
|
## startLocalRecording
|
|
1014
1046
|
|
|
1015
|
-
|
|
1047
|
+
**开启本地媒体录制。**
|
|
1016
1048
|
|
|
1017
1049
|
开启后把直播过程中的音视频内容录制到本地的一个文件中,该功能不会产生额外费用。
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1050
|
+
|
|
1051
|
+
|参数|描述|
|
|
1052
|
+
|---------|---------|
|
|
1053
|
+
|params|录制参数,请参见 TRTCLocalRecordingParams。|
|
|
1021
1054
|
|
|
1022
1055
|
## stopLocalRecording
|
|
1023
1056
|
|
|
1024
|
-
|
|
1057
|
+
**停止本地媒体录制。**
|
|
1025
1058
|
|
|
1026
1059
|
如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
|
|
1027
1060
|
|
|
1028
1061
|
## setRemoteAudioParallelParams
|
|
1029
1062
|
|
|
1030
|
-
|
|
1063
|
+
**设置远端音频流智能并发播放策略。**
|
|
1031
1064
|
|
|
1032
1065
|
设置远端音频流智能并发播放策略,适用于上麦人数比较多的场景。
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1066
|
+
|
|
1067
|
+
|参数|描述|
|
|
1068
|
+
|---------|---------|
|
|
1069
|
+
|params|音频并发参数,请参见 TRTCAudioParallelParams。|
|
|
1036
1070
|
|
|
1037
1071
|
## enable3DSpatialAudioEffect
|
|
1038
1072
|
|
|
1039
|
-
|
|
1073
|
+
**启用 3D 音效。**
|
|
1040
1074
|
|
|
1041
1075
|
启用 3D 音效。注意需使用流畅音质 TRTC_AUDIO_QUALITY_SPEECH 或默认音质 TRTC_AUDIO_QUALITY_DEFAULT。
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1076
|
+
|
|
1077
|
+
|参数|描述|
|
|
1078
|
+
|---------|---------|
|
|
1079
|
+
|enabled|是否启用 3D 音效,默认为关闭状态。|
|
|
1045
1080
|
|
|
1046
1081
|
## updateSelf3DSpatialPosition
|
|
1047
1082
|
|
|
1048
|
-
|
|
1083
|
+
**设置 3D 音效中自身坐标及朝向信息。**
|
|
1049
1084
|
|
|
1050
1085
|
更新自身在世界坐标系中的位置和朝向, SDK 会根据该方法参数计算自身和远端用户之间的相对位置,进而渲染出空间音效。
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
|
1055
|
-
|
|
|
1056
|
-
|
|
|
1086
|
+
|
|
1087
|
+
|参数|描述|
|
|
1088
|
+
|---------|---------|
|
|
1089
|
+
|axisForward|自身坐标系前轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1090
|
+
|axisRight|自身坐标系右轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1091
|
+
|axisUp|自身坐标系上轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1092
|
+
|position|自身在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
|
|
1057
1093
|
|
|
1058
1094
|
> **注意**
|
|
1059
1095
|
>
|
|
@@ -1066,13 +1102,14 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1066
1102
|
|
|
1067
1103
|
## updateRemote3DSpatialPosition
|
|
1068
1104
|
|
|
1069
|
-
|
|
1105
|
+
**设置 3D 音效中远端用户坐标信息。**
|
|
1070
1106
|
|
|
1071
1107
|
更新远端用户在世界坐标系中的位置,SDK 会根据自身和远端用户之间的相对位置,进而渲染出空间音效。
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
|
1108
|
+
|
|
1109
|
+
|参数|描述|
|
|
1110
|
+
|---------|---------|
|
|
1111
|
+
|position|该远端用户在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
|
|
1112
|
+
|userId|指定远端用户的 ID。|
|
|
1076
1113
|
|
|
1077
1114
|
> **注意**
|
|
1078
1115
|
>
|
|
@@ -1085,27 +1122,26 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1085
1122
|
|
|
1086
1123
|
## set3DSpatialReceivingRange
|
|
1087
1124
|
|
|
1088
|
-
|
|
1125
|
+
**设置指定用户所发出声音的可被接收范围。**
|
|
1089
1126
|
|
|
1090
1127
|
设置该范围大小之后,该指定用户的声音将在该范围内可被听见,超出该范围将被衰减为 0。
|
|
1091
|
-
| 参数 | 描述 |
|
|
1092
|
-
| --- | --- |
|
|
1093
|
-
| range | 声音最大可被接收范围。 |
|
|
1094
|
-
| userId | 指定远端用户的 ID。 |
|
|
1095
1128
|
|
|
1096
|
-
|
|
1129
|
+
|参数|描述|
|
|
1130
|
+
|---------|---------|
|
|
1131
|
+
|range|声音最大可被接收范围。|
|
|
1132
|
+
|userId|指定远端用户的 ID。|
|
|
1097
1133
|
|
|
1098
|
-
|
|
1134
|
+
## getDeviceManager
|
|
1099
1135
|
|
|
1100
|
-
|
|
1136
|
+
**获取设备管理类(TXDeviceManager)。**
|
|
1101
1137
|
|
|
1102
|
-
|
|
1138
|
+
通过设备管理,您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。**返回值说明:**
|
|
1103
1139
|
|
|
1104
1140
|
设备管理类 TXDeviceManager。
|
|
1105
1141
|
|
|
1106
1142
|
## getBeautyManager
|
|
1107
1143
|
|
|
1108
|
-
|
|
1144
|
+
**获取美颜管理类(TXBeautyManager)。**
|
|
1109
1145
|
|
|
1110
1146
|
通过美颜管理,您可以使用以下功能:
|
|
1111
1147
|
- 设置“磨皮”、“美白”、“红润”等美颜特效。
|
|
@@ -1119,14 +1155,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1119
1155
|
- 设置“眼影”、“腮红”等美妆特效。
|
|
1120
1156
|
|
|
1121
1157
|
- 设置动态贴纸和人脸挂件等动画特效。
|
|
1122
|
-
|
|
1123
|
-
#### 返回值说明:
|
|
1158
|
+
**返回值说明:**
|
|
1124
1159
|
|
|
1125
1160
|
美颜管理类 TXBeautyManager。
|
|
1126
1161
|
|
|
1127
1162
|
## setWatermark
|
|
1128
1163
|
|
|
1129
|
-
|
|
1164
|
+
**添加水印。**
|
|
1130
1165
|
|
|
1131
1166
|
水印的位置是通过 rect 参数来指定的,rect 是一个四元组参数,其格式为 (x,y,width,height)
|
|
1132
1167
|
- x:水印的坐标,取值范围为 [0, 1] 的浮点数。
|
|
@@ -1142,11 +1177,12 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1142
1177
|
如果当前视频的编码分辨率是 540 × 960,且 rect 参数设置为(0.1,0.1,0.2,0.0),
|
|
1143
1178
|
|
|
1144
1179
|
那么水印的左上坐标点就是(540 × 0.1,960 × 0.1)即(54,96),水印的宽度是 ` 540 × 0.2 = 108px `,水印的高度会根据水印图片的宽高比由 SDK 自动算出。
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
|
1149
|
-
|
|
|
1180
|
+
|
|
1181
|
+
|参数|描述|
|
|
1182
|
+
|---------|---------|
|
|
1183
|
+
|image|水印图片,**必须使用透明底色的 png 格式**。|
|
|
1184
|
+
|rect|水印相对于编码分辨率的归一化坐标,x,y,width,height 取值范围 [0, 1]。|
|
|
1185
|
+
|streamType|指定给哪一路画面设置水印,详情请参见TRTCVideoStreamType。|
|
|
1150
1186
|
|
|
1151
1187
|
> **注意**
|
|
1152
1188
|
>
|
|
@@ -1156,7 +1192,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1156
1192
|
|
|
1157
1193
|
## getAudioEffectManager
|
|
1158
1194
|
|
|
1159
|
-
|
|
1195
|
+
**获取音效管理类(TXAudioEffectManager)。**
|
|
1160
1196
|
|
|
1161
1197
|
TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如下功能:
|
|
1162
1198
|
- 背景音乐:支持在线音乐和本地音乐,支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
|
|
@@ -1168,14 +1204,13 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1168
1204
|
- 变声特效:萝莉、大叔、重金属等。
|
|
1169
1205
|
|
|
1170
1206
|
- 短音效:鼓掌声、欢笑声等简短的音效文件(对于小于10秒的文件,请将 isShortFile 参数设置为 true)。
|
|
1171
|
-
|
|
1172
|
-
#### 返回值说明:
|
|
1207
|
+
**返回值说明:**
|
|
1173
1208
|
|
|
1174
1209
|
音效管理类 TXAudioEffectManager。
|
|
1175
1210
|
|
|
1176
1211
|
## startSystemAudioLoopback
|
|
1177
1212
|
|
|
1178
|
-
|
|
1213
|
+
**开启系统声音采集。**
|
|
1179
1214
|
|
|
1180
1215
|
该接口会采集其他应用音频数据,并将其混入到 SDK 当前的音频数据流中,从而使房间中的其他用户也能听到主播的其他应用所播放出的声音。
|
|
1181
1216
|
|
|
@@ -1200,11 +1235,19 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1200
1235
|
|
|
1201
1236
|
## stopSystemAudioLoopback
|
|
1202
1237
|
|
|
1203
|
-
|
|
1238
|
+
**停止系统声音采集(iOS 端暂未支持)。**
|
|
1239
|
+
|
|
1240
|
+
## getAITranscriberManager
|
|
1241
|
+
|
|
1242
|
+
**获取 AI 转录管理类(AITranscriberManager)。**
|
|
1243
|
+
|
|
1244
|
+
通过 AI 转录管理,您可以启动/停止实时转录服务,对指定用户的音频进行实时转录和翻译。**返回值说明:**
|
|
1245
|
+
|
|
1246
|
+
AI 转录管理类 AITranscriberManager。
|
|
1204
1247
|
|
|
1205
1248
|
## startScreenCapture
|
|
1206
1249
|
|
|
1207
|
-
|
|
1250
|
+
**启动屏幕分享。**
|
|
1208
1251
|
|
|
1209
1252
|
该接口支持抓取整个 Android 系统的屏幕,可以实现类似腾讯会议的全系统级的屏幕分享。
|
|
1210
1253
|
|
|
@@ -1220,11 +1263,12 @@ Android 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
|
|
|
1220
1263
|
- 分辨率自适应(enableAdjustRes):false。
|
|
1221
1264
|
|
|
1222
1265
|
#### [REMARK]
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
|
1227
|
-
|
|
|
1266
|
+
|
|
1267
|
+
|参数|描述|
|
|
1268
|
+
|---------|---------|
|
|
1269
|
+
|encParams|编码参数,请参见 TRTCVideoEncParam。如果您指定 ` encParams ` 为 null,SDK 会自动使用之前设定的编码参数。|
|
|
1270
|
+
|shareParams|请参见 TRTCScreenShareParams,您可以通过其中的 ` floatingView ` 参数弹出悬浮窗(也可以使用 Android 系统的 WindowManager 接口自行弹出)。|
|
|
1271
|
+
|streamType|屏幕分享使用的线路,可以设置为主路(TRTC_VIDEO_STREAM_TYPE_BIG)或者辅路(TRTC_VIDEO_STREAM_TYPE_SUB)。|
|
|
1228
1272
|
|
|
1229
1273
|
> **注意**
|
|
1230
1274
|
>
|
|
@@ -1243,11 +1287,11 @@ Android 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
|
|
|
1243
1287
|
|
|
1244
1288
|
## stopScreenCapture
|
|
1245
1289
|
|
|
1246
|
-
|
|
1290
|
+
**停止屏幕分享。**
|
|
1247
1291
|
|
|
1248
1292
|
## pauseScreenCapture
|
|
1249
1293
|
|
|
1250
|
-
|
|
1294
|
+
**暂停屏幕分享。**
|
|
1251
1295
|
|
|
1252
1296
|
> **注意**
|
|
1253
1297
|
>
|
|
@@ -1257,11 +1301,11 @@ Android 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
|
|
|
1257
1301
|
|
|
1258
1302
|
## resumeScreenCapture
|
|
1259
1303
|
|
|
1260
|
-
|
|
1304
|
+
**恢复屏幕分享。**
|
|
1261
1305
|
|
|
1262
1306
|
## setSubStreamEncoderParam
|
|
1263
1307
|
|
|
1264
|
-
|
|
1308
|
+
**设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。**
|
|
1265
1309
|
|
|
1266
1310
|
该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
|
|
1267
1311
|
|
|
@@ -1270,25 +1314,26 @@ Android 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
|
|
|
1270
1314
|
|
|
1271
1315
|
- setSubStreamEncoderParam 用于设置辅路画面(TRTC_VIDEO_STREAM_TYPE_SUB,一般用于屏幕分享)的视频编码参数。
|
|
1272
1316
|
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
|
1317
|
+
|参数|描述|
|
|
1318
|
+
|---------|---------|
|
|
1319
|
+
|param|辅流编码参数,详情请参见 TRTCVideoEncParam。|
|
|
1276
1320
|
|
|
1277
1321
|
## enableCustomVideoCapture
|
|
1278
1322
|
|
|
1279
|
-
|
|
1323
|
+
**启用/关闭视频自定义采集模式。**
|
|
1280
1324
|
|
|
1281
1325
|
开启该模式后,SDK 不再运行原有的视频采集流程,即不再继续从摄像头采集数据和美颜,而是只保留视频编码和发送能力。
|
|
1282
1326
|
|
|
1283
1327
|
您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
|
1328
|
+
|
|
1329
|
+
|参数|描述|
|
|
1330
|
+
|---------|---------|
|
|
1331
|
+
|enable|是否启用视频自定义采集,默认值:false。|
|
|
1332
|
+
|streamType|用于指定视频流类型,TRTC_VIDEO_STREAM_TYPE_BIG:高清大画面;TRTC_VIDEO_STREAM_TYPE_SUB:辅路画面。|
|
|
1288
1333
|
|
|
1289
1334
|
## sendCustomVideoData
|
|
1290
1335
|
|
|
1291
|
-
|
|
1336
|
+
**向 SDK 投送自己采集的视频帧。**
|
|
1292
1337
|
|
|
1293
1338
|
使用此接口可以向 SDK 投送自己采集的视频帧,SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
|
|
1294
1339
|
|
|
@@ -1298,10 +1343,11 @@ Android 平台有两种投送方案:
|
|
|
1298
1343
|
- 显存传递方案:对接需要一定的 OpenGL 基础,但是性能较好,640 × 360 以上的分辨率请采用该方案。
|
|
1299
1344
|
|
|
1300
1345
|
参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
|
1346
|
+
|
|
1347
|
+
|参数|描述|
|
|
1348
|
+
|---------|---------|
|
|
1349
|
+
|frame|视频数据,如果是内存传递方案,请设置 data 字段;如果是显存传递方案,请设置 TRTCTexture 字段。bufferType 推荐选择 TRTC_VIDEO_BUFFER_TYPE_TEXTURE,pixelFormat 推荐选择 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D,更多支持格式参考 TRTCVideoFrame。|
|
|
1350
|
+
|streamType|用于指定视频流类型,TRTC_VIDEO_STREAM_TYPE_BIG: 高清大画面;TRTC_VIDEO_STREAM_TYPE_SUB: 辅路画面。|
|
|
1305
1351
|
|
|
1306
1352
|
> **注意**
|
|
1307
1353
|
>
|
|
@@ -1317,14 +1363,15 @@ Android 平台有两种投送方案:
|
|
|
1317
1363
|
|
|
1318
1364
|
## enableCustomAudioCapture
|
|
1319
1365
|
|
|
1320
|
-
|
|
1366
|
+
**启用音频自定义采集模式。**
|
|
1321
1367
|
|
|
1322
1368
|
开启该模式后,SDK 不再运行原有的音频采集流程,即不再继续从麦克风采集音频数据,而是只保留音频编码和发送能力。
|
|
1323
1369
|
|
|
1324
1370
|
您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1371
|
+
|
|
1372
|
+
|参数|描述|
|
|
1373
|
+
|---------|---------|
|
|
1374
|
+
|enable|是否启用音频自定义采集模式,默认值:false。|
|
|
1328
1375
|
|
|
1329
1376
|
> **注意**
|
|
1330
1377
|
>
|
|
@@ -1334,7 +1381,7 @@ Android 平台有两种投送方案:
|
|
|
1334
1381
|
|
|
1335
1382
|
## sendCustomAudioData
|
|
1336
1383
|
|
|
1337
|
-
|
|
1384
|
+
**向 SDK 投送自己采集的音频数据。**
|
|
1338
1385
|
|
|
1339
1386
|
参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
|
|
1340
1387
|
- audioFormat:音频数据格式,仅支持 TRTCAudioFrameFormatPCM。
|
|
@@ -1348,9 +1395,10 @@ Android 平台有两种投送方案:
|
|
|
1348
1395
|
- timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在采集到一帧音频帧之后,通过调用 generateCustomPTS 获取时间戳)。
|
|
1349
1396
|
|
|
1350
1397
|
参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1398
|
+
|
|
1399
|
+
|参数|描述|
|
|
1400
|
+
|---------|---------|
|
|
1401
|
+
|frame|音频数据|
|
|
1354
1402
|
|
|
1355
1403
|
> **注意**
|
|
1356
1404
|
>
|
|
@@ -1360,13 +1408,14 @@ Android 平台有两种投送方案:
|
|
|
1360
1408
|
|
|
1361
1409
|
## enableMixExternalAudioFrame
|
|
1362
1410
|
|
|
1363
|
-
|
|
1411
|
+
**启用/关闭自定义音轨。**
|
|
1364
1412
|
|
|
1365
1413
|
开启后,您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数,您可以控制该音轨是否要在远端和本地播放。
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
|
1414
|
+
|
|
1415
|
+
|参数|描述|
|
|
1416
|
+
|---------|---------|
|
|
1417
|
+
|enablePlayout|控制混入的音轨是否要在本地播放,默认值:false。|
|
|
1418
|
+
|enablePublish|控制混入的音轨是否要在远端播放,默认值:false。|
|
|
1370
1419
|
|
|
1371
1420
|
> **注意**
|
|
1372
1421
|
>
|
|
@@ -1376,7 +1425,7 @@ Android 平台有两种投送方案:
|
|
|
1376
1425
|
|
|
1377
1426
|
## mixExternalAudioFrame
|
|
1378
1427
|
|
|
1379
|
-
|
|
1428
|
+
**向 SDK 混入自定义音轨。**
|
|
1380
1429
|
|
|
1381
1430
|
调用该接口之前,您需要先通过 enableMixExternalAudioFrame 开启自定义音轨,之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
|
|
1382
1431
|
|
|
@@ -1391,37 +1440,37 @@ Android 平台有两种投送方案:
|
|
|
1391
1440
|
参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
|
|
1392
1441
|
- data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5ms - 100ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000采样率, 单声道的帧长度:` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
1393
1442
|
|
|
1394
|
-
- sampleRate:采样率,支持:16000、
|
|
1443
|
+
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
1395
1444
|
|
|
1396
1445
|
- channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
|
|
1397
1446
|
|
|
1398
1447
|
- timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在获得一帧音频帧之后,通过调用 generateCustomPTS 获得时间戳)。
|
|
1399
1448
|
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
|
1449
|
+
|参数|描述|
|
|
1450
|
+
|---------|---------|
|
|
1451
|
+
|frame|音频数据|
|
|
1403
1452
|
|
|
1404
1453
|
> **注意**
|
|
1405
1454
|
>
|
|
1406
1455
|
|
|
1407
1456
|
> 请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。
|
|
1408
1457
|
>
|
|
1409
|
-
|
|
1410
|
-
#### 返回值说明:
|
|
1458
|
+
**返回值说明:**
|
|
1411
1459
|
|
|
1412
1460
|
>= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用 ` mixExternalAudioFrame `)
|
|
1413
1461
|
|
|
1414
1462
|
## setMixExternalAudioVolume
|
|
1415
1463
|
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
|
1464
|
+
**设置推流时混入外部音频的推流音量和播放音量。**
|
|
1465
|
+
|
|
1466
|
+
|参数|描述|
|
|
1467
|
+
|---------|---------|
|
|
1468
|
+
|playoutVolume|设置的播放音量大小,范围 [0, 150],-1 表示不改变。|
|
|
1469
|
+
|publishVolume|设置的推流音量大小,范围 [0, 150],-1 表示不改变。|
|
|
1421
1470
|
|
|
1422
1471
|
## generateCustomPTS
|
|
1423
1472
|
|
|
1424
|
-
|
|
1473
|
+
**生成自定义采集时的时间戳。**
|
|
1425
1474
|
|
|
1426
1475
|
本接口仅适用于自定义采集模式,用于解决音视频帧的采集时间(capture time)和投送时间(send time)不一致所导致的音画不同步问题。
|
|
1427
1476
|
|
|
@@ -1431,15 +1480,13 @@ Android 平台有两种投送方案:
|
|
|
1431
1480
|
|
|
1432
1481
|
2. 之后可以将该视频或音频帧送入您使用的前处理模块(如第三方美颜组件,或第三方音效组件)。
|
|
1433
1482
|
|
|
1434
|
-
3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp
|
|
1435
|
-
|
|
1436
|
-
#### 返回值说明:
|
|
1483
|
+
3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。**返回值说明:**
|
|
1437
1484
|
|
|
1438
1485
|
时间戳(单位:ms)
|
|
1439
1486
|
|
|
1440
1487
|
## setLocalVideoProcessListener
|
|
1441
1488
|
|
|
1442
|
-
|
|
1489
|
+
**设置第三方美颜的视频数据回调。**
|
|
1443
1490
|
|
|
1444
1491
|
设置该回调之后,SDK 会把采集到的视频帧通过您设置的 listener 回调出来,用于第三方美颜组件进行二次处理,之后 SDK 会将处理后的视频帧进行编码和发送。
|
|
1445
1492
|
| 参数 | 描述 |
|
|
@@ -1447,14 +1494,13 @@ Android 平台有两种投送方案:
|
|
|
1447
1494
|
| bufferType | 指定回调的数据格式,目前支持:<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 时。 |
|
|
1448
1495
|
| listener | 自定义预处理回调,详见 TRTCVideoFrameListener。 |
|
|
1449
1496
|
| pixelFormat | 指定回调的像素格式,目前支持:<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D: 显存纹理方案。<br>- TRTC_VIDEO_PIXEL_FORMAT_I420:内存数据方案。 |
|
|
1450
|
-
|
|
1451
|
-
#### 返回值说明:
|
|
1497
|
+
**返回值说明:**
|
|
1452
1498
|
|
|
1453
1499
|
0:成功;< 0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/38307))。
|
|
1454
1500
|
|
|
1455
1501
|
## setLocalVideoRenderListener
|
|
1456
1502
|
|
|
1457
|
-
|
|
1503
|
+
**设置本地视频自定义渲染回调。**
|
|
1458
1504
|
|
|
1459
1505
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1460
1506
|
- pixelFormat 指定回调的数据格式,目前支持 Texture2D、I420 和 RGBA 三种格式。
|
|
@@ -1467,14 +1513,13 @@ Android 平台有两种投送方案:
|
|
|
1467
1513
|
| bufferType | 指定视频帧的数据结构:<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 和 TRTC_VIDEO_PIXEL_FORMAT_RGBA 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY:适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 和 TRTC_VIDEO_PIXEL_FORMAT_RGBA 时。 |
|
|
1468
1514
|
| listener | 自定义视频渲染回调,每一帧视频数据回调一次。 |
|
|
1469
1515
|
| pixelFormat | 指定视频帧的像素格式,如:<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D:OpenGL 纹理格式,比较适合 GPU 进行处理,处理效率高。<br>- TRTC_VIDEO_PIXEL_FORMAT_I420:标准 i420 格式,比较适合 CPU 进行处理,处理效率较差。<br>- TRTC_VIDEO_PIXEL_FORMAT_RGBA:RGBA 格式,比较适合 CPU 进行处理,处理效率较差。 |
|
|
1470
|
-
|
|
1471
|
-
#### 返回值说明:
|
|
1516
|
+
**返回值说明:**
|
|
1472
1517
|
|
|
1473
1518
|
0:成功;< 0:错误。
|
|
1474
1519
|
|
|
1475
1520
|
## setRemoteVideoRenderListener
|
|
1476
1521
|
|
|
1477
|
-
|
|
1522
|
+
**设置远端视频自定义渲染回调。**
|
|
1478
1523
|
|
|
1479
1524
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1480
1525
|
- pixelFormat 指定回调的数据格式,例如 NV12、i420 以及 32BGRA。
|
|
@@ -1482,26 +1527,26 @@ Android 平台有两种投送方案:
|
|
|
1482
1527
|
- bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。
|
|
1483
1528
|
|
|
1484
1529
|
参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
|
1489
|
-
|
|
|
1490
|
-
|
|
|
1530
|
+
|
|
1531
|
+
|参数|描述|
|
|
1532
|
+
|---------|---------|
|
|
1533
|
+
|bufferType|指定视频帧的数据结构,如 TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER,TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY。|
|
|
1534
|
+
|listener|自定义视频渲染回调,每一帧视频数据回调一次。|
|
|
1535
|
+
|pixelFormat|指定视频帧的像素格式,目前支持 TRTC_VIDEO_PIXEL_FORMAT_I420,TRTC_VIDEO_PIXEL_FORMAT_RGBA。|
|
|
1536
|
+
|userId|指定远端用户的 ID。|
|
|
1491
1537
|
|
|
1492
1538
|
> **注意**
|
|
1493
1539
|
>
|
|
1494
1540
|
|
|
1495
1541
|
> 实际使用时,需要先调用 ` startRemoteView(userId, null) ` 启动远程视频流的拉取,并将 view 设置为 null,否则不会有数据回调出来。
|
|
1496
1542
|
>
|
|
1497
|
-
|
|
1498
|
-
#### 返回值说明:
|
|
1543
|
+
**返回值说明:**
|
|
1499
1544
|
|
|
1500
1545
|
0:成功;< 0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/38307))。
|
|
1501
1546
|
|
|
1502
1547
|
## setAudioFrameListener
|
|
1503
1548
|
|
|
1504
|
-
|
|
1549
|
+
**设置音频数据自定义回调。**
|
|
1505
1550
|
|
|
1506
1551
|
设置该回调之后,SDK 内部会把音频数据(PCM 格式)回调出来,包括:
|
|
1507
1552
|
- onCapturedAudioFrame:本地麦克风采集到的音频数据回调
|
|
@@ -1520,7 +1565,7 @@ Android 平台有两种投送方案:
|
|
|
1520
1565
|
|
|
1521
1566
|
## setCapturedAudioFrameCallbackFormat
|
|
1522
1567
|
|
|
1523
|
-
|
|
1568
|
+
**设置本地麦克风采集出的音频帧回调格式。**
|
|
1524
1569
|
|
|
1525
1570
|
本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1526
1571
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1532,23 +1577,23 @@ Android 平台有两种投送方案:
|
|
|
1532
1577
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1533
1578
|
|
|
1534
1579
|
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填:` 960 = 20 * 48000 / 1000 `。
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1580
|
+
|
|
1581
|
+
|参数|描述|
|
|
1582
|
+
|---------|---------|
|
|
1583
|
+
|format|音频数据回调格式。|
|
|
1538
1584
|
|
|
1539
1585
|
> **注意**
|
|
1540
1586
|
>
|
|
1541
1587
|
|
|
1542
1588
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1543
1589
|
>
|
|
1544
|
-
|
|
1545
|
-
#### 返回值说明:
|
|
1590
|
+
**返回值说明:**
|
|
1546
1591
|
|
|
1547
1592
|
0:成功;<0:错误。
|
|
1548
1593
|
|
|
1549
1594
|
## setLocalProcessedAudioFrameCallbackFormat
|
|
1550
1595
|
|
|
1551
|
-
|
|
1596
|
+
**设置经过前处理后的本地音频帧回调格式。**
|
|
1552
1597
|
|
|
1553
1598
|
本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1554
1599
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1560,23 +1605,23 @@ Android 平台有两种投送方案:
|
|
|
1560
1605
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1561
1606
|
|
|
1562
1607
|
举例:48000Hz 采样率希望回调20ms帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1608
|
+
|
|
1609
|
+
|参数|描述|
|
|
1610
|
+
|---------|---------|
|
|
1611
|
+
|format|音频数据回调格式。|
|
|
1566
1612
|
|
|
1567
1613
|
> **注意**
|
|
1568
1614
|
>
|
|
1569
1615
|
|
|
1570
1616
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1571
1617
|
>
|
|
1572
|
-
|
|
1573
|
-
#### 返回值说明:
|
|
1618
|
+
**返回值说明:**
|
|
1574
1619
|
|
|
1575
1620
|
0:成功;<0:错误。
|
|
1576
1621
|
|
|
1577
1622
|
## setMixedPlayAudioFrameCallbackFormat
|
|
1578
1623
|
|
|
1579
|
-
|
|
1624
|
+
**设置最终要由系统播放出的音频帧回调格式。**
|
|
1580
1625
|
|
|
1581
1626
|
本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1582
1627
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1588,30 +1633,31 @@ Android 平台有两种投送方案:
|
|
|
1588
1633
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1589
1634
|
|
|
1590
1635
|
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1636
|
+
|
|
1637
|
+
|参数|描述|
|
|
1638
|
+
|---------|---------|
|
|
1639
|
+
|format|音频数据回调格式。|
|
|
1594
1640
|
|
|
1595
1641
|
> **注意**
|
|
1596
1642
|
>
|
|
1597
1643
|
|
|
1598
1644
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1599
1645
|
>
|
|
1600
|
-
|
|
1601
|
-
#### 返回值说明:
|
|
1646
|
+
**返回值说明:**
|
|
1602
1647
|
|
|
1603
1648
|
0:成功;<0:错误。
|
|
1604
1649
|
|
|
1605
1650
|
## enableCustomAudioRendering
|
|
1606
1651
|
|
|
1607
|
-
|
|
1652
|
+
**开启音频自定义播放。**
|
|
1608
1653
|
|
|
1609
1654
|
如果您需要外接一些特定的音频设备,或者希望自己掌控音频的播放逻辑,您可以通过该接口启用音频自定义播放。
|
|
1610
1655
|
|
|
1611
1656
|
启用音频自定义播放后,SDK 将不再调用系统的音频接口播放数据,您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1657
|
+
|
|
1658
|
+
|参数|描述|
|
|
1659
|
+
|---------|---------|
|
|
1660
|
+
|enable|是否启用音频自定义播放,默认为关闭状态。|
|
|
1615
1661
|
|
|
1616
1662
|
> **注意**
|
|
1617
1663
|
>
|
|
@@ -1621,7 +1667,7 @@ Android 平台有两种投送方案:
|
|
|
1621
1667
|
|
|
1622
1668
|
## getCustomAudioRenderingFrame
|
|
1623
1669
|
|
|
1624
|
-
|
|
1670
|
+
**获取可播放的音频数据。**
|
|
1625
1671
|
|
|
1626
1672
|
调用该接口之前,您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
|
|
1627
1673
|
|
|
@@ -1633,9 +1679,10 @@ Android 平台有两种投送方案:
|
|
|
1633
1679
|
- data:用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长,推荐使用 20ms 的帧长。
|
|
1634
1680
|
|
|
1635
1681
|
计算公式为:` 采样率 x 播放时长 x 声道数量 x 2(每个样点的字节数) `, 例如: 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1682
|
+
|
|
1683
|
+
|参数|描述|
|
|
1684
|
+
|---------|---------|
|
|
1685
|
+
|audioFrame|音频数据帧。|
|
|
1639
1686
|
|
|
1640
1687
|
> **注意**
|
|
1641
1688
|
>
|
|
@@ -1651,17 +1698,18 @@ Android 平台有两种投送方案:
|
|
|
1651
1698
|
|
|
1652
1699
|
## sendCustomCmdMsg
|
|
1653
1700
|
|
|
1654
|
-
|
|
1701
|
+
**使用 UDP 通道发送自定义消息给房间内所有用户。**
|
|
1655
1702
|
|
|
1656
1703
|
该接口可以让您借助 TRTC 的 UDP 通道,向当前房间里的其他用户广播自定义数据,以达到传输信令的目的。
|
|
1657
1704
|
|
|
1658
1705
|
房间中的其他用户可以通过 TRTCCloudListener 中的 onRecvCustomCmdMsg 回调接收消息。
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
|
1663
|
-
|
|
|
1664
|
-
|
|
|
1706
|
+
|
|
1707
|
+
|参数|描述|
|
|
1708
|
+
|---------|---------|
|
|
1709
|
+
|cmdID|消息 ID,取值范围为 [1, 10]。|
|
|
1710
|
+
|data|待发送的消息,单个消息的最大长度被限制为 1KB。|
|
|
1711
|
+
|ordered|是否要求有序,即是否要求接收端的数据包顺序和发送端的数据包顺序一致(这会带来一定的接收延时)。|
|
|
1712
|
+
|reliable|是否可靠发送,可靠发送可以获得更高的发送成功率,但可靠发送比不可靠发送会带来更大的接收延迟。|
|
|
1665
1713
|
|
|
1666
1714
|
> **注意**
|
|
1667
1715
|
>
|
|
@@ -1683,14 +1731,13 @@ Android 平台有两种投送方案:
|
|
|
1683
1731
|
|
|
1684
1732
|
> 6. 目前仅支持主播身份。
|
|
1685
1733
|
>
|
|
1686
|
-
|
|
1687
|
-
#### 返回值说明:
|
|
1734
|
+
**返回值说明:**
|
|
1688
1735
|
|
|
1689
1736
|
true:消息已经发出;false:消息发送失败。
|
|
1690
1737
|
|
|
1691
1738
|
## sendSEIMsg
|
|
1692
1739
|
|
|
1693
|
-
|
|
1740
|
+
**使用 SEI 通道发送自定义消息给房间内所有用户。**
|
|
1694
1741
|
|
|
1695
1742
|
该接口可以让您借助 TRTC 的 SEI 通道,向当前房间里的其他用户广播自定义数据,已达到传输信令的目的。
|
|
1696
1743
|
|
|
@@ -1703,10 +1750,11 @@ true:消息已经发出;false:消息发送失败。
|
|
|
1703
1750
|
最常见的用法是把自定义的时间戳(timestamp)用本接口嵌入视频帧中,实现消息和画面的完美对齐(例如:教育场景下的课件和视频信号的对齐)。
|
|
1704
1751
|
|
|
1705
1752
|
房间中的其他用户可以通过 TRTCCloudListener 中的 onRecvSEIMsg 回调接收消息。
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
|
1753
|
+
|
|
1754
|
+
|参数|描述|
|
|
1755
|
+
|---------|---------|
|
|
1756
|
+
|data|待发送的数据,最大支持 1KB(1000字节)的数据大小|
|
|
1757
|
+
|repeatCount|发送数据次数|
|
|
1710
1758
|
|
|
1711
1759
|
> **注意**
|
|
1712
1760
|
>
|
|
@@ -1728,17 +1776,17 @@ true:消息已经发出;false:消息发送失败。
|
|
|
1728
1776
|
|
|
1729
1777
|
> 5. 若指定多次发送(repeatCount > 1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。
|
|
1730
1778
|
>
|
|
1731
|
-
|
|
1732
|
-
#### 返回值说明:
|
|
1779
|
+
**返回值说明:**
|
|
1733
1780
|
|
|
1734
1781
|
true:消息已通过限制,等待后续视频帧发送;false:消息被限制发送
|
|
1735
1782
|
|
|
1736
1783
|
## startSpeedTest
|
|
1737
1784
|
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1785
|
+
**开始进行网速测试(进入房间前使用)。**
|
|
1786
|
+
|
|
1787
|
+
|参数|描述|
|
|
1788
|
+
|---------|---------|
|
|
1789
|
+
|params|测速选项|
|
|
1742
1790
|
|
|
1743
1791
|
> **注意**
|
|
1744
1792
|
>
|
|
@@ -1751,47 +1799,49 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1751
1799
|
|
|
1752
1800
|
> 3. 同一时间只允许一项网速测试任务运行。
|
|
1753
1801
|
>
|
|
1754
|
-
|
|
1755
|
-
#### 返回值说明:
|
|
1802
|
+
**返回值说明:**
|
|
1756
1803
|
|
|
1757
1804
|
接口调用结果,< 0:失败
|
|
1758
1805
|
|
|
1759
1806
|
## stopSpeedTest
|
|
1760
1807
|
|
|
1761
|
-
|
|
1808
|
+
**停止网络测速。**
|
|
1762
1809
|
|
|
1763
1810
|
## getSDKVersion
|
|
1764
1811
|
|
|
1765
|
-
|
|
1812
|
+
**获取 SDK 版本信息。**
|
|
1766
1813
|
|
|
1767
1814
|
## setLogLevel
|
|
1768
1815
|
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1816
|
+
**设置 Log 输出级别。**
|
|
1817
|
+
|
|
1818
|
+
|参数|描述|
|
|
1819
|
+
|---------|---------|
|
|
1820
|
+
|level|参见 TRTCLogLevel,默认值:TRTC_LOG_LEVEL_NULL|
|
|
1773
1821
|
|
|
1774
1822
|
## setConsoleEnabled
|
|
1775
1823
|
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1824
|
+
**启用/禁用控制台日志打印。**
|
|
1825
|
+
|
|
1826
|
+
|参数|描述|
|
|
1827
|
+
|---------|---------|
|
|
1828
|
+
|enabled|指定是否启用,默认:禁止状态。|
|
|
1780
1829
|
|
|
1781
1830
|
## setLogCompressEnabled
|
|
1782
1831
|
|
|
1783
|
-
|
|
1832
|
+
**启用/禁用日志的本地压缩。**
|
|
1784
1833
|
|
|
1785
1834
|
开启压缩后,Log 存储体积明显减小,但需要腾讯云提供的 Python 脚本解压后才能阅读。
|
|
1786
1835
|
|
|
1787
1836
|
禁用压缩后,Log 采用明文存储,可以直接用记事本打开阅读,但占用空间较大。
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1837
|
+
|
|
1838
|
+
|参数|描述|
|
|
1839
|
+
|---------|---------|
|
|
1840
|
+
|enabled|指定是否启用,默认为启动状态|
|
|
1791
1841
|
|
|
1792
1842
|
## setLogDirPath
|
|
1793
1843
|
|
|
1794
|
-
|
|
1844
|
+
**设置本地日志的保存路径。**
|
|
1795
1845
|
|
|
1796
1846
|
通过该接口您可以更改 SDK 本地日志的默认存储路径,SDK 默认的本地日志的存储位置:
|
|
1797
1847
|
- Windows 平台:在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log,即 %appdata%/liteav/log 下。
|
|
@@ -1800,9 +1850,9 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1800
1850
|
|
|
1801
1851
|
- Android 平台:在 /app私有目录/files/log/liteav/ 下。
|
|
1802
1852
|
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
|
1853
|
+
|参数|描述|
|
|
1854
|
+
|---------|---------|
|
|
1855
|
+
|path|存储日志的路径|
|
|
1806
1856
|
|
|
1807
1857
|
> **注意**
|
|
1808
1858
|
>
|
|
@@ -1812,47 +1862,49 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1812
1862
|
|
|
1813
1863
|
## setLogListener
|
|
1814
1864
|
|
|
1815
|
-
|
|
1865
|
+
**设置日志回调。**
|
|
1816
1866
|
|
|
1817
1867
|
## showDebugView
|
|
1818
1868
|
|
|
1819
|
-
|
|
1869
|
+
**显示仪表盘。**
|
|
1820
1870
|
|
|
1821
1871
|
“仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层,用于展示音视频信息和事件信息,便于对接和调试。
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1872
|
+
|
|
1873
|
+
|参数|描述|
|
|
1874
|
+
|---------|---------|
|
|
1875
|
+
|showType|0:不显示;1:显示精简版(仅显示音视频信息);2:显示完整版(包含音视频信息和事件信息)。|
|
|
1825
1876
|
|
|
1826
1877
|
## TRTCViewMargin
|
|
1827
1878
|
|
|
1828
|
-
|
|
1879
|
+
**设置仪表盘的边距。**
|
|
1829
1880
|
|
|
1830
1881
|
用于调整仪表盘在视频渲染控件中的位置,必须在 showDebugView 之前调用才能生效。
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
|
1882
|
+
|
|
1883
|
+
|参数|描述|
|
|
1884
|
+
|---------|---------|
|
|
1885
|
+
|margin|仪表盘内边距,注意这里是基于 parentView 的百分比,` margin ` 的取值范围是 [0, 1]。|
|
|
1886
|
+
|userId|用户 ID。|
|
|
1835
1887
|
|
|
1836
1888
|
## callExperimentalAPI
|
|
1837
1889
|
|
|
1838
|
-
|
|
1890
|
+
**调用实验性接口。**
|
|
1839
1891
|
|
|
1840
1892
|
## enablePayloadPrivateEncryption
|
|
1841
1893
|
|
|
1842
|
-
|
|
1894
|
+
**开启或关闭媒体流私有加密。**
|
|
1843
1895
|
|
|
1844
1896
|
在安全要求较高的场景下,TRTC 建议您在加入房间前,调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
|
|
1845
1897
|
|
|
1846
1898
|
用户退出房间后,SDK 会自动关闭私有加密。如需重新开启私有加密,您需要在用户再次加入房间前调用该方法。
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
|
1899
|
+
|
|
1900
|
+
|参数|描述|
|
|
1901
|
+
|---------|---------|
|
|
1902
|
+
|config|配置媒体流私有加密的算法和密钥,参见 TRTCPayloadPrivateEncryptionConfig。|
|
|
1903
|
+
|enabled|是否开启媒体流私有加密。|
|
|
1851
1904
|
|
|
1852
1905
|
> **注意**
|
|
1853
1906
|
>
|
|
1854
1907
|
|
|
1855
|
-
> TRTC
|
|
1908
|
+
> TRTC 已经内置对媒体流进行加密后再传输,启用媒体流私有加密后将使用您传入的密钥与初始向量进行再次加密。
|
|
1856
1909
|
>
|
|
1857
|
-
|
|
1858
|
-
#### 返回值说明:
|
|
1910
|
+
**返回值说明:**
|