@tencentcloud/sdk-mcp 1.7.6 → 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 +18 -0
- package/README.md +8 -5
- package/index.js +23 -1
- 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 +20 -6
- 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/normalize-error.js +13 -0
- package/utils/preflight-route.js +8 -0
- package/utils/report-cls-client.js +2 -2
- package/utils/report-es-client.js +1 -1
|
@@ -172,11 +172,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
172
172
|
**本地采集并经过音频模块前处理后的音频数据回调。**
|
|
173
173
|
|
|
174
174
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
|
|
175
|
-
-
|
|
175
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
176
176
|
|
|
177
|
-
-
|
|
177
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
178
178
|
|
|
179
|
-
-
|
|
179
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
180
180
|
|
|
181
181
|
|参数|描述|
|
|
182
182
|
|---------|---------|
|
|
@@ -196,11 +196,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
196
196
|
**本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。**
|
|
197
197
|
|
|
198
198
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据,在最终进行网络编码之前,以 PCM 格式的形式通过本接口回调给您。
|
|
199
|
-
-
|
|
199
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
200
200
|
|
|
201
|
-
-
|
|
201
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
202
202
|
|
|
203
|
-
-
|
|
203
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
204
204
|
|
|
205
205
|
特殊说明:
|
|
206
206
|
|
|
@@ -226,11 +226,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
226
226
|
**混音前的每一路远程用户的音频数据。**
|
|
227
227
|
|
|
228
228
|
当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
|
|
229
|
-
-
|
|
229
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
230
230
|
|
|
231
|
-
-
|
|
231
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
232
232
|
|
|
233
|
-
-
|
|
233
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
234
234
|
|
|
235
235
|
|参数|描述|
|
|
236
236
|
|---------|---------|
|
|
@@ -247,11 +247,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
247
247
|
**将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。**
|
|
248
248
|
|
|
249
249
|
当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
|
|
250
|
-
-
|
|
250
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
251
251
|
|
|
252
|
-
-
|
|
252
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
253
253
|
|
|
254
|
-
-
|
|
254
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
255
255
|
|
|
256
256
|
|参数|描述|
|
|
257
257
|
|---------|---------|
|
|
@@ -271,11 +271,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
271
271
|
**SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。**
|
|
272
272
|
|
|
273
273
|
当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
|
|
274
|
-
-
|
|
274
|
+
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
275
275
|
|
|
276
|
-
-
|
|
276
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
277
277
|
|
|
278
|
-
-
|
|
278
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
279
279
|
|
|
280
280
|
|参数|描述|
|
|
281
281
|
|---------|---------|
|
|
@@ -293,11 +293,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
293
293
|
**耳返的音频数据。**
|
|
294
294
|
|
|
295
295
|
当您设置完音频数据自定义回调之后,SDK 内部会把耳返的音频数据在播放之前以 PCM 格式的形式通过本接口回调给您。
|
|
296
|
-
-
|
|
296
|
+
- 此接口回调出的音频时间帧长不固定,格式为 PCM 格式。
|
|
297
297
|
|
|
298
|
-
-
|
|
298
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
299
299
|
|
|
300
|
-
-
|
|
300
|
+
- 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,0.02s 的音频数据字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
301
301
|
|
|
302
302
|
|参数|描述|
|
|
303
303
|
|---------|---------|
|
|
@@ -332,9 +332,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
332
332
|
|
|
333
333
|
|参数|描述|
|
|
334
334
|
|---------|---------|
|
|
335
|
-
|errCode
|
|
336
|
-
|errMsg
|
|
337
|
-
|extInfo
|
|
335
|
+
|errCode|错误码。|
|
|
336
|
+
|errMsg|错误信息。|
|
|
337
|
+
|extInfo|扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。|
|
|
338
338
|
|
|
339
339
|
## onWarning
|
|
340
340
|
|
|
@@ -346,18 +346,18 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
346
346
|
|
|
347
347
|
|参数|描述|
|
|
348
348
|
|---------|---------|
|
|
349
|
-
|extInfo
|
|
350
|
-
|warningCode
|
|
351
|
-
|warningMsg
|
|
349
|
+
|extInfo|扩展信息字段,个别警告码可能会带额外的信息帮助定位问题。|
|
|
350
|
+
|warningCode|警告码。|
|
|
351
|
+
|warningMsg|警告信息。|
|
|
352
352
|
|
|
353
353
|
## onEnterRoom
|
|
354
354
|
|
|
355
355
|
**进入房间成功与否的事件回调。**
|
|
356
356
|
|
|
357
357
|
调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 TRTCCloudListener 的 `onEnterRoom(result)` 回调:
|
|
358
|
-
-
|
|
358
|
+
- 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
|
|
359
359
|
|
|
360
|
-
-
|
|
360
|
+
- 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
|
|
361
361
|
|
|
362
362
|
进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/38308)。
|
|
363
363
|
|
|
@@ -453,9 +453,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
453
453
|
**有用户加入当前房间。**
|
|
454
454
|
|
|
455
455
|
出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 `AppScene` ,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
|
|
456
|
-
-
|
|
456
|
+
- 直播类场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
|
|
457
457
|
|
|
458
|
-
-
|
|
458
|
+
- 通话类场景(TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
|
|
459
459
|
|
|
460
460
|
|参数|描述|
|
|
461
461
|
|---------|---------|
|
|
@@ -473,9 +473,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
473
473
|
**有用户离开当前房间。**
|
|
474
474
|
|
|
475
475
|
与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
|
|
476
|
-
-
|
|
476
|
+
- 直播类场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM):该场景下的用户区分主播和观众两种角色,只有主播离开房间时才会触发该通知,观众离开房间时不会触发该通知。
|
|
477
477
|
|
|
478
|
-
-
|
|
478
|
+
- 通话类场景(TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL):该场景下的用户没有角色的区分(可认为都是主播),任何用户离开房间都会触发该通知。
|
|
479
479
|
|
|
480
480
|
|参数|描述|
|
|
481
481
|
|---------|---------|
|
|
@@ -520,9 +520,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
520
520
|
**某远端用户发布/取消了自己的音频。**
|
|
521
521
|
|
|
522
522
|
当您收到 `onUserAudioAvailable(userId, true)` 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
|
|
523
|
-
-
|
|
523
|
+
- 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
|
|
524
524
|
|
|
525
|
-
-
|
|
525
|
+
- 在手动订阅模式下,您可以通过 muteRemoteAudio(userid, false) 来播放该用户的声音。
|
|
526
526
|
|
|
527
527
|
|参数|描述|
|
|
528
528
|
|---------|---------|
|
|
@@ -539,9 +539,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
539
539
|
**SDK 开始渲染自己本地或远端用户的首帧画面。**
|
|
540
540
|
|
|
541
541
|
SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
|
|
542
|
-
-
|
|
542
|
+
- 如果 userId 为空值,代表 SDK 已经开始渲染自己本地的视频画面,不过前提是您已经调用了 startLocalPreview 或 startScreenCapture。
|
|
543
543
|
|
|
544
|
-
-
|
|
544
|
+
- 如果 userId 不为空,代表 SDK 已经开始渲染远端用户的视频画面,不过前提是您已经调用了 startRemoteView 订阅了该用户的视频画面。
|
|
545
545
|
|
|
546
546
|
|参数|描述|
|
|
547
547
|
|---------|---------|
|
|
@@ -641,11 +641,11 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
|
|
|
641
641
|
**音视频技术指标的实时统计回调。**
|
|
642
642
|
|
|
643
643
|
该统计回调每间隔2秒抛出一次,用于通知 SDK 内部音频、视频以及网络相关的专业技术指标,这些信息在 TRTCStatistics 均有罗列:
|
|
644
|
-
-
|
|
644
|
+
- 视频统计信息:视频的分辨率(resolution)、帧率(FPS)和比特率(bitrate)等信息。
|
|
645
645
|
|
|
646
|
-
-
|
|
646
|
+
- 音频统计信息:音频的采样率(samplerate)、声道(channel)和比特率(bitrate)等信息。
|
|
647
647
|
|
|
648
|
-
-
|
|
648
|
+
- 网络统计信息:SDK 和云端一次往返(SDK > Cloud > SDK)的网络耗时(rtt)、丢包率(loss)、上行流量(sentBytes)和下行流量(receivedBytes)等信息。
|
|
649
649
|
|
|
650
650
|
|参数|描述|
|
|
651
651
|
|---------|---------|
|
|
@@ -713,15 +713,15 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
|
|
|
713
713
|
**当前音频路由发生变化(仅适用于移动设备)。**
|
|
714
714
|
|
|
715
715
|
所谓“音频路由”,是指声音是从手机的扬声器还是从听筒中播放出来,音频路由变化也就是声音的播放位置发生了变化。
|
|
716
|
-
-
|
|
716
|
+
- 当音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
|
|
717
717
|
|
|
718
|
-
-
|
|
718
|
+
- 当音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
|
|
719
719
|
|
|
720
|
-
-
|
|
720
|
+
- 当音频路由为有线耳机。
|
|
721
721
|
|
|
722
|
-
-
|
|
722
|
+
- 当音频路由为蓝牙耳机。
|
|
723
723
|
|
|
724
|
-
-
|
|
724
|
+
- 当音频路由为USB专业声卡设备。
|
|
725
725
|
|
|
726
726
|
|参数|描述|
|
|
727
727
|
|---------|---------|
|
|
@@ -864,7 +864,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
864
864
|
| 参数 | 描述 |
|
|
865
865
|
| --- | --- |
|
|
866
866
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
867
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
867
|
+
| 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: 资源受限,建议延迟重试 |
|
|
868
868
|
| message | 具体回调信息。 |
|
|
869
869
|
| taskId | 当请求成功时,TRTC 后台会在回调中提供给您这项任务的 taskId,后续您可以通过该 taskId 结合 updatePublishMediaStream 和 stopPublishMediaStream 进行更新和停止。 |
|
|
870
870
|
|
|
@@ -876,7 +876,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
876
876
|
| 参数 | 描述 |
|
|
877
877
|
| --- | --- |
|
|
878
878
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
879
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
879
|
+
| 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 接口启动任务 |
|
|
880
880
|
| message | 具体回调信息。 |
|
|
881
881
|
| taskId | 您调用媒体流发布接口 (updatePublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次更新请求。 |
|
|
882
882
|
|
|
@@ -888,7 +888,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
888
888
|
| 参数 | 描述 |
|
|
889
889
|
| --- | --- |
|
|
890
890
|
| code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
891
|
-
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>-
|
|
891
|
+
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
|
|
892
892
|
| message | 具体回调信息。 |
|
|
893
893
|
| taskId | 您调用停止发布媒体流 (stopPublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次停止请求。 |
|
|
894
894
|
|
|
@@ -905,7 +905,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
905
905
|
| code | 推流结果,0 表示成功,其余值表示出错,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
|
|
906
906
|
| extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。 |
|
|
907
907
|
| message | 具体推流信息。 |
|
|
908
|
-
| status | 推流状态。<br>-
|
|
908
|
+
| 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。 |
|
|
909
909
|
|
|
910
910
|
## onScreenCaptureStarted
|
|
911
911
|
|
|
@@ -942,7 +942,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
942
942
|
当您调用 startLocalRecording 启动本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务是否已经顺利启动。
|
|
943
943
|
| 参数 | 描述 |
|
|
944
944
|
| --- | --- |
|
|
945
|
-
| errCode | 状态码。<br>-
|
|
945
|
+
| errCode | 状态码。<br>- 0:录制任务启动成功。<br>- -1:内部错误导致录制任务启动失败。<br>- -2:文件后缀名有误(例如不支持的录制格式)。<br>- -6:录制已经启动,需要先停止录制。<br>- -7:录制文件已存在,需要先删除文件。<br>- -8:录制目录无写入权限,请检查目录权限问题。 |
|
|
946
946
|
| storagePath | 录制文件存储路径。 |
|
|
947
947
|
|
|
948
948
|
## onLocalRecording
|
|
@@ -977,7 +977,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
977
977
|
当您调用 stopLocalRecording 停止本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务的最终结果。
|
|
978
978
|
| 参数 | 描述 |
|
|
979
979
|
| --- | --- |
|
|
980
|
-
| errCode | 状态码。<br>-
|
|
980
|
+
| errCode | 状态码。<br>- 0:结束录制任务成功。<br>- -1:录制失败。<br>- -2:切换分辨率或横竖屏导致录制结束。<br>- -3:录制时间太短,或未采集到任何视频或音频数据,请检查录制时长,或是否已开启音、视频采集。 |
|
|
981
981
|
| storagePath | 录制文件存储路径。 |
|
|
982
982
|
|
|
983
983
|
## onSnapshotComplete
|
|
@@ -8,16 +8,16 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
8
8
|
|
|
9
9
|
|函数列表|描述|
|
|
10
10
|
|---------|---------|
|
|
11
|
-
|onLoadProgress
|
|
12
|
-
|onLoadError
|
|
11
|
+
|onLoadProgress|背景音乐预加载进度。|
|
|
12
|
+
|onLoadError|背景音乐预加载出错。|
|
|
13
13
|
|
|
14
14
|
## TXMusicPlayObserver
|
|
15
15
|
|
|
16
16
|
|函数列表|描述|
|
|
17
17
|
|---------|---------|
|
|
18
|
-
|onStart
|
|
19
|
-
|onPlayProgress
|
|
20
|
-
|onComplete
|
|
18
|
+
|onStart|背景音乐开始播放。|
|
|
19
|
+
|onPlayProgress|背景音乐的播放进度。|
|
|
20
|
+
|onComplete|背景音乐已经播放完毕。|
|
|
21
21
|
|
|
22
22
|
## TXAudioEffectManager
|
|
23
23
|
|
|
@@ -52,22 +52,22 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
52
52
|
|
|
53
53
|
|函数列表|描述|
|
|
54
54
|
|---------|---------|
|
|
55
|
-
|AudioMusicParam
|
|
55
|
+
|AudioMusicParam|背景音乐的播放控制信息。|
|
|
56
56
|
|
|
57
57
|
## 枚举类型
|
|
58
58
|
|
|
59
59
|
|枚举类型|描述|
|
|
60
60
|
|---------|---------|
|
|
61
|
-
|TXVoiceReverbType
|
|
62
|
-
|TXVoiceChangerType
|
|
61
|
+
|TXVoiceReverbType|混响特效。|
|
|
62
|
+
|TXVoiceChangerType|变声特效。|
|
|
63
63
|
|
|
64
64
|
## onLoadProgress
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
**背景音乐预加载进度。**
|
|
67
67
|
|
|
68
68
|
## onLoadError
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
**背景音乐预加载出错。**
|
|
71
71
|
|
|
72
72
|
|参数|描述|
|
|
73
73
|
|---------|---------|
|
|
@@ -75,7 +75,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
75
75
|
|
|
76
76
|
## onStart
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
**背景音乐开始播放。**
|
|
79
79
|
|
|
80
80
|
在背景音乐开始播放成功或者失败时调用。
|
|
81
81
|
|
|
@@ -86,11 +86,11 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
86
86
|
|
|
87
87
|
## onPlayProgress
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
**背景音乐的播放进度。**
|
|
90
90
|
|
|
91
91
|
## onComplete
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
**背景音乐已经播放完毕。**
|
|
94
94
|
|
|
95
95
|
在背景音乐播放完毕或播放错误时调用。
|
|
96
96
|
|
|
@@ -274,9 +274,9 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
274
274
|
**设置所有背景音乐的本地音量和远端音量的大小。**
|
|
275
275
|
|
|
276
276
|
该接口可以设置所有背景音乐的本地音量和远端音量。
|
|
277
|
-
-
|
|
277
|
+
- 本地音量:即主播本地可以听到的背景音乐的音量大小。
|
|
278
278
|
|
|
279
|
-
-
|
|
279
|
+
- 远端音量:即观众端可以听到的背景音乐的音量大小。
|
|
280
280
|
|
|
281
281
|
|参数|描述|
|
|
282
282
|
|---------|---------|
|
|
@@ -444,7 +444,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
444
444
|
|
|
445
445
|
## TXVoiceReverbType
|
|
446
446
|
|
|
447
|
-
|
|
447
|
+
**混响特效。**
|
|
448
448
|
|
|
449
449
|
混响特效可以作用于人声之上,通过声学算法对声音进行叠加处理,模拟出各种不同环境下的临场感受,目前支持如下几种混响效果:
|
|
450
450
|
|
|
@@ -467,7 +467,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
467
467
|
|
|
468
468
|
## TXVoiceChangeType
|
|
469
469
|
|
|
470
|
-
|
|
470
|
+
**变声特效。**
|
|
471
471
|
|
|
472
472
|
变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色,目前支持如下几种变声特效:
|
|
473
473
|
|
|
@@ -492,7 +492,7 @@ Function: 用于对背景音乐、短音效和人声特效进行设置的管理
|
|
|
492
492
|
|
|
493
493
|
## TXAudioMusicParam
|
|
494
494
|
|
|
495
|
-
|
|
495
|
+
**背景音乐的播放控制信息。**
|
|
496
496
|
|
|
497
497
|
该信息用于在接口 [startPlayMusic 中指定背景音乐的相关信息,包括播放 ID、文件路径和循环次数等:
|
|
498
498
|
|
|
@@ -125,10 +125,10 @@ Function: 用于管理摄像头、麦克风和扬声器等音视频相关的硬
|
|
|
125
125
|
@deprecated v9.5 版本开始不推荐使用。
|
|
126
126
|
|
|
127
127
|
现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
|
|
128
|
-
-
|
|
128
|
+
- 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。
|
|
129
129
|
|
|
130
130
|
当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前处于通话音量。
|
|
131
|
-
-
|
|
131
|
+
- 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。
|
|
132
132
|
|
|
133
133
|
当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前处于媒体音量。
|
|
134
134
|
|
|
@@ -147,9 +147,9 @@ SDK 目前提供了三种系统音量类型的控制模式:自动切换模式
|
|
|
147
147
|
音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
|
|
148
148
|
|
|
149
149
|
手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
|
|
150
|
-
-
|
|
150
|
+
- 设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
|
|
151
151
|
|
|
152
|
-
-
|
|
152
|
+
- 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
|
|
153
153
|
|
|
154
154
|
|枚举|取值|描述|
|
|
155
155
|
|---------|---------|---------|
|
|
@@ -85,6 +85,7 @@ Function: 用于通知客户 TRTC 在使用过程中出现的警告和错误
|
|
|
85
85
|
| ERR_BGM_NO_AUDIO_STREAM | -4007 | 无音频流导致打开文件失败,请确认您传入的文件是否是合法的音频文件,以及文件是否被损坏 |
|
|
86
86
|
| ERR_BGM_FORMAT_NOT_SUPPORTED | -4008 | 格式不支持导致打开文件失败,请确认您传入的文件格式是否是支持的文件格式,移动端支持【mp3, aac, m4a, wav, ogg, mp4, mkv】,桌面端支持 【mp3, aac, m4a, wav, mp4, mkv】 |
|
|
87
87
|
| ERR_CONCURRENT_BGM_OVER_LIMIT | -4009 | 同时播放 bgm 数量超过限定值,如当前同时播放 bgm 数量超过 10 后提示该错误,请检查并发播放 bgm 数量 |
|
|
88
|
+
| ERR_BGM_SET_MUSIC_TRACK_FAILED | -4010 | 设置 BGM 音轨失败,请检查音频文件是否包含对应的音轨索引,或对应音轨的数据是否受损 |
|
|
88
89
|
|
|
89
90
|
## TXLiteAVWarning
|
|
90
91
|
|