tencentcloud-sdk-nodejs 4.0.411 → 4.0.412

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.
Files changed (64) hide show
  1. package/CHANGELOG.md +250 -0
  2. package/SERVICE_CHANGELOG.md +419 -22
  3. package/package.json +1 -1
  4. package/products.md +13 -13
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aa/v20200224/aa_client.ts +1 -42
  7. package/src/services/aa/v20200224/aa_models.ts +0 -624
  8. package/src/services/batch/v20170312/batch_models.ts +2 -2
  9. package/src/services/cbs/v20170312/cbs_models.ts +13 -13
  10. package/src/services/ckafka/v20190819/ckafka_client.ts +13 -1
  11. package/src/services/ckafka/v20190819/ckafka_models.ts +55 -10
  12. package/src/services/cvm/v20170312/cvm_client.ts +24 -11
  13. package/src/services/cvm/v20170312/cvm_models.ts +237 -192
  14. package/src/services/ess/v20201111/ess_models.ts +22 -14
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +45 -20
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +264 -113
  17. package/src/services/iai/v20180301/iai_models.ts +2 -2
  18. package/src/services/live/v20180801/live_client.ts +4 -2
  19. package/src/services/live/v20180801/live_models.ts +173 -87
  20. package/src/services/ocr/v20181119/ocr_client.ts +28 -12
  21. package/src/services/tag/v20180813/tag_client.ts +16 -3
  22. package/src/services/tag/v20180813/tag_models.ts +113 -43
  23. package/src/services/trtc/v20190722/trtc_client.ts +16 -91
  24. package/src/services/trtc/v20190722/trtc_models.ts +5 -357
  25. package/src/services/wedata/v20210820/wedata_client.ts +469 -16
  26. package/src/services/wedata/v20210820/wedata_models.ts +3015 -114
  27. package/tencentcloud/common/sdk_version.d.ts +1 -1
  28. package/tencentcloud/common/sdk_version.js +1 -1
  29. package/tencentcloud/services/aa/v20200224/aa_client.d.ts +1 -9
  30. package/tencentcloud/services/aa/v20200224/aa_client.js +0 -12
  31. package/tencentcloud/services/aa/v20200224/aa_models.d.ts +0 -529
  32. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  33. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +13 -13
  34. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  35. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  36. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +46 -8
  37. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +5 -1
  38. package/tencentcloud/services/cvm/v20170312/cvm_client.js +6 -0
  39. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +211 -172
  40. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +22 -14
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -5
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -6
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +229 -100
  44. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +2 -2
  45. package/tencentcloud/services/live/v20180801/live_client.d.ts +1 -1
  46. package/tencentcloud/services/live/v20180801/live_models.d.ts +148 -76
  47. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +16 -0
  48. package/tencentcloud/services/ocr/v20181119/ocr_client.js +16 -0
  49. package/tencentcloud/services/tag/v20180813/tag_client.d.ts +5 -1
  50. package/tencentcloud/services/tag/v20180813/tag_client.js +6 -0
  51. package/tencentcloud/services/tag/v20180813/tag_models.d.ts +95 -36
  52. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +10 -37
  53. package/tencentcloud/services/trtc/v20190722/trtc_client.js +10 -49
  54. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +5 -306
  55. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +147 -5
  56. package/tencentcloud/services/wedata/v20210820/wedata_client.js +218 -6
  57. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +2583 -125
  58. package/test/aa.v20200224.test.js +0 -20
  59. package/test/ckafka.v20190819.test.js +10 -0
  60. package/test/cvm.v20170312.test.js +10 -0
  61. package/test/essbasic.v20210526.test.js +24 -4
  62. package/test/tag.v20180813.test.js +10 -0
  63. package/test/trtc.v20190722.test.js +2 -62
  64. package/test/wedata.v20210820.test.js +354 -4
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribeAbnormalEventResponse, DescribeAbnormalEventRequest, CreatePictureRequest, DescribeHistoryScaleRequest, DescribeCallDetailRequest, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeDetailEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeRoomInformationRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, DescribeUserInformationRequest, ModifyPictureRequest, DescribeRoomInfoResponse, DescribeUserInfoResponse, ModifyPictureResponse, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeDetailEventRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DescribeUserInformationResponse, DescribeCallDetailResponse, DeletePictureRequest, DescribeRoomInformationResponse, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, DescribeUserEventResponse, CreatePictureResponse, RemoveUserResponse, DescribeHistoryScaleResponse } from "./trtc_models";
3
+ import { CreatePictureRequest, RemoveUserByStrRoomIdResponse, StartMCUMixTranscodeRequest, DescribeUserEventRequest, StartMCUMixTranscodeByStrRoomIdRequest, DescribeUserEventResponse, StopMCUMixTranscodeByStrRoomIdResponse, DescribeCallDetailInfoRequest, DescribeUserInfoRequest, DescribeRecordStatisticResponse, StartMCUMixTranscodeByStrRoomIdResponse, DismissRoomByStrRoomIdRequest, DescribeRecordStatisticRequest, DescribeRoomInfoRequest, DescribeCallDetailInfoResponse, ModifyPictureRequest, DescribeRoomInfoResponse, DescribeUserInfoResponse, ModifyPictureResponse, DescribeScaleInfoResponse, StopMCUMixTranscodeResponse, RemoveUserRequest, DismissRoomRequest, DescribeUnusualEventRequest, DescribeCloudRecordingRequest, StopMCUMixTranscodeRequest, CreateCloudRecordingRequest, DeleteCloudRecordingResponse, StopMCUMixTranscodeByStrRoomIdRequest, DeletePictureResponse, ModifyCloudRecordingRequest, CreateCloudRecordingResponse, StartMCUMixTranscodeResponse, DescribeTrtcMcuTranscodeTimeResponse, DeleteCloudRecordingRequest, DescribePictureRequest, DescribeExternalTrtcMeasureResponse, DescribePictureResponse, DescribeTrtcMcuTranscodeTimeRequest, DescribeScaleInfoRequest, DismissRoomByStrRoomIdResponse, DescribeUnusualEventResponse, ModifyCloudRecordingResponse, DescribeCloudRecordingResponse, DismissRoomResponse, DeletePictureRequest, DescribeExternalTrtcMeasureRequest, RemoveUserByStrRoomIdRequest, CreatePictureResponse, RemoveUserResponse } from "./trtc_models";
4
4
  /**
5
5
  * trtc client
6
6
  * @class
@@ -36,11 +36,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
36
36
  3、客户端混流和服务端混流不能混用。
37
37
  */
38
38
  StartMCUMixTranscode(req: StartMCUMixTranscodeRequest, cb?: (error: string, rep: StartMCUMixTranscodeResponse) => void): Promise<StartMCUMixTranscodeResponse>;
39
- /**
40
- * 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
41
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
42
- */
43
- DescribeRoomInformation(req: DescribeRoomInformationRequest, cb?: (error: string, rep: DescribeRoomInformationResponse) => void): Promise<DescribeRoomInformationResponse>;
44
39
  /**
45
40
  * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
46
41
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
@@ -50,10 +45,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
50
45
  * 接口说明:结束云端混流
51
46
  */
52
47
  StopMCUMixTranscode(req: StopMCUMixTranscodeRequest, cb?: (error: string, rep: StopMCUMixTranscodeResponse) => void): Promise<StopMCUMixTranscodeResponse>;
53
- /**
54
- * 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数
55
- */
56
- DescribeHistoryScale(req: DescribeHistoryScaleRequest, cb?: (error: string, rep: DescribeHistoryScaleResponse) => void): Promise<DescribeHistoryScaleResponse>;
57
48
  /**
58
49
  * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
59
50
  */
@@ -67,31 +58,26 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
67
58
  */
68
59
  RemoveUser(req: RemoveUserRequest, cb?: (error: string, rep: RemoveUserResponse) => void): Promise<RemoveUserResponse>;
69
60
  /**
70
- * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
71
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
61
+ * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
72
62
  */
73
- DescribeCallDetail(req: DescribeCallDetailRequest, cb?: (error: string, rep: DescribeCallDetailResponse) => void): Promise<DescribeCallDetailResponse>;
63
+ ModifyCloudRecording(req: ModifyCloudRecordingRequest, cb?: (error: string, rep: ModifyCloudRecordingResponse) => void): Promise<ModifyCloudRecordingResponse>;
74
64
  /**
75
65
  * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
76
66
  */
77
67
  DescribeUserEvent(req: DescribeUserEventRequest, cb?: (error: string, rep: DescribeUserEventResponse) => void): Promise<DescribeUserEventResponse>;
78
68
  /**
79
- * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
80
- */
81
- ModifyCloudRecording(req: ModifyCloudRecordingRequest, cb?: (error: string, rep: ModifyCloudRecordingResponse) => void): Promise<ModifyCloudRecordingResponse>;
82
- /**
83
- * ###接口说明:
69
+ * 接口说明:
84
70
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
85
71
 
86
- ###您可以通过此接口实现如下目标:
72
+ 您可以通过此接口实现如下目标:
87
73
  * 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
88
74
  * 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储
89
75
  * 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
90
76
  * 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
91
77
 
92
- ###关键名词:
93
- * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。
94
- * 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。
78
+ 关键名词:
79
+ * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件上传至云点播存储。
80
+ * 合流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件上传至云点播存储。
95
81
  */
96
82
  CreateCloudRecording(req: CreateCloudRecordingRequest, cb?: (error: string, rep: CreateCloudRecordingResponse) => void): Promise<CreateCloudRecordingResponse>;
97
83
  /**
@@ -119,11 +105,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
119
105
  * 接口说明:结束云端混流
120
106
  */
121
107
  StopMCUMixTranscodeByStrRoomId(req: StopMCUMixTranscodeByStrRoomIdRequest, cb?: (error: string, rep: StopMCUMixTranscodeByStrRoomIdResponse) => void): Promise<StopMCUMixTranscodeByStrRoomIdResponse>;
122
- /**
123
- * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。
124
- 异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
125
- */
126
- DescribeAbnormalEvent(req: DescribeAbnormalEventRequest, cb?: (error: string, rep: DescribeAbnormalEventResponse) => void): Promise<DescribeAbnormalEventResponse>;
127
108
  /**
128
109
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
129
110
 
@@ -175,28 +156,20 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
175
156
  DescribeTrtcMcuTranscodeTime(req: DescribeTrtcMcuTranscodeTimeRequest, cb?: (error: string, rep: DescribeTrtcMcuTranscodeTimeResponse) => void): Promise<DescribeTrtcMcuTranscodeTimeResponse>;
176
157
  /**
177
158
  * 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
159
+ 录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
178
160
  */
179
161
  DescribeCloudRecording(req: DescribeCloudRecordingRequest, cb?: (error: string, rep: DescribeCloudRecordingResponse) => void): Promise<DescribeCloudRecordingResponse>;
180
162
  /**
181
- * 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
163
+ * 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
182
164
  */
183
165
  DeleteCloudRecording(req: DeleteCloudRecordingRequest, cb?: (error: string, rep: DeleteCloudRecordingResponse) => void): Promise<DeleteCloudRecordingResponse>;
184
166
  /**
185
167
  * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
186
168
  */
187
169
  DescribePicture(req: DescribePictureRequest, cb?: (error: string, rep: DescribePictureResponse) => void): Promise<DescribePictureResponse>;
188
- /**
189
- * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
190
- */
191
- DescribeDetailEvent(req: DescribeDetailEventRequest, cb?: (error: string, rep: DescribeDetailEventResponse) => void): Promise<DescribeDetailEventResponse>;
192
170
  /**
193
171
  * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
194
172
  异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
195
173
  */
196
174
  DescribeUnusualEvent(req: DescribeUnusualEventRequest, cb?: (error: string, rep: DescribeUnusualEventResponse) => void): Promise<DescribeUnusualEventResponse>;
197
- /**
198
- * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
199
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
200
- */
201
- DescribeUserInformation(req: DescribeUserInformationRequest, cb?: (error: string, rep: DescribeUserInformationResponse) => void): Promise<DescribeUserInformationResponse>;
202
175
  }
@@ -60,13 +60,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
60
60
  async StartMCUMixTranscode(req, cb) {
61
61
  return this.request("StartMCUMixTranscode", req, cb);
62
62
  }
63
- /**
64
- * 查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
65
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
66
- */
67
- async DescribeRoomInformation(req, cb) {
68
- return this.request("DescribeRoomInformation", req, cb);
69
- }
70
63
  /**
71
64
  * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
72
65
  **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
@@ -80,12 +73,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
80
73
  async StopMCUMixTranscode(req, cb) {
81
74
  return this.request("StopMCUMixTranscode", req, cb);
82
75
  }
83
- /**
84
- * 可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数
85
- */
86
- async DescribeHistoryScale(req, cb) {
87
- return this.request("DescribeHistoryScale", req, cb);
88
- }
89
76
  /**
90
77
  * 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
91
78
  */
@@ -105,11 +92,10 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
105
92
  return this.request("RemoveUser", req, cb);
106
93
  }
107
94
  /**
108
- * 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。
109
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
95
+ * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
110
96
  */
111
- async DescribeCallDetail(req, cb) {
112
- return this.request("DescribeCallDetail", req, cb);
97
+ async ModifyCloudRecording(req, cb) {
98
+ return this.request("ModifyCloudRecording", req, cb);
113
99
  }
114
100
  /**
115
101
  * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
@@ -118,24 +104,18 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
118
104
  return this.request("DescribeUserEvent", req, cb);
119
105
  }
120
106
  /**
121
- * 成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
122
- */
123
- async ModifyCloudRecording(req, cb) {
124
- return this.request("ModifyCloudRecording", req, cb);
125
- }
126
- /**
127
- * ###接口说明:
107
+ * 接口说明:
128
108
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制有或者多路视频画面混流一路。
129
109
 
130
- ###您可以通过此接口实现如下目标:
110
+ 您可以通过此接口实现如下目标:
131
111
  * 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
132
112
  * 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储
133
113
  * 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
134
114
  * 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
135
115
 
136
- ###关键名词:
137
- * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件(M3U8/TS)上传至云存储。
138
- * 混流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件(M3U8/TS)上传至云存储。
116
+ 关键名词:
117
+ * 单流录制:分别录制房间的订阅UserId的音频和视频。录制服务会实时将录制文件上传至云点播存储。
118
+ * 合流录制:将房间内订阅UserId的音视频混录成一个音视频文件,并将录制文件上传至云点播存储。
139
119
  */
140
120
  async CreateCloudRecording(req, cb) {
141
121
  return this.request("CreateCloudRecording", req, cb);
@@ -177,13 +157,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
177
157
  async StopMCUMixTranscodeByStrRoomId(req, cb) {
178
158
  return this.request("StopMCUMixTranscodeByStrRoomId", req, cb);
179
159
  }
180
- /**
181
- * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。
182
- 异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
183
- */
184
- async DescribeAbnormalEvent(req, cb) {
185
- return this.request("DescribeAbnormalEvent", req, cb);
186
- }
187
160
  /**
188
161
  * 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
189
162
 
@@ -245,12 +218,13 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
245
218
  }
246
219
  /**
247
220
  * 成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
221
+ 录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
248
222
  */
249
223
  async DescribeCloudRecording(req, cb) {
250
224
  return this.request("DescribeCloudRecording", req, cb);
251
225
  }
252
226
  /**
253
- * 成功开启录制后,可以使用此接口来停止录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
227
+ * 成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
254
228
  */
255
229
  async DeleteCloudRecording(req, cb) {
256
230
  return this.request("DeleteCloudRecording", req, cb);
@@ -261,12 +235,6 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
261
235
  async DescribePicture(req, cb) {
262
236
  return this.request("DescribePicture", req, cb);
263
237
  }
264
- /**
265
- * 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。
266
- */
267
- async DescribeDetailEvent(req, cb) {
268
- return this.request("DescribeDetailEvent", req, cb);
269
- }
270
238
  /**
271
239
  * 查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
272
240
  异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
@@ -274,12 +242,5 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
274
242
  async DescribeUnusualEvent(req, cb) {
275
243
  return this.request("DescribeUnusualEvent", req, cb);
276
244
  }
277
- /**
278
- * 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。
279
- **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
280
- */
281
- async DescribeUserInformation(req, cb) {
282
- return this.request("DescribeUserInformation", req, cb);
283
- }
284
245
  }
285
246
  exports.Client = Client;
@@ -1,42 +1,3 @@
1
- /**
2
- * DescribeAbnormalEvent返回参数结构体
3
- */
4
- export interface DescribeAbnormalEventResponse {
5
- /**
6
- * 返回的数据总条数
7
- */
8
- Total: number;
9
- /**
10
- * 异常体验列表
11
- */
12
- AbnormalExperienceList: Array<AbnormalExperience>;
13
- /**
14
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15
- */
16
- RequestId?: string;
17
- }
18
- /**
19
- * DescribeAbnormalEvent请求参数结构体
20
- */
21
- export interface DescribeAbnormalEventRequest {
22
- /**
23
- * 用户SdkAppId(如:1400xxxxxx)
24
- */
25
- SdkAppId: string;
26
- /**
27
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
28
- 注意:支持查询14天内的数据
29
- */
30
- StartTime: number;
31
- /**
32
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。
33
- */
34
- EndTime: number;
35
- /**
36
- * 房间号,查询房间内任意20条以内异常体验事件
37
- */
38
- RoomId?: string;
39
- }
40
1
  /**
41
2
  * CreatePicture请求参数结构体
42
3
  */
@@ -123,81 +84,6 @@ export interface MixLayout {
123
84
  */
124
85
  SubBackgroundImage?: string;
125
86
  }
126
- /**
127
- * DescribeHistoryScale请求参数结构体
128
- */
129
- export interface DescribeHistoryScaleRequest {
130
- /**
131
- * 用户SdkAppId(如:1400xxxxxx)
132
- */
133
- SdkAppId: string;
134
- /**
135
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
136
- 注意:支持查询14天内的数据。
137
- */
138
- StartTime: number;
139
- /**
140
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
141
- 注意:按天统计,结束时间小于前一天,否则查询数据为空(如:需查询20号数据,结束时间需小于20号0点)。
142
- */
143
- EndTime: number;
144
- }
145
- /**
146
- * DescribeCallDetail请求参数结构体
147
- */
148
- export interface DescribeCallDetailRequest {
149
- /**
150
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
151
- */
152
- CommId: string;
153
- /**
154
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777),
155
- 注意:支持查询14天内的数据。
156
- */
157
- StartTime: number;
158
- /**
159
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
160
- 注意:DataType 不为null ,与StartTime间隔时间不超过1小时;DataType 为null,与StartTime间隔时间不超过4小时。
161
- */
162
- EndTime: number;
163
- /**
164
- * 用户SdkAppId(如:1400xxxxxx)。
165
- */
166
- SdkAppId: string;
167
- /**
168
- * 需查询的用户数组,默认不填返回6个用户。
169
- */
170
- UserIds?: Array<string>;
171
- /**
172
- * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。
173
- appCpu:APP CPU使用率;
174
- sysCpu:系统 CPU使用率;
175
- aBit:上/下行音频码率;单位:bps
176
- aBlock:音频卡顿时长;单位:ms
177
- bigvBit:上/下行视频码率;单位:bps
178
- bigvCapFps:视频采集帧率;
179
- bigvEncFps:视频发送帧率;
180
- bigvDecFps:渲染帧率;
181
- bigvBlock:视频卡顿时长;单位:ms
182
- aLoss:上/下行音频丢包率;
183
- bigvLoss:上/下行视频丢包率;
184
- bigvWidth:上/下行分辨率宽;
185
- bigvHeight:上/下行分辨率高
186
- */
187
- DataType?: Array<string>;
188
- /**
189
- * 当前页数,默认为0,
190
- 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
191
- */
192
- PageNumber?: string;
193
- /**
194
- * 每页个数,默认为6,
195
- 范围:[1,100]
196
- 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6;
197
- DataType 为null,UserIds长度不超过100,PageSize最大不超过100。
198
- */
199
- PageSize?: string;
200
- }
201
87
  /**
202
88
  * RemoveUserByStrRoomId返回参数结构体
203
89
  */
@@ -321,9 +207,9 @@ export interface ScaleInfomation {
321
207
  RoomNumbers: number;
322
208
  }
323
209
  /**
324
- * DescribeDetailEvent返回参数结构体
210
+ * DescribeUserEvent返回参数结构体
325
211
  */
326
- export interface DescribeDetailEventResponse {
212
+ export interface DescribeUserEventResponse {
327
213
  /**
328
214
  * 返回的事件列表,若没有数据,会返回空数组。
329
215
  */
@@ -440,39 +326,6 @@ export interface MixTranscodeParams {
440
326
  */
441
327
  AudioParams?: AudioParams;
442
328
  }
443
- /**
444
- * DescribeRoomInformation请求参数结构体
445
- */
446
- export interface DescribeRoomInformationRequest {
447
- /**
448
- * 用户SdkAppId(如:1400xxxxxx)
449
- */
450
- SdkAppId: string;
451
- /**
452
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
453
- 注意:支持查询14天内的数据
454
- */
455
- StartTime: number;
456
- /**
457
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
458
- 注意:与StartTime间隔时间不超过24小时。
459
- */
460
- EndTime: number;
461
- /**
462
- * 房间号(如:223)
463
- */
464
- RoomId?: string;
465
- /**
466
- * 当前页数,默认为0,
467
- 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。
468
- */
469
- PageNumber?: string;
470
- /**
471
- * 每页个数,默认为10,
472
- 范围:[1,100]
473
- */
474
- PageSize?: string;
475
- }
476
329
  /**
477
330
  * DescribeUserInfo请求参数结构体
478
331
  */
@@ -803,44 +656,6 @@ export interface DescribeCallDetailInfoResponse {
803
656
  */
804
657
  RequestId?: string;
805
658
  }
806
- /**
807
- * DescribeUserInformation请求参数结构体
808
- */
809
- export interface DescribeUserInformationRequest {
810
- /**
811
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
812
- */
813
- CommId: string;
814
- /**
815
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
816
- 注意:支持查询14天内的数据
817
- */
818
- StartTime: number;
819
- /**
820
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
821
- 注意:与StartTime间隔时间不超过4小时。
822
- */
823
- EndTime: number;
824
- /**
825
- * 用户SdkAppId(如:1400xxxxxx)
826
- */
827
- SdkAppId: string;
828
- /**
829
- * 需查询的用户数组,不填默认返回6个用户
830
- 范围:[1,100]。
831
- */
832
- UserIds?: Array<string>;
833
- /**
834
- * 当前页数,默认为0,
835
- 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。
836
- */
837
- PageNumber?: string;
838
- /**
839
- * 每页个数,默认为6,
840
- 范围:[1,100]。
841
- */
842
- PageSize?: string;
843
- }
844
659
  /**
845
660
  * 实时音视频用量的某一时间段的统计信息.
846
661
  */
@@ -1412,11 +1227,11 @@ export interface CreateCloudRecordingRequest {
1412
1227
  */
1413
1228
  RoomId: string;
1414
1229
  /**
1415
- * 录制服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
1230
+ * 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC功能或者录制服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
1416
1231
  */
1417
1232
  UserId: string;
1418
1233
  /**
1419
- * 云端录制加入房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
1234
+ * 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
1420
1235
  */
1421
1236
  UserSig: string;
1422
1237
  /**
@@ -1424,7 +1239,7 @@ export interface CreateCloudRecordingRequest {
1424
1239
  */
1425
1240
  RecordParams: RecordParams;
1426
1241
  /**
1427
- * 云端录制文件上传到云存储的参数。
1242
+ * 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
1428
1243
  */
1429
1244
  StorageParams: StorageParams;
1430
1245
  /**
@@ -1716,33 +1531,6 @@ export interface DescribeTrtcMcuTranscodeTimeRequest {
1716
1531
  */
1717
1532
  SdkAppId?: number;
1718
1533
  }
1719
- /**
1720
- * DescribeDetailEvent请求参数结构体
1721
- */
1722
- export interface DescribeDetailEventRequest {
1723
- /**
1724
- * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。
1725
- */
1726
- CommId: string;
1727
- /**
1728
- * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
1729
- 注意:支持查询14天内的数据
1730
- */
1731
- StartTime: number;
1732
- /**
1733
- * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)
1734
- 注意:查询时间大于房间结束时间,以房间结束时间为准。
1735
- */
1736
- EndTime: number;
1737
- /**
1738
- * 用户UserId
1739
- */
1740
- UserId: string;
1741
- /**
1742
- * 房间号(如:223)
1743
- */
1744
- RoomId: string;
1745
- }
1746
1534
  /**
1747
1535
  * 用户信息,包括用户进房时间,退房时间等
1748
1536
  */
@@ -1887,47 +1675,6 @@ export interface DismissRoomResponse {
1887
1675
  */
1888
1676
  RequestId?: string;
1889
1677
  }
1890
- /**
1891
- * DescribeUserInformation返回参数结构体
1892
- */
1893
- export interface DescribeUserInformationResponse {
1894
- /**
1895
- * 返回的用户总条数
1896
- */
1897
- Total: number;
1898
- /**
1899
- * 用户信息列表
1900
- 注意:此字段可能返回 null,表示取不到有效值。
1901
- */
1902
- UserList: Array<UserInformation>;
1903
- /**
1904
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1905
- */
1906
- RequestId?: string;
1907
- }
1908
- /**
1909
- * DescribeCallDetail返回参数结构体
1910
- */
1911
- export interface DescribeCallDetailResponse {
1912
- /**
1913
- * 返回的用户总条数
1914
- */
1915
- Total: number;
1916
- /**
1917
- * 用户信息列表
1918
- 注意:此字段可能返回 null,表示取不到有效值。
1919
- */
1920
- UserList: Array<UserInformation>;
1921
- /**
1922
- * 质量数据
1923
- 注意:此字段可能返回 null,表示取不到有效值。
1924
- */
1925
- Data: Array<QualityData>;
1926
- /**
1927
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1928
- */
1929
- RequestId?: string;
1930
- }
1931
1678
  /**
1932
1679
  * DeletePicture请求参数结构体
1933
1680
  */
@@ -1941,23 +1688,6 @@ export interface DeletePictureRequest {
1941
1688
  */
1942
1689
  SdkAppId: number;
1943
1690
  }
1944
- /**
1945
- * DescribeRoomInformation返回参数结构体
1946
- */
1947
- export interface DescribeRoomInformationResponse {
1948
- /**
1949
- * 返回当页数据总数
1950
- */
1951
- Total: number;
1952
- /**
1953
- * 房间信息列表
1954
- */
1955
- RoomList: Array<RoomState>;
1956
- /**
1957
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1958
- */
1959
- RequestId?: string;
1960
- }
1961
1691
  /**
1962
1692
  * DescribeExternalTrtcMeasure请求参数结构体
1963
1693
  */
@@ -2022,19 +1752,6 @@ export interface RecordParams {
2022
1752
  */
2023
1753
  OutputFormat?: number;
2024
1754
  }
2025
- /**
2026
- * DescribeUserEvent返回参数结构体
2027
- */
2028
- export interface DescribeUserEventResponse {
2029
- /**
2030
- * 返回的事件列表,若没有数据,会返回空数组。
2031
- */
2032
- Data: Array<EventList>;
2033
- /**
2034
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2035
- */
2036
- RequestId?: string;
2037
- }
2038
1755
  /**
2039
1756
  * SdkAppId级别录制时长数据。
2040
1757
  */
@@ -2204,21 +1921,3 @@ export interface RemoveUserResponse {
2204
1921
  */
2205
1922
  RequestId?: string;
2206
1923
  }
2207
- /**
2208
- * DescribeHistoryScale返回参数结构体
2209
- */
2210
- export interface DescribeHistoryScaleResponse {
2211
- /**
2212
- * 返回的数据条数
2213
- */
2214
- Total: number;
2215
- /**
2216
- * 返回的数据
2217
- 注意:此字段可能返回 null,表示取不到有效值。
2218
- */
2219
- ScaleList: Array<ScaleInfomation>;
2220
- /**
2221
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2222
- */
2223
- RequestId?: string;
2224
- }