@tencentcloud/sdk-mcp 1.7.7 → 1.7.8
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/CHANGELOG.md +13 -0
- package/README.md +7 -9
- package/index.js +8 -8
- package/knowledge/doc-url-resolver.js +16 -9
- package/knowledge/embedding/build-vectors.js +92 -0
- package/knowledge/embedding/embed-model.js +41 -0
- package/knowledge/embedding/vector-augment.js +126 -0
- package/knowledge/embedding/vector-index.js +70 -0
- package/knowledge/search/exact-lookup.js +145 -16
- package/knowledge/search/filter-pool.js +68 -32
- package/knowledge/search/requires-framework.js +1 -1
- package/knowledge/search/search-core.js +18 -12
- package/knowledge/search/search-knowledge.js +24 -34
- package/knowledge/search/search-pass.js +373 -168
- package/knowledge/search/url-row-scorer.js +24 -6
- package/package.json +3 -1
- package/resource/index/manifest.json +1 -1
- package/resource/index/vectors/index.json +4 -0
- package/resource/integration/chat/preset/react/integration.md +9 -5
- package/resource/integration/chat/preset/uni-app/integration.md +4 -0
- package/resource/integration/chat/preset/vue/integration.md +10 -6
- package/resource/integration/roomkit/preset/vue/integration.md +154 -208
- package/resource/knowledge/callkit/preset/miniprogram/integration.md +2 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -16
- package/resource/knowledge/chat/preset/react/h5/integration.md +16 -5
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +6 -3
- package/resource/knowledge/chat/preset/vue/h5/integration.md +7 -4
- package/resource/knowledge/push/config/android/honor.md +16 -1
- package/resource/knowledge/push/config/android/huawei.md +20 -4
- package/resource/knowledge/push/config/android/meizu.md +19 -5
- package/resource/knowledge/push/config/android/vivo.md +20 -1
- package/resource/knowledge/push/config/harmonyos.md +21 -5
- package/resource/knowledge/push/integration/flutter.md +1 -1
- package/resource/knowledge/roomkit/preset/uniapp-app/integration.md +18 -14
- package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +30 -0
- package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +4 -0
- package/resource/knowledge/trtc/android/TRTCCloud.md +94 -85
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +48 -46
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +48 -48
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +18 -18
- package/resource/knowledge/trtc/android/TXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +90 -90
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +18 -18
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +9 -9
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +47 -47
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +47 -45
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/ios/TRTCCloud.md +93 -93
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +50 -50
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +8 -8
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +9 -9
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -0
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +48 -46
- package/server-config.js +8 -9
- package/server.js +1 -1
- package/tools/common/present_framework_choice.js +1 -1
- package/tools/common/search_trtc_knowledge.js +20 -1
- package/utils/preflight-route.js +8 -0
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
|
@@ -109,9 +109,9 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
109
109
|
|
|
110
110
|
|参数|描述|
|
|
111
111
|
|---------|---------|
|
|
112
|
-
|errCode
|
|
113
|
-
|errMsg
|
|
114
|
-
|extInfo
|
|
112
|
+
|errCode|错误码。|
|
|
113
|
+
|errMsg|错误信息。|
|
|
114
|
+
|extInfo|扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。|
|
|
115
115
|
|
|
116
116
|
## onWarning:warningMsg:extInfo:
|
|
117
117
|
|
|
@@ -123,18 +123,18 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
123
123
|
|
|
124
124
|
|参数|描述|
|
|
125
125
|
|---------|---------|
|
|
126
|
-
|extInfo
|
|
127
|
-
|warningCode
|
|
128
|
-
|warningMsg
|
|
126
|
+
|extInfo|扩展信息字段,个别警告码可能会带额外的信息帮助定位问题。|
|
|
127
|
+
|warningCode|警告码。|
|
|
128
|
+
|warningMsg|警告信息。|
|
|
129
129
|
|
|
130
130
|
## onEnterRoom:
|
|
131
131
|
|
|
132
132
|
**进入房间成功与否的事件回调。**
|
|
133
133
|
|
|
134
134
|
调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 TRTCCloudDelegate 的 `onEnterRoom(result)` 回调:
|
|
135
|
-
-
|
|
135
|
+
- 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
|
|
136
136
|
|
|
137
|
-
-
|
|
137
|
+
- 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
|
|
138
138
|
|
|
139
139
|
进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/38308)。
|
|
140
140
|
|
|
@@ -230,9 +230,9 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
230
230
|
**有用户加入当前房间。**
|
|
231
231
|
|
|
232
232
|
出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 `AppScene` ,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
|
|
233
|
-
-
|
|
233
|
+
- 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
|
|
234
234
|
|
|
235
|
-
-
|
|
235
|
+
- 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
|
|
236
236
|
|
|
237
237
|
|参数|描述|
|
|
238
238
|
|---------|---------|
|
|
@@ -250,9 +250,9 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
250
250
|
**有用户离开当前房间。**
|
|
251
251
|
|
|
252
252
|
与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
|
|
253
|
-
-
|
|
253
|
+
- 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景下的用户区分主播和观众两种角色,只有主播离开房间时才会触发该通知,观众离开房间时不会触发该通知。
|
|
254
254
|
|
|
255
|
-
-
|
|
255
|
+
- 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下的用户没有角色的区分(可认为都是主播),任何用户离开房间都会触发该通知。
|
|
256
256
|
|
|
257
257
|
|参数|描述|
|
|
258
258
|
|---------|---------|
|
|
@@ -297,9 +297,9 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
297
297
|
**某远端用户发布/取消了自己的音频。**
|
|
298
298
|
|
|
299
299
|
当您收到 `onUserAudioAvailable(userId, YES)` 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
|
|
300
|
-
-
|
|
300
|
+
- 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
|
|
301
301
|
|
|
302
|
-
-
|
|
302
|
+
- 在手动订阅模式下,您可以通过 muteRemoteAudio(userid, NO) 来播放该用户的声音。
|
|
303
303
|
|
|
304
304
|
|参数|描述|
|
|
305
305
|
|---------|---------|
|
|
@@ -316,9 +316,9 @@ Function: 腾讯云实时音视频的事件回调接口
|
|
|
316
316
|
**SDK 开始渲染自己本地或远端用户的首帧画面。**
|
|
317
317
|
|
|
318
318
|
SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
|
|
319
|
-
-
|
|
319
|
+
- 如果 userId 为空值,代表 SDK 已经开始渲染自己本地的视频画面,不过前提是您已经调用了 startLocalPreview 或 startScreenCapture。
|
|
320
320
|
|
|
321
|
-
-
|
|
321
|
+
- 如果 userId 不为空,代表 SDK 已经开始渲染远端用户的视频画面,不过前提是您已经调用了 startRemoteView 订阅了该用户的视频画面。
|
|
322
322
|
|
|
323
323
|
|参数|描述|
|
|
324
324
|
|---------|---------|
|
|
@@ -418,11 +418,11 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
|
|
|
418
418
|
**音视频技术指标的实时统计回调。**
|
|
419
419
|
|
|
420
420
|
该统计回调每间隔2秒抛出一次,用于通知 SDK 内部音频、视频以及网络相关的专业技术指标,这些信息在 TRTCStatistics 均有罗列:
|
|
421
|
-
-
|
|
421
|
+
- 视频统计信息:视频的分辨率(resolution)、帧率(FPS)和比特率(bitrate)等信息。
|
|
422
422
|
|
|
423
|
-
-
|
|
423
|
+
- 音频统计信息:音频的采样率(samplerate)、声道(channel)和比特率(bitrate)等信息。
|
|
424
424
|
|
|
425
|
-
-
|
|
425
|
+
- 网络统计信息:SDK 和云端一次往返(SDK > Cloud > SDK)的网络耗时(rtt)、丢包率(loss)、上行流量(sentBytes)和下行流量(receivedBytes)等信息。
|
|
426
426
|
|
|
427
427
|
|参数|描述|
|
|
428
428
|
|---------|---------|
|
|
@@ -490,15 +490,15 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
|
|
|
490
490
|
**当前音频路由发生变化(仅适用于移动设备)。**
|
|
491
491
|
|
|
492
492
|
所谓“音频路由”,是指声音是从手机的扬声器还是从听筒中播放出来,音频路由变化也就是声音的播放位置发生了变化。
|
|
493
|
-
-
|
|
493
|
+
- 当音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
|
|
494
494
|
|
|
495
|
-
-
|
|
495
|
+
- 当音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
|
|
496
496
|
|
|
497
|
-
-
|
|
497
|
+
- 当音频路由为有线耳机。
|
|
498
498
|
|
|
499
|
-
-
|
|
499
|
+
- 当音频路由为蓝牙耳机。
|
|
500
500
|
|
|
501
|
-
-
|
|
501
|
+
- 当音频路由为USB专业声卡设备。
|
|
502
502
|
|
|
503
503
|
|参数|描述|
|
|
504
504
|
|---------|---------|
|
|
@@ -711,7 +711,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
711
711
|
| 参数 | 描述 |
|
|
712
712
|
| --- | --- |
|
|
713
713
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
714
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
714
|
+
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4006: 同一个任务并发冲突,上一个 startPublishMediaStream 任务服务器还在处理中,建议延迟重试<br>- 4007: 同一个任务已经通过 startPublishMediaStream 启动成功,建议使用返回的 taskId 调用 updatePublishMediaStream 接口更新任务<br>- 5001: 资源受限,建议延迟重试 |
|
|
715
715
|
| message | 具体回调信息。 |
|
|
716
716
|
| taskId | 当请求成功时,TRTC 后台会在回调中提供给您这项任务的 taskId,后续您可以通过该 taskId 结合 updatePublishMediaStream 和 stopPublishMediaStream 进行更新和停止。 |
|
|
717
717
|
|
|
@@ -723,7 +723,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
723
723
|
| 参数 | 描述 |
|
|
724
724
|
| --- | --- |
|
|
725
725
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
726
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
726
|
+
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2002: 找不到任务,建议调用 startPublishMediaStream 接口重新启动任务<br>- 2018: 并发请求乱序,建议使用最新混流参数重试<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,建议先调用 stopPublishMediaStream 接口停止任务,再调用 startPublishMediaStream 接口启动任务 |
|
|
727
727
|
| message | 具体回调信息。 |
|
|
728
728
|
| taskId | 您调用媒体流发布接口 (updatePublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次更新请求。 |
|
|
729
729
|
|
|
@@ -735,7 +735,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
735
735
|
| 参数 | 描述 |
|
|
736
736
|
| --- | --- |
|
|
737
737
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
738
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
738
|
+
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
|
|
739
739
|
| message | 具体回调信息。 |
|
|
740
740
|
| taskId | 您调用停止发布媒体流 (stopPublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次停止请求。 |
|
|
741
741
|
|
|
@@ -752,7 +752,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
752
752
|
| code | 推流结果,0 表示成功,其余值表示出错,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
753
753
|
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。 |
|
|
754
754
|
| message | 具体推流信息。 |
|
|
755
|
-
| status | 推流状态。<br>-
|
|
755
|
+
| status | 推流状态。<br>- 0:推流未开始或者已结束。在您调用 stopPublishMediaStream 时会返回该状态。<br>- 1:正在连接 TRTC 服务器和 CDN 服务器。若无法立刻成功,TRTC 后台服务会多次重试尝试推流,并返回该状态(5s回调一次)。如成功进行推流,则进入状态 2;如服务器出错或 60 秒内未成功推流,则进入状态 4。<br>- 2:CDN 推流正在进行。在成功推流后,会返回该状态。<br>- 3:TRTC 服务器和 CDN 服务器推流中断,正在恢复。当 CDN 出现异常,或推流短暂中断时,TRTC 后台服务会自动尝试恢复推流,并返回该状态(5s回调一次)。如成功恢复推流,则进入状态 2;如服务器出错或 60 秒内未成功恢复,则进入状态 4。<br>- 4:TRTC 服务器和 CDN 服务器推流中断,且恢复或连接超时。即此时推流失败,您可以再次调用 updatePublishMediaStream 尝试推流。<br>- 5:正在断开 TRTC 服务器和 CDN 服务器。在您调用 stopPublishMediaStream 时,TRTC 后台服务会依次同步状态 5 和状态 0。 |
|
|
756
756
|
|
|
757
757
|
## onScreenCaptureStarted
|
|
758
758
|
|
|
@@ -767,7 +767,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
767
767
|
当您通过 pauseScreenCapture 暂停屏幕分享时,SDK 便会抛出此事件回调。
|
|
768
768
|
| 参数 | 描述 |
|
|
769
769
|
| --- | --- |
|
|
770
|
-
| reason | 暂停原因:<br>-
|
|
770
|
+
| reason | 暂停原因:<br>- 0:用户主动暂停。<br>- 1:屏幕窗口不可见导致的暂停(macOS)/ 屏幕分享参数设置导致的暂停(Windows)。<br>- 2:屏幕分享窗口被最小化导致的暂停(仅 Windows)。<br>- 3:屏幕分享窗口被隐藏导致的暂停(仅 Windows)。<br>- 4:系统操作导致屏幕分享暂停(仅 iOS)。 |
|
|
771
771
|
|
|
772
772
|
## onScreenCaptureResumed:
|
|
773
773
|
|
|
@@ -776,7 +776,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
776
776
|
当您通过 resumeScreenCapture 恢复屏幕分享时,SDK 便会抛出此事件回调。
|
|
777
777
|
| 参数 | 描述 |
|
|
778
778
|
| --- | --- |
|
|
779
|
-
| reason | 恢复原因:<br>-
|
|
779
|
+
| reason | 恢复原因:<br>- 0:用户主动恢复。<br>- 1:屏幕窗口恢复可见导致的分享恢复(macOS)/ 屏幕分享参数设置完毕后自动恢复(Windows)。<br>- 2:屏幕分享窗口从最小化状态恢复(仅 Windows)。<br>- 3:屏幕分享窗口从隐藏状态恢复(仅 Windows)。<br>- 4:系统操作导致屏幕分享恢复(仅 iOS)。 |
|
|
780
780
|
|
|
781
781
|
## onScreenCaptureStoped:
|
|
782
782
|
|
|
@@ -795,7 +795,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
795
795
|
当您调用 startLocalRecording 启动本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务是否已经顺利启动。
|
|
796
796
|
| 参数 | 描述 |
|
|
797
797
|
| --- | --- |
|
|
798
|
-
| errCode | 状态码。<br>-
|
|
798
|
+
| errCode | 状态码。<br>- 0:录制任务启动成功。<br>- -1:内部错误导致录制任务启动失败。<br>- -2:文件后缀名有误(例如不支持的录制格式)。<br>- -6:录制已经启动,需要先停止录制。<br>- -7:录制文件已存在,需要先删除文件。<br>- -8:录制目录无写入权限,请检查目录权限问题。 |
|
|
799
799
|
| storagePath | 录制文件存储路径。 |
|
|
800
800
|
|
|
801
801
|
## onLocalRecording:storagePath:
|
|
@@ -830,7 +830,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
|
|
|
830
830
|
当您调用 stopLocalRecording 停止本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务的最终结果。
|
|
831
831
|
| 参数 | 描述 |
|
|
832
832
|
| --- | --- |
|
|
833
|
-
| errCode | 状态码。<br>-
|
|
833
|
+
| errCode | 状态码。<br>- 0:结束录制任务成功。<br>- -1:录制失败。<br>- -2:切换分辨率或横竖屏导致录制结束。<br>- -3:录制时间太短,或未采集到任何视频或音频数据,请检查录制时长,或是否已开启音、视频采集。 |
|
|
834
834
|
| storagePath | 录制文件存储路径。 |
|
|
835
835
|
|
|
836
836
|
## onExperimentalEvent:params:
|
|
@@ -924,11 +924,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
924
924
|
**本地采集并经过音频模块前处理后的音频数据回调。**
|
|
925
925
|
|
|
926
926
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
|
|
927
|
-
-
|
|
927
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
928
928
|
|
|
929
|
-
-
|
|
929
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
930
930
|
|
|
931
|
-
-
|
|
931
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
932
932
|
|
|
933
933
|
|参数|描述|
|
|
934
934
|
|---------|---------|
|
|
@@ -948,11 +948,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
948
948
|
**本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。**
|
|
949
949
|
|
|
950
950
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据,在最终进行网络编码之前,以 PCM 格式的形式通过本接口回调给您。
|
|
951
|
-
-
|
|
951
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
952
952
|
|
|
953
|
-
-
|
|
953
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
954
954
|
|
|
955
|
-
-
|
|
955
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
956
956
|
|
|
957
957
|
特殊说明:
|
|
958
958
|
|
|
@@ -978,11 +978,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
978
978
|
**混音前的每一路远程用户的音频数据。**
|
|
979
979
|
|
|
980
980
|
当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
|
|
981
|
-
-
|
|
981
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
982
982
|
|
|
983
|
-
-
|
|
983
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
984
984
|
|
|
985
|
-
-
|
|
985
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
986
986
|
|
|
987
987
|
|参数|描述|
|
|
988
988
|
|---------|---------|
|
|
@@ -999,11 +999,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
999
999
|
**将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。**
|
|
1000
1000
|
|
|
1001
1001
|
当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
|
|
1002
|
-
-
|
|
1002
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
1003
1003
|
|
|
1004
|
-
-
|
|
1004
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
1005
1005
|
|
|
1006
|
-
-
|
|
1006
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1007
1007
|
|
|
1008
1008
|
|参数|描述|
|
|
1009
1009
|
|---------|---------|
|
|
@@ -1023,11 +1023,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
1023
1023
|
**SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。**
|
|
1024
1024
|
|
|
1025
1025
|
当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
|
|
1026
|
-
-
|
|
1026
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
1027
1027
|
|
|
1028
|
-
-
|
|
1028
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
1029
1029
|
|
|
1030
|
-
-
|
|
1030
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1031
1031
|
|
|
1032
1032
|
|参数|描述|
|
|
1033
1033
|
|---------|---------|
|
|
@@ -1045,11 +1045,11 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
|
|
|
1045
1045
|
**耳返的音频数据。**
|
|
1046
1046
|
|
|
1047
1047
|
当您设置完音频数据自定义回调之后,SDK 内部会把耳返的音频数据在播放之前以 PCM 格式的形式通过本接口回调给您。
|
|
1048
|
-
-
|
|
1048
|
+
- 此接口回调出的音频时间帧长不固定,格式为 PCM 格式。
|
|
1049
1049
|
|
|
1050
|
-
-
|
|
1050
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
1051
1051
|
|
|
1052
|
-
-
|
|
1052
|
+
- 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,0.02s 的音频数据字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1053
1053
|
|
|
1054
1054
|
|参数|描述|
|
|
1055
1055
|
|---------|---------|
|
|
@@ -35,14 +35,14 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
35
35
|
|
|
36
36
|
|函数列表|描述|
|
|
37
37
|
|---------|---------|
|
|
38
|
-
|TXAudioMusicParam
|
|
38
|
+
|TXAudioMusicParam|背景音乐的播放控制信息。|
|
|
39
39
|
|
|
40
40
|
## 枚举类型
|
|
41
41
|
|
|
42
42
|
|枚举类型|描述|
|
|
43
43
|
|---------|---------|
|
|
44
|
-
|TXVoiceReverbType
|
|
45
|
-
|TXVoiceChangeType
|
|
44
|
+
|TXVoiceReverbType|混响特效。|
|
|
45
|
+
|TXVoiceChangeType|变声特效。|
|
|
46
46
|
|
|
47
47
|
## enableVoiceEarMonitor:
|
|
48
48
|
|
|
@@ -176,9 +176,9 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
176
176
|
**设置所有背景音乐的本地音量和远端音量的大小。**
|
|
177
177
|
|
|
178
178
|
该接口可以设置所有背景音乐的本地音量和远端音量。
|
|
179
|
-
-
|
|
179
|
+
- 本地音量:即主播本地可以听到的背景音乐的音量大小。
|
|
180
180
|
|
|
181
|
-
-
|
|
181
|
+
- 远端音量:即观众端可以听到的背景音乐的音量大小。
|
|
182
182
|
|
|
183
183
|
|参数|描述|
|
|
184
184
|
|---------|---------|
|
|
@@ -336,7 +336,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
336
336
|
|
|
337
337
|
## TXVoiceReverbType
|
|
338
338
|
|
|
339
|
-
|
|
339
|
+
**混响特效。**
|
|
340
340
|
|
|
341
341
|
混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果:
|
|
342
342
|
|
|
@@ -359,7 +359,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
359
359
|
|
|
360
360
|
## TXVoiceChangeType
|
|
361
361
|
|
|
362
|
-
|
|
362
|
+
**变声特效。**
|
|
363
363
|
|
|
364
364
|
变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色,目前支持如下几种变声特效:
|
|
365
365
|
|
|
@@ -384,7 +384,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
384
384
|
|
|
385
385
|
## TXAudioMusicParam
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
**背景音乐的播放控制信息。**
|
|
388
388
|
|
|
389
389
|
该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
|
|
390
390
|
|
|
@@ -165,10 +165,10 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
|
|
|
165
165
|
|
|
166
166
|
> **注意**
|
|
167
167
|
>
|
|
168
|
-
> -
|
|
169
|
-
> -
|
|
170
|
-
> -
|
|
171
|
-
> -
|
|
168
|
+
> - 使用完毕后请调用 release 方法释放资源,这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
|
|
169
|
+
> - 不要使用 delete 释放返回的 Collection 对象, `delete ITXDeviceCollection*` 指针会导致异常崩溃。
|
|
170
|
+
> - type 只支持 `TXMediaDeviceTypeMic` 、 `TXMediaDeviceTypeSpeaker` 、 `TXMediaDeviceTypeCamera` 。
|
|
171
|
+
> - 此接口只支持 Mac 和 Windows 平台。
|
|
172
172
|
|
|
173
173
|
## setCurrentDevice:deviceId:
|
|
174
174
|
|
|
@@ -221,7 +221,7 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
|
|
|
221
221
|
仅支持设置麦克风和扬声器类型,摄像头暂不支持跟随系统默认设备
|
|
222
222
|
| 参数 | 描述 |
|
|
223
223
|
| --- | --- |
|
|
224
|
-
| enable | 是否跟随系统默认的音频设备。<br>-
|
|
224
|
+
| enable | 是否跟随系统默认的音频设备。<br>- true:跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 立即切换音频设备。<br>- false:不跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 不会切换音频设备。 |
|
|
225
225
|
| type | 设备类型。 |
|
|
226
226
|
|
|
227
227
|
## startCameraDeviceTest:
|
|
@@ -302,10 +302,10 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
|
|
|
302
302
|
@deprecated v9.5 版本开始不推荐使用。
|
|
303
303
|
|
|
304
304
|
现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
|
|
305
|
-
-
|
|
305
|
+
- 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。
|
|
306
306
|
|
|
307
307
|
当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前处于通话音量。
|
|
308
|
-
-
|
|
308
|
+
- 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。
|
|
309
309
|
|
|
310
310
|
当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前处于媒体音量。
|
|
311
311
|
|
|
@@ -324,9 +324,9 @@ SDK 目前提供了三种系统音量类型的控制模式:自动切换模式
|
|
|
324
324
|
音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
|
|
325
325
|
|
|
326
326
|
手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
|
|
327
|
-
-
|
|
327
|
+
- 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
|
|
328
328
|
|
|
329
|
-
-
|
|
329
|
+
- 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
|
|
330
330
|
|
|
331
331
|
|枚举|取值|描述|
|
|
332
332
|
|---------|---------|---------|
|
|
@@ -87,6 +87,7 @@ Function: 用于通知客户 TRTC 在使用过程中出现的警告和错误
|
|
|
87
87
|
| ERR_BGM_NO_AUDIO_STREAM | -4007 | 无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏 |
|
|
88
88
|
| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | 格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3, aac, m4a, wav, ogg, mp4, mkv】,桌面端支持 【mp3, aac, m4a, wav, mp4, mkv】 |
|
|
89
89
|
| ERR_CONCURRENT_BGM_OVER_LIMIT | -4009 | 同时播放 bgm 数量超过限定值,如当前同时播放 bgm 数量超过 10 后提示该错误,请检查并发播放 bgm 数量 |
|
|
90
|
+
| ERR_BGM_SET_MUSIC_TRACK_FAILED | -4010 | 设置 BGM 音轨失败,请检查音频文件是否包含对应的音轨索引,或对应音轨的数据是否受损 |
|
|
90
91
|
|
|
91
92
|
## TXLiteAVWarning
|
|
92
93
|
|