@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.2
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 +36 -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,401 +0,0 @@
|
|
|
1
|
-
## TUICallKit API 简介
|
|
2
|
-
|
|
3
|
-
TUICallKit API 是音视频通话组件的**含 UI 接口**,使用TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 快速接入(TUICallKit)。
|
|
4
|
-
|
|
5
|
-
## API 概览
|
|
6
|
-
| API | 描述 |
|
|
7
|
-
| --- | --- |
|
|
8
|
-
| login | 登录 |
|
|
9
|
-
| logout | 登出 |
|
|
10
|
-
| setSelfInfo | 设置用户的昵称、头像 |
|
|
11
|
-
| calls | 发起通话。 |
|
|
12
|
-
| join | 主动加入通话。 |
|
|
13
|
-
| enableMuteMode | 开启/关闭静音模式 |
|
|
14
|
-
| enableFloatWindow | 开启/关闭悬浮窗功能 |
|
|
15
|
-
| setCallingBell | 设置自定义来电铃音 |
|
|
16
|
-
| enableVirtualBackground | 开启/关闭虚拟背景功能 |
|
|
17
|
-
|
|
18
|
-
## API 详情
|
|
19
|
-
|
|
20
|
-
### login
|
|
21
|
-
|
|
22
|
-
登录。
|
|
23
|
-
``` cpp
|
|
24
|
-
Future<TUIResult> login(int sdkAppId, String userId, String userSig)
|
|
25
|
-
```
|
|
26
|
-
| 参数 | 类型 | 含义 |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| sdkAppId | int | 用户 SDKAppID |
|
|
29
|
-
| userId | String | 用户 ID |
|
|
30
|
-
| userSig | String | 用户签名 userSig |
|
|
31
|
-
| 返回值 | TUIResult | 包含 code 和 message 信息:code 为空 ("") 表示调用成功;code 不为空 ("") 表示调用失败,失败原因见 message |
|
|
32
|
-
|
|
33
|
-
### logout
|
|
34
|
-
|
|
35
|
-
登出。
|
|
36
|
-
``` cpp
|
|
37
|
-
Future<void> logout()
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### setSelfInfo
|
|
41
|
-
|
|
42
|
-
设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是URL格式。
|
|
43
|
-
``` cpp
|
|
44
|
-
Future<TUIResult> setSelfInfo(String nickname, String avatar)
|
|
45
|
-
```
|
|
46
|
-
| 参数 | 类型 | 含义 |
|
|
47
|
-
| --- | --- | --- |
|
|
48
|
-
| nickName | String | 目标用户的昵称,非必填 |
|
|
49
|
-
| avatar | String | 目标用户的头像,非必填 |
|
|
50
|
-
| 返回值 | TUIResult | 包含 code 和 message 信息:code 为空 ("") 表示调用成功;code 不为空 ("") 表示调用失败,失败原因见 message |
|
|
51
|
-
|
|
52
|
-
### calls
|
|
53
|
-
|
|
54
|
-
发起通话。**v2.9+ 版本支持。**
|
|
55
|
-
``` java
|
|
56
|
-
Future<TUIResult> calls(List<String> userIdList, TUICallMediaType mediaType, TUICallParams params)
|
|
57
|
-
```
|
|
58
|
-
| 参数 | 类型 | 含义 |
|
|
59
|
-
| --- | --- | --- |
|
|
60
|
-
| userIdList | List<String> | 目标用户的userId 列表 |
|
|
61
|
-
| callMediaType | TUICallMediaType | 通话的媒体类型,比如:`TUICallMediaType.video `或 `TUICallMediaType.audio` |
|
|
62
|
-
| params | TUICallParams | **可选**通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
|
|
63
|
-
|
|
64
|
-
### join
|
|
65
|
-
|
|
66
|
-
主动加入通话。**v2.9+ 版本支持。**
|
|
67
|
-
``` java
|
|
68
|
-
Future<void> join(String callId)
|
|
69
|
-
```
|
|
70
|
-
| 参数 | 类型 | 含义 |
|
|
71
|
-
| --- | --- | --- |
|
|
72
|
-
| callId | String | 此次通话的唯一 ID |
|
|
73
|
-
|
|
74
|
-
### enableMuteMode
|
|
75
|
-
|
|
76
|
-
开启后,收到通话请求,不会播放来电铃声。
|
|
77
|
-
``` javascript
|
|
78
|
-
Future<void> enableMuteMode(bool enable)
|
|
79
|
-
```
|
|
80
|
-
| 参数 | 类型 | 含义 |
|
|
81
|
-
| --- | --- | --- |
|
|
82
|
-
| enable | bool | 开启、关闭静音;true 表示开启静音 |
|
|
83
|
-
|
|
84
|
-
### enableFloatWindow
|
|
85
|
-
|
|
86
|
-
开启/关闭悬浮窗功能,设置为false后,通话界面左上角的悬浮窗按钮会隐藏。
|
|
87
|
-
``` javascript
|
|
88
|
-
Future<void> enableFloatWindow(bool enable)
|
|
89
|
-
```
|
|
90
|
-
| 参数 | 类型 | 含义 |
|
|
91
|
-
| --- | --- | --- |
|
|
92
|
-
| enable | bool | 开启、关闭悬浮窗功能;true 表示开启浮窗 |
|
|
93
|
-
|
|
94
|
-
### setCallingBell
|
|
95
|
-
|
|
96
|
-
自定义来电铃声:将铃声文件添加至主工程的`assets`资源中,传入资源文件名称即可。
|
|
97
|
-
``` javascript
|
|
98
|
-
Future<void> setCallingBell(String assetName)
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
### enableVirtualBackground
|
|
102
|
-
|
|
103
|
-
开启/关闭虚拟背景功能,开启虚拟背景功能后,您可以在 UI 上显示模糊背景的功能按钮,点击按钮可直接启用模糊背景功能。
|
|
104
|
-
``` javascript
|
|
105
|
-
Future<void> enableVirtualBackground(bool enable)
|
|
106
|
-
```
|
|
107
|
-
| 参数 | 类型 | 含义 |
|
|
108
|
-
| --- | --- | --- |
|
|
109
|
-
| enable | bool | 开启、关闭静音;true 表示开启静音 |
|
|
110
|
-
|
|
111
|
-
## 废弃接口
|
|
112
|
-
|
|
113
|
-
### call
|
|
114
|
-
|
|
115
|
-
拨打电话(1v1通话)。
|
|
116
|
-
|
|
117
|
-
> **注意:**
|
|
118
|
-
>
|
|
119
|
-
|
|
120
|
-
> 该接口已在 v2.9+ 版本废弃,建议使用 calls 接口替代。
|
|
121
|
-
>
|
|
122
|
-
|
|
123
|
-
``` cpp
|
|
124
|
-
Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
| 参数 | 类型 | 含义 |
|
|
128
|
-
| --- | --- | --- |
|
|
129
|
-
| userId | String | 目标用户的 userID |
|
|
130
|
-
| callMediaType | TUICallMediaType | 通话的媒体类型,比如:`TUICallMediaType.video `或 `TUICallMediaType.audio` |
|
|
131
|
-
|
|
132
|
-
### groupCall
|
|
133
|
-
|
|
134
|
-
发起群组通话,注意:使用群组通话前需要创建 IM 群组,如果已经创建,请忽略。
|
|
135
|
-
|
|
136
|
-
> **注意:**
|
|
137
|
-
>
|
|
138
|
-
|
|
139
|
-
> 该接口已在 v2.9+ 版本废弃,建议使用 calls 接口替代。
|
|
140
|
-
>
|
|
141
|
-
|
|
142
|
-
``` javascript
|
|
143
|
-
Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType,[TUICallParams? params])
|
|
144
|
-
```
|
|
145
|
-
| 参数 | 类型 | 含义 |
|
|
146
|
-
| --- | --- | --- |
|
|
147
|
-
| groupId | String | 此次群组通话的群 ID |
|
|
148
|
-
| userIdList | List<String> | 目标用户的 userId 列表 |
|
|
149
|
-
| callMediaType | TUICallMediaType | 通话的媒体类型,比如:`TUICallMediaType.video `或 `TUICallMediaType.audio` |
|
|
150
|
-
|
|
151
|
-
### joinInGroupCall
|
|
152
|
-
|
|
153
|
-
加入群组中已有的音视频通话。
|
|
154
|
-
|
|
155
|
-
> **注意:**
|
|
156
|
-
>
|
|
157
|
-
|
|
158
|
-
> 该接口已在 v2.9+ 版本废弃,建议使用 join 接口替代。
|
|
159
|
-
>
|
|
160
|
-
|
|
161
|
-
``` javascript
|
|
162
|
-
Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
|
|
163
|
-
```
|
|
164
|
-
| 参数 | 类型 | 含义 |
|
|
165
|
-
| --- | --- | --- |
|
|
166
|
-
| roomId | TUIRoomID | 此次通话的音视频房间 ID |
|
|
167
|
-
| groupId | String | 此次群组通话的群 ID |
|
|
168
|
-
| callMediaType | TUICallMediaType | 通话的媒体类型,比如:`TUICallMediaType.video `或 `TUICallMediaType.audio` |
|
|
169
|
-
## **常用结构**
|
|
170
|
-
|
|
171
|
-
### TUIResult
|
|
172
|
-
|
|
173
|
-
调用 API 的返回值
|
|
174
|
-
| 类型 | 类型 | 描述 |
|
|
175
|
-
| --- | --- | --- |
|
|
176
|
-
| code | String | code 为空 "" 表示调用成功,code 不为空 "" 表示调用失败 |
|
|
177
|
-
| message | String | 失败原因 |
|
|
178
|
-
|
|
179
|
-
### TUIRoomId
|
|
180
|
-
|
|
181
|
-
房间 ID
|
|
182
|
-
| 类型 | 类型 | 描述 |
|
|
183
|
-
| --- | --- | --- |
|
|
184
|
-
| intRoomId | int | 数字房间号 |
|
|
185
|
-
| strRoomId | String | 字符串房间号 |
|
|
186
|
-
|
|
187
|
-
### VideoRenderParams
|
|
188
|
-
|
|
189
|
-
视频画面的渲染参数
|
|
190
|
-
| 类型 | 类型 | 描述 |
|
|
191
|
-
| --- | --- | --- |
|
|
192
|
-
| fillMode | FillMode | 视频画面填充模式 |
|
|
193
|
-
| rotation | Rotation | 视频画面旋转方向 |
|
|
194
|
-
|
|
195
|
-
### VideoEncoderParams
|
|
196
|
-
|
|
197
|
-
视频编码参数
|
|
198
|
-
| 类型 | 类型 | 描述 |
|
|
199
|
-
| --- | --- | --- |
|
|
200
|
-
| resolution | Resolution | 视频分辨率 |
|
|
201
|
-
| resolutionMode | ResolutionMode | 视频宽高比模式 |
|
|
202
|
-
|
|
203
|
-
### TUICallParams
|
|
204
|
-
|
|
205
|
-
通话参数
|
|
206
|
-
| 类型 | 类型 | 描述 |
|
|
207
|
-
| --- | --- | --- |
|
|
208
|
-
| roomId | TUIRoomId | 房间 ID |
|
|
209
|
-
| offlinePushInfo | TUIOfflinePushInfo | 厂商离线推送配置信息 |
|
|
210
|
-
| timeout | String | 超时时常 |
|
|
211
|
-
| userData | String | 用户自定义数据 |
|
|
212
|
-
| chatGroupId | String | 群组 ID |
|
|
213
|
-
|
|
214
|
-
### TUIOfflinePushInfo
|
|
215
|
-
|
|
216
|
-
厂商离线推送配置信息,详情配置步骤请参考:离线唤醒。
|
|
217
|
-
| 类型 | 类型 | 描述 |
|
|
218
|
-
| --- | --- | --- |
|
|
219
|
-
| title | String | 离线推送展示通知栏标题 |
|
|
220
|
-
| desc | String | 离线推送展示通知栏内容 |
|
|
221
|
-
| ignoreIOSBadge | bool | 离线推送忽略 badge 计数(仅对 iOS 生效), 如果设置为 true,在 iOS 接收端,这条消息不会使 APP 的应用图标未读计数增加 |
|
|
222
|
-
| iOSSound | String | 离线推送声音设置(仅对 iOS 生效)。 当 sound = IOS_OFFLINE_PUSH_NO_SOUND,表示接收时不会播放声音。 当 sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND,表示接收时播放系统声音。 如果要自定义 iOSSound,需要先把语音文件链接进 Xcode 工程,然后把语音文件名(带后缀)设置给 iOSSound |
|
|
223
|
-
| androidSound | String | 离线推送声音设置(仅对 Android 生效, IMSDK 6.1 及以上版本支持)。 只有华为和谷歌手机支持设置声音提示,小米手机设置声音提示,请您参照:[小米自定义铃声](https://dev.mi.com/console/doc/detail?pId=1278%23_3_0#_3_0)。 另外,谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示,必须调用 setAndroidFCMChannelID 设置好 channelID,才能生效 |
|
|
224
|
-
| androidOPPOChannelID | String | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID |
|
|
225
|
-
| androidVIVOClassification | int | VIVO 推送消息分类 (待废弃接口,VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则,推荐使用 setAndroidVIVOCategory 设置消息类别)。0:运营消息 1:系统消息,默认取值为 1 |
|
|
226
|
-
| androidXiaoMiChannelID | String | 小米手机 8.0 系统及以上的渠道 ID |
|
|
227
|
-
| androidFCMChannelID | String | FCM 通道手机 8.0 系统及以上的渠道 ID |
|
|
228
|
-
| androidHuaWeiCategory | String | 华为推送消息分类,详见:[华为消息分类标准](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835) |
|
|
229
|
-
| isDisablePush | bool | 是否关闭推送(默认开启推送) |
|
|
230
|
-
| iOSPushType | TUICallIOSOfflinePushType | iOS 离线推送类型,默认:APNs |
|
|
231
|
-
|
|
232
|
-
### TUICallRecords
|
|
233
|
-
|
|
234
|
-
通话记录信息
|
|
235
|
-
| 类型 | 类型 | 描述 |
|
|
236
|
-
| --- | --- | --- |
|
|
237
|
-
| callId | String | 通话记录 ID |
|
|
238
|
-
| inviter | String | 邀请者 ID |
|
|
239
|
-
| inviteList | List<String> | 被邀请用户 ID 列表 |
|
|
240
|
-
| scene | TUICallScene | 通话场景 |
|
|
241
|
-
| mediaType | TUICallMediaType | 通话媒体类型 |
|
|
242
|
-
| groupId | String | 群组 ID |
|
|
243
|
-
| role | TUICallRole | 通话角色 |
|
|
244
|
-
| result | TUICallResultType | 通话结果类型 |
|
|
245
|
-
| beginTime | int | 开始时间 |
|
|
246
|
-
| totalTime | int | 总时间 |
|
|
247
|
-
|
|
248
|
-
### TUICallRecentCallsFilter
|
|
249
|
-
|
|
250
|
-
通话记录过滤条件
|
|
251
|
-
| 类型 | 类型 | 描述 |
|
|
252
|
-
| --- | --- | --- |
|
|
253
|
-
| begin | double | 开始时间 |
|
|
254
|
-
| end | double | 结束时间 |
|
|
255
|
-
| resultType | TUICallResultType | 通话记录类型 |
|
|
256
|
-
|
|
257
|
-
### CallObserverExtraInfo
|
|
258
|
-
|
|
259
|
-
回调扩展信息
|
|
260
|
-
| 类型 | 类型 | 描述 |
|
|
261
|
-
| --- | --- | --- |
|
|
262
|
-
| roomId | TUIRoomId | 房间 ID |
|
|
263
|
-
| role | TUICallRole | 通话角色 |
|
|
264
|
-
| userData | String | 发起通话时自定义扩展字段,详情见 TUICallParams |
|
|
265
|
-
| chatGroupId | String | 群组 ID |
|
|
266
|
-
|
|
267
|
-
## **枚举定义**
|
|
268
|
-
|
|
269
|
-
### TUICallMediaType
|
|
270
|
-
|
|
271
|
-
通话类型
|
|
272
|
-
| 类型 | 描述 |
|
|
273
|
-
| --- | --- |
|
|
274
|
-
| none | 未知类型 |
|
|
275
|
-
| audio | 语音通话 |
|
|
276
|
-
| video | 视频通话 |
|
|
277
|
-
|
|
278
|
-
### TUICallRole
|
|
279
|
-
|
|
280
|
-
通话角色
|
|
281
|
-
| 类型 | 描述 |
|
|
282
|
-
| --- | --- |
|
|
283
|
-
| none | 未知类型 |
|
|
284
|
-
| caller | 主叫(邀请方) |
|
|
285
|
-
| called | 被叫(被邀请方) |
|
|
286
|
-
|
|
287
|
-
### TUICallStatus
|
|
288
|
-
|
|
289
|
-
通话状态
|
|
290
|
-
| 类型 | 描述 |
|
|
291
|
-
| --- | --- |
|
|
292
|
-
| none | 未知类型 |
|
|
293
|
-
| waiting | 通话等待中 |
|
|
294
|
-
| accept | 通话已接听 |
|
|
295
|
-
|
|
296
|
-
### TUICallScene
|
|
297
|
-
|
|
298
|
-
通话场景
|
|
299
|
-
| 类型 | 描述 |
|
|
300
|
-
| --- | --- |
|
|
301
|
-
| singleCall | 单人通话 |
|
|
302
|
-
| groupCall | 群组通话 |
|
|
303
|
-
|
|
304
|
-
### TUINetworkQuality
|
|
305
|
-
|
|
306
|
-
网络质量
|
|
307
|
-
| 类型 | 描述 |
|
|
308
|
-
| --- | --- |
|
|
309
|
-
| unknown | 未定义 |
|
|
310
|
-
| excellent | 当前网络非常好 |
|
|
311
|
-
| good | 当前网络比较好 |
|
|
312
|
-
| poor | 当前网络一般 |
|
|
313
|
-
| bad | 当前网络较差 |
|
|
314
|
-
| vBad | 当前网络很差 |
|
|
315
|
-
| down | 当前网络不满足通话的最低要求 |
|
|
316
|
-
|
|
317
|
-
### FillMode
|
|
318
|
-
|
|
319
|
-
视频画面填充模式
|
|
320
|
-
| 类型 | 描述 |
|
|
321
|
-
| --- | --- |
|
|
322
|
-
| fill | 填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。 |
|
|
323
|
-
| fit | 适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。 |
|
|
324
|
-
|
|
325
|
-
### Rotation
|
|
326
|
-
|
|
327
|
-
视频画面旋转方向
|
|
328
|
-
| 类型 | 描述 |
|
|
329
|
-
| --- | --- |
|
|
330
|
-
| rotation_0 | 不旋转 |
|
|
331
|
-
| rotation_90 | 顺时针旋转90度 |
|
|
332
|
-
| rotation_180 | 顺时针旋转180度 |
|
|
333
|
-
| rotation_270 | 顺时针旋转270度 |
|
|
334
|
-
|
|
335
|
-
### ResolutionMode
|
|
336
|
-
|
|
337
|
-
视频宽高比模式
|
|
338
|
-
| 类型 | 描述 |
|
|
339
|
-
| --- | --- |
|
|
340
|
-
| landscape | 横屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360 |
|
|
341
|
-
| portrait | 竖屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640 |
|
|
342
|
-
|
|
343
|
-
### Resolution
|
|
344
|
-
|
|
345
|
-
视频分辨率
|
|
346
|
-
| 类型 | 描述 |
|
|
347
|
-
| --- | --- |
|
|
348
|
-
| resolution_640_360 | 宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps |
|
|
349
|
-
| resolution_960_540 | 宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps |
|
|
350
|
-
| resolution_1280_720 | 宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps |
|
|
351
|
-
| resolution_1920_1080 | 宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps |
|
|
352
|
-
|
|
353
|
-
### TUICallIOSOfflinePushType
|
|
354
|
-
|
|
355
|
-
iOS 离线推送类型
|
|
356
|
-
| 类型 | 描述 |
|
|
357
|
-
| --- | --- |
|
|
358
|
-
| APNs | 普通推送 |
|
|
359
|
-
| VoIP | VoIP 推送 |
|
|
360
|
-
|
|
361
|
-
### TUICamera
|
|
362
|
-
|
|
363
|
-
摄像头类型
|
|
364
|
-
| 类型 | 描述 |
|
|
365
|
-
| --- | --- |
|
|
366
|
-
| front | 前置摄像头 |
|
|
367
|
-
| back | 后置摄像头 |
|
|
368
|
-
|
|
369
|
-
### TUIAudioPlaybackDevice
|
|
370
|
-
|
|
371
|
-
音频播放路由
|
|
372
|
-
| 类型 | 描述 |
|
|
373
|
-
| --- | --- |
|
|
374
|
-
| speakerphone | 扬声器 |
|
|
375
|
-
| earpiece | 耳麦 |
|
|
376
|
-
|
|
377
|
-
### TUICallResultType
|
|
378
|
-
|
|
379
|
-
通话记录类型
|
|
380
|
-
| 类型 | 描述 |
|
|
381
|
-
| --- | --- |
|
|
382
|
-
| unknown | 未知 |
|
|
383
|
-
| missed | 未接 |
|
|
384
|
-
| incoming | 接入 |
|
|
385
|
-
| outgoing | 拨出 |
|
|
386
|
-
|
|
387
|
-
### CallEndReason
|
|
388
|
-
|
|
389
|
-
通话结束原因
|
|
390
|
-
| 类型 | 描述 |
|
|
391
|
-
| --- | --- |
|
|
392
|
-
| unknown | 未知 |
|
|
393
|
-
| hangup | 挂断 |
|
|
394
|
-
| reject | 拒绝 |
|
|
395
|
-
| noResponse | 无响应 |
|
|
396
|
-
| offline | 离线 |
|
|
397
|
-
| lineBusy | 忙线 |
|
|
398
|
-
| canceled | 取消通话 |
|
|
399
|
-
| otherDeviceAccepted | 其他设备接听 |
|
|
400
|
-
| otherDeviceReject | 其他设备拒绝 |
|
|
401
|
-
| endByServer | 后台结束 |
|
|
@@ -1,282 +0,0 @@
|
|
|
1
|
-
## TUICallKit API 简介
|
|
2
|
-
|
|
3
|
-
TUICallKit API 是音视频通话组件的**含 UI 接口**,使用TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 [快速接入TUICallKit](https://cloud.tencent.com/document/product/647/78730)。
|
|
4
|
-
|
|
5
|
-
## API 概览
|
|
6
|
-
| API | 描述 |
|
|
7
|
-
| --- | --- |
|
|
8
|
-
| [createInstance](https://cloud.tencent.com/document/product/647/78753#createInstance) | 创建 TUICallKit 实例(单例模式) |
|
|
9
|
-
| [setSelfInfo](https://cloud.tencent.com/document/product/647/78753#setSelfInfo) | 设置用户的昵称、头像 |
|
|
10
|
-
| [calls](https://cloud.tencent.com/document/product/647/78753#calls) | 发起单人或多人通话 |
|
|
11
|
-
| [join](https://cloud.tencent.com/document/product/647/78753#join) | 主动加入通话 |
|
|
12
|
-
| [setCallingBell](https://cloud.tencent.com/document/product/647/78753#setCallingBell) | 设置自定义来电铃音 |
|
|
13
|
-
| [enableMuteMode](https://cloud.tencent.com/document/product/647/78753#enableMuteMode) | 开启/关闭静音模式 |
|
|
14
|
-
| [enableFloatWindow](https://cloud.tencent.com/document/product/647/78753#enableFloatWindow) | 开启/关闭悬浮窗功能 |
|
|
15
|
-
| [enableIncomingBanner](https://cloud.tencent.com/document/product/647/78753#enableIncomingBanner) | 开启/关闭来电横幅显示 |
|
|
16
|
-
|
|
17
|
-
## API 详情
|
|
18
|
-
|
|
19
|
-
### createInstance
|
|
20
|
-
|
|
21
|
-
创建 TUICallKit 的单例。
|
|
22
|
-
|
|
23
|
-
【Objective-C】
|
|
24
|
-
``` objectivec
|
|
25
|
-
- (instancetype)createInstance;
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
【Swift】
|
|
29
|
-
``` swift
|
|
30
|
-
public static func createInstance() -> TUICallKit
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### setSelfInfo
|
|
34
|
-
|
|
35
|
-
设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是 URL 格式。
|
|
36
|
-
|
|
37
|
-
【Objective-C】
|
|
38
|
-
``` objectivec
|
|
39
|
-
- (void)setSelfInfo:(NSString * _Nullable)nickname avatar:(NSString * _Nullable)avatar succ:(TUICallSucc)succ fail:(TUICallFail)fail;
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
【Swift】
|
|
43
|
-
``` swift
|
|
44
|
-
public func setSelfInfo(nickname: String, avatar: String, succ:@escaping TUICallSucc, fail: @escaping TUICallFail)
|
|
45
|
-
```
|
|
46
|
-
| 参数 | 类型 | 含义 |
|
|
47
|
-
| --- | --- | --- |
|
|
48
|
-
| nickname | NSString | 用户昵称 |
|
|
49
|
-
| avatar | NSString | 用户头像(格式为 URL) |
|
|
50
|
-
| succ | TUICallSucc | 成功回调 |
|
|
51
|
-
| fail | TUICallFail | 失败回调 |
|
|
52
|
-
|
|
53
|
-
### calls
|
|
54
|
-
|
|
55
|
-
发起通话。
|
|
56
|
-
|
|
57
|
-
【Swift】
|
|
58
|
-
``` swift
|
|
59
|
-
func calls(userIdList: [String], callMediaType: TUICallMediaType, params: TUICallParams,
|
|
60
|
-
succ: @escaping TUICallSucc, fail: @escaping TUICallFail)
|
|
61
|
-
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
【Objective-C】
|
|
65
|
-
``` objectivec
|
|
66
|
-
- (void)calls:(NSArray<NSString *> *)userIdList callMediaType:(TUICallMediaType)callMediaType params:(TUICallParams *)params succ:(TUICallSucc)succ fail:(TUICallFail)fail;
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
参数如下表所示:
|
|
70
|
-
| 参数 | 类型 | 含义 |
|
|
71
|
-
| --- | --- | --- |
|
|
72
|
-
| userIdList | NSArray | 目标用户的 userId 列表 |
|
|
73
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|
|
74
|
-
| params | [TUICallParams](https://cloud.tencent.com/document/product/647/90446#CallParams) | 通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
|
|
75
|
-
|
|
76
|
-
### join
|
|
77
|
-
|
|
78
|
-
主动加入通话。
|
|
79
|
-
|
|
80
|
-
【Swift】
|
|
81
|
-
``` java
|
|
82
|
-
func join(callId: String)
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
【Objective-C】
|
|
86
|
-
``` java
|
|
87
|
-
- (void)join:(NSString *)callId;
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
参数如下表所示:
|
|
91
|
-
| 参数 | 类型 | 含义 |
|
|
92
|
-
| --- | --- | --- |
|
|
93
|
-
| callId | NSString | 此次通话的唯一 ID |
|
|
94
|
-
|
|
95
|
-
### setCallingBell
|
|
96
|
-
|
|
97
|
-
设置自定义来电铃音。
|
|
98
|
-
这里仅限传入本地文件地址,需要确保该文件目录是应用可以访问的。
|
|
99
|
-
- 铃声设置后与设备绑定,更换用户,铃声依旧会生效。
|
|
100
|
-
|
|
101
|
-
- 如需恢复默认铃声,`filePath` 传空即可。
|
|
102
|
-
|
|
103
|
-
【Objective-C】
|
|
104
|
-
``` objectivec
|
|
105
|
-
- (void)setCallingBell:(NSString *)filePath;
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
【Swift】
|
|
109
|
-
``` swift
|
|
110
|
-
public func setCallingBell(filePath: String)
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### enableMuteMode
|
|
114
|
-
|
|
115
|
-
开启后,收到通话请求,不会播放来电铃声。
|
|
116
|
-
|
|
117
|
-
【Objective-C】
|
|
118
|
-
``` objectivec
|
|
119
|
-
- (void)enableMuteMode:(BOOL)enable;
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
【Swift】
|
|
123
|
-
``` swift
|
|
124
|
-
public func enableMuteMode(enable: Bool)
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### enableFloatWindow
|
|
128
|
-
|
|
129
|
-
开启/关闭悬浮窗功能。
|
|
130
|
-
默认为`false`,通话界面左上角的悬浮窗按钮隐藏,设置为 true 后显示。
|
|
131
|
-
|
|
132
|
-
【Objective-C】
|
|
133
|
-
``` objectivec
|
|
134
|
-
- (void)enableFloatWindow:(BOOL)enable;
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
【Swift】
|
|
138
|
-
``` swift
|
|
139
|
-
public func enableFloatWindow(enable: Bool)
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
### enableIncomingBanner
|
|
143
|
-
|
|
144
|
-
开启/关闭来电横幅显示。
|
|
145
|
-
|
|
146
|
-
默认为`false`,被叫端收到邀请后默认弹出全屏通话等待界面,开启后先展示一个横幅,然后根据需要拉起全屏通话界面。
|
|
147
|
-
``` swift
|
|
148
|
-
public func enableIncomingBanner(enable: Bool)
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
## 废弃接口
|
|
152
|
-
|
|
153
|
-
### call
|
|
154
|
-
|
|
155
|
-
拨打电话(1v1通话)。**注意:建议使用 calls 接口。**
|
|
156
|
-
|
|
157
|
-
【Objective-C】
|
|
158
|
-
``` objectivec
|
|
159
|
-
- (void)call:(NSString *)userId callMediaType:(TUICallMediaType)callMediaType;
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
【Swift】
|
|
163
|
-
``` swift
|
|
164
|
-
public func call(userId: String, callMediaType: TUICallMediaType)
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
参数如下表所示:
|
|
168
|
-
| 参数 | 类型 | 含义 |
|
|
169
|
-
| --- | --- | --- |
|
|
170
|
-
| userId | NSString | 目标用户的 userId |
|
|
171
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|
|
172
|
-
|
|
173
|
-
### call
|
|
174
|
-
|
|
175
|
-
拨打电话(1v1通话),支持自定义房间号、通话邀请超时时间,离线推送内容等。**注意:建议使用 calls 接口。**
|
|
176
|
-
|
|
177
|
-
【Objective-C】
|
|
178
|
-
``` objectivec
|
|
179
|
-
- (void)call:(NSString *)userId callMediaType:(TUICallMediaType)callMediaType params:(TUICallParams *)params succ:(TUICallSucc __nullable)succ fail:(TUICallFail __nullable)fail;
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
【Swift】
|
|
183
|
-
``` swift
|
|
184
|
-
public func call(userId: String, callMediaType: TUICallMediaType, params: TUICallParams,
|
|
185
|
-
succ: @escaping TUICallSucc, fail: @escaping TUICallFail)
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
参数如下表所示:
|
|
189
|
-
| 参数 | 类型 | 含义 |
|
|
190
|
-
| --- | --- | --- |
|
|
191
|
-
| userId | NSString | 目标用户的 userId |
|
|
192
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|
|
193
|
-
| params | [TUICallParams](https://cloud.tencent.com/document/product/647/90446#CallParams) | 通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
|
|
194
|
-
| succ | TUICallSucc | 成功回调 |
|
|
195
|
-
| fail | TUICallFail | 失败回调 |
|
|
196
|
-
|
|
197
|
-
### groupCall
|
|
198
|
-
|
|
199
|
-
发起群组通话。**注意:建议使用 calls 接口。**
|
|
200
|
-
|
|
201
|
-
> **注意:**
|
|
202
|
-
>
|
|
203
|
-
|
|
204
|
-
> 使用群组通话前需要创建 IM 群组,如果已经创建,请忽略。
|
|
205
|
-
>
|
|
206
|
-
|
|
207
|
-
> 群组的创建详见:[IM 群组管理](https://cloud.tencent.com/document/product/269/75394#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ,或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059),一站式集成聊天、通话等场景。
|
|
208
|
-
>
|
|
209
|
-
|
|
210
|
-
【Objective-C】
|
|
211
|
-
``` objectivec
|
|
212
|
-
- (void)groupCall:(NSString *)groupId userIdList:(NSArray<NSString *> *)userIdList callMediaType:(TUICallMediaType)callMediaType;
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
【Swift】
|
|
216
|
-
``` swift
|
|
217
|
-
public func groupCall(groupId: String, userIdList: [String], callMediaType: TUICallMediaType)
|
|
218
|
-
```
|
|
219
|
-
| 参数 | 类型 | 含义 |
|
|
220
|
-
| --- | --- | --- |
|
|
221
|
-
| groupId | NSString | 此次群组通话的群 ID |
|
|
222
|
-
| userIdList | NSArray | 目标用户的 userId 列表 |
|
|
223
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|
|
224
|
-
|
|
225
|
-
### groupCall
|
|
226
|
-
|
|
227
|
-
发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等。**注意:建议使用 calls 接口。**
|
|
228
|
-
|
|
229
|
-
> **注意:**
|
|
230
|
-
>
|
|
231
|
-
|
|
232
|
-
> 使用群组通话前需要创建 IM 群组,如果已经创建,请忽略。
|
|
233
|
-
>
|
|
234
|
-
|
|
235
|
-
> 群组的创建详见:[IM 群组管理](https://cloud.tencent.com/document/product/269/75394#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ,或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059),一站式集成聊天、通话等场景。
|
|
236
|
-
>
|
|
237
|
-
|
|
238
|
-
【Objective-C】
|
|
239
|
-
``` objectivec
|
|
240
|
-
- (void)groupCall:(NSString *)groupId userIdList:(NSArray<NSString *> *)userIdList callMediaType:(TUICallMediaType)callMediaType params:(TUICallParams *)params succ:(TUICallSucc __nullable)succ fail:(TUICallFail __nullable)fail;
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
【Swift】
|
|
244
|
-
``` swift
|
|
245
|
-
public func groupCall(groupId: String, userIdList: [String], callMediaType: TUICallMediaType, params: TUICallParams, succ: @escaping TUICallSucc, fail: @escaping TUICallFail)
|
|
246
|
-
```
|
|
247
|
-
| 参数 | 类型 | 含义 |
|
|
248
|
-
| --- | --- | --- |
|
|
249
|
-
| groupId | NSString | 此次群组通话的群 ID |
|
|
250
|
-
| userIdList | NSArray | 目标用户的 userId 列表 |
|
|
251
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|
|
252
|
-
| params | [TUICallParams](https://cloud.tencent.com/document/product/647/90446#CallParams) | 通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等 |
|
|
253
|
-
| succ | TUICallSucc | 成功回调 |
|
|
254
|
-
| fail | TUICallFail | 失败回调 |
|
|
255
|
-
|
|
256
|
-
### joinInGroupCall
|
|
257
|
-
|
|
258
|
-
加入群组中已有的音视频通话。**注意:建议使用 join 接口。**
|
|
259
|
-
|
|
260
|
-
> **注意:**
|
|
261
|
-
>
|
|
262
|
-
|
|
263
|
-
> 加入群组中已有的音视频通话前,需要提前创建或加入 IM 群组,并且群组中已有用户在通话中,如果已经创建,请忽略。
|
|
264
|
-
>
|
|
265
|
-
|
|
266
|
-
> 群组的创建详见:[IM 群组管理](https://cloud.tencent.com/document/product/269/75394#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ,或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059),一站式集成聊天、通话等场景。
|
|
267
|
-
>
|
|
268
|
-
|
|
269
|
-
【Objective-C】
|
|
270
|
-
``` objectivec
|
|
271
|
-
- (void)joinInGroupCall:(TUIRoomId *)roomId groupId:(NSString *)groupId callMediaType:(TUICallMediaType)callMediaType;
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
【Swift】
|
|
275
|
-
``` swift
|
|
276
|
-
public func joinInGroupCall(roomId: TUIRoomId, groupId: String, callMediaType: TUICallMediaType)
|
|
277
|
-
```
|
|
278
|
-
| 参数 | 类型 | 含义 |
|
|
279
|
-
| --- | --- | --- |
|
|
280
|
-
| roomId | [TUIRoomId](https://cloud.tencent.com/document/product/647/90446#RoomId) | 此次通话的音视频房间 ID |
|
|
281
|
-
| groupId | NSString | 此次群组通话的群 ID |
|
|
282
|
-
| callMediaType | [TUICallMediaType](https://cloud.tencent.com/document/product/647/90446#MediaType) | 通话的媒体类型,比如视频通话、语音通话 |
|