@tencent-rtc/mcp 1.6.4 → 1.6.6
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/knowledge/chunker.js +83 -54
- package/knowledge/path-meta.js +179 -26
- package/knowledge/search/exact-lookup.js +168 -10
- package/knowledge/search/filter-pool.js +73 -19
- package/knowledge/search/product-scope-intent.js +2 -2
- package/knowledge/search/requires-framework.js +2 -2
- package/knowledge/search/search-knowledge.js +247 -61
- package/package.json +1 -1
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +2 -4
- package/resource/integration/callkit/preset/flutter/integration.md +4 -5
- package/resource/integration/callkit/preset/ios/integration.md +1 -4
- package/resource/integration/callkit/preset/react/integration.md +13 -20
- package/resource/integration/callkit/preset/vue/integration.md +14 -21
- package/resource/integration/chat/preset/android/integration.md +6 -9
- package/resource/integration/chat/preset/flutter/integration.md +9 -12
- package/resource/integration/chat/preset/ios/integration.md +2 -4
- package/resource/integration/chat/preset/react/integration.md +0 -10
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +129 -0
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +219 -0
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +261 -0
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +254 -0
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +202 -0
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +369 -0
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +229 -0
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +204 -0
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -3
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +0 -5
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +0 -6
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +5 -10
- package/resource/integration/roomkit/preset/vue/integration.md +0 -4
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +24 -0
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +7 -8
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +5 -7
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +3 -5
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -6
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -6
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +4 -9
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1 -4
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +8 -11
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +17 -23
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +33 -0
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +327 -0
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +33 -0
- package/resource/knowledge/callkit/faq/android.md +0 -2
- package/resource/knowledge/callkit/faq/error-code.md +0 -2
- package/resource/knowledge/callkit/faq/flutter.md +2 -2
- package/resource/knowledge/callkit/faq/ios.md +3 -5
- package/resource/knowledge/callkit/faq/web.md +2 -3
- package/resource/knowledge/callkit/preset/android/api.md +2 -5
- package/resource/knowledge/callkit/preset/ios/api.md +0 -2
- package/resource/knowledge/callkit/preset/react/api.md +445 -0
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +445 -0
- package/resource/knowledge/callkit/preset/vue/api.md +465 -0
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +465 -0
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -1
- package/resource/knowledge/chat/preset/android/features/language.md +0 -1
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
- package/resource/knowledge/chat/preset/android/features/message-list.md +2 -3
- package/resource/knowledge/chat/preset/android/features/search.md +0 -1
- package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/android-view/integration.md +3 -11
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/flutter/features/search.md +5 -6
- package/resource/knowledge/chat/preset/flutter/features/theme.md +2 -2
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -2
- package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +13 -15
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +5 -5
- package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
- package/resource/knowledge/chat/urls/sdk/android.md +3 -3
- package/resource/knowledge/chat/urls/sdk/flutter.md +3 -3
- package/resource/knowledge/chat/urls/sdk/ios.md +3 -3
- package/resource/knowledge/chat/urls/sdk/web.md +3 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +5 -8
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +15 -18
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +15 -20
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +10 -13
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +8 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +5 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +6 -9
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +15 -18
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +15 -20
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +10 -13
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +8 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +3 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +5 -8
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +6 -9
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +5 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +3 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +24 -24
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/{live/android/live-gift.md → features/android/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-room-list.md → features/android/live-list.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-gift.md → features/flutter/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-gift.md → features/ios/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-room-list.md → features/ios/live-list.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +5 -7
- package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +3 -6
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +2 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +3 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +3 -6
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +6 -9
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +4 -6
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -2
- package/resource/knowledge/push/api-reference/android.md +123 -0
- package/resource/knowledge/push/api-reference/flutter.md +176 -0
- package/resource/knowledge/push/api-reference/harmonyos.md +138 -0
- package/resource/knowledge/push/api-reference/ios.md +176 -0
- package/resource/knowledge/push/api-reference/react-native.md +147 -0
- package/resource/knowledge/push/api-reference/uni-app.md +147 -0
- package/resource/knowledge/push/api-reference/unity.md +119 -0
- package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
- package/resource/knowledge/push/config/android.md +4 -7
- package/resource/knowledge/push/config/harmonyos.md +0 -3
- package/resource/knowledge/push/config/ios.md +12 -20
- package/resource/knowledge/push/config/react-native.md +18 -26
- package/resource/knowledge/push/config/unity.md +20 -28
- package/resource/knowledge/push/config/unreal-engine.md +21 -29
- package/resource/knowledge/push/integration/android.md +6 -8
- package/resource/knowledge/push/integration/flutter.md +6 -9
- package/resource/knowledge/push/integration/harmonyos.md +1 -0
- package/resource/knowledge/push/integration/ios.md +7 -9
- package/resource/knowledge/push/integration/react-native.md +9 -13
- package/resource/knowledge/push/integration/uni-app.md +7 -7
- package/resource/knowledge/push/integration/unity.md +10 -13
- package/resource/knowledge/push/integration/unreal-engine.md +6 -9
- package/resource/knowledge/push/overview/prepare.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +3 -3
- package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +6 -6
- package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/preset/android/integration.md +5 -7
- package/resource/knowledge/roomkit/preset/flutter/integration.md +2 -7
- package/resource/knowledge/roomkit/preset/ios/integration.md +3 -9
- package/resource/knowledge/roomkit/preset/react/integration.md +12 -16
- package/resource/knowledge/trtc/android/TRTCCloud.md +154 -238
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +133 -134
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +86 -120
- package/resource/knowledge/trtc/android/TRTCStatistics.md +10 -10
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +10 -30
- package/resource/knowledge/trtc/android/TXBeautyManager.md +25 -25
- package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +12 -12
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +166 -261
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +12 -12
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +10 -30
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +9 -11
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +96 -130
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +122 -123
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +12 -12
- package/resource/knowledge/trtc/ios/TRTCCloud.md +168 -255
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +124 -125
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +89 -124
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +10 -10
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +9 -28
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +25 -25
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +9 -11
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +12 -12
- package/server.js +21 -21
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +2 -2
- package/tools/common/search_trtc_knowledge.js +3 -3
- package/tools/common/submit_feedback.js +1 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +61 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +3 -3
- package/tools/definitions/present_framework_choice_def.js +2 -2
- package/tools/definitions/search_trtc_knowledge_def.js +5 -5
- package/tools/index.js +2 -0
- package/tools/live/get_native_live_uikit_integration.js +69 -0
- package/tools/live/get_native_livekit_core_integration.js +6 -6
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/knowledge/callkit/preset/web/api.md +0 -83
- package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -226
- package/resource/knowledge/livekit/core-sdk/live/android/live-live-list.md +0 -438
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -490
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -264
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -216
- package/resource/knowledge/livekit/core-sdk/live/ios/live-gift.md +0 -407
- package/resource/knowledge/livekit/core-sdk/live/ios/live-live-list.md +0 -349
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -269
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -456
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-gift.md +0 -455
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -260
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -598
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +0 -424
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-barrage.md +0 -408
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/ios/live-barrage.md → features/ios/barrage.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -0
|
@@ -33,21 +33,21 @@ Function: the TRTC SDK reports to you the current real-time audio/video metrics
|
|
|
33
33
|
| --- | --- |
|
|
34
34
|
| audioBitrate | Field description: local audio bitrate (Kbps) |
|
|
35
35
|
| audioBlockRate | Field description: audio playback lag rate (%)<br>Audio playback lag rate (audioBlockRate) = cumulative audio playback lag duration (audioTotalBlockTime)/total audio playback duration |
|
|
36
|
-
| audioPacketLoss | Field description: total packet loss rate (%) of the audio stream<br><code>
|
|
36
|
+
| audioPacketLoss | Field description: total packet loss rate (%) of the audio stream<br><code>audioPacketLoss</code> represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the <code>audioPacketLoss</code> , the better. The packet loss rate of 0 indicates that all data of the audio stream has entirely reached the audience.<br>If <code>downLoss</code> is <code>0</code> but <code>audioPacketLoss</code> isn't, there is no packet loss on the linkage of "cloud -> audience" for the audiostream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
|
|
37
37
|
| audioSampleRate | Field description: local audio sample rate (Hz) |
|
|
38
38
|
| audioTotalBlockTime | Field description: cumulative audio playback lag duration (ms) |
|
|
39
39
|
| finalLoss | Field description: total packet loss rate (%) of the audio/video stream<br>Deprecated, please use audioPacketLoss and videoPacketLoss instead. |
|
|
40
40
|
| frameRate | Field description: remote video frame rate (fps) |
|
|
41
41
|
| height | Field description: remote video height in px |
|
|
42
|
-
| jitterBufferDelay | Field description: playback delay (ms)<br>In order to avoid audio/video lags caused by network jitters and network packet disorders, TRTC maintains a playback buffer on the playback side to organize the received network data packets.<br>The size of the buffer is adaptively adjusted according to the current network quality and converted to the length of time in milliseconds, i.e.,
|
|
43
|
-
| point2PointDelay | Field description: end-to-end delay (ms)<br><code>
|
|
44
|
-
| remoteNetworkRTT | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If
|
|
45
|
-
| remoteNetworkUplinkLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If
|
|
42
|
+
| jitterBufferDelay | Field description: playback delay (ms)<br>In order to avoid audio/video lags caused by network jitters and network packet disorders, TRTC maintains a playback buffer on the playback side to organize the received network data packets.<br>The size of the buffer is adaptively adjusted according to the current network quality and converted to the length of time in milliseconds, i.e., <code>jitterBufferDelay</code> . |
|
|
43
|
+
| point2PointDelay | Field description: end-to-end delay (ms)<br><code>point2PointDelay</code> represents the delay of "anchor -> cloud -> audience". To be more precise, it represents the delay of the entire linkage of "collection -> encoding -> network transfer -> receiving -> buffering -> decoding -> playback".<br><code>point2PointDelay</code> works only if both the local and remote SDKs are on version 8.5 or above. If the remote SDK is on a version below 8.5, this value will always be 0 and thus meaningless. |
|
|
44
|
+
| remoteNetworkRTT | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If <code>remoteNetworkRTT</code> is below 50 ms, it means a short audio/video call delay; if <code>remoteNetworkRTT</code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code>remoteNetworkRTT</code> represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between <code>remoteNetworkUpRTT</code> and <code>remoteNetworkDownRTT</code> . |
|
|
45
|
+
| remoteNetworkUplinkLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If <code>remoteNetworkUplinkLoss</code> is <code>0%</code> , the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If <code>remoteNetworkUplinkLoss</code> is <code>30%</code> , 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |
|
|
46
46
|
| streamType | Field description: video stream type (HD big image \\| smooth small image \\| substream image) |
|
|
47
47
|
| userId | Field description: user ID |
|
|
48
48
|
| videoBitrate | Field description: remote video bitrate (Kbps) |
|
|
49
49
|
| videoBlockRate | Field description: video playback lag rate (%)<br>Video playback lag rate (videoBlockRate) = cumulative video playback lag duration (videoTotalBlockTime)/total video playback duration |
|
|
50
|
-
| videoPacketLoss | Field description: total packet loss rate (%) of the video stream<br><code>
|
|
50
|
+
| videoPacketLoss | Field description: total packet loss rate (%) of the video stream<br><code>videoPacketLoss</code> represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the <code>videoPacketLoss</code> , the better. The packet loss rate of 0 indicates that all data of the video stream has entirely reached the audience.<br>If <code>downLoss</code> is <code>0</code> but <code>videoPacketLoss</code> isn't, there is no packet loss on the linkage of "cloud -> audience" for the video stream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
|
|
51
51
|
| videoTotalBlockTime | Field description: cumulative video playback lag duration (ms) |
|
|
52
52
|
| width | Field description: remote video width in px |
|
|
53
53
|
|
|
@@ -58,16 +58,16 @@ Function: the TRTC SDK reports to you the current real-time audio/video metrics
|
|
|
58
58
|
| --- | --- |
|
|
59
59
|
| appCpu | Field description: CPU utilization (%) of the current application, Android 8.0 and above systems are not supported |
|
|
60
60
|
| appMemoryUsageInMB | Field description: Memory usage size (MB) of current application |
|
|
61
|
-
| downLoss | Field description: downstream packet loss rate (%) from cloud to the SDK<br>The smaller the value, the better. If
|
|
62
|
-
| gatewayRtt | Field description: round-trip delay (ms) from the SDK to gateway<br>This value represents the total time it takes to send a network packet from the SDK to the gateway and then send a network packet back from the gateway to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> gateway -> SDK".<br>The smaller the value, the better. If
|
|
61
|
+
| downLoss | Field description: downstream packet loss rate (%) from cloud to the SDK<br>The smaller the value, the better. If <code>downLoss</code> is <code>0%</code> , the downstream network quality is very good, and the data packets received from the cloud are basically not lost.<br>If <code>downLoss</code> is <code>30%</code> , 30% of the audio/video data packets sent to the SDK by the cloud are lost on the transfer linkage. |
|
|
62
|
+
| gatewayRtt | Field description: round-trip delay (ms) from the SDK to gateway<br>This value represents the total time it takes to send a network packet from the SDK to the gateway and then send a network packet back from the gateway to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> gateway -> SDK".<br>The smaller the value, the better. If <code>gatewayRtt</code> is below 50 ms, it means a short audio/video call delay; if <code>gatewayRtt</code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code>gatewayRtt</code> is invalid for cellular network. |
|
|
63
63
|
| localStatisticsArray | Field description: local audio/video statistics<br>As there may be three local audio/video streams (i.e., HD big image, smooth small image, and substream image), the local audio/video statistics are an array. |
|
|
64
|
-
| localStatisticsArraySize | Field description:
|
|
64
|
+
| localStatisticsArraySize | Field description: <code>localStatisticsArray</code> array size |
|
|
65
65
|
| receivedBytes | Field description: total number of received bytes (including signaling data and audio/video data) |
|
|
66
66
|
| remoteStatisticsArray | Field description: remote audio/video statistics<br>As there may be multiple concurrent remote users, and each of them may have multiple concurrent audio/video streams (i.e., HD big image, smooth small image, and substream image), the remote audio/video statistics are an array. |
|
|
67
|
-
| remoteStatisticsArraySize | Field description:
|
|
68
|
-
| rtt | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If
|
|
67
|
+
| remoteStatisticsArraySize | Field description: <code>remoteStatisticsArray</code> array size |
|
|
68
|
+
| rtt | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If <code>rtt</code> is below 50 ms, it means a short audio/video call delay; if <code>rtt</code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code>rtt</code> represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between <code>upRtt</code> and <code>downRtt</code> . |
|
|
69
69
|
| sentBytes | Field description: total number of sent bytes (including signaling data and audio/video data) |
|
|
70
70
|
| systemCpu | Field description: CPU utilization (%) of the current system, Android 8.0 and above systems are not supported |
|
|
71
71
|
| systemMemoryInMB | Field description: Memory size (MB) of current system |
|
|
72
72
|
| systemMemoryUsageInMB | Field description: Memory usage size (MB) of current system , iOS and MAC are not supported |
|
|
73
|
-
| upLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If
|
|
73
|
+
| upLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If <code>upLoss</code> is <code>0%</code> , the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If <code>upLoss</code> is <code>30%</code> , 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |
|
|
@@ -111,11 +111,10 @@ Given that not all phones deliver excellent in-ear monitoring effects, we have b
|
|
|
111
111
|
|
|
112
112
|
|Param|DESC|
|
|
113
113
|
|---------|---------|
|
|
114
|
-
|enable
|
|
114
|
+
|enable| `true:` enable; `false` : disable|
|
|
115
115
|
|
|
116
116
|
> **Note**
|
|
117
117
|
>
|
|
118
|
-
|
|
119
118
|
> In-ear monitoring can be enabled only when earphones are used. Please remind anchors to use wired earphones.
|
|
120
119
|
>
|
|
121
120
|
|
|
@@ -131,7 +130,6 @@ This API is used to set the volume of in-ear monitoring.
|
|
|
131
130
|
|
|
132
131
|
> **Note**
|
|
133
132
|
>
|
|
134
|
-
|
|
135
133
|
> The volume of the ear monitor is one of the most important factors affecting the user experience. Considering that different users have different sensitivities to volume, it is strongly recommended to provide a ear monitor volume adjustment slider on the UI interface. The recommended adjustment range is between 0 and 150. The gain effect of 100-150 is very helpful for some Android phones with low recording volume.
|
|
136
134
|
>
|
|
137
135
|
|
|
@@ -143,7 +141,6 @@ This API is used to set reverb effects for human voice. For the effects supporte
|
|
|
143
141
|
|
|
144
142
|
> **Note**
|
|
145
143
|
>
|
|
146
|
-
|
|
147
144
|
> Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
|
|
148
145
|
>
|
|
149
146
|
|
|
@@ -155,7 +152,6 @@ This API is used to set voice changing effects. For the effects supported, pleas
|
|
|
155
152
|
|
|
156
153
|
> **Note**
|
|
157
154
|
>
|
|
158
|
-
|
|
159
155
|
> Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
|
|
160
156
|
>
|
|
161
157
|
|
|
@@ -171,7 +167,6 @@ This API is used to set the volume of speech. It is often used together with the
|
|
|
171
167
|
|
|
172
168
|
> **Note**
|
|
173
169
|
>
|
|
174
|
-
|
|
175
170
|
> If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
|
|
176
171
|
>
|
|
177
172
|
|
|
@@ -194,11 +189,10 @@ Before playing background music, please use this API to set the music callback,
|
|
|
194
189
|
|Param|DESC|
|
|
195
190
|
|---------|---------|
|
|
196
191
|
|musicId|Music ID|
|
|
197
|
-
|observer|For more information, please see the APIs defined in
|
|
192
|
+
|observer|For more information, please see the APIs defined in `ITXMusicPlayObserver` .|
|
|
198
193
|
|
|
199
194
|
> **Note**
|
|
200
195
|
>
|
|
201
|
-
|
|
202
196
|
> 1. If the ID does not need to be used, the observer can be set to NULL to release it completely.
|
|
203
197
|
>
|
|
204
198
|
|
|
@@ -214,13 +208,10 @@ You must assign an ID to each music track so that you can start, stop, or set th
|
|
|
214
208
|
|
|
215
209
|
> **Note**
|
|
216
210
|
>
|
|
217
|
-
|
|
218
211
|
> 1. If you play the same music track multiple times, please use the same ID instead of a separate ID for each playback.
|
|
219
212
|
>
|
|
220
|
-
|
|
221
213
|
> 2. If you want to play different music tracks at the same time, use different IDs for them.
|
|
222
214
|
>
|
|
223
|
-
|
|
224
215
|
> 3. If you use the same ID to play a music track different from the current one, the SDK will stop the current one before playing the new one.
|
|
225
216
|
>
|
|
226
217
|
|
|
@@ -263,7 +254,6 @@ This API is used to set the local and remote playback volume of background music
|
|
|
263
254
|
|
|
264
255
|
> **Note**
|
|
265
256
|
>
|
|
266
|
-
|
|
267
257
|
> If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
|
|
268
258
|
>
|
|
269
259
|
|
|
@@ -280,7 +270,6 @@ This API is used to control the remote playback volume (the volume heard by audi
|
|
|
280
270
|
|
|
281
271
|
> **Note**
|
|
282
272
|
>
|
|
283
|
-
|
|
284
273
|
> If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
|
|
285
274
|
>
|
|
286
275
|
|
|
@@ -297,7 +286,6 @@ This API is used to control the local playback volume (the volume heard by ancho
|
|
|
297
286
|
|
|
298
287
|
> **Note**
|
|
299
288
|
>
|
|
300
|
-
|
|
301
289
|
> If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
|
|
302
290
|
>
|
|
303
291
|
|
|
@@ -352,13 +340,10 @@ The length of the specified music file is returned. -1 indicates failure to get
|
|
|
352
340
|
|
|
353
341
|
> **Note**
|
|
354
342
|
>
|
|
355
|
-
|
|
356
343
|
> Do not call this API frequently as the music file may be read and written to each time the API is called, which can be time-consuming.
|
|
357
344
|
>
|
|
358
|
-
|
|
359
345
|
> Wait till users finish dragging the progress bar before you call this API.
|
|
360
346
|
>
|
|
361
|
-
|
|
362
347
|
> The progress bar controller on the UI tends to update the progress at a high frequency as users drag the progress bar. This will result in poor user experience unless you limit the frequency.
|
|
363
348
|
>
|
|
364
349
|
|
|
@@ -373,7 +358,6 @@ The length of the specified music file is returned. -1 indicates failure to get
|
|
|
373
358
|
|
|
374
359
|
> **Note**
|
|
375
360
|
>
|
|
376
|
-
|
|
377
361
|
> Precondition preloadMusic succeeds.
|
|
378
362
|
>
|
|
379
363
|
|
|
@@ -399,14 +383,11 @@ You must assign an ID to each music track so that you can start, stop, or set th
|
|
|
399
383
|
|
|
400
384
|
> **Note**
|
|
401
385
|
>
|
|
402
|
-
|
|
403
386
|
> 1. Preload supports up to 2 preloads with different IDs at the same time, and the preload time does not exceed 10 minutes,you need to call stopPlayMusic API after use, otherwise the memory will not be released.
|
|
404
387
|
>
|
|
405
|
-
|
|
406
388
|
> 2. If the music corresponding to the ID is being played, the preloading fails, and stopPlayMusic must be called first.
|
|
407
389
|
>
|
|
408
|
-
|
|
409
|
-
> 3. When the ` musicParam ` passed to startPlayMusic is exactly the same, preloading works.
|
|
390
|
+
> 3. When the `musicParam` passed to startPlayMusic is exactly the same, preloading works.
|
|
410
391
|
>
|
|
411
392
|
|
|
412
393
|
## getMusicTrackCount
|
|
@@ -428,7 +409,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
|
|
|
428
409
|
|
|
429
410
|
> **Note**
|
|
430
411
|
>
|
|
431
|
-
|
|
432
412
|
> The total number of tracks can be obtained through the [getMusicTrackCount interface.
|
|
433
413
|
>
|
|
434
414
|
|
|
@@ -493,10 +473,10 @@ The information, including playback ID, file path, and loop times, is passed in
|
|
|
493
473
|
3. If you use the same ID to play a music track different from the current one, the SDK will stop the current one before playing the new one.
|
|
494
474
|
| EnumType | DESC |
|
|
495
475
|
| --- | --- |
|
|
496
|
-
| endTimeMS | <code>
|
|
497
|
-
| id | <code>
|
|
498
|
-
| isShortFile | <code>
|
|
499
|
-
| loopCount | <code>
|
|
500
|
-
| path | <code>
|
|
501
|
-
| publish | <code>
|
|
502
|
-
| startTimeMS | <code>
|
|
476
|
+
| endTimeMS | <code>Field description:</code> the point in time in milliseconds for ending music playback. 0 indicates that playback continues till the end of the music track. |
|
|
477
|
+
| id | <code>Field description:</code> music ID<br><strong>Note</strong><br>the SDK supports playing multiple music tracks. IDs are used to distinguish different music tracks and control their start, end, volume, etc. |
|
|
478
|
+
| isShortFile | <code>Field description:</code> whether the music played is a short music track<br><code>Valid values:</code> <code>true</code> : short music track that needs to be looped; <code>false</code> (default): normal-length music track |
|
|
479
|
+
| loopCount | <code>Field description:</code> number of times the music track is looped<br><code>Valid values:</code> 0 or any positive integer. 0 (default) indicates that the music is played once, 1 twice, and so on. |
|
|
480
|
+
| path | <code>Field description:</code> absolute path of the music file or url.the mp3,aac,m4a,wav supported. |
|
|
481
|
+
| publish | <code>Field description:</code> whether to send the music to remote users<br><code>Valid values:</code> <code>true</code> : remote users can hear the music played locally; <code>false</code> (default): only the local user can hear the music. |
|
|
482
|
+
| startTimeMS | <code>Field description:</code> the point in time in milliseconds for starting music playback |
|
|
@@ -107,9 +107,9 @@ This API can be used to achieve the following:
|
|
|
107
107
|
|
|
108
108
|
> **Note**
|
|
109
109
|
>
|
|
110
|
-
|
|
111
110
|
> Before using this API, you must first disable auto focus using enableCameraAutoFocus.
|
|
112
111
|
>
|
|
112
|
+
|
|
113
113
|
**Return Desc:**
|
|
114
114
|
|
|
115
115
|
0: operation successful; negative number: operation failed.
|
|
@@ -138,9 +138,9 @@ If the audio route is set to the speaker, the volume is relatively high, and the
|
|
|
138
138
|
|
|
139
139
|
> **Note**
|
|
140
140
|
>
|
|
141
|
-
> - To ensure that the SDK can manage the lifecycle of the
|
|
142
|
-
> - Do not use
|
|
143
|
-
> - The valid values of
|
|
141
|
+
> - To ensure that the SDK can manage the lifecycle of the `ITXDeviceCollection` object, after using this API, please call the `release` method to release the resources.
|
|
142
|
+
> - Do not use `delete` to release the Collection object returned as deleting the ITXDeviceCollection* pointer will cause crash.
|
|
143
|
+
> - The valid values of `type` are `TXMediaDeviceTypeMic` , `TXMediaDeviceTypeSpeaker` , and `TXMediaDeviceTypeCamera` .
|
|
144
144
|
> - This API can be used only on macOS and Windows.
|
|
145
145
|
|
|
146
146
|
## setCurrentDevice
|
|
@@ -150,7 +150,7 @@ If the audio route is set to the speaker, the volume is relatively high, and the
|
|
|
150
150
|
|Param|DESC|
|
|
151
151
|
|---------|---------|
|
|
152
152
|
|deviceId|Device ID. You can get the ID of a device using the getDevicesList API.|
|
|
153
|
-
|type|Device type. For details, please see the definition of
|
|
153
|
+
|type|Device type. For details, please see the definition of `TXMediaDeviceType` .|
|
|
154
154
|
**Return Desc:**
|
|
155
155
|
|
|
156
156
|
0: operation successful; negative number: operation failed.
|
|
@@ -195,7 +195,7 @@ This API is used to set the microphone and speaker types. Camera following the s
|
|
|
195
195
|
| Param | DESC |
|
|
196
196
|
| --- | --- |
|
|
197
197
|
| enable | Whether to follow the system default audio device.<br>- true: following. When the default audio device of the system is changed or new audio device is plugged in, the SDK immediately switches the audio device.<br>- false:not following. When the default audio device of the system is changed or new audio device is plugged in, the SDK doesn't switch the audio device. |
|
|
198
|
-
| type | Device type. For details, please see the definition of
|
|
198
|
+
| type | Device type. For details, please see the definition of <code>TXMediaDeviceType</code> . |
|
|
199
199
|
|
|
200
200
|
## startCameraDeviceTest
|
|
201
201
|
|
|
@@ -203,7 +203,6 @@ This API is used to set the microphone and speaker types. Camera following the s
|
|
|
203
203
|
|
|
204
204
|
> **Note**
|
|
205
205
|
>
|
|
206
|
-
|
|
207
206
|
> You can use the setCurrentDevice API to switch between cameras during testing.
|
|
208
207
|
>
|
|
209
208
|
|
|
@@ -223,7 +222,6 @@ This API is used to test whether the mic functions properly. The mic volume dete
|
|
|
223
222
|
|
|
224
223
|
> **Note**
|
|
225
224
|
>
|
|
226
|
-
|
|
227
225
|
> When this interface is called, the sound recorded by the microphone will be played back to the speakers by default.
|
|
228
226
|
>
|
|
229
227
|
|
|
@@ -236,7 +234,7 @@ This API is used to test whether the mic functions properly. The mic volume dete
|
|
|
236
234
|
|Param|DESC|
|
|
237
235
|
|---------|---------|
|
|
238
236
|
|interval|Interval of volume callbacks, in milliseconds.|
|
|
239
|
-
|playback|Whether to play back the microphone sound. The user will hear his own sound when testing the microphone if
|
|
237
|
+
|playback|Whether to play back the microphone sound. The user will hear his own sound when testing the microphone if `playback` is true.|
|
|
240
238
|
|
|
241
239
|
## stopMicDeviceTest
|
|
242
240
|
|
|
@@ -260,7 +258,7 @@ This API is used to test whether the audio playback device functions properly by
|
|
|
260
258
|
|
|
261
259
|
**Starting camera testing (for desktop OS).**
|
|
262
260
|
|
|
263
|
-
This API supports custom rendering, meaning that you can use the callback API
|
|
261
|
+
This API supports custom rendering, meaning that you can use the callback API `ITRTCVideoRenderCallback` to get the images captured by the camera for custom rendering.
|
|
264
262
|
|
|
265
263
|
## setApplicationPlayVolume
|
|
266
264
|
|
|
@@ -290,7 +288,7 @@ This API supports custom rendering, meaning that you can use the callback API `
|
|
|
290
288
|
|
|
291
289
|
**Setting the system volume type (for mobile OS).**
|
|
292
290
|
|
|
293
|
-
@deprecated This API is not recommended after v9.5. Please use the
|
|
291
|
+
@deprecated This API is not recommended after v9.5. Please use the `startLocalAudio(quality)` API in `TRTCCloud` instead, which param `quality` is used to decide audio quality.
|
|
294
292
|
|
|
295
293
|
## TXSystemVolumeType(Deprecated)
|
|
296
294
|
|