tencentcloud-sdk-nodejs 4.0.534 → 4.0.536

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 (100) hide show
  1. package/CHANGELOG.md +409 -0
  2. package/SERVICE_CHANGELOG.md +468 -251
  3. package/package.json +1 -1
  4. package/products.md +32 -32
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +15 -0
  7. package/src/services/asr/v20190614/asr_models.ts +14 -2
  8. package/src/services/cbs/v20170312/cbs_models.ts +9 -4
  9. package/src/services/ccc/v20200210/ccc_client.ts +46 -9
  10. package/src/services/ccc/v20200210/ccc_models.ts +138 -17
  11. package/src/services/cdb/v20170320/cdb_models.ts +1 -1
  12. package/src/services/cdn/v20180606/cdn_models.ts +2 -0
  13. package/src/services/clb/v20180317/clb_models.ts +2 -2
  14. package/src/services/cls/v20201016/cls_models.ts +1 -1
  15. package/src/services/cme/v20191029/cme_models.ts +6 -4
  16. package/src/services/cvm/v20170312/cvm_models.ts +2 -2
  17. package/src/services/dlc/v20210125/dlc_client.ts +204 -52
  18. package/src/services/dlc/v20210125/dlc_models.ts +1109 -70
  19. package/src/services/dts/v20211206/dts_models.ts +23 -5
  20. package/src/services/ess/v20201111/ess_client.ts +1 -1
  21. package/src/services/ess/v20201111/ess_models.ts +1 -1
  22. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  23. package/src/services/essbasic/v20210526/essbasic_models.ts +1 -1
  24. package/src/services/iai/v20180301/iai_client.ts +12 -4
  25. package/src/services/iai/v20200303/iai_client.ts +13 -5
  26. package/src/services/lcic/v20220817/lcic_client.ts +198 -72
  27. package/src/services/lcic/v20220817/lcic_models.ts +856 -120
  28. package/src/services/live/v20180801/live_client.ts +1 -1
  29. package/src/services/live/v20180801/live_models.ts +1 -1
  30. package/src/services/rum/v20210622/rum_client.ts +36 -0
  31. package/src/services/rum/v20210622/rum_models.ts +105 -0
  32. package/src/services/sqlserver/v20180328/sqlserver_client.ts +3 -2
  33. package/src/services/sqlserver/v20180328/sqlserver_models.ts +105 -54
  34. package/src/services/tdmq/v20200217/tdmq_models.ts +22 -10
  35. package/src/services/teo/v20220901/teo_client.ts +551 -488
  36. package/src/services/teo/v20220901/teo_models.ts +450 -113
  37. package/src/services/tse/v20201207/tse_models.ts +25 -6
  38. package/src/services/tsf/v20180326/tsf_client.ts +13 -1
  39. package/src/services/tsf/v20180326/tsf_models.ts +70 -20
  40. package/src/services/tts/v20190823/tts_models.ts +1 -1
  41. package/src/services/vod/v20180717/vod_models.ts +3 -2
  42. package/src/services/vpc/v20170312/vpc_client.ts +6 -7
  43. package/src/services/vpc/v20170312/vpc_models.ts +24 -18
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +12 -0
  47. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +12 -2
  48. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +8 -4
  49. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +15 -3
  50. package/tencentcloud/services/ccc/v20200210/ccc_client.js +21 -3
  51. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +119 -15
  52. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
  53. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +2 -0
  54. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +2 -2
  55. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  56. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +4 -2
  57. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +2 -2
  58. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +64 -16
  59. package/tencentcloud/services/dlc/v20210125/dlc_client.js +94 -22
  60. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +953 -75
  61. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +21 -5
  62. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +1 -1
  63. package/tencentcloud/services/ess/v20201111/ess_client.js +1 -1
  64. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +1 -1
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  67. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  68. package/tencentcloud/services/iai/v20180301/iai_client.d.ts +12 -4
  69. package/tencentcloud/services/iai/v20180301/iai_client.js +12 -4
  70. package/tencentcloud/services/iai/v20200303/iai_client.d.ts +12 -4
  71. package/tencentcloud/services/iai/v20200303/iai_client.js +12 -4
  72. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +65 -25
  73. package/tencentcloud/services/lcic/v20220817/lcic_client.js +96 -36
  74. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +727 -101
  75. package/tencentcloud/services/live/v20180801/live_client.d.ts +1 -1
  76. package/tencentcloud/services/live/v20180801/live_client.js +1 -1
  77. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -1
  78. package/tencentcloud/services/rum/v20210622/rum_client.d.ts +13 -1
  79. package/tencentcloud/services/rum/v20210622/rum_client.js +18 -0
  80. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +90 -0
  81. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +90 -48
  82. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +20 -10
  83. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +183 -163
  84. package/tencentcloud/services/teo/v20220901/teo_client.js +273 -243
  85. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +390 -99
  86. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +21 -4
  87. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +5 -1
  88. package/tencentcloud/services/tsf/v20180326/tsf_client.js +6 -0
  89. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +60 -17
  90. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +1 -1
  91. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +3 -2
  92. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -3
  93. package/tencentcloud/services/vpc/v20170312/vpc_client.js +2 -3
  94. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +23 -18
  95. package/test/ccc.v20200210.test.js +32 -2
  96. package/test/dlc.v20210125.test.js +134 -14
  97. package/test/lcic.v20220817.test.js +124 -24
  98. package/test/rum.v20210622.test.js +30 -0
  99. package/test/teo.v20220901.test.js +212 -162
  100. package/test/tsf.v20180326.test.js +10 -0
@@ -68,6 +68,19 @@ coteaching 双师
68
68
  */
69
69
  RecordLayout?: number;
70
70
  }
71
+ /**
72
+ * BatchCreateRoom返回参数结构体
73
+ */
74
+ export interface BatchCreateRoomResponse {
75
+ /**
76
+ * 创建成功课堂ID,与传入课堂信息顺序一致
77
+ */
78
+ RoomIds?: Array<number>;
79
+ /**
80
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
81
+ */
82
+ RequestId?: string;
83
+ }
71
84
  /**
72
85
  * SetAppCustomContent请求参数结构体
73
86
  */
@@ -81,6 +94,95 @@ export interface SetAppCustomContentRequest {
81
94
  */
82
95
  SdkAppId: number;
83
96
  }
97
+ /**
98
+ * 批量创建房间的房间信息
99
+ */
100
+ export interface RoomInfo {
101
+ /**
102
+ * 房间名称。
103
+ 注意:此字段可能返回 null,表示取不到有效值。
104
+ */
105
+ Name: string;
106
+ /**
107
+ * 预定的房间开始时间,unix时间戳。
108
+ 注意:此字段可能返回 null,表示取不到有效值。
109
+ */
110
+ StartTime: number;
111
+ /**
112
+ * 预定的房间结束时间,unix时间戳。
113
+ 注意:此字段可能返回 null,表示取不到有效值。
114
+ */
115
+ EndTime: number;
116
+ /**
117
+ * 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
118
+ 注意:此字段可能返回 null,表示取不到有效值。
119
+ */
120
+ Resolution: number;
121
+ /**
122
+ * 最大连麦人数(不包括老师)。取值范围[0, 16]
123
+ 注意:此字段可能返回 null,表示取不到有效值。
124
+ */
125
+ MaxMicNumber: number;
126
+ /**
127
+ * 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频 coteaching 双师
128
+ 注意:此字段可能返回 null,表示取不到有效值。
129
+ */
130
+ SubType: string;
131
+ /**
132
+ * 老师ID。通过[注册用户]接口获取的UserId。
133
+ 注意:此字段可能返回 null,表示取不到有效值。
134
+ */
135
+ TeacherId?: string;
136
+ /**
137
+ * 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
138
+ 注意:此字段可能返回 null,表示取不到有效值。
139
+ */
140
+ AutoMic?: number;
141
+ /**
142
+ * 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
143
+ 注意:此字段可能返回 null,表示取不到有效值。
144
+ */
145
+ TurnOffMic?: number;
146
+ /**
147
+ * 高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质
148
+ 注意:此字段可能返回 null,表示取不到有效值。
149
+ */
150
+ AudioQuality?: number;
151
+ /**
152
+ * 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
153
+ 注意:此字段可能返回 null,表示取不到有效值。
154
+ */
155
+ DisableRecord?: number;
156
+ /**
157
+ * 助教Id列表。通过[注册用户]接口获取的UserId。
158
+ 注意:此字段可能返回 null,表示取不到有效值。
159
+ */
160
+ Assistants?: Array<string>;
161
+ /**
162
+ * rtc人数。
163
+ 注意:此字段可能返回 null,表示取不到有效值。
164
+ */
165
+ RTCAudienceNumber?: number;
166
+ /**
167
+ * 观看类型。
168
+ 注意:此字段可能返回 null,表示取不到有效值。
169
+ */
170
+ AudienceType?: number;
171
+ /**
172
+ * 录制布局。
173
+ 注意:此字段可能返回 null,表示取不到有效值。
174
+ */
175
+ RecordLayout?: number;
176
+ }
177
+ /**
178
+ * SetWatermark返回参数结构体
179
+ */
180
+ export interface SetWatermarkResponse {
181
+ /**
182
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
183
+ */
184
+ RequestId?: string;
185
+ }
84
186
  /**
85
187
  * ModifyRoom返回参数结构体
86
188
  */
@@ -108,6 +210,81 @@ export interface DescribeUserRequest {
108
210
  */
109
211
  UserId: string;
110
212
  }
213
+ /**
214
+ * ModifyRoom请求参数结构体
215
+ */
216
+ export interface ModifyRoomRequest {
217
+ /**
218
+ * 房间ID。
219
+ */
220
+ RoomId: number;
221
+ /**
222
+ * 低代码互动课堂的SdkAppId
223
+ */
224
+ SdkAppId: number;
225
+ /**
226
+ * 预定的房间开始时间,unix时间戳。直播开始后不允许修改。
227
+ */
228
+ StartTime?: number;
229
+ /**
230
+ * 预定的房间结束时间,unix时间戳。直播开始后不允许修改。
231
+ */
232
+ EndTime?: number;
233
+ /**
234
+ * 老师ID。直播开始后不允许修改。
235
+ */
236
+ TeacherId?: string;
237
+ /**
238
+ * 房间名称。
239
+ */
240
+ Name?: string;
241
+ /**
242
+ * 分辨率。可以有如下取值:
243
+ 1 标清
244
+ 2 高清
245
+ 3 全高清
246
+ 直播开始后不允许修改。
247
+ */
248
+ Resolution?: number;
249
+ /**
250
+ * 最大连麦人数(不包括老师)。取值范围[0, 17)
251
+ 直播开始后不允许修改。
252
+ */
253
+ MaxMicNumber?: number;
254
+ /**
255
+ * 进入房间时是否自动连麦。可以有以下取值:
256
+ 0 不自动连麦(默认值)
257
+ 1 自动连麦
258
+ 直播开始后不允许修改。
259
+ */
260
+ AutoMic?: number;
261
+ /**
262
+ * 高音质模式。可以有以下取值:
263
+ 0 不开启高音质(默认值)
264
+ 1 开启高音质
265
+ 直播开始后不允许修改。
266
+ */
267
+ AudioQuality?: number;
268
+ /**
269
+ * 房间子类型,可以有以下取值:
270
+ videodoc 文档+视频
271
+ video 纯视频
272
+ coteaching 双师
273
+ 直播开始后不允许修改。
274
+ */
275
+ SubType?: string;
276
+ /**
277
+ * 禁止录制。可以有以下取值:
278
+ 0 不禁止录制(默认值)
279
+ 1 禁止录制
280
+ 直播开始后不允许修改。
281
+ */
282
+ DisableRecord?: number;
283
+ /**
284
+ * 助教Id列表。直播开始后不允许修改。
285
+ */
286
+ Assistants?: Array<string>;
287
+ }
111
288
  /**
112
289
  * CreateDocument返回参数结构体
113
290
  */
@@ -122,21 +299,25 @@ export interface CreateDocumentResponse {
122
299
  RequestId?: string;
123
300
  }
124
301
  /**
125
- * DescribeRoomStatistics请求参数结构体
302
+ * DescribeAppDetail返回参数结构体
126
303
  */
127
- export interface DescribeRoomStatisticsRequest {
304
+ export interface DescribeAppDetailResponse {
128
305
  /**
129
- * 房间Id。
306
+ * SDK 对应的AppId
130
307
  */
131
- RoomId: number;
308
+ SdkAppId?: string;
132
309
  /**
133
- * 分页查询当前页数,从1开始递增。
310
+ * 应用配置
134
311
  */
135
- Page: number;
312
+ AppConfig?: AppConfig;
136
313
  /**
137
- * 每页数据量,最大1000。
314
+ * 场景配置
138
315
  */
139
- Limit: number;
316
+ SceneConfig?: Array<SceneItem>;
317
+ /**
318
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
319
+ */
320
+ RequestId?: string;
140
321
  }
141
322
  /**
142
323
  * BindDocumentToRoom请求参数结构体
@@ -199,79 +380,22 @@ export interface CreateDocumentRequest {
199
380
  DocumentSize?: number;
200
381
  }
201
382
  /**
202
- * ModifyRoom请求参数结构体
383
+ * DescribeDocumentsByRoom返回参数结构体
203
384
  */
204
- export interface ModifyRoomRequest {
205
- /**
206
- * 房间ID。
207
- */
208
- RoomId: number;
209
- /**
210
- * 低代码互动课堂的SdkAppId
211
- */
212
- SdkAppId: number;
213
- /**
214
- * 预定的房间开始时间,unix时间戳。直播开始后不允许修改。
215
- */
216
- StartTime?: number;
217
- /**
218
- * 预定的房间结束时间,unix时间戳。直播开始后不允许修改。
219
- */
220
- EndTime?: number;
221
- /**
222
- * 老师ID。直播开始后不允许修改。
223
- */
224
- TeacherId?: string;
225
- /**
226
- * 房间名称。
227
- */
228
- Name?: string;
229
- /**
230
- * 分辨率。可以有如下取值:
231
- 1 标清
232
- 2 高清
233
- 3 全高清
234
- 直播开始后不允许修改。
235
- */
236
- Resolution?: number;
237
- /**
238
- * 最大连麦人数(不包括老师)。取值范围[0, 17)
239
- 直播开始后不允许修改。
240
- */
241
- MaxMicNumber?: number;
242
- /**
243
- * 进入房间时是否自动连麦。可以有以下取值:
244
- 0 不自动连麦(默认值)
245
- 1 自动连麦
246
- 直播开始后不允许修改。
247
- */
248
- AutoMic?: number;
249
- /**
250
- * 高音质模式。可以有以下取值:
251
- 0 不开启高音质(默认值)
252
- 1 开启高音质
253
- 直播开始后不允许修改。
254
- */
255
- AudioQuality?: number;
385
+ export interface DescribeDocumentsByRoomResponse {
256
386
  /**
257
- * 房间子类型,可以有以下取值:
258
- videodoc 文档+视频
259
- video 纯视频
260
- coteaching 双师
261
- 直播开始后不允许修改。
387
+ * 文档信息列表
388
+ 注意:此字段可能返回 null,表示取不到有效值。
262
389
  */
263
- SubType?: string;
390
+ Documents?: Array<DocumentInfo>;
264
391
  /**
265
- * 禁止录制。可以有以下取值:
266
- 0 不禁止录制(默认值)
267
- 1 禁止录制
268
- 直播开始后不允许修改。
392
+ * 符合查询条件文档总数
269
393
  */
270
- DisableRecord?: number;
394
+ Total?: number;
271
395
  /**
272
- * 助教Id列表。直播开始后不允许修改。
396
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
273
397
  */
274
- Assistants?: Array<string>;
398
+ RequestId?: string;
275
399
  }
276
400
  /**
277
401
  * 批量注册用户信息
@@ -348,6 +472,19 @@ export interface BatchUserRequest {
348
472
  */
349
473
  Avatar?: string;
350
474
  }
475
+ /**
476
+ * BatchDeleteRecord请求参数结构体
477
+ */
478
+ export interface BatchDeleteRecordRequest {
479
+ /**
480
+ * 房间ID列表
481
+ */
482
+ RoomIds: Array<number>;
483
+ /**
484
+ * 低代码互动课堂的SdkAppId。
485
+ */
486
+ SdkAppId: number;
487
+ }
351
488
  /**
352
489
  * LoginUser返回参数结构体
353
490
  */
@@ -483,9 +620,130 @@ export interface DeleteRoomResponse {
483
620
  RequestId?: string;
484
621
  }
485
622
  /**
486
- * 应用自定义内容
623
+ * ModifyUserProfile请求参数结构体
487
624
  */
488
- export interface AppCustomContent {
625
+ export interface ModifyUserProfileRequest {
626
+ /**
627
+ * 待修改用户ID
628
+ */
629
+ UserId: string;
630
+ /**
631
+ * 待修改的用户名
632
+ */
633
+ Nickname?: string;
634
+ /**
635
+ * 待修改头像url
636
+ */
637
+ Avatar?: string;
638
+ }
639
+ /**
640
+ * DescribeDocumentsByRoom请求参数结构体
641
+ */
642
+ export interface DescribeDocumentsByRoomRequest {
643
+ /**
644
+ * 房间ID。
645
+ */
646
+ RoomId: number;
647
+ /**
648
+ * 低代码互动课堂的SdkAppId
649
+ */
650
+ SdkAppId: number;
651
+ /**
652
+ * 分页查询当前页数,从1开始递增,默认值为1
653
+ */
654
+ Page?: number;
655
+ /**
656
+ * 每页数据量,最大1000,默认值为100
657
+ */
658
+ Limit?: number;
659
+ /**
660
+ * 课件权限。
661
+ [0]:获取owner的私有课件;
662
+ [1]:获取owner的公开课件;
663
+ [0,1]:则获取owner的私有课件和公开课件;
664
+ [2]:获取owner的私有课件和所有人(包括owner)的公开课件。
665
+ 默认值为[2]
666
+ */
667
+ Permission?: Array<number>;
668
+ /**
669
+ * 文档所有者的user_id,不填默认获取SdkAppId下所有课件
670
+ */
671
+ Owner?: string;
672
+ }
673
+ /**
674
+ * DescribeSdkAppIdUsers返回参数结构体
675
+ */
676
+ export interface DescribeSdkAppIdUsersResponse {
677
+ /**
678
+ * 用户总数
679
+ */
680
+ Total?: number;
681
+ /**
682
+ * 当前获取用户信息数组列表
683
+ 注意:此字段可能返回 null,表示取不到有效值。
684
+ */
685
+ Users?: Array<UserInfo>;
686
+ /**
687
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
688
+ */
689
+ RequestId?: string;
690
+ }
691
+ /**
692
+ * GetWatermark返回参数结构体
693
+ */
694
+ export interface GetWatermarkResponse {
695
+ /**
696
+ * 老师视频区域的水印参数配置
697
+ 注意:此字段可能返回 null,表示取不到有效值。
698
+ */
699
+ TeacherLogo?: WatermarkConfig;
700
+ /**
701
+ * 白板区域的水印参数配置
702
+ 注意:此字段可能返回 null,表示取不到有效值。
703
+ */
704
+ BoardLogo?: WatermarkConfig;
705
+ /**
706
+ * 背景图片配置
707
+ 注意:此字段可能返回 null,表示取不到有效值。
708
+ */
709
+ BackgroundPicture?: BackgroundPictureConfig;
710
+ /**
711
+ * 文字水印配置
712
+ 注意:此字段可能返回 null,表示取不到有效值。
713
+ */
714
+ Text?: TextMarkConfig;
715
+ /**
716
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
717
+ */
718
+ RequestId?: string;
719
+ }
720
+ /**
721
+ * DeleteDocument返回参数结构体
722
+ */
723
+ export interface DeleteDocumentResponse {
724
+ /**
725
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
726
+ */
727
+ RequestId?: string;
728
+ }
729
+ /**
730
+ * DeleteRecord请求参数结构体
731
+ */
732
+ export interface DeleteRecordRequest {
733
+ /**
734
+ * 房间Id。
735
+ */
736
+ RoomId: number;
737
+ /**
738
+ * 低代码互动课堂的SdkAppId。
739
+
740
+ */
741
+ SdkAppId: number;
742
+ }
743
+ /**
744
+ * 应用自定义内容
745
+ */
746
+ export interface AppCustomContent {
489
747
  /**
490
748
  * 场景参数,一个应用下可以设置多个不同场景。
491
749
  */
@@ -532,6 +790,156 @@ export interface DescribeRoomStatisticsResponse {
532
790
  */
533
791
  RequestId?: string;
534
792
  }
793
+ /**
794
+ * DeleteDocument请求参数结构体
795
+ */
796
+ export interface DeleteDocumentRequest {
797
+ /**
798
+ * 文档ID。
799
+ */
800
+ DocumentId: string;
801
+ }
802
+ /**
803
+ * DescribeSdkAppIdUsers请求参数结构体
804
+ */
805
+ export interface DescribeSdkAppIdUsersRequest {
806
+ /**
807
+ * 应用ID
808
+ */
809
+ SdkAppId: number;
810
+ /**
811
+ * 分页,默认值为1
812
+ */
813
+ Page?: number;
814
+ /**
815
+ * 分页数据限制,默认值为20
816
+ */
817
+ Limit?: number;
818
+ }
819
+ /**
820
+ * DescribeUser返回参数结构体
821
+ */
822
+ export interface DescribeUserResponse {
823
+ /**
824
+ * 应用Id。
825
+ */
826
+ SdkAppId: number;
827
+ /**
828
+ * 用户Id。
829
+ */
830
+ UserId: string;
831
+ /**
832
+ * 用户昵称。
833
+ */
834
+ Name: string;
835
+ /**
836
+ * 用户头像Url。
837
+ */
838
+ Avatar: string;
839
+ /**
840
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
841
+ */
842
+ RequestId?: string;
843
+ }
844
+ /**
845
+ * DescribeDocument返回参数结构体
846
+ */
847
+ export interface DescribeDocumentResponse {
848
+ /**
849
+ * 文档Id
850
+ */
851
+ DocumentId: string;
852
+ /**
853
+ * 文档原址url
854
+ */
855
+ DocumentUrl: string;
856
+ /**
857
+ * 文档名称
858
+ */
859
+ DocumentName: string;
860
+ /**
861
+ * 文档所有者UserId
862
+ */
863
+ Owner: string;
864
+ /**
865
+ * 应用Id
866
+ */
867
+ SdkAppId: number;
868
+ /**
869
+ * 文档权限
870
+ */
871
+ Permission: number;
872
+ /**
873
+ * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
874
+ */
875
+ TranscodeResult: string;
876
+ /**
877
+ * 转码类型
878
+ */
879
+ TranscodeType: number;
880
+ /**
881
+ * 转码进度, 0 - 100 表示(0% - 100%)
882
+ */
883
+ TranscodeProgress: number;
884
+ /**
885
+ * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
886
+ */
887
+ TranscodeState: number;
888
+ /**
889
+ * 转码失败后的错误信息
890
+ */
891
+ TranscodeInfo: string;
892
+ /**
893
+ * 文档类型
894
+ */
895
+ DocumentType: string;
896
+ /**
897
+ * 文档大小,单位:字节
898
+ */
899
+ DocumentSize: number;
900
+ /**
901
+ * 更新的UNIX时间戳
902
+ */
903
+ UpdateTime: number;
904
+ /**
905
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
906
+ */
907
+ RequestId?: string;
908
+ }
909
+ /**
910
+ * ModifyUserProfile返回参数结构体
911
+ */
912
+ export interface ModifyUserProfileResponse {
913
+ /**
914
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
915
+ */
916
+ RequestId?: string;
917
+ }
918
+ /**
919
+ * 文字水印配置
920
+ */
921
+ export interface TextMarkConfig {
922
+ /**
923
+ * 文字水印内容
924
+ 注意:此字段可能返回 null,表示取不到有效值。
925
+ */
926
+ Text?: string;
927
+ /**
928
+ * 文字水印颜色
929
+ 注意:此字段可能返回 null,表示取不到有效值。
930
+ */
931
+ Color?: string;
932
+ }
933
+ /**
934
+ * GetWatermark请求参数结构体
935
+ */
936
+ export interface GetWatermarkRequest {
937
+ /**
938
+ * 低代码互动课堂的SdkAppId。
939
+
940
+ */
941
+ SdkAppId: number;
942
+ }
535
943
  /**
536
944
  * CreateSupervisor返回参数结构体
537
945
  */
@@ -572,25 +980,126 @@ export interface RegisterUserResponse {
572
980
  RequestId?: string;
573
981
  }
574
982
  /**
575
- * DescribeAppDetail返回参数结构体
983
+ * 水印配置
576
984
  */
577
- export interface DescribeAppDetailResponse {
985
+ export interface WatermarkConfig {
578
986
  /**
579
- * SDK 对应的AppId
987
+ * 水印图片的url
988
+ 注意:此字段可能返回 null,表示取不到有效值。
580
989
  */
581
- SdkAppId?: string;
990
+ Url?: string;
582
991
  /**
583
- * 应用配置
992
+ * 水印宽。为比例值
993
+ 注意:此字段可能返回 null,表示取不到有效值。
584
994
  */
585
- AppConfig?: AppConfig;
995
+ Width?: number;
586
996
  /**
587
- * 场景配置
997
+ * 水印高。为比例值
998
+ 注意:此字段可能返回 null,表示取不到有效值。
588
999
  */
589
- SceneConfig?: Array<SceneItem>;
1000
+ Height?: number;
590
1001
  /**
591
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1002
+ * 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间。
1003
+ 注意:此字段可能返回 null,表示取不到有效值。
592
1004
  */
593
- RequestId?: string;
1005
+ LocationX?: number;
1006
+ /**
1007
+ * 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50,则表示位于Y轴中间。
1008
+ 注意:此字段可能返回 null,表示取不到有效值。
1009
+ */
1010
+ LocationY?: number;
1011
+ }
1012
+ /**
1013
+ * DescribeRoomStatistics请求参数结构体
1014
+ */
1015
+ export interface DescribeRoomStatisticsRequest {
1016
+ /**
1017
+ * 房间Id。
1018
+ */
1019
+ RoomId: number;
1020
+ /**
1021
+ * 分页查询当前页数,从1开始递增。
1022
+ */
1023
+ Page: number;
1024
+ /**
1025
+ * 每页数据量,最大1000。
1026
+ */
1027
+ Limit: number;
1028
+ }
1029
+ /**
1030
+ * 文档信息
1031
+ */
1032
+ export interface DocumentInfo {
1033
+ /**
1034
+ * 文档Id
1035
+ 注意:此字段可能返回 null,表示取不到有效值。
1036
+ */
1037
+ DocumentId?: string;
1038
+ /**
1039
+ * 文档原址url
1040
+ 注意:此字段可能返回 null,表示取不到有效值。
1041
+ */
1042
+ DocumentUrl?: string;
1043
+ /**
1044
+ * 文档名称
1045
+ 注意:此字段可能返回 null,表示取不到有效值。
1046
+ */
1047
+ DocumentName?: string;
1048
+ /**
1049
+ * 文档所有者UserId
1050
+ 注意:此字段可能返回 null,表示取不到有效值。
1051
+ */
1052
+ Owner?: string;
1053
+ /**
1054
+ * 应用Id
1055
+ 注意:此字段可能返回 null,表示取不到有效值。
1056
+ */
1057
+ SdkAppId?: number;
1058
+ /**
1059
+ * 文档权限,0:私有课件 1:公共课件
1060
+ 注意:此字段可能返回 null,表示取不到有效值。
1061
+ */
1062
+ Permission?: number;
1063
+ /**
1064
+ * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码
1065
+ 注意:此字段可能返回 null,表示取不到有效值。
1066
+ */
1067
+ TranscodeResult?: string;
1068
+ /**
1069
+ * 转码类型
1070
+ 注意:此字段可能返回 null,表示取不到有效值。
1071
+ */
1072
+ TranscodeType?: number;
1073
+ /**
1074
+ * 转码进度, 0 - 100 表示(0% - 100%)
1075
+ 注意:此字段可能返回 null,表示取不到有效值。
1076
+ */
1077
+ TranscodeProgress?: number;
1078
+ /**
1079
+ * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功
1080
+ 注意:此字段可能返回 null,表示取不到有效值。
1081
+ */
1082
+ TranscodeState?: number;
1083
+ /**
1084
+ * 转码失败后的错误信息
1085
+ 注意:此字段可能返回 null,表示取不到有效值。
1086
+ */
1087
+ TranscodeInfo?: string;
1088
+ /**
1089
+ * 文档类型
1090
+ 注意:此字段可能返回 null,表示取不到有效值。
1091
+ */
1092
+ DocumentType?: string;
1093
+ /**
1094
+ * 文档大小,单位:字节
1095
+ 注意:此字段可能返回 null,表示取不到有效值。
1096
+ */
1097
+ DocumentSize?: number;
1098
+ /**
1099
+ * 更新的UNIX时间戳
1100
+ 注意:此字段可能返回 null,表示取不到有效值。
1101
+ */
1102
+ UpdateTime?: number;
594
1103
  }
595
1104
  /**
596
1105
  * 成员记录信息。
@@ -662,6 +1171,16 @@ export interface ModifyAppRequest {
662
1171
  * CreateSupervisor请求参数结构体
663
1172
  */
664
1173
  export declare type CreateSupervisorRequest = null;
1174
+ /**
1175
+ * 背景图片配置
1176
+ */
1177
+ export interface BackgroundPictureConfig {
1178
+ /**
1179
+ * 背景图片的url
1180
+ 注意:此字段可能返回 null,表示取不到有效值。
1181
+ */
1182
+ Url: string;
1183
+ }
665
1184
  /**
666
1185
  * UnbindDocumentFromRoom请求参数结构体
667
1186
  */
@@ -715,6 +1234,19 @@ export interface LoginUserRequest {
715
1234
  */
716
1235
  UserId: string;
717
1236
  }
1237
+ /**
1238
+ * BatchCreateRoom请求参数结构体
1239
+ */
1240
+ export interface BatchCreateRoomRequest {
1241
+ /**
1242
+ * 低代码平台的SdkAppId。
1243
+ */
1244
+ SdkAppId: number;
1245
+ /**
1246
+ * 创建房间ID列表
1247
+ */
1248
+ RoomInfos: Array<RoomInfo>;
1249
+ }
718
1250
  /**
719
1251
  * BindDocumentToRoom返回参数结构体
720
1252
  */
@@ -725,38 +1257,109 @@ export interface BindDocumentToRoomResponse {
725
1257
  RequestId?: string;
726
1258
  }
727
1259
  /**
728
- * CreateRoom返回参数结构体
1260
+ * 用户信息结构体
729
1261
  */
730
- export interface CreateRoomResponse {
1262
+ export interface UserInfo {
731
1263
  /**
732
- * 房间ID
1264
+ * 应用Id
1265
+ 注意:此字段可能返回 null,表示取不到有效值。
733
1266
  */
734
- RoomId?: number;
1267
+ SdkAppId?: number;
735
1268
  /**
736
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1269
+ * 用户Id
1270
+ 注意:此字段可能返回 null,表示取不到有效值。
737
1271
  */
738
- RequestId?: string;
1272
+ UserId?: string;
1273
+ /**
1274
+ * 用户昵称。
1275
+ 注意:此字段可能返回 null,表示取不到有效值。
1276
+ */
1277
+ Name?: string;
1278
+ /**
1279
+ * 用户头像Url。
1280
+ 注意:此字段可能返回 null,表示取不到有效值。
1281
+ */
1282
+ Avatar?: string;
739
1283
  }
740
1284
  /**
741
- * DescribeUser返回参数结构体
1285
+ * SetWatermark请求参数结构体
742
1286
  */
743
- export interface DescribeUserResponse {
1287
+ export interface SetWatermarkRequest {
744
1288
  /**
745
- * 应用Id
1289
+ * 低代码互动课堂的SdkAppId
1290
+
746
1291
  */
747
1292
  SdkAppId: number;
748
1293
  /**
749
- * 用户Id。
1294
+ * 老师视频区域的水印参数地址,设置为空字符串表示删除
750
1295
  */
751
- UserId: string;
1296
+ TeacherUrl?: string;
752
1297
  /**
753
- * 用户昵称。
1298
+ * 白板视频区域的水印参数地址,设置为空字符串表示删除
754
1299
  */
755
- Name: string;
1300
+ BoardUrl?: string;
756
1301
  /**
757
- * 用户头像Url。
1302
+ * 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除
758
1303
  */
759
- Avatar: string;
1304
+ VideoUrl?: string;
1305
+ /**
1306
+ * 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
1307
+ */
1308
+ BoardW?: number;
1309
+ /**
1310
+ * 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
1311
+ */
1312
+ BoardH?: number;
1313
+ /**
1314
+ * 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
1315
+ */
1316
+ BoardX?: number;
1317
+ /**
1318
+ * 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
1319
+ */
1320
+ BoardY?: number;
1321
+ /**
1322
+ * 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比
1323
+ */
1324
+ TeacherW?: number;
1325
+ /**
1326
+ * 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比
1327
+ */
1328
+ TeacherH?: number;
1329
+ /**
1330
+ * 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
1331
+ */
1332
+ TeacherX?: number;
1333
+ /**
1334
+ * 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间
1335
+ */
1336
+ TeacherY?: number;
1337
+ /**
1338
+ * 文字水印内容,设置为空字符串表示删除
1339
+ */
1340
+ Text?: string;
1341
+ /**
1342
+ * 文字水印颜色
1343
+ */
1344
+ TextColor?: string;
1345
+ }
1346
+ /**
1347
+ * CreateRoom返回参数结构体
1348
+ */
1349
+ export interface CreateRoomResponse {
1350
+ /**
1351
+ * 房间ID。
1352
+ */
1353
+ RoomId?: number;
1354
+ /**
1355
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1356
+ */
1357
+ RequestId?: string;
1358
+ }
1359
+ /**
1360
+ * DeleteRecord返回参数结构体
1361
+ */
1362
+ export interface DeleteRecordResponse {
760
1363
  /**
761
1364
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
762
1365
  */
@@ -771,6 +1374,15 @@ export interface DescribeRoomRequest {
771
1374
  */
772
1375
  RoomId: number;
773
1376
  }
1377
+ /**
1378
+ * DescribeDocument请求参数结构体
1379
+ */
1380
+ export interface DescribeDocumentRequest {
1381
+ /**
1382
+ * 文档Id(唯一id)
1383
+ */
1384
+ DocumentId: string;
1385
+ }
774
1386
  /**
775
1387
  * RegisterUser请求参数结构体
776
1388
  */
@@ -792,3 +1404,17 @@ export interface RegisterUserRequest {
792
1404
  */
793
1405
  Avatar?: string;
794
1406
  }
1407
+ /**
1408
+ * BatchDeleteRecord返回参数结构体
1409
+ */
1410
+ export interface BatchDeleteRecordResponse {
1411
+ /**
1412
+ * 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除,则出参列表中无对应的房间ID。
1413
+ 注意:此字段可能返回 null,表示取不到有效值。
1414
+ */
1415
+ RoomIds?: Array<number>;
1416
+ /**
1417
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1418
+ */
1419
+ RequestId?: string;
1420
+ }