@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,128 +1,133 @@
|
|
|
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
|
## ITRTCCloud
|
|
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
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
10
|
+
|
|
11
|
+
|函数列表|描述|
|
|
12
|
+
|---------|---------|
|
|
13
|
+
|getTRTCShareInstance|创建 TRTCCloud 实例(单例模式)。|
|
|
14
|
+
|destroyTRTCShareInstance|销毁 TRTCCloud 实例(单例模式)。|
|
|
15
|
+
|addCallback|添加 TRTC 事件回调。|
|
|
16
|
+
|removeCallback|移除 TRTC 事件回调。|
|
|
17
|
+
|enterRoom|进入房间。|
|
|
18
|
+
|exitRoom|离开房间。|
|
|
19
|
+
|switchRole|切换角色。|
|
|
20
|
+
|switchRole|切换角色(支持设置权限位)。|
|
|
21
|
+
|switchRoom|切换房间。|
|
|
22
|
+
|connectOtherRoom|请求跨房通话。|
|
|
23
|
+
|disconnectOtherRoom|退出跨房通话。|
|
|
24
|
+
|setDefaultStreamRecvMode|设置订阅模式(需要在进入房前设置才能生效)。|
|
|
25
|
+
|createSubCloud|创建子房间实例(用于多房间并发观看)。|
|
|
26
|
+
|destroySubCloud|销毁子房间实例。|
|
|
27
|
+
|updateOtherRoomForwardMode|更改跨房主播在本房间的上行能力。|
|
|
28
|
+
|startPublishMediaStream|开始发布媒体流。|
|
|
29
|
+
|updatePublishMediaStream|更新发布媒体流。|
|
|
30
|
+
|stopPublishMediaStream|停止发布媒体流。|
|
|
31
|
+
|startLocalPreview|开启本地摄像头的预览画面(移动端)。|
|
|
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
|
+
|enableSmallVideoStream|开启大小画面双路编码模式。|
|
|
48
|
+
|setRemoteVideoStreamType|切换指定远端用户的大小画面。|
|
|
49
|
+
|snapshotVideo|视频画面截图。|
|
|
50
|
+
|setGravitySensorAdaptiveMode|设置重力感应的适配模式(11.7 及以上版本)。|
|
|
51
|
+
|startLocalAudio|开启本地音频的采集和发布。|
|
|
52
|
+
|stopLocalAudio|停止本地音频的采集和发布。|
|
|
53
|
+
|muteLocalAudio|暂停/恢复发布本地的音频流。|
|
|
54
|
+
|muteRemoteAudio|暂停/恢复播放远端的音频流。|
|
|
55
|
+
|muteAllRemoteAudio|暂停/恢复播放所有远端用户的音频流。|
|
|
56
|
+
|setRemoteAudioVolume|设定某一个远端用户的声音播放音量。|
|
|
57
|
+
|setAudioCaptureVolume|设定本地音频的采集音量。|
|
|
58
|
+
|getAudioCaptureVolume|获取本地音频的采集音量。|
|
|
59
|
+
|setAudioPlayoutVolume|设定远端音频的播放音量。|
|
|
60
|
+
|getAudioPlayoutVolume|获取远端音频的播放音量。|
|
|
61
|
+
|enableAudioVolumeEvaluation|启用音量大小提示。|
|
|
62
|
+
|startAudioRecording|开始录音。|
|
|
63
|
+
|stopAudioRecording|停止录音。|
|
|
64
|
+
|startLocalRecording|开启本地媒体录制。|
|
|
65
|
+
|stopLocalRecording|停止本地媒体录制。|
|
|
66
|
+
|setRemoteAudioParallelParams|设置远端音频流智能并发播放策略。|
|
|
67
|
+
|enable3DSpatialAudioEffect|启用 3D 音效。|
|
|
68
|
+
|updateSelf3DSpatialPosition|设置 3D 音效中自身坐标及朝向信息。|
|
|
69
|
+
|updateRemote3DSpatialPosition|设置 3D 音效中远端用户坐标信息。|
|
|
70
|
+
|set3DSpatialReceivingRange|设置指定用户所发出声音的可被接收范围。|
|
|
71
|
+
|getDeviceManager|获取设备管理类(TXDeviceManager)。|
|
|
72
|
+
|getBeautyManager|获取美颜管理类(TXBeautyManager)。|
|
|
73
|
+
|setWaterMark|添加水印。|
|
|
74
|
+
|getAudioEffectManager|获取音效管理类(TXAudioEffectManager)。|
|
|
75
|
+
|startSystemAudioLoopback|开启系统声音采集(iOS 端暂未支持)。|
|
|
76
|
+
|stopSystemAudioLoopback|停止系统声音采集(iOS 端暂未支持)。|
|
|
77
|
+
|setSystemAudioLoopbackVolume|设置系统声音的采集音量。|
|
|
78
|
+
|getAITranscriberManager|获取 AI 转录管理类(AITranscriberManager)。|
|
|
79
|
+
|startScreenCapture|启动屏幕分享。|
|
|
80
|
+
|stopScreenCapture|停止屏幕分享。|
|
|
81
|
+
|pauseScreenCapture|暂停屏幕分享。|
|
|
82
|
+
|resumeScreenCapture|恢复屏幕分享。|
|
|
83
|
+
|getScreenCaptureSources|枚举可分享的屏幕和窗口(该接口仅支持桌面系统)。|
|
|
84
|
+
|selectScreenCaptureTarget|选取要分享的屏幕或窗口(该接口仅支持桌面系统)。|
|
|
85
|
+
|setSubStreamEncoderParam|设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。|
|
|
86
|
+
|setSubStreamMixVolume|设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。|
|
|
87
|
+
|addExcludedShareWindow|将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。|
|
|
88
|
+
|removeExcludedShareWindow|将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。|
|
|
89
|
+
|removeAllExcludedShareWindow|将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。|
|
|
90
|
+
|addIncludedShareWindow|将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。|
|
|
91
|
+
|removeIncludedShareWindow|将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。|
|
|
92
|
+
|removeAllIncludedShareWindow|将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。|
|
|
93
|
+
|enableCustomVideoCapture|启用/关闭视频自定义采集模式。|
|
|
94
|
+
|sendCustomVideoData|向 SDK 投送自己采集的视频帧。|
|
|
95
|
+
|enableCustomAudioCapture|启用音频自定义采集模式。|
|
|
96
|
+
|sendCustomAudioData|向 SDK 投送自己采集的音频数据。|
|
|
97
|
+
|enableMixExternalAudioFrame|启用/关闭自定义音轨。|
|
|
98
|
+
|mixExternalAudioFrame|向 SDK 混入自定义音轨。|
|
|
99
|
+
|setMixExternalAudioVolume|设置推流时混入外部音频的推流音量和播放音量。|
|
|
100
|
+
|generateCustomPTS|生成自定义采集时的时间戳。|
|
|
101
|
+
|enableLocalVideoCustomProcess|.1 开启视频第三方美颜。|
|
|
102
|
+
|setLocalVideoCustomProcessCallback|.2 设置第三方美颜的视频数据回调。|
|
|
103
|
+
|setLocalVideoRenderCallback|设置本地视频自定义渲染回调。|
|
|
104
|
+
|setRemoteVideoRenderCallback|设置远端视频自定义渲染回调。|
|
|
105
|
+
|setAudioFrameCallback|设置音频数据自定义回调。|
|
|
106
|
+
|setCapturedAudioFrameCallbackFormat|设置本地麦克风采集出的音频帧回调格式。|
|
|
107
|
+
|setLocalProcessedAudioFrameCallbackFormat|设置经过前处理后的本地音频帧回调格式。|
|
|
108
|
+
|setMixedPlayAudioFrameCallbackFormat|设置最终要由系统播放出的音频帧回调格式。|
|
|
109
|
+
|enableCustomAudioRendering|开启音频自定义播放。|
|
|
110
|
+
|getCustomAudioRenderingFrame|获取可播放的音频数据。|
|
|
111
|
+
|sendCustomCmdMsg|使用 UDP 通道发送自定义消息给房间内所有用户。|
|
|
112
|
+
|sendSEIMsg|使用 SEI 通道发送自定义消息给房间内所有用户。|
|
|
113
|
+
|startSpeedTest|开始进行网速测试(进入房间前使用)。|
|
|
114
|
+
|stopSpeedTest|停止网络测速。|
|
|
115
|
+
|getSDKVersion|获取 SDK 版本信息。|
|
|
116
|
+
|setLogLevel|设置 Log 输出级别。|
|
|
117
|
+
|setConsoleEnabled|启用/禁用控制台日志打印。|
|
|
118
|
+
|setLogCompressEnabled|启用/禁用日志的本地压缩。|
|
|
119
|
+
|setLogDirPath|设置本地日志的保存路径。|
|
|
120
|
+
|setLogCallback|设置日志回调。|
|
|
121
|
+
|showDebugView|显示仪表盘。|
|
|
122
|
+
|callExperimentalAPI|调用实验性接口。|
|
|
123
|
+
|enablePayloadPrivateEncryption|开启或关闭媒体流私有加密。|
|
|
119
124
|
|
|
120
125
|
## getTRTCShareInstance
|
|
121
126
|
|
|
122
|
-
|
|
127
|
+
**创建 TRTCCloud 实例(单例模式)。**
|
|
123
128
|
| 参数 | 描述 |
|
|
124
129
|
| --- | --- |
|
|
125
|
-
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的
|
|
130
|
+
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 <code> context </code> 参数为空,SDK 内部会自动获取当前进程的 ApplicationContext。 |
|
|
126
131
|
|
|
127
132
|
> **注意**
|
|
128
133
|
>
|
|
@@ -138,21 +143,21 @@
|
|
|
138
143
|
|
|
139
144
|
## destroyTRTCShareInstance
|
|
140
145
|
|
|
141
|
-
|
|
146
|
+
**销毁 TRTCCloud 实例(单例模式)。**
|
|
142
147
|
|
|
143
148
|
## addCallback
|
|
144
149
|
|
|
145
|
-
|
|
150
|
+
**添加 TRTC 事件回调。**
|
|
146
151
|
|
|
147
152
|
您可以通过 ITRTCCloudCallback 获得来自 SDK 的各类事件通知(例如:错误码,警告码,音视频状态参数等)。
|
|
148
153
|
|
|
149
154
|
## removeCallback
|
|
150
155
|
|
|
151
|
-
|
|
156
|
+
**移除 TRTC 事件回调。**
|
|
152
157
|
|
|
153
158
|
## enterRoom
|
|
154
159
|
|
|
155
|
-
|
|
160
|
+
**进入房间。**
|
|
156
161
|
|
|
157
162
|
TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流,“发布”是指将自己的音频和视频推送到云端,“订阅”是指从云端拉取房间里其他用户的音视频流。
|
|
158
163
|
|
|
@@ -171,10 +176,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
171
176
|
|
|
172
177
|
- 如果进房失败,参数 ` result ` 会是一个负数(result < 0),表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
|
|
173
178
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
|
177
|
-
|
|
|
179
|
+
|参数|描述|
|
|
180
|
+
|---------|---------|
|
|
181
|
+
|param|进房参数,用于指定用户的身份、角色和安全票据等信息,详情请参见 TRTCParams 。|
|
|
182
|
+
|scene|应用场景,用于指定您的业务场景,同一个房间内的所有用户需要设定相同的 TRTCAppScene。|
|
|
178
183
|
|
|
179
184
|
> **注意**
|
|
180
185
|
>
|
|
@@ -190,7 +195,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
190
195
|
|
|
191
196
|
## exitRoom
|
|
192
197
|
|
|
193
|
-
|
|
198
|
+
**离开房间。**
|
|
194
199
|
|
|
195
200
|
调用该接口会让用户离开自己所在的音视频房间,并释放摄像头、麦克风、扬声器等设备资源。
|
|
196
201
|
|
|
@@ -200,7 +205,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
200
205
|
|
|
201
206
|
## switchRole
|
|
202
207
|
|
|
203
|
-
|
|
208
|
+
**切换角色。**
|
|
204
209
|
|
|
205
210
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
206
211
|
|
|
@@ -209,7 +214,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
209
214
|
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
210
215
|
| 参数 | 描述 |
|
|
211
216
|
| --- | --- |
|
|
212
|
-
| role | 角色,默认为
|
|
217
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
213
218
|
|
|
214
219
|
> **注意**
|
|
215
220
|
>
|
|
@@ -222,7 +227,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
222
227
|
|
|
223
228
|
## switchRole
|
|
224
229
|
|
|
225
|
-
|
|
230
|
+
**切换角色(支持设置权限位)。**
|
|
226
231
|
|
|
227
232
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
228
233
|
|
|
@@ -231,8 +236,8 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
231
236
|
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
232
237
|
| 参数 | 描述 |
|
|
233
238
|
| --- | --- |
|
|
234
|
-
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用
|
|
235
|
-
| role | 角色,默认为
|
|
239
|
+
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用 <code> privateMapKey </code> 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
|
|
240
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
236
241
|
|
|
237
242
|
> **注意**
|
|
238
243
|
>
|
|
@@ -245,7 +250,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
245
250
|
|
|
246
251
|
## switchRoom
|
|
247
252
|
|
|
248
|
-
|
|
253
|
+
**切换房间。**
|
|
249
254
|
|
|
250
255
|
使用该接口可以让用户快速从一个房间切换到另一个房间。
|
|
251
256
|
- 如果用户的身份是“观众”,该接口的调用效果等同于 ` exitRoom(当前房间) + enterRoom(新的房间) `。
|
|
@@ -255,9 +260,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
255
260
|
该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
|
|
256
261
|
|
|
257
262
|
接口调用结果会通过 ITRTCCloudCallback 中的 onSwitchRoom 回调。
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
263
|
+
|
|
264
|
+
|参数|描述|
|
|
265
|
+
|---------|---------|
|
|
266
|
+
|config|房间参数,详情请参见 TRTCSwitchRoomConfig。|
|
|
261
267
|
|
|
262
268
|
> **注意**
|
|
263
269
|
>
|
|
@@ -273,7 +279,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
273
279
|
|
|
274
280
|
## connectOtherRoom
|
|
275
281
|
|
|
276
|
-
|
|
282
|
+
**请求跨房通话。**
|
|
277
283
|
|
|
278
284
|
默认情况下,只有同一个房间中的用户之间可以进行音视频通话,不同的房间之间的音视频流是相互隔离的。
|
|
279
285
|
|
|
@@ -317,19 +323,20 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
317
323
|
std::string params = writer.write(jsonObj);
|
|
318
324
|
trtc.connectOtherRoom(params.c_str());
|
|
319
325
|
```
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
326
|
+
|
|
327
|
+
|参数|描述|
|
|
328
|
+
|---------|---------|
|
|
329
|
+
|param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID。|
|
|
323
330
|
|
|
324
331
|
## disconnectOtherRoom
|
|
325
332
|
|
|
326
|
-
|
|
333
|
+
**退出跨房通话。**
|
|
327
334
|
|
|
328
335
|
退出结果会通过 ITRTCCloudCallback 中的 onDisconnectOtherRoom 回调通知给您。
|
|
329
336
|
|
|
330
337
|
## setDefaultStreamRecvMode
|
|
331
338
|
|
|
332
|
-
|
|
339
|
+
**设置订阅模式(需要在进入房前设置才能生效)。**
|
|
333
340
|
|
|
334
341
|
您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换:
|
|
335
342
|
- 自动订阅:默认模式,用户在进入房间后会立刻接收到该房间中的音视频流,音频会自动播放,视频会自动开始解码(依然需要您通过 startRemoteView 接口绑定渲染控件)。
|
|
@@ -339,10 +346,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
339
346
|
在绝大多数场景下,用户进入房间后都会订阅房间中所有主播的音视频流,因此 TRTC 默认采用了自动订阅模式,以求得最佳的“秒开体验”。
|
|
340
347
|
|
|
341
348
|
如果您的应用场景中每个房间同时会有很多路音视频流在发布,而每个用户只想选择性地订阅其中的 1-2 路,则推荐使用“手动订阅”模式以节省流量费用。
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
|
349
|
+
|
|
350
|
+
|参数|描述|
|
|
351
|
+
|---------|---------|
|
|
352
|
+
|autoRecvAudio|true:自动订阅音频;false:需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值:true。|
|
|
353
|
+
|autoRecvVideo|true:自动订阅视频;false:需手动调用 ` startRemoteView ` 订阅视频。默认值:true。|
|
|
346
354
|
|
|
347
355
|
> **注意**
|
|
348
356
|
>
|
|
@@ -355,7 +363,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
355
363
|
|
|
356
364
|
## createSubCloud
|
|
357
365
|
|
|
358
|
-
|
|
366
|
+
**创建子房间实例(用于多房间并发观看)。**
|
|
359
367
|
|
|
360
368
|
TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的能力。
|
|
361
369
|
|
|
@@ -407,21 +415,21 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
407
415
|
>
|
|
408
416
|
> - 多实例的音频需要同时为麦克风采集或自定义采集,而且与音频设备相关的接口调用会以最后一次为准;
|
|
409
417
|
> - 与摄像头相关的调用会以最后一次为准:startLocalPreview。
|
|
410
|
-
|
|
411
|
-
#### 返回值说明:
|
|
418
|
+
**返回值说明:**
|
|
412
419
|
|
|
413
420
|
子 TRTCCloud 实例
|
|
414
421
|
|
|
415
422
|
## destroySubCloud
|
|
416
423
|
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
424
|
+
**销毁子房间实例。**
|
|
425
|
+
|
|
426
|
+
|参数|描述|
|
|
427
|
+
|---------|---------|
|
|
428
|
+
|subCloud|子房间实例|
|
|
421
429
|
|
|
422
430
|
## updateOtherRoomForwardMode
|
|
423
431
|
|
|
424
|
-
|
|
432
|
+
**更改跨房主播在本房间的上行能力。**
|
|
425
433
|
|
|
426
434
|
通常情况下,在调用 connectOtherRoom 接口与另一个房间的主播进行跨房通话后,本房间内的所有观众都将收到该主播发布的音视频流。
|
|
427
435
|
|
|
@@ -466,20 +474,22 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
466
474
|
"muteSubStream":false
|
|
467
475
|
}
|
|
468
476
|
```
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
477
|
+
|
|
478
|
+
|参数|描述|
|
|
479
|
+
|---------|---------|
|
|
480
|
+
|param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID,` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项,分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
|
|
472
481
|
|
|
473
482
|
## startPublishMediaStream
|
|
474
483
|
|
|
475
|
-
|
|
484
|
+
**开始发布媒体流。**
|
|
476
485
|
|
|
477
486
|
该接口会向 TRTC 服务器发送指令,要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 TRTCPublishTarget 配置中的 TRTCPublishMode 指定具体的发布模式
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
|
482
|
-
|
|
|
487
|
+
|
|
488
|
+
|参数|描述|
|
|
489
|
+
|---------|---------|
|
|
490
|
+
|config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
|
|
491
|
+
|params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
|
|
492
|
+
|target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
|
|
483
493
|
|
|
484
494
|
> **注意**
|
|
485
495
|
>
|
|
@@ -498,15 +508,16 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
498
508
|
|
|
499
509
|
## updatePublishMediaStream
|
|
500
510
|
|
|
501
|
-
|
|
511
|
+
**更新发布媒体流。**
|
|
502
512
|
|
|
503
513
|
该接口会向 TRTC 服务器发送指令,更新通过 startPublishMediaStream 启动的媒体流
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
|
508
|
-
|
|
|
509
|
-
|
|
|
514
|
+
|
|
515
|
+
|参数|描述|
|
|
516
|
+
|---------|---------|
|
|
517
|
+
|config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
|
|
518
|
+
|params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
|
|
519
|
+
|target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
|
|
520
|
+
|taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
|
|
510
521
|
|
|
511
522
|
> **注意**
|
|
512
523
|
>
|
|
@@ -522,12 +533,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
522
533
|
|
|
523
534
|
## stopPublishMediaStream
|
|
524
535
|
|
|
525
|
-
|
|
536
|
+
**停止发布媒体流。**
|
|
526
537
|
|
|
527
538
|
该接口会向 TRTC 服务器发送指令,停止通过 startPublishMediaStream 启动的媒体流
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
539
|
+
|
|
540
|
+
|参数|描述|
|
|
541
|
+
|---------|---------|
|
|
542
|
+
|taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
|
|
531
543
|
|
|
532
544
|
> **注意**
|
|
533
545
|
>
|
|
@@ -540,17 +552,18 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
540
552
|
|
|
541
553
|
## startLocalPreview
|
|
542
554
|
|
|
543
|
-
|
|
555
|
+
**开启本地摄像头的预览画面(移动端)。**
|
|
544
556
|
|
|
545
557
|
在 enterRoom 之前调用此函数,SDK 只会开启摄像头,并一直等到您调用 enterRoom 之后才开始推流。
|
|
546
558
|
|
|
547
559
|
在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。
|
|
548
560
|
|
|
549
561
|
当开始渲染首帧摄像头画面时,您会收到 ITRTCCloudCallback 中的 onCameraDidReady 回调通知。
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
|
562
|
+
|
|
563
|
+
|参数|描述|
|
|
564
|
+
|---------|---------|
|
|
565
|
+
|frontCamera|true:前置摄像头;false:后置摄像头。|
|
|
566
|
+
|view|承载视频画面的控件。|
|
|
554
567
|
|
|
555
568
|
> **注意**
|
|
556
569
|
>
|
|
@@ -562,7 +575,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
562
575
|
|
|
563
576
|
## startLocalPreview
|
|
564
577
|
|
|
565
|
-
|
|
578
|
+
**开启本地摄像头的预览画面(桌面端)。**
|
|
566
579
|
|
|
567
580
|
在调用该接口之前,您可以先调用 setCurrentDevice 选择使用桌面端设备自带摄像头或外接摄像头。
|
|
568
581
|
|
|
@@ -571,9 +584,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
571
584
|
在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。
|
|
572
585
|
|
|
573
586
|
当开始渲染首帧摄像头画面时,您会收到 ITRTCCloudCallback 中的 onCameraDidReady 回调通知。
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
587
|
+
|
|
588
|
+
|参数|描述|
|
|
589
|
+
|---------|---------|
|
|
590
|
+
|view|承载视频画面的控件。|
|
|
577
591
|
|
|
578
592
|
> **注意**
|
|
579
593
|
>
|
|
@@ -585,15 +599,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
585
599
|
|
|
586
600
|
## updateLocalView
|
|
587
601
|
|
|
588
|
-
|
|
602
|
+
**更新本地摄像头的预览画面。**
|
|
589
603
|
|
|
590
604
|
## stopLocalPreview
|
|
591
605
|
|
|
592
|
-
|
|
606
|
+
**停止摄像头预览。**
|
|
593
607
|
|
|
594
608
|
## muteLocalVideo
|
|
595
609
|
|
|
596
|
-
|
|
610
|
+
**暂停/恢复发布本地的视频流。**
|
|
597
611
|
|
|
598
612
|
该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
|
|
599
613
|
|
|
@@ -606,24 +620,26 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
606
620
|
当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
|
|
607
621
|
|
|
608
622
|
当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
|
623
|
+
|
|
624
|
+
|参数|描述|
|
|
625
|
+
|---------|---------|
|
|
626
|
+
|mute|true:暂停;false:恢复。|
|
|
627
|
+
|streamType|要暂停/恢复的视频流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。|
|
|
613
628
|
|
|
614
629
|
## setVideoMuteImage
|
|
615
630
|
|
|
616
|
-
|
|
631
|
+
**设置本地画面被暂停期间的替代图片。**
|
|
617
632
|
|
|
618
633
|
当您调用 ` muteLocalVideo(true) ` 暂停本地画面时,您可以通过调用本接口设置一张替代图片,设置后,房间中的其他用户会看到这张替代图片,而不是黑屏画面。
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
|
634
|
+
|
|
635
|
+
|参数|描述|
|
|
636
|
+
|---------|---------|
|
|
637
|
+
|fps|设置替代图片帧率,最小值为5,最大值为10,默认5。|
|
|
638
|
+
|image|设置替代图片,空值代表在 muteLocalVideo 之后不再发送视频流数据,默认值为空。|
|
|
623
639
|
|
|
624
640
|
## startRemoteView
|
|
625
641
|
|
|
626
|
-
|
|
642
|
+
**订阅远端用户的视频流,并绑定视频渲染控件。**
|
|
627
643
|
|
|
628
644
|
调用该接口可以让 SDK 拉取指定 userId 的视频流,并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
|
|
629
645
|
- 如果您已经知道房间中有视频流的用户的 userId,可以直接调用 ` startRemoteView ` 订阅该用户的画面。
|
|
@@ -654,18 +670,19 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
654
670
|
|
|
655
671
|
## updateRemoteView
|
|
656
672
|
|
|
657
|
-
|
|
673
|
+
**更新远端用户的视频渲染控件。**
|
|
658
674
|
|
|
659
675
|
该接口可用于更新远端视频画面的渲染控件,常被用于切换显示区域的交互场景中。
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
|
664
|
-
|
|
|
676
|
+
|
|
677
|
+
|参数|描述|
|
|
678
|
+
|---------|---------|
|
|
679
|
+
|streamType|要设置预览窗口的流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。|
|
|
680
|
+
|userId|指定远端用户的 ID。|
|
|
681
|
+
|view|承载视频画面的控件。|
|
|
665
682
|
|
|
666
683
|
## stopRemoteView
|
|
667
684
|
|
|
668
|
-
|
|
685
|
+
**停止订阅远端用户的视频流,并释放渲染控件。**
|
|
669
686
|
|
|
670
687
|
调用此接口会让 SDK 停止接收该用户的视频流,并释放该路视频流的解码和渲染资源。
|
|
671
688
|
| 参数 | 描述 |
|
|
@@ -675,7 +692,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
675
692
|
|
|
676
693
|
## stopAllRemoteView
|
|
677
694
|
|
|
678
|
-
|
|
695
|
+
**停止订阅所有远端用户的视频流,并释放全部渲染资源。**
|
|
679
696
|
|
|
680
697
|
调用此接口会让 SDK 停止接收所有来自远端的视频流,并释放全部的解码和渲染资源。
|
|
681
698
|
|
|
@@ -687,7 +704,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
687
704
|
|
|
688
705
|
## muteRemoteVideoStream
|
|
689
706
|
|
|
690
|
-
|
|
707
|
+
**暂停/恢复订阅远端用户的视频流。**
|
|
691
708
|
|
|
692
709
|
该接口仅暂停/恢复接收指定用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
|
|
693
710
|
| 参数 | 描述 |
|
|
@@ -704,12 +721,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
704
721
|
|
|
705
722
|
## muteAllRemoteVideoStreams
|
|
706
723
|
|
|
707
|
-
|
|
724
|
+
**暂停/恢复订阅所有远端用户的视频流。**
|
|
708
725
|
|
|
709
726
|
该接口仅暂停/恢复接收所有用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
727
|
+
|
|
728
|
+
|参数|描述|
|
|
729
|
+
|---------|---------|
|
|
730
|
+
|mute|是否暂停接收。|
|
|
713
731
|
|
|
714
732
|
> **注意**
|
|
715
733
|
>
|
|
@@ -722,12 +740,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
722
740
|
|
|
723
741
|
## setVideoEncoderParam
|
|
724
742
|
|
|
725
|
-
|
|
743
|
+
**设置视频编码器的编码参数。**
|
|
726
744
|
|
|
727
745
|
该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
746
|
+
|
|
747
|
+
|参数|描述|
|
|
748
|
+
|---------|---------|
|
|
749
|
+
|param|用于设置视频编码器的相关参数,详情请参见 TRTCVideoEncParam。|
|
|
731
750
|
|
|
732
751
|
> **注意**
|
|
733
752
|
>
|
|
@@ -737,66 +756,70 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
737
756
|
|
|
738
757
|
## setNetworkQosParam
|
|
739
758
|
|
|
740
|
-
|
|
759
|
+
**设置网络质量控制的相关参数。**
|
|
741
760
|
|
|
742
761
|
该设置决定在差网络环境下的质量调控策略,如“画质优先”或“流畅优先”等策略。
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
762
|
+
|
|
763
|
+
|参数|描述|
|
|
764
|
+
|---------|---------|
|
|
765
|
+
|param|用于设置网络质量控制的相关参数,详情请参见 TRTCNetworkQosParam。|
|
|
746
766
|
|
|
747
767
|
## setLocalRenderParams
|
|
748
768
|
|
|
749
|
-
|
|
769
|
+
**设置本地画面的渲染参数。**
|
|
750
770
|
|
|
751
771
|
可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
772
|
+
|
|
773
|
+
|参数|描述|
|
|
774
|
+
|---------|---------|
|
|
775
|
+
|params|画面渲染参数,详情请参见 TRTCRenderParams。|
|
|
755
776
|
|
|
756
777
|
## setRemoteRenderParams
|
|
757
778
|
|
|
758
|
-
|
|
779
|
+
**设置远端画面的渲染模式。**
|
|
759
780
|
|
|
760
781
|
可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
|
765
|
-
|
|
|
782
|
+
|
|
783
|
+
|参数|描述|
|
|
784
|
+
|---------|---------|
|
|
785
|
+
|params|画面渲染参数,详情请参见 TRTCRenderParams。|
|
|
786
|
+
|streamType|可以设置为主路画面(TRTCVideoStreamTypeBig)或辅路画面(TRTCVideoStreamTypeSub)。|
|
|
787
|
+
|userId|指定远端用户的 ID。|
|
|
766
788
|
|
|
767
789
|
## enableSmallVideoStream
|
|
768
790
|
|
|
769
|
-
|
|
791
|
+
**开启大小画面双路编码模式。**
|
|
770
792
|
|
|
771
793
|
开启双路编码模式后,当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流(但只有一路音频流)。
|
|
772
794
|
|
|
773
795
|
如此以来,房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
|
796
|
+
|
|
797
|
+
|参数|描述|
|
|
798
|
+
|---------|---------|
|
|
799
|
+
|enable|是否开启小画面编码,默认值:false。|
|
|
800
|
+
|smallVideoEncParam|小流的视频参数。|
|
|
778
801
|
|
|
779
802
|
> **注意**
|
|
780
803
|
>
|
|
781
804
|
|
|
782
805
|
> 双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以 Mac、Windows 或者高性能 Pad 可以考虑开启,不建议手机端开启。
|
|
783
806
|
>
|
|
784
|
-
|
|
785
|
-
#### 返回值说明:
|
|
807
|
+
**返回值说明:**
|
|
786
808
|
|
|
787
809
|
0:成功;-1:当前大画面已被设置为较低画质,开启双路编码已无必要。
|
|
788
810
|
|
|
789
811
|
## setRemoteVideoStreamType
|
|
790
812
|
|
|
791
|
-
|
|
813
|
+
**切换指定远端用户的大小画面。**
|
|
792
814
|
|
|
793
815
|
当房间中某个主播开启了双路编码之后,房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。
|
|
794
816
|
|
|
795
817
|
您可以通过此接口选定希望订阅的画面是大画面还是小画面,该接口在 startRemoteView 之前和之后调用均可生效。
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
|
818
|
+
|
|
819
|
+
|参数|描述|
|
|
820
|
+
|---------|---------|
|
|
821
|
+
|streamType|视频流类型,即选择看大画面还是小画面,默认为大画面。|
|
|
822
|
+
|userId|指定远端用户的 ID。|
|
|
800
823
|
|
|
801
824
|
> **注意**
|
|
802
825
|
>
|
|
@@ -806,14 +829,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
806
829
|
|
|
807
830
|
## snapshotVideo
|
|
808
831
|
|
|
809
|
-
|
|
832
|
+
**视频画面截图。**
|
|
810
833
|
|
|
811
834
|
您可以通过本接口截取本地的视频画面,远端用户的主路画面以及远端用户的辅路(屏幕分享)画面。
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
|
816
|
-
|
|
|
835
|
+
|
|
836
|
+
|参数|描述|
|
|
837
|
+
|---------|---------|
|
|
838
|
+
|sourceType|画面来源,可选择截取视频流画面(TRTCSnapshotSourceTypeStream)、视频渲染画面(TRTCSnapshotSourceTypeView)或 采集画面(TRTCSnapshotSourceTypeCapture),采集画面截图更清晰。|
|
|
839
|
+
|streamType|视频流类型,可选择截取主路画面(TRTCVideoStreamTypeBig,常用于摄像头)或辅路画面(TRTCVideoStreamTypeSub,常用于屏幕分享)。|
|
|
840
|
+
|userId|用户 ID,如指定空置表示截取本地的视频画面。|
|
|
817
841
|
|
|
818
842
|
> **注意**
|
|
819
843
|
>
|
|
@@ -823,7 +847,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
823
847
|
|
|
824
848
|
## setGravitySensorAdaptiveMode
|
|
825
849
|
|
|
826
|
-
|
|
850
|
+
**设置重力感应的适配模式(11.7 及以上版本)。**
|
|
827
851
|
|
|
828
852
|
开启重力感应后,如果采集端的设备发生旋转,采集端和观众端的画面都会进行相应地渲染以确保视野中的画面始终朝上。
|
|
829
853
|
|
|
@@ -832,13 +856,14 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
832
856
|
1. 该接口仅对采集端起作用,如果只是观看房间中的画面,开启此接口是无效的
|
|
833
857
|
|
|
834
858
|
2. 当采集端设备发生 90 度或 270 度旋转时,采集端或者观众看到的画面可能会被裁剪以保持比例的协调
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
859
|
+
|
|
860
|
+
|参数|描述|
|
|
861
|
+
|---------|---------|
|
|
862
|
+
|mode|重力感应模式,详情请参见 TRTCGravitySensorAdaptiveMode_Disable、TRTCGravitySensorAdaptiveMode_FillByCenterCrop 和 TRTCGravitySensorAdaptiveMode_FitWithBlackBorder 默认值:TRTCGravitySensorAdaptiveMode_Disable。|
|
|
838
863
|
|
|
839
864
|
## startLocalAudio
|
|
840
865
|
|
|
841
|
-
|
|
866
|
+
**开启本地音频的采集和发布。**
|
|
842
867
|
|
|
843
868
|
SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调用该接口开启麦克风采集,并将音频编码并发布到当前的房间中。
|
|
844
869
|
|
|
@@ -855,13 +880,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
855
880
|
|
|
856
881
|
## stopLocalAudio
|
|
857
882
|
|
|
858
|
-
|
|
883
|
+
**停止本地音频的采集和发布。**
|
|
859
884
|
|
|
860
885
|
停止本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
861
886
|
|
|
862
887
|
## muteLocalAudio
|
|
863
888
|
|
|
864
|
-
|
|
889
|
+
**暂停/恢复发布本地的音频流。**
|
|
865
890
|
|
|
866
891
|
当您暂停发布本地音频流之后,房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
867
892
|
|
|
@@ -872,19 +897,21 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
872
897
|
这对于需要云端录制的场景非常适用,因为 MP4 等格式的视频文件,对于音频数据的连续性要求很高,使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
|
|
873
898
|
|
|
874
899
|
因此在对录制文件的质量要求较高的场景中,建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
900
|
+
|
|
901
|
+
|参数|描述|
|
|
902
|
+
|---------|---------|
|
|
903
|
+
|mute|true:静音;false:恢复。|
|
|
878
904
|
|
|
879
905
|
## muteRemoteAudio
|
|
880
906
|
|
|
881
|
-
|
|
907
|
+
**暂停/恢复播放远端的音频流。**
|
|
882
908
|
|
|
883
909
|
当您静音某用户的远端音频时,SDK 会停止播放指定用户的声音,同时也会停止拉取该用户的音频数据。
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
|
910
|
+
|
|
911
|
+
|参数|描述|
|
|
912
|
+
|---------|---------|
|
|
913
|
+
|mute|true:静音;false:取消静音。|
|
|
914
|
+
|userId|用于指定远端用户的 ID。|
|
|
888
915
|
|
|
889
916
|
> **注意**
|
|
890
917
|
>
|
|
@@ -894,12 +921,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
894
921
|
|
|
895
922
|
## muteAllRemoteAudio
|
|
896
923
|
|
|
897
|
-
|
|
924
|
+
**暂停/恢复播放所有远端用户的音频流。**
|
|
898
925
|
|
|
899
926
|
当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
927
|
+
|
|
928
|
+
|参数|描述|
|
|
929
|
+
|---------|---------|
|
|
930
|
+
|mute|true:静音;false:取消静音。|
|
|
903
931
|
|
|
904
932
|
> **注意**
|
|
905
933
|
>
|
|
@@ -909,13 +937,14 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
909
937
|
|
|
910
938
|
## setRemoteAudioVolume
|
|
911
939
|
|
|
912
|
-
|
|
940
|
+
**设定某一个远端用户的声音播放音量。**
|
|
913
941
|
|
|
914
942
|
您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
|
943
|
+
|
|
944
|
+
|参数|描述|
|
|
945
|
+
|---------|---------|
|
|
946
|
+
|userId|用于指定远端用户的 ID。|
|
|
947
|
+
|volume|音量大小,取值范围为 [0, 150],默认值:100。|
|
|
919
948
|
|
|
920
949
|
> **注意**
|
|
921
950
|
>
|
|
@@ -925,10 +954,11 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
925
954
|
|
|
926
955
|
## setAudioCaptureVolume
|
|
927
956
|
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
957
|
+
**设定本地音频的采集音量。**
|
|
958
|
+
|
|
959
|
+
|参数|描述|
|
|
960
|
+
|---------|---------|
|
|
961
|
+
|volume|音量大小,取值范围为 [0, 150];默认值:100。|
|
|
932
962
|
|
|
933
963
|
> **注意**
|
|
934
964
|
>
|
|
@@ -938,20 +968,19 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
938
968
|
|
|
939
969
|
## getAudioCaptureVolume
|
|
940
970
|
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
#### 返回值说明:
|
|
971
|
+
**获取本地音频的采集音量。****返回值说明:**
|
|
944
972
|
|
|
945
973
|
采集音量。
|
|
946
974
|
|
|
947
975
|
## setAudioPlayoutVolume
|
|
948
976
|
|
|
949
|
-
|
|
977
|
+
**设定远端音频的播放音量。**
|
|
950
978
|
|
|
951
979
|
该接口会控制 SDK 最终交给系统播放的声音音量,调节效果会影响到本地音频录制文件的音量大小,但不会影响到耳返的音量大小。
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
980
|
+
|
|
981
|
+
|参数|描述|
|
|
982
|
+
|---------|---------|
|
|
983
|
+
|volume|音量大小,取值范围为 [0, 150],默认值:100。|
|
|
955
984
|
|
|
956
985
|
> **注意**
|
|
957
986
|
>
|
|
@@ -961,17 +990,18 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
961
990
|
|
|
962
991
|
## getAudioPlayoutVolume
|
|
963
992
|
|
|
964
|
-
|
|
993
|
+
**获取远端音频的播放音量。**
|
|
965
994
|
|
|
966
995
|
## enableAudioVolumeEvaluation
|
|
967
996
|
|
|
968
|
-
|
|
997
|
+
**启用音量大小提示。**
|
|
969
998
|
|
|
970
999
|
开启此功能后,SDK 会在 ITRTCCloudCallback 中的 onUserVoiceVolume 回调中反馈本地和远端用户的音频音量评估信息,包括音量大小、人声检测、音频频谱等。
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
|
1000
|
+
|
|
1001
|
+
|参数|描述|
|
|
1002
|
+
|---------|---------|
|
|
1003
|
+
|enable|是否启用音量提示,默认为关闭状态。|
|
|
1004
|
+
|params|音量评估等相关参数,请参见 TRTCAudioVolumeEvaluateParams。|
|
|
975
1005
|
|
|
976
1006
|
> **注意**
|
|
977
1007
|
>
|
|
@@ -981,77 +1011,81 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
981
1011
|
|
|
982
1012
|
## startAudioRecording
|
|
983
1013
|
|
|
984
|
-
|
|
1014
|
+
**开始录音。**
|
|
985
1015
|
|
|
986
1016
|
当您调用该接口后, SDK 会将本地和远端的所有音频(包括本地音频,远端音频,背景音乐和音效等)混合并录制到一个本地文件中。
|
|
987
1017
|
|
|
988
1018
|
该接口在进入房间前后调用均可生效,如果录制任务在退出房间前尚未通过 stopAudioRecording 停止,则退出房间后录制任务会自动被停止。
|
|
989
1019
|
|
|
990
1020
|
本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 ITRTCCloudCallback 相关回调。
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
1021
|
+
|
|
1022
|
+
|参数|描述|
|
|
1023
|
+
|---------|---------|
|
|
1024
|
+
|param|录音参数,请参见 TRTCAudioRecordingParams。|
|
|
994
1025
|
|
|
995
1026
|
> **注意**
|
|
996
1027
|
>
|
|
997
1028
|
|
|
998
1029
|
> 自 v11.5 版本,音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 ITRTCCloudCallback 相关回调。
|
|
999
1030
|
>
|
|
1000
|
-
|
|
1001
|
-
#### 返回值说明:
|
|
1031
|
+
**返回值说明:**
|
|
1002
1032
|
|
|
1003
1033
|
0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持。
|
|
1004
1034
|
|
|
1005
1035
|
## stopAudioRecording
|
|
1006
1036
|
|
|
1007
|
-
|
|
1037
|
+
**停止录音。**
|
|
1008
1038
|
|
|
1009
1039
|
如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
|
|
1010
1040
|
|
|
1011
1041
|
## startLocalRecording
|
|
1012
1042
|
|
|
1013
|
-
|
|
1043
|
+
**开启本地媒体录制。**
|
|
1014
1044
|
|
|
1015
1045
|
开启后把直播过程中的音视频内容录制到本地的一个文件中,该功能不会产生额外费用。
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1046
|
+
|
|
1047
|
+
|参数|描述|
|
|
1048
|
+
|---------|---------|
|
|
1049
|
+
|params|录制参数,请参见 TRTCLocalRecordingParams。|
|
|
1019
1050
|
|
|
1020
1051
|
## stopLocalRecording
|
|
1021
1052
|
|
|
1022
|
-
|
|
1053
|
+
**停止本地媒体录制。**
|
|
1023
1054
|
|
|
1024
1055
|
如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
|
|
1025
1056
|
|
|
1026
1057
|
## setRemoteAudioParallelParams
|
|
1027
1058
|
|
|
1028
|
-
|
|
1059
|
+
**设置远端音频流智能并发播放策略。**
|
|
1029
1060
|
|
|
1030
1061
|
设置远端音频流智能并发播放策略,适用于上麦人数比较多的场景。
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1062
|
+
|
|
1063
|
+
|参数|描述|
|
|
1064
|
+
|---------|---------|
|
|
1065
|
+
|params|音频并发参数,请参见 TRTCAudioParallelParams。|
|
|
1034
1066
|
|
|
1035
1067
|
## enable3DSpatialAudioEffect
|
|
1036
1068
|
|
|
1037
|
-
|
|
1069
|
+
**启用 3D 音效。**
|
|
1038
1070
|
|
|
1039
1071
|
启用 3D 音效。注意需使用流畅音质 TRTCAudioQualitySpeech 或默认音质 TRTCAudioQualityDefault。
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1072
|
+
|
|
1073
|
+
|参数|描述|
|
|
1074
|
+
|---------|---------|
|
|
1075
|
+
|enabled|是否启用 3D 音效,默认为关闭状态。|
|
|
1043
1076
|
|
|
1044
1077
|
## updateSelf3DSpatialPosition
|
|
1045
1078
|
|
|
1046
|
-
|
|
1079
|
+
**设置 3D 音效中自身坐标及朝向信息。**
|
|
1047
1080
|
|
|
1048
1081
|
更新自身在世界坐标系中的位置和朝向, SDK 会根据该方法参数计算自身和远端用户之间的相对位置,进而渲染出空间音效。
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
|
1053
|
-
|
|
|
1054
|
-
|
|
|
1082
|
+
|
|
1083
|
+
|参数|描述|
|
|
1084
|
+
|---------|---------|
|
|
1085
|
+
|axisForward|自身坐标系前轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1086
|
+
|axisRight|自身坐标系右轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1087
|
+
|axisUp|自身坐标系上轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
|
|
1088
|
+
|position|自身在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
|
|
1055
1089
|
|
|
1056
1090
|
> **注意**
|
|
1057
1091
|
>
|
|
@@ -1064,13 +1098,14 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1064
1098
|
|
|
1065
1099
|
## updateRemote3DSpatialPosition
|
|
1066
1100
|
|
|
1067
|
-
|
|
1101
|
+
**设置 3D 音效中远端用户坐标信息。**
|
|
1068
1102
|
|
|
1069
1103
|
更新远端用户在世界坐标系中的位置,SDK 会根据自身和远端用户之间的相对位置,进而渲染出空间音效。
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
|
1104
|
+
|
|
1105
|
+
|参数|描述|
|
|
1106
|
+
|---------|---------|
|
|
1107
|
+
|position|该远端用户在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
|
|
1108
|
+
|userId|指定远端用户的 ID。|
|
|
1074
1109
|
|
|
1075
1110
|
> **注意**
|
|
1076
1111
|
>
|
|
@@ -1083,27 +1118,26 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1083
1118
|
|
|
1084
1119
|
## set3DSpatialReceivingRange
|
|
1085
1120
|
|
|
1086
|
-
|
|
1121
|
+
**设置指定用户所发出声音的可被接收范围。**
|
|
1087
1122
|
|
|
1088
1123
|
设置该范围大小之后,该指定用户的声音将在该范围内可被听见,超出该范围将被衰减为 0。
|
|
1089
|
-
| 参数 | 描述 |
|
|
1090
|
-
| --- | --- |
|
|
1091
|
-
| range | 声音最大可被接收范围。 |
|
|
1092
|
-
| userId | 指定远端用户的 ID。 |
|
|
1093
1124
|
|
|
1094
|
-
|
|
1125
|
+
|参数|描述|
|
|
1126
|
+
|---------|---------|
|
|
1127
|
+
|range|声音最大可被接收范围。|
|
|
1128
|
+
|userId|指定远端用户的 ID。|
|
|
1095
1129
|
|
|
1096
|
-
|
|
1130
|
+
## getDeviceManager
|
|
1097
1131
|
|
|
1098
|
-
|
|
1132
|
+
**获取设备管理类(TXDeviceManager)。**
|
|
1099
1133
|
|
|
1100
|
-
|
|
1134
|
+
通过设备管理,您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。**返回值说明:**
|
|
1101
1135
|
|
|
1102
1136
|
设备管理类 TXDeviceManager。
|
|
1103
1137
|
|
|
1104
1138
|
## getBeautyManager
|
|
1105
1139
|
|
|
1106
|
-
|
|
1140
|
+
**获取美颜管理类(TXBeautyManager)。**
|
|
1107
1141
|
|
|
1108
1142
|
通过美颜管理,您可以使用以下功能:
|
|
1109
1143
|
- 设置“磨皮”、“美白”、“红润”等美颜特效。
|
|
@@ -1117,14 +1151,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1117
1151
|
- 设置“眼影”、“腮红”等美妆特效。
|
|
1118
1152
|
|
|
1119
1153
|
- 设置动态贴纸和人脸挂件等动画特效。
|
|
1120
|
-
|
|
1121
|
-
#### 返回值说明:
|
|
1154
|
+
**返回值说明:**
|
|
1122
1155
|
|
|
1123
1156
|
美颜管理类 TXBeautyManager。
|
|
1124
1157
|
|
|
1125
1158
|
## setWaterMark
|
|
1126
1159
|
|
|
1127
|
-
|
|
1160
|
+
**添加水印。**
|
|
1128
1161
|
|
|
1129
1162
|
水印的位置是通过 xOffset, yOffset, fWidthRatio 来指定的。
|
|
1130
1163
|
- xOffset:水印的坐标,取值范围为 [0, 1] 的浮点数。
|
|
@@ -1133,17 +1166,17 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1133
1166
|
|
|
1134
1167
|
- fWidthRatio:水印的大小比例,取值范围为 [0, 1] 的浮点数。
|
|
1135
1168
|
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
|
1139
|
-
|
|
|
1140
|
-
|
|
|
1141
|
-
|
|
|
1142
|
-
|
|
|
1143
|
-
|
|
|
1144
|
-
|
|
|
1145
|
-
|
|
|
1146
|
-
|
|
|
1169
|
+
|参数|描述|
|
|
1170
|
+
|---------|---------|
|
|
1171
|
+
|fWidthRatio|水印显示的宽度占画面宽度比例(水印按该参数等比例缩放显示)。|
|
|
1172
|
+
|isVisibleOnLocalPreview|true:本地预览显示水印;false:本地预览不显示水印,仅在win/mac下生效。|
|
|
1173
|
+
|nHeight|水印图片像素高度(源数据为文件路径时忽略该参数)。|
|
|
1174
|
+
|nWidth|水印图片像素宽度(源数据为文件路径时忽略该参数)。|
|
|
1175
|
+
|srcData|水印图片源数据(传 nullptr 表示去掉水印)。|
|
|
1176
|
+
|srcType|水印图片源数据类型。请参见 TRTCWaterMarkSrcType。|
|
|
1177
|
+
|streamType|要设置水印的流类型(TRTCVideoStreamTypeBig,TRTCVideoStreamTypeSub)。|
|
|
1178
|
+
|xOffset|水印显示的左上角 x 轴偏移。|
|
|
1179
|
+
|yOffset|水印显示的左上角 y 轴偏移。|
|
|
1147
1180
|
|
|
1148
1181
|
> **注意**
|
|
1149
1182
|
>
|
|
@@ -1153,7 +1186,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1153
1186
|
|
|
1154
1187
|
## getAudioEffectManager
|
|
1155
1188
|
|
|
1156
|
-
|
|
1189
|
+
**获取音效管理类(TXAudioEffectManager)。**
|
|
1157
1190
|
|
|
1158
1191
|
TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如下功能:
|
|
1159
1192
|
- 背景音乐:支持在线音乐和本地音乐,支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
|
|
@@ -1165,23 +1198,23 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1165
1198
|
- 变声特效:萝莉、大叔、重金属等。
|
|
1166
1199
|
|
|
1167
1200
|
- 短音效:鼓掌声、欢笑声等简短的音效文件(对于小于10秒的文件,请将 isShortFile 参数设置为 true)。
|
|
1168
|
-
|
|
1169
|
-
#### 返回值说明:
|
|
1201
|
+
**返回值说明:**
|
|
1170
1202
|
|
|
1171
1203
|
音效管理类 TXAudioEffectManager。
|
|
1172
1204
|
|
|
1173
1205
|
## startSystemAudioLoopback
|
|
1174
1206
|
|
|
1175
|
-
|
|
1207
|
+
**开启系统声音采集(iOS 端暂未支持)。**
|
|
1176
1208
|
|
|
1177
1209
|
该接口会从电脑的声卡中采集音频数据,并将其混入到 SDK 当前的音频数据流中,从而使房间中的其他用户也能听到主播的电脑所播放出的声音。
|
|
1178
1210
|
|
|
1179
1211
|
在线教育场景中,老师可以使用此功能让 SDK 采集教学影片中的声音,并广播给同房间中的学生。
|
|
1180
1212
|
|
|
1181
1213
|
音乐直播场景中,主播可以使用此功能让 SDK 采集音乐播放器中的音乐,从而为自己的直播间增加背景音乐。
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1214
|
+
|
|
1215
|
+
|参数|描述|
|
|
1216
|
+
|---------|---------|
|
|
1217
|
+
|deviceName|您可以指定该参数为空值(nullptr),代表让 SDK 采集整个系统的声音。|
|
|
1185
1218
|
|
|
1186
1219
|
> **注意**
|
|
1187
1220
|
>
|
|
@@ -1200,23 +1233,32 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1200
1233
|
|
|
1201
1234
|
## stopSystemAudioLoopback
|
|
1202
1235
|
|
|
1203
|
-
|
|
1236
|
+
**停止系统声音采集(iOS 端暂未支持)。**
|
|
1204
1237
|
|
|
1205
1238
|
## setSystemAudioLoopbackVolume
|
|
1206
1239
|
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1240
|
+
**设置系统声音的采集音量。**
|
|
1241
|
+
|
|
1242
|
+
|参数|描述|
|
|
1243
|
+
|---------|---------|
|
|
1244
|
+
|volume|设置的音量大小,范围是:[0, 150],默认值为 100。|
|
|
1245
|
+
|
|
1246
|
+
## getAITranscriberManager
|
|
1247
|
+
|
|
1248
|
+
**获取 AI 转录管理类(AITranscriberManager)。**
|
|
1249
|
+
|
|
1250
|
+
通过 AI 转录管理,您可以启动/停止实时转录服务,对指定用户的音频进行实时转录和翻译。**返回值说明:**
|
|
1251
|
+
|
|
1252
|
+
AI 转录管理类 AITranscriberManager。
|
|
1211
1253
|
|
|
1212
1254
|
## startScreenCapture
|
|
1213
1255
|
|
|
1214
|
-
|
|
1256
|
+
**启动屏幕分享。**
|
|
1215
1257
|
|
|
1216
1258
|
该接口可以抓取整个屏幕的内容,或抓取您指定的某个应用的窗口内容,并将其分享给同房间中的其他用户。
|
|
1217
1259
|
| 参数 | 描述 |
|
|
1218
1260
|
| --- | --- |
|
|
1219
|
-
| encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置
|
|
1261
|
+
| encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置 <code> encParam </code> 为空值,且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 <code> encParam </code> 为空值,且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
|
|
1220
1262
|
| streamType | 屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub),推荐使用辅路。 |
|
|
1221
1263
|
| view | 渲染控件所在的父控件,可以设置为空值,表示不显示屏幕分享的预览效果。 |
|
|
1222
1264
|
|
|
@@ -1237,11 +1279,11 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1237
1279
|
|
|
1238
1280
|
## stopScreenCapture
|
|
1239
1281
|
|
|
1240
|
-
|
|
1282
|
+
**停止屏幕分享。**
|
|
1241
1283
|
|
|
1242
1284
|
## pauseScreenCapture
|
|
1243
1285
|
|
|
1244
|
-
|
|
1286
|
+
**暂停屏幕分享。**
|
|
1245
1287
|
|
|
1246
1288
|
> **注意**
|
|
1247
1289
|
>
|
|
@@ -1251,19 +1293,20 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1251
1293
|
|
|
1252
1294
|
## resumeScreenCapture
|
|
1253
1295
|
|
|
1254
|
-
|
|
1296
|
+
**恢复屏幕分享。**
|
|
1255
1297
|
|
|
1256
1298
|
## getScreenCaptureSources
|
|
1257
1299
|
|
|
1258
|
-
|
|
1300
|
+
**枚举可分享的屏幕和窗口(该接口仅支持桌面系统)。**
|
|
1259
1301
|
|
|
1260
1302
|
当您在对接桌面端系统的屏幕分享功能时,一般都需要展示一个选择分享目标的界面,这样用户能够使用这个界面选择是分享整个屏幕还是某个窗口。
|
|
1261
1303
|
|
|
1262
1304
|
通过本接口,您就可以查询到当前系统中可用于分享的窗口的 ID、名称以及缩略图。我们在 Demo 中提供了一份默认的界面实现供您参考。
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
|
1305
|
+
|
|
1306
|
+
|参数|描述|
|
|
1307
|
+
|---------|---------|
|
|
1308
|
+
|iconSize|指定要获取的窗口图标大小。|
|
|
1309
|
+
|thumbnailSize|指定要获取的窗口缩略图大小,缩略图可用于绘制在窗口选择界面上。|
|
|
1267
1310
|
|
|
1268
1311
|
> **注意**
|
|
1269
1312
|
>
|
|
@@ -1273,14 +1316,13 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1273
1316
|
|
|
1274
1317
|
> 2. 请不要使用 ` delete ITRTCScreenCaptureSourceList* ` 删除 SourceList,这很容易导致崩溃,请使用 ITRTCScreenCaptureSourceList 中的 release 方法释放列表。
|
|
1275
1318
|
>
|
|
1276
|
-
|
|
1277
|
-
#### 返回值说明:
|
|
1319
|
+
**返回值说明:**
|
|
1278
1320
|
|
|
1279
1321
|
窗口列表包括屏幕。
|
|
1280
1322
|
|
|
1281
1323
|
## selectScreenCaptureTarget
|
|
1282
1324
|
|
|
1283
|
-
|
|
1325
|
+
**选取要分享的屏幕或窗口(该接口仅支持桌面系统)。**
|
|
1284
1326
|
|
|
1285
1327
|
当您通过 getScreenCaptureSources 获取到可以分享的屏幕和窗口之后,您可以调用该接口选定期望分享的目标屏幕或目标窗口。
|
|
1286
1328
|
|
|
@@ -1295,11 +1337,11 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1295
1337
|
|
|
1296
1338
|
- 共享窗口区域:source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source,captureRect 设为非 nullptr,例如 { 100, 100, 300, 300 }。
|
|
1297
1339
|
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
|
1301
|
-
|
|
|
1302
|
-
|
|
|
1340
|
+
|参数|描述|
|
|
1341
|
+
|---------|---------|
|
|
1342
|
+
|captureRect|指定捕获的区域。|
|
|
1343
|
+
|property|指定屏幕分享目标的属性,包括捕获鼠标,高亮捕获窗口等,详情参考 TRTCScreenCaptureProperty。|
|
|
1344
|
+
|source|指定分享源。详情参考 TRTCScreenCaptureSourceInfo|
|
|
1303
1345
|
|
|
1304
1346
|
> **注意**
|
|
1305
1347
|
>
|
|
@@ -1309,7 +1351,7 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1309
1351
|
|
|
1310
1352
|
## setSubStreamEncoderParam
|
|
1311
1353
|
|
|
1312
|
-
|
|
1354
|
+
**设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。**
|
|
1313
1355
|
|
|
1314
1356
|
该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
|
|
1315
1357
|
|
|
@@ -1318,29 +1360,31 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1318
1360
|
|
|
1319
1361
|
- setSubStreamEncoderParam 用于设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的视频编码参数。
|
|
1320
1362
|
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
|
1363
|
+
|参数|描述|
|
|
1364
|
+
|---------|---------|
|
|
1365
|
+
|param|辅流编码参数,详情请参见 TRTCVideoEncParam。|
|
|
1324
1366
|
|
|
1325
1367
|
## setSubStreamMixVolume
|
|
1326
1368
|
|
|
1327
|
-
|
|
1369
|
+
**设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。**
|
|
1328
1370
|
|
|
1329
1371
|
这个数值越高,屏幕分享音量的占比就越高,麦克风音量占比就越小,所以不推荐设置得太大,否则会导致麦克风的声音被压制。
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1372
|
+
|
|
1373
|
+
|参数|描述|
|
|
1374
|
+
|---------|---------|
|
|
1375
|
+
|volume|设置的混音音量大小,范围 [0, 150]。|
|
|
1333
1376
|
|
|
1334
1377
|
## addExcludedShareWindow
|
|
1335
1378
|
|
|
1336
|
-
|
|
1379
|
+
**将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。**
|
|
1337
1380
|
|
|
1338
1381
|
加入排除列表中的窗口不会被分享出去,常见的用法是将某个应用的窗口加入到排除列表中以避免隐私问题。
|
|
1339
1382
|
|
|
1340
1383
|
支持启动屏幕分享前设置过滤窗口,也支持屏幕分享过程中动态添加过滤窗口。
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1384
|
+
|
|
1385
|
+
|参数|描述|
|
|
1386
|
+
|---------|---------|
|
|
1387
|
+
|windowID|不希望分享出去的窗口|
|
|
1344
1388
|
|
|
1345
1389
|
> **注意**
|
|
1346
1390
|
>
|
|
@@ -1356,25 +1400,27 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1356
1400
|
|
|
1357
1401
|
## removeExcludedShareWindow
|
|
1358
1402
|
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1403
|
+
**将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。**
|
|
1404
|
+
|
|
1405
|
+
|参数|描述|
|
|
1406
|
+
|---------|---------|
|
|
1407
|
+
|windowID|要排除的窗口 id。|
|
|
1363
1408
|
|
|
1364
1409
|
## removeAllExcludedShareWindow
|
|
1365
1410
|
|
|
1366
|
-
|
|
1411
|
+
**将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。**
|
|
1367
1412
|
|
|
1368
1413
|
## addIncludedShareWindow
|
|
1369
1414
|
|
|
1370
|
-
|
|
1415
|
+
**将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。**
|
|
1371
1416
|
|
|
1372
1417
|
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。即只有在分享窗口内容时,额外包含指定窗口的功能才生效。
|
|
1373
1418
|
|
|
1374
1419
|
您在 startScreenCapture 之前和之后调用均可。
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1420
|
+
|
|
1421
|
+
|参数|描述|
|
|
1422
|
+
|---------|---------|
|
|
1423
|
+
|windowID|希望被分享出去的窗口(Windows 平台下为窗口句柄: HWND)|
|
|
1378
1424
|
|
|
1379
1425
|
> **注意**
|
|
1380
1426
|
>
|
|
@@ -1384,18 +1430,19 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1384
1430
|
|
|
1385
1431
|
## removeIncludedShareWindow
|
|
1386
1432
|
|
|
1387
|
-
|
|
1433
|
+
**将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。**
|
|
1388
1434
|
|
|
1389
1435
|
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
|
|
1390
1436
|
|
|
1391
1437
|
即只有在分享窗口内容时,额外包含指定窗口的功能才生效。
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1438
|
+
|
|
1439
|
+
|参数|描述|
|
|
1440
|
+
|---------|---------|
|
|
1441
|
+
|windowID|希望被分享出去的窗口(Mac 平台:窗口 ID;Windows 平台:HWND)|
|
|
1395
1442
|
|
|
1396
1443
|
## removeAllIncludedShareWindow
|
|
1397
1444
|
|
|
1398
|
-
|
|
1445
|
+
**将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。**
|
|
1399
1446
|
|
|
1400
1447
|
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
|
|
1401
1448
|
|
|
@@ -1403,19 +1450,20 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1403
1450
|
|
|
1404
1451
|
## enableCustomVideoCapture
|
|
1405
1452
|
|
|
1406
|
-
|
|
1453
|
+
**启用/关闭视频自定义采集模式。**
|
|
1407
1454
|
|
|
1408
1455
|
开启该模式后,SDK 不再运行原有的视频采集流程,即不再继续从摄像头采集数据和美颜,而是只保留视频编码和发送能力。
|
|
1409
1456
|
|
|
1410
1457
|
您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
|
1458
|
+
|
|
1459
|
+
|参数|描述|
|
|
1460
|
+
|---------|---------|
|
|
1461
|
+
|enable|是否启用视频自定义采集,默认值:false。|
|
|
1462
|
+
|streamType|用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。|
|
|
1415
1463
|
|
|
1416
1464
|
## sendCustomVideoData
|
|
1417
1465
|
|
|
1418
|
-
|
|
1466
|
+
**向 SDK 投送自己采集的视频帧。**
|
|
1419
1467
|
|
|
1420
1468
|
使用此接口可以向 SDK 投送自己采集的视频帧,SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
|
|
1421
1469
|
|
|
@@ -1435,10 +1483,11 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1435
1483
|
- timestamp:时间戳,单位为毫秒(ms),请使用视频帧在采集时被记录下来的时间戳(可以在采集到一帧视频帧之后,通过调用 generateCustomPTS 获取时间戳)。
|
|
1436
1484
|
|
|
1437
1485
|
参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
|
1486
|
+
|
|
1487
|
+
|参数|描述|
|
|
1488
|
+
|---------|---------|
|
|
1489
|
+
|frame|视频数据,支持 I420 格式数据。|
|
|
1490
|
+
|streamType|用于指定视频流类型,TRTCVideoStreamTypeBig: 高清大画面;TRTCVideoStreamTypeSub: 辅路画面。|
|
|
1442
1491
|
|
|
1443
1492
|
> **注意**
|
|
1444
1493
|
>
|
|
@@ -1460,14 +1509,15 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1460
1509
|
|
|
1461
1510
|
## enableCustomAudioCapture
|
|
1462
1511
|
|
|
1463
|
-
|
|
1512
|
+
**启用音频自定义采集模式。**
|
|
1464
1513
|
|
|
1465
1514
|
开启该模式后,SDK 不再运行原有的音频采集流程,即不再继续从麦克风采集音频数据,而是只保留音频编码和发送能力。
|
|
1466
1515
|
|
|
1467
1516
|
您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1517
|
+
|
|
1518
|
+
|参数|描述|
|
|
1519
|
+
|---------|---------|
|
|
1520
|
+
|enable|是否启用音频自定义采集模式,默认值:false。|
|
|
1471
1521
|
|
|
1472
1522
|
> **注意**
|
|
1473
1523
|
>
|
|
@@ -1477,7 +1527,7 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1477
1527
|
|
|
1478
1528
|
## sendCustomAudioData
|
|
1479
1529
|
|
|
1480
|
-
|
|
1530
|
+
**向 SDK 投送自己采集的音频数据。**
|
|
1481
1531
|
|
|
1482
1532
|
参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
|
|
1483
1533
|
- audioFormat:音频数据格式,仅支持 TRTCAudioFrameFormatPCM。
|
|
@@ -1491,9 +1541,10 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1491
1541
|
- timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在采集到一帧音频帧之后,通过调用 generateCustomPTS 获取时间戳)。
|
|
1492
1542
|
|
|
1493
1543
|
参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1544
|
+
|
|
1545
|
+
|参数|描述|
|
|
1546
|
+
|---------|---------|
|
|
1547
|
+
|frame|音频数据|
|
|
1497
1548
|
|
|
1498
1549
|
> **注意**
|
|
1499
1550
|
>
|
|
@@ -1503,13 +1554,14 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1503
1554
|
|
|
1504
1555
|
## enableMixExternalAudioFrame
|
|
1505
1556
|
|
|
1506
|
-
|
|
1557
|
+
**启用/关闭自定义音轨。**
|
|
1507
1558
|
|
|
1508
1559
|
开启后,您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数,您可以控制该音轨是否要在远端和本地播放。
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
|
1560
|
+
|
|
1561
|
+
|参数|描述|
|
|
1562
|
+
|---------|---------|
|
|
1563
|
+
|enablePlayout|控制混入的音轨是否要在本地播放,默认值:false。|
|
|
1564
|
+
|enablePublish|控制混入的音轨是否要在远端播放,默认值:false。|
|
|
1513
1565
|
|
|
1514
1566
|
> **注意**
|
|
1515
1567
|
>
|
|
@@ -1519,7 +1571,7 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1519
1571
|
|
|
1520
1572
|
## mixExternalAudioFrame
|
|
1521
1573
|
|
|
1522
|
-
|
|
1574
|
+
**向 SDK 混入自定义音轨。**
|
|
1523
1575
|
|
|
1524
1576
|
调用该接口之前,您需要先通过 enableMixExternalAudioFrame 开启自定义音轨,之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
|
|
1525
1577
|
|
|
@@ -1540,31 +1592,31 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1540
1592
|
|
|
1541
1593
|
- timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在获得一帧音频帧之后,通过调用 generateCustomPTS 获得时间戳)。
|
|
1542
1594
|
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
|
1595
|
+
|参数|描述|
|
|
1596
|
+
|---------|---------|
|
|
1597
|
+
|frame|音频数据|
|
|
1546
1598
|
|
|
1547
1599
|
> **注意**
|
|
1548
1600
|
>
|
|
1549
1601
|
|
|
1550
1602
|
> 请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。
|
|
1551
1603
|
>
|
|
1552
|
-
|
|
1553
|
-
#### 返回值说明:
|
|
1604
|
+
**返回值说明:**
|
|
1554
1605
|
|
|
1555
1606
|
>= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用 ` mixExternalAudioFrame `)
|
|
1556
1607
|
|
|
1557
1608
|
## setMixExternalAudioVolume
|
|
1558
1609
|
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
|
1610
|
+
**设置推流时混入外部音频的推流音量和播放音量。**
|
|
1611
|
+
|
|
1612
|
+
|参数|描述|
|
|
1613
|
+
|---------|---------|
|
|
1614
|
+
|playoutVolume|设置的播放音量大小,范围 [0, 150],-1 表示不改变。|
|
|
1615
|
+
|publishVolume|设置的推流音量大小,范围 [0, 150],-1 表示不改变。|
|
|
1564
1616
|
|
|
1565
1617
|
## generateCustomPTS
|
|
1566
1618
|
|
|
1567
|
-
|
|
1619
|
+
**生成自定义采集时的时间戳。**
|
|
1568
1620
|
|
|
1569
1621
|
本接口仅适用于自定义采集模式,用于解决音视频帧的采集时间(capture time)和投送时间(send time)不一致所导致的音画不同步问题。
|
|
1570
1622
|
|
|
@@ -1574,39 +1626,38 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1574
1626
|
|
|
1575
1627
|
2. 之后可以将该视频或音频帧送入您使用的前处理模块(如第三方美颜组件,或第三方音效组件)。
|
|
1576
1628
|
|
|
1577
|
-
3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp
|
|
1578
|
-
|
|
1579
|
-
#### 返回值说明:
|
|
1629
|
+
3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。**返回值说明:**
|
|
1580
1630
|
|
|
1581
1631
|
时间戳(单位:ms)
|
|
1582
1632
|
|
|
1583
1633
|
## enableLocalVideoCustomProcess
|
|
1584
1634
|
|
|
1585
|
-
|
|
1635
|
+
**.1 开启视频第三方美颜。**
|
|
1586
1636
|
|
|
1587
1637
|
开启后,您可以通过 ITRTCVideoFrameCallback 获取到指定像素格式和视频数据结构类型的图像帧。
|
|
1588
|
-
| 参数 | 描述 |
|
|
1589
|
-
| --- | --- |
|
|
1590
|
-
| bufferType | 指定视频数据结构类型。 |
|
|
1591
|
-
| enable | 是否启用视频第三方美颜,默认为关闭状态。 |
|
|
1592
|
-
| pixelFormat | 指定回调的像素格式。 |
|
|
1593
1638
|
|
|
1594
|
-
|
|
1639
|
+
|参数|描述|
|
|
1640
|
+
|---------|---------|
|
|
1641
|
+
|bufferType|指定视频数据结构类型。|
|
|
1642
|
+
|enable|是否启用视频第三方美颜,默认为关闭状态。|
|
|
1643
|
+
|pixelFormat|指定回调的像素格式。|
|
|
1644
|
+
**返回值说明:**
|
|
1595
1645
|
|
|
1596
1646
|
0:成功;<0:错误
|
|
1597
1647
|
|
|
1598
1648
|
## setLocalVideoCustomProcessCallback
|
|
1599
1649
|
|
|
1600
|
-
|
|
1650
|
+
**.2 设置第三方美颜的视频数据回调。**
|
|
1601
1651
|
|
|
1602
1652
|
设置该回调之后,SDK 会把采集到的视频帧通过您设置的 callback 回调出来,用于第三方美颜组件进行二次处理,之后 SDK 会将处理后的视频帧进行编码和发送。
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1653
|
+
|
|
1654
|
+
|参数|描述|
|
|
1655
|
+
|---------|---------|
|
|
1656
|
+
|callback|自定义美颜回调,详见 ITRTCVideoFrameCallback。|
|
|
1606
1657
|
|
|
1607
1658
|
## setLocalVideoRenderCallback
|
|
1608
1659
|
|
|
1609
|
-
|
|
1660
|
+
**设置本地视频自定义渲染回调。**
|
|
1610
1661
|
|
|
1611
1662
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1612
1663
|
- 您可以通过调用 ` setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr) ` 停止回调。
|
|
@@ -1615,19 +1666,18 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1615
1666
|
|
|
1616
1667
|
- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
|
|
1617
1668
|
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
|
1621
|
-
|
|
|
1622
|
-
|
|
|
1623
|
-
|
|
1624
|
-
#### 返回值说明:
|
|
1669
|
+
|参数|描述|
|
|
1670
|
+
|---------|---------|
|
|
1671
|
+
|bufferType|指定视频数据结构类型|
|
|
1672
|
+
|callback|自定义渲染回调|
|
|
1673
|
+
|pixelFormat|指定回调的像素格式|
|
|
1674
|
+
**返回值说明:**
|
|
1625
1675
|
|
|
1626
1676
|
0:成功;<0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/38308))。
|
|
1627
1677
|
|
|
1628
1678
|
## setRemoteVideoRenderCallback
|
|
1629
1679
|
|
|
1630
|
-
|
|
1680
|
+
**设置远端视频自定义渲染回调。**
|
|
1631
1681
|
|
|
1632
1682
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1633
1683
|
- 您可以通过调用 ` setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr) ` 停止回调。
|
|
@@ -1636,26 +1686,25 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1636
1686
|
|
|
1637
1687
|
- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
|
|
1638
1688
|
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
|
1642
|
-
|
|
|
1643
|
-
|
|
|
1644
|
-
|
|
|
1689
|
+
|参数|描述|
|
|
1690
|
+
|---------|---------|
|
|
1691
|
+
|bufferType|指定视频数据结构类型,目前只支持 TRTCVideoBufferType_Buffer|
|
|
1692
|
+
|callback|自定义渲染回调。|
|
|
1693
|
+
|pixelFormat|指定回调的像素格式|
|
|
1694
|
+
|userId|远端用户id|
|
|
1645
1695
|
|
|
1646
1696
|
> **注意**
|
|
1647
1697
|
>
|
|
1648
1698
|
|
|
1649
1699
|
> 实际使用时,需要先调用 startRemoteView(userid, nullptr) 来获取远端用户的视频流(view 设置为 nullptr 即可),否则不会有数据回调出来。
|
|
1650
1700
|
>
|
|
1651
|
-
|
|
1652
|
-
#### 返回值说明:
|
|
1701
|
+
**返回值说明:**
|
|
1653
1702
|
|
|
1654
1703
|
0:成功;< 0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/38308))。
|
|
1655
1704
|
|
|
1656
1705
|
## setAudioFrameCallback
|
|
1657
1706
|
|
|
1658
|
-
|
|
1707
|
+
**设置音频数据自定义回调。**
|
|
1659
1708
|
|
|
1660
1709
|
设置该回调之后,SDK 内部会把音频数据(PCM 格式)回调出来,包括:
|
|
1661
1710
|
- onCapturedAudioFrame:本地麦克风采集到的音频数据回调
|
|
@@ -1674,7 +1723,7 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1674
1723
|
|
|
1675
1724
|
## setCapturedAudioFrameCallbackFormat
|
|
1676
1725
|
|
|
1677
|
-
|
|
1726
|
+
**设置本地麦克风采集出的音频帧回调格式。**
|
|
1678
1727
|
|
|
1679
1728
|
本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1680
1729
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1686,23 +1735,23 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1686
1735
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1687
1736
|
|
|
1688
1737
|
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填:` 960 = 20 * 48000 / 1000 `。
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1738
|
+
|
|
1739
|
+
|参数|描述|
|
|
1740
|
+
|---------|---------|
|
|
1741
|
+
|format|音频数据回调格式。|
|
|
1692
1742
|
|
|
1693
1743
|
> **注意**
|
|
1694
1744
|
>
|
|
1695
1745
|
|
|
1696
1746
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1697
1747
|
>
|
|
1698
|
-
|
|
1699
|
-
#### 返回值说明:
|
|
1748
|
+
**返回值说明:**
|
|
1700
1749
|
|
|
1701
1750
|
0:成功;<0:错误。
|
|
1702
1751
|
|
|
1703
1752
|
## setLocalProcessedAudioFrameCallbackFormat
|
|
1704
1753
|
|
|
1705
|
-
|
|
1754
|
+
**设置经过前处理后的本地音频帧回调格式。**
|
|
1706
1755
|
|
|
1707
1756
|
本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1708
1757
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1714,23 +1763,23 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1714
1763
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1715
1764
|
|
|
1716
1765
|
举例:48000Hz 采样率希望回调20ms帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1766
|
+
|
|
1767
|
+
|参数|描述|
|
|
1768
|
+
|---------|---------|
|
|
1769
|
+
|format|音频数据回调格式。|
|
|
1720
1770
|
|
|
1721
1771
|
> **注意**
|
|
1722
1772
|
>
|
|
1723
1773
|
|
|
1724
1774
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1725
1775
|
>
|
|
1726
|
-
|
|
1727
|
-
#### 返回值说明:
|
|
1776
|
+
**返回值说明:**
|
|
1728
1777
|
|
|
1729
1778
|
0:成功;<0:错误。
|
|
1730
1779
|
|
|
1731
1780
|
## setMixedPlayAudioFrameCallbackFormat
|
|
1732
1781
|
|
|
1733
|
-
|
|
1782
|
+
**设置最终要由系统播放出的音频帧回调格式。**
|
|
1734
1783
|
|
|
1735
1784
|
本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式:
|
|
1736
1785
|
- sampleRate:采样率,支持:16000、32000、44100、48000。
|
|
@@ -1742,30 +1791,31 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1742
1791
|
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
1743
1792
|
|
|
1744
1793
|
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1794
|
+
|
|
1795
|
+
|参数|描述|
|
|
1796
|
+
|---------|---------|
|
|
1797
|
+
|format|音频数据回调格式。|
|
|
1748
1798
|
|
|
1749
1799
|
> **注意**
|
|
1750
1800
|
>
|
|
1751
1801
|
|
|
1752
1802
|
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1753
1803
|
>
|
|
1754
|
-
|
|
1755
|
-
#### 返回值说明:
|
|
1804
|
+
**返回值说明:**
|
|
1756
1805
|
|
|
1757
1806
|
0:成功;<0:错误。
|
|
1758
1807
|
|
|
1759
1808
|
## enableCustomAudioRendering
|
|
1760
1809
|
|
|
1761
|
-
|
|
1810
|
+
**开启音频自定义播放。**
|
|
1762
1811
|
|
|
1763
1812
|
如果您需要外接一些特定的音频设备,或者希望自己掌控音频的播放逻辑,您可以通过该接口启用音频自定义播放。
|
|
1764
1813
|
|
|
1765
1814
|
启用音频自定义播放后,SDK 将不再调用系统的音频接口播放数据,您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1815
|
+
|
|
1816
|
+
|参数|描述|
|
|
1817
|
+
|---------|---------|
|
|
1818
|
+
|enable|是否启用音频自定义播放,默认为关闭状态。|
|
|
1769
1819
|
|
|
1770
1820
|
> **注意**
|
|
1771
1821
|
>
|
|
@@ -1775,7 +1825,7 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1775
1825
|
|
|
1776
1826
|
## getCustomAudioRenderingFrame
|
|
1777
1827
|
|
|
1778
|
-
|
|
1828
|
+
**获取可播放的音频数据。**
|
|
1779
1829
|
|
|
1780
1830
|
调用该接口之前,您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
|
|
1781
1831
|
|
|
@@ -1787,9 +1837,10 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1787
1837
|
- data:用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长,推荐使用 20ms 的帧长。
|
|
1788
1838
|
|
|
1789
1839
|
计算公式为:` 采样率 x 播放时长 x 声道数量 x 2(每个样点的字节数) `, 例如: 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1840
|
+
|
|
1841
|
+
|参数|描述|
|
|
1842
|
+
|---------|---------|
|
|
1843
|
+
|audioFrame|音频数据帧。|
|
|
1793
1844
|
|
|
1794
1845
|
> **注意**
|
|
1795
1846
|
>
|
|
@@ -1805,17 +1856,18 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1805
1856
|
|
|
1806
1857
|
## sendCustomCmdMsg
|
|
1807
1858
|
|
|
1808
|
-
|
|
1859
|
+
**使用 UDP 通道发送自定义消息给房间内所有用户。**
|
|
1809
1860
|
|
|
1810
1861
|
该接口可以让您借助 TRTC 的 UDP 通道,向当前房间里的其他用户广播自定义数据,以达到传输信令的目的。
|
|
1811
1862
|
|
|
1812
1863
|
房间中的其他用户可以通过 ITRTCCloudCallback 中的 onRecvCustomCmdMsg 回调接收消息。
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
|
1817
|
-
|
|
|
1818
|
-
|
|
|
1864
|
+
|
|
1865
|
+
|参数|描述|
|
|
1866
|
+
|---------|---------|
|
|
1867
|
+
|cmdID|消息 ID,取值范围为 [1, 10]。|
|
|
1868
|
+
|data|待发送的消息,单个消息的最大长度被限制为 1KB。|
|
|
1869
|
+
|ordered|是否要求有序,即是否要求接收端的数据包顺序和发送端的数据包顺序一致(这会带来一定的接收延时)。|
|
|
1870
|
+
|reliable|是否可靠发送,可靠发送可以获得更高的发送成功率,但可靠发送比不可靠发送会带来更大的接收延迟。|
|
|
1819
1871
|
|
|
1820
1872
|
> **注意**
|
|
1821
1873
|
>
|
|
@@ -1837,14 +1889,13 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1837
1889
|
|
|
1838
1890
|
> 6. 目前仅支持主播身份。
|
|
1839
1891
|
>
|
|
1840
|
-
|
|
1841
|
-
#### 返回值说明:
|
|
1892
|
+
**返回值说明:**
|
|
1842
1893
|
|
|
1843
1894
|
true:消息已经发出;false:消息发送失败。
|
|
1844
1895
|
|
|
1845
1896
|
## sendSEIMsg
|
|
1846
1897
|
|
|
1847
|
-
|
|
1898
|
+
**使用 SEI 通道发送自定义消息给房间内所有用户。**
|
|
1848
1899
|
|
|
1849
1900
|
该接口可以让您借助 TRTC 的 SEI 通道,向当前房间里的其他用户广播自定义数据,已达到传输信令的目的。
|
|
1850
1901
|
|
|
@@ -1857,10 +1908,11 @@ true:消息已经发出;false:消息发送失败。
|
|
|
1857
1908
|
最常见的用法是把自定义的时间戳(timestamp)用本接口嵌入视频帧中,实现消息和画面的完美对齐(例如:教育场景下的课件和视频信号的对齐)。
|
|
1858
1909
|
|
|
1859
1910
|
房间中的其他用户可以通过 ITRTCCloudCallback 中的 onRecvSEIMsg 回调接收消息。
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
|
1911
|
+
|
|
1912
|
+
|参数|描述|
|
|
1913
|
+
|---------|---------|
|
|
1914
|
+
|data|待发送的数据,最大支持 1KB(1000字节)的数据大小|
|
|
1915
|
+
|repeatCount|发送数据次数|
|
|
1864
1916
|
|
|
1865
1917
|
> **注意**
|
|
1866
1918
|
>
|
|
@@ -1882,17 +1934,17 @@ true:消息已经发出;false:消息发送失败。
|
|
|
1882
1934
|
|
|
1883
1935
|
> 5. 若指定多次发送(repeatCount > 1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。
|
|
1884
1936
|
>
|
|
1885
|
-
|
|
1886
|
-
#### 返回值说明:
|
|
1937
|
+
**返回值说明:**
|
|
1887
1938
|
|
|
1888
1939
|
true:消息已通过限制,等待后续视频帧发送;false:消息被限制发送
|
|
1889
1940
|
|
|
1890
1941
|
## startSpeedTest
|
|
1891
1942
|
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1943
|
+
**开始进行网速测试(进入房间前使用)。**
|
|
1944
|
+
|
|
1945
|
+
|参数|描述|
|
|
1946
|
+
|---------|---------|
|
|
1947
|
+
|params|测速选项|
|
|
1896
1948
|
|
|
1897
1949
|
> **注意**
|
|
1898
1950
|
>
|
|
@@ -1905,47 +1957,49 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1905
1957
|
|
|
1906
1958
|
> 3. 同一时间只允许一项网速测试任务运行。
|
|
1907
1959
|
>
|
|
1908
|
-
|
|
1909
|
-
#### 返回值说明:
|
|
1960
|
+
**返回值说明:**
|
|
1910
1961
|
|
|
1911
1962
|
接口调用结果,< 0:失败
|
|
1912
1963
|
|
|
1913
1964
|
## stopSpeedTest
|
|
1914
1965
|
|
|
1915
|
-
|
|
1966
|
+
**停止网络测速。**
|
|
1916
1967
|
|
|
1917
1968
|
## getSDKVersion
|
|
1918
1969
|
|
|
1919
|
-
|
|
1970
|
+
**获取 SDK 版本信息。**
|
|
1920
1971
|
|
|
1921
1972
|
## setLogLevel
|
|
1922
1973
|
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1974
|
+
**设置 Log 输出级别。**
|
|
1975
|
+
|
|
1976
|
+
|参数|描述|
|
|
1977
|
+
|---------|---------|
|
|
1978
|
+
|level|参见 TRTCLogLevel,默认值:TRTCLogLevelNone|
|
|
1927
1979
|
|
|
1928
1980
|
## setConsoleEnabled
|
|
1929
1981
|
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1982
|
+
**启用/禁用控制台日志打印。**
|
|
1983
|
+
|
|
1984
|
+
|参数|描述|
|
|
1985
|
+
|---------|---------|
|
|
1986
|
+
|enabled|指定是否启用,默认:禁止状态。|
|
|
1934
1987
|
|
|
1935
1988
|
## setLogCompressEnabled
|
|
1936
1989
|
|
|
1937
|
-
|
|
1990
|
+
**启用/禁用日志的本地压缩。**
|
|
1938
1991
|
|
|
1939
1992
|
开启压缩后,Log 存储体积明显减小,但需要腾讯云提供的 Python 脚本解压后才能阅读。
|
|
1940
1993
|
|
|
1941
1994
|
禁用压缩后,Log 采用明文存储,可以直接用记事本打开阅读,但占用空间较大。
|
|
1942
|
-
|
|
1943
|
-
|
|
1944
|
-
|
|
1995
|
+
|
|
1996
|
+
|参数|描述|
|
|
1997
|
+
|---------|---------|
|
|
1998
|
+
|enabled|指定是否启用,默认为启动状态|
|
|
1945
1999
|
|
|
1946
2000
|
## setLogDirPath
|
|
1947
2001
|
|
|
1948
|
-
|
|
2002
|
+
**设置本地日志的保存路径。**
|
|
1949
2003
|
|
|
1950
2004
|
通过该接口您可以更改 SDK 本地日志的默认存储路径,SDK 默认的本地日志的存储位置:
|
|
1951
2005
|
- Windows 平台:在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log,即 %appdata%/liteav/log 下。
|
|
@@ -1954,9 +2008,9 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1954
2008
|
|
|
1955
2009
|
- Android 平台:在 /app私有目录/files/log/liteav/ 下。
|
|
1956
2010
|
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
|
2011
|
+
|参数|描述|
|
|
2012
|
+
|---------|---------|
|
|
2013
|
+
|path|存储日志的路径|
|
|
1960
2014
|
|
|
1961
2015
|
> **注意**
|
|
1962
2016
|
>
|
|
@@ -1966,37 +2020,38 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1966
2020
|
|
|
1967
2021
|
## setLogCallback
|
|
1968
2022
|
|
|
1969
|
-
|
|
2023
|
+
**设置日志回调。**
|
|
1970
2024
|
|
|
1971
2025
|
## showDebugView
|
|
1972
2026
|
|
|
1973
|
-
|
|
2027
|
+
**显示仪表盘。**
|
|
1974
2028
|
|
|
1975
2029
|
“仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层,用于展示音视频信息和事件信息,便于对接和调试。
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
2030
|
+
|
|
2031
|
+
|参数|描述|
|
|
2032
|
+
|---------|---------|
|
|
2033
|
+
|showType|0:不显示;1:显示精简版(仅显示音视频信息);2:显示完整版(包含音视频信息和事件信息)。|
|
|
1979
2034
|
|
|
1980
2035
|
## callExperimentalAPI
|
|
1981
2036
|
|
|
1982
|
-
|
|
2037
|
+
**调用实验性接口。**
|
|
1983
2038
|
|
|
1984
2039
|
## enablePayloadPrivateEncryption
|
|
1985
2040
|
|
|
1986
|
-
|
|
2041
|
+
**开启或关闭媒体流私有加密。**
|
|
1987
2042
|
|
|
1988
2043
|
在安全要求较高的场景下,TRTC 建议您在加入房间前,调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
|
|
1989
2044
|
|
|
1990
2045
|
用户退出房间后,SDK 会自动关闭私有加密。如需重新开启私有加密,您需要在用户再次加入房间前调用该方法。
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
|
2046
|
+
|
|
2047
|
+
|参数|描述|
|
|
2048
|
+
|---------|---------|
|
|
2049
|
+
|config|配置媒体流私有加密的算法和密钥,参见 TRTCPayloadPrivateEncryptionConfig。|
|
|
2050
|
+
|enabled|是否开启媒体流私有加密。|
|
|
1995
2051
|
|
|
1996
2052
|
> **注意**
|
|
1997
2053
|
>
|
|
1998
2054
|
|
|
1999
|
-
> TRTC
|
|
2055
|
+
> TRTC 已经内置对媒体流进行加密后再传输,启用媒体流私有加密后将使用您传入的密钥与初始向量进行再次加密。
|
|
2000
2056
|
>
|
|
2001
|
-
|
|
2002
|
-
#### 返回值说明:
|
|
2057
|
+
**返回值说明:**
|