tencentcloud-sdk-nodejs 4.0.1049 → 4.0.1051

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 (96) hide show
  1. package/package.json +1 -1
  2. package/src/common/sdk_version.ts +1 -1
  3. package/src/services/as/v20180419/as_models.ts +47 -71
  4. package/src/services/bh/v20230418/bh_client.ts +18 -5
  5. package/src/services/bh/v20230418/bh_models.ts +241 -147
  6. package/src/services/cdwch/v20200915/cdwch_models.ts +7 -3
  7. package/src/services/cfg/v20210820/cfg_models.ts +16 -11
  8. package/src/services/cmq/v20190304/cmq_models.ts +2 -47
  9. package/src/services/cynosdb/v20190107/cynosdb_models.ts +18 -196
  10. package/src/services/dlc/v20210125/dlc_client.ts +28 -14
  11. package/src/services/dlc/v20210125/dlc_models.ts +128 -8
  12. package/src/services/domain/v20180808/domain_models.ts +33 -95
  13. package/src/services/dsgc/v20190723/dsgc_models.ts +2 -0
  14. package/src/services/dts/v20180330/dts_models.ts +1 -2
  15. package/src/services/dts/v20211206/dts_models.ts +1 -165
  16. package/src/services/emr/v20190103/emr_client.ts +17 -3
  17. package/src/services/emr/v20190103/emr_models.ts +275 -159
  18. package/src/services/es/v20180416/es_models.ts +5 -0
  19. package/src/services/fmu/v20191213/fmu_client.ts +23 -67
  20. package/src/services/fmu/v20191213/fmu_models.ts +140 -292
  21. package/src/services/iotcloud/v20210408/iotcloud_models.ts +11 -11
  22. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +2 -32
  23. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +42 -182
  24. package/src/services/iss/v20230517/iss_models.ts +12 -275
  25. package/src/services/kms/v20190118/kms_models.ts +8 -0
  26. package/src/services/lcic/v20220817/lcic_client.ts +36 -12
  27. package/src/services/lcic/v20220817/lcic_models.ts +56 -0
  28. package/src/services/mongodb/v20190725/mongodb_client.ts +19 -7
  29. package/src/services/mongodb/v20190725/mongodb_models.ts +38 -6
  30. package/src/services/monitor/v20180724/monitor_models.ts +1 -1
  31. package/src/services/rum/v20210622/rum_models.ts +0 -1
  32. package/src/services/svp/v20240125/svp_client.ts +14 -0
  33. package/src/services/svp/v20240125/svp_models.ts +136 -0
  34. package/src/services/tiw/v20190919/tiw_client.ts +66 -389
  35. package/src/services/tiw/v20190919/tiw_models.ts +341 -1652
  36. package/src/services/trtc/v20190722/trtc_models.ts +16 -4
  37. package/src/services/tsf/v20180326/tsf_client.ts +19 -7
  38. package/src/services/tsf/v20180326/tsf_models.ts +103 -84
  39. package/src/services/vpc/v20170312/vpc_client.ts +15 -3
  40. package/src/services/vpc/v20170312/vpc_models.ts +41 -10
  41. package/src/services/wedata/v20210820/wedata_client.ts +14 -0
  42. package/src/services/wedata/v20210820/wedata_models.ts +187 -0
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/as/v20180419/as_models.d.ts +47 -71
  46. package/tencentcloud/services/bh/v20230418/bh_client.d.ts +5 -1
  47. package/tencentcloud/services/bh/v20230418/bh_client.js +6 -0
  48. package/tencentcloud/services/bh/v20230418/bh_models.d.ts +238 -147
  49. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +7 -3
  50. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +16 -11
  51. package/tencentcloud/services/cmq/v20190304/cmq_models.d.ts +2 -47
  52. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +16 -194
  53. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +10 -6
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.js +12 -6
  55. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +124 -8
  56. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +33 -95
  57. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +2 -0
  58. package/tencentcloud/services/dts/v20180330/dts_models.d.ts +1 -2
  59. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +0 -164
  60. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
  61. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
  62. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +271 -159
  63. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
  64. package/tencentcloud/services/fmu/v20191213/fmu_client.d.ts +5 -23
  65. package/tencentcloud/services/fmu/v20191213/fmu_client.js +6 -30
  66. package/tencentcloud/services/fmu/v20191213/fmu_models.d.ts +137 -281
  67. package/tencentcloud/services/iotcloud/v20210408/iotcloud_models.d.ts +11 -11
  68. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +1 -13
  69. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +0 -16
  70. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +42 -176
  71. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +4 -267
  72. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +8 -0
  73. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +13 -5
  74. package/tencentcloud/services/lcic/v20220817/lcic_client.js +18 -6
  75. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +52 -0
  76. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +7 -3
  77. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +9 -3
  78. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +36 -6
  79. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
  80. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +0 -1
  81. package/tencentcloud/services/svp/v20240125/svp_client.d.ts +5 -1
  82. package/tencentcloud/services/svp/v20240125/svp_client.js +6 -0
  83. package/tencentcloud/services/svp/v20240125/svp_models.d.ts +132 -0
  84. package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +18 -125
  85. package/tencentcloud/services/tiw/v20190919/tiw_client.js +25 -182
  86. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +458 -1703
  87. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +16 -4
  88. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +5 -1
  89. package/tencentcloud/services/tsf/v20180326/tsf_client.js +6 -0
  90. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +101 -84
  91. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  92. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  93. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +39 -10
  94. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +5 -1
  95. package/tencentcloud/services/wedata/v20210820/wedata_client.js +6 -0
  96. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +183 -0
@@ -12,61 +12,58 @@ export interface Canvas {
12
12
  BackgroundColor?: string;
13
13
  }
14
14
  /**
15
- * StopOnlineRecord返回参数结构体
15
+ * CreateVideoGenerationTask请求参数结构体
16
16
  */
17
- export interface StopOnlineRecordResponse {
17
+ export interface CreateVideoGenerationTaskRequest {
18
18
  /**
19
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19
+ * 实时录制任务的TaskId
20
20
  */
21
- RequestId?: string;
22
- }
23
- /**
24
- * SetVideoGenerationTaskCallbackKey请求参数结构体
25
- */
26
- export interface SetVideoGenerationTaskCallbackKeyRequest {
21
+ OnlineRecordTaskId: string;
27
22
  /**
28
- * 应用的SdkAppId
23
+ * 客户的SdkAppId
29
24
  */
30
25
  SdkAppId: number;
31
26
  /**
32
- * 设置视频生成回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥
33
- */
34
- CallbackKey: string;
35
- }
36
- /**
37
- * DescribeTIWRoomDailyUsage请求参数结构体
38
- */
39
- export interface DescribeTIWRoomDailyUsageRequest {
40
- /**
41
- * 互动白板应用SdkAppId
27
+ * 视频生成的白板参数,例如白板宽高等。
28
+
29
+ 此参数与开始录制接口提供的Whiteboard参数互斥,在本接口与开始录制接口都提供了Whiteboard参数时,优先使用本接口指定的Whiteboard参数进行视频生成,否则使用开始录制接口提供的Whiteboard参数进行视频生成。
42
30
  */
43
- SdkAppId: number;
31
+ Whiteboard?: Whiteboard;
44
32
  /**
45
- * 需要查询的子产品用量,支持传入以下值
46
- - sp_tiw_board: 互动白板时长,单位为分钟
47
- - sp_tiw_ric: 实时录制时长,单位分钟
33
+ * 视频拼接参数
34
+
35
+ 此参数与开始录制接口提供的Concat参数互斥,在本接口与开始录制接口都提供了Concat参数时,优先使用本接口指定的Concat参数进行视频拼接,否则使用开始录制接口提供的Concat参数进行视频拼接。
48
36
  */
49
- SubProduct: string;
37
+ Concat?: Concat;
50
38
  /**
51
- * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
39
+ * 视频生成混流参数
40
+
41
+ 此参数与开始录制接口提供的MixStream参数互斥,在本接口与开始录制接口都提供了MixStream参数时,优先使用本接口指定的MixStream参数进行视频混流,否则使用开始录制接口提供的MixStream参数进行视频拼混流。
52
42
  */
53
- StartTime: string;
43
+ MixStream?: MixStream;
54
44
  /**
55
- * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
45
+ * 视频生成控制参数,用于更精细地指定需要生成哪些流,某一路流是否禁用音频,是否只录制小画面等
46
+
47
+ 此参数与开始录制接口提供的RecordControl参数互斥,在本接口与开始录制接口都提供了RecordControl参数时,优先使用本接口指定的RecordControl参数进行视频生成控制,否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。
56
48
  */
57
- EndTime: string;
49
+ RecordControl?: RecordControl;
58
50
  /**
59
- * 需要查询的房间ID列表,不填默认查询全部房间
51
+ * 内部参数
60
52
  */
61
- RoomIDs?: Array<number | bigint>;
53
+ ExtraData?: string;
54
+ }
55
+ /**
56
+ * SetVideoGenerationTaskCallbackKey请求参数结构体
57
+ */
58
+ export interface SetVideoGenerationTaskCallbackKeyRequest {
62
59
  /**
63
- * 查询偏移量,默认为0
60
+ * 应用的SdkAppId
64
61
  */
65
- Offset?: number;
62
+ SdkAppId: number;
66
63
  /**
67
- * 每次查询返回条目限制,默认为20
64
+ * 设置视频生成回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥
68
65
  */
69
- Limit?: number;
66
+ CallbackKey: string;
70
67
  }
71
68
  /**
72
69
  * DescribeWhiteboardPush请求参数结构体
@@ -81,23 +78,6 @@ export interface DescribeWhiteboardPushRequest {
81
78
  */
82
79
  TaskId: string;
83
80
  }
84
- /**
85
- * DescribeWhiteboardPushSearch返回参数结构体
86
- */
87
- export interface DescribeWhiteboardPushSearchResponse {
88
- /**
89
- * 推流任务搜索结果集合
90
- */
91
- WhiteboardPushTaskSet: Array<WhiteboardPushTaskSearchResult>;
92
- /**
93
- * 推流总任务数
94
- */
95
- TotalCount: number;
96
- /**
97
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
98
- */
99
- RequestId?: string;
100
- }
101
81
  /**
102
82
  * ResumeOnlineRecord返回参数结构体
103
83
  */
@@ -108,159 +88,76 @@ export interface ResumeOnlineRecordResponse {
108
88
  RequestId?: string;
109
89
  }
110
90
  /**
111
- * 互动白板用量信息
112
- */
113
- export interface UsageDataItem {
114
- /**
115
- * 日期,格式为YYYY-MM-DD
116
- */
117
- Time: string;
118
- /**
119
- * 白板应用SDKAppID
120
- */
121
- SdkAppId: number;
122
- /**
123
- * 互动白板子产品,请求参数传入的一致
124
- - sp_tiw_board: 互动白板时长
125
- - sp_tiw_dt: 动态转码页数
126
- - sp_tiw_st: 静态转码页数
127
- - sp_tiw_ric: 实时录制时长
128
- */
129
- SubProduct: string;
130
- /**
131
- * 用量值
132
- - 静态转码、动态转码单位为页
133
- - 白板时长、实时录制时长单位为分钟
134
- */
135
- Value: number;
136
- }
137
- /**
138
- * DescribeWhiteboardApplicationConfig返回参数结构体
91
+ * SetPPTCheckCallbackKey返回参数结构体
139
92
  */
140
- export interface DescribeWhiteboardApplicationConfigResponse {
141
- /**
142
- * 客户的SdkAppId
143
- */
144
- SdkAppId: number;
145
- /**
146
- * 白板应用任务相关配置
147
- */
148
- Configs: Array<WhiteboardApplicationConfig>;
93
+ export interface SetPPTCheckCallbackKeyResponse {
149
94
  /**
150
95
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
151
96
  */
152
97
  RequestId?: string;
153
98
  }
154
99
  /**
155
- * 白板推流任务结果
100
+ * CreateTranscode返回参数结构体
156
101
  */
157
- export interface WhiteboardPushResult {
158
- /**
159
- * AUTO - 自动停止推流, USER_CALL - 用户主动调用停止推流
160
- */
161
- FinishReason: string;
162
- /**
163
- * 异常数
164
- */
165
- ExceptionCnt: number;
166
- /**
167
- * 房间号
168
- */
169
- RoomId: number;
170
- /**
171
- * IM群组ID
172
- */
173
- GroupId: string;
174
- /**
175
- * 推流真实开始时间
176
- */
177
- PushStartTime: number;
178
- /**
179
- * 推流结束时间
180
- */
181
- PushStopTime: number;
182
- /**
183
- * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
184
- */
185
- IMSyncTime: number;
102
+ export interface CreateTranscodeResponse {
186
103
  /**
187
- * 任务失败错误码
104
+ * 文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果
188
105
  */
189
- ErrorCode: number;
106
+ TaskId?: string;
190
107
  /**
191
- * 错误信息
108
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
192
109
  */
193
- ErrorMsg: string;
110
+ RequestId?: string;
194
111
  }
195
112
  /**
196
- * CreateSnapshotTask返回参数结构体
113
+ * 视频信息
197
114
  */
198
- export interface CreateSnapshotTaskResponse {
115
+ export interface VideoInfo {
199
116
  /**
200
- * 白板板书生成任务ID,只有任务创建成功的时候才会返回此字段
117
+ * 视频开始播放的时间(单位:毫秒)
201
118
  */
202
- TaskID: string;
119
+ VideoPlayTime: number;
203
120
  /**
204
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
121
+ * 视频大小(字节)
205
122
  */
206
- RequestId?: string;
207
- }
208
- /**
209
- * ModifyApplication返回参数结构体
210
- */
211
- export interface ModifyApplicationResponse {
123
+ VideoSize: number;
212
124
  /**
213
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
125
+ * 视频格式
214
126
  */
215
- RequestId?: string;
216
- }
217
- /**
218
- * SetPPTCheckCallbackKey返回参数结构体
219
- */
220
- export interface SetPPTCheckCallbackKeyResponse {
127
+ VideoFormat: string;
221
128
  /**
222
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
129
+ * 视频播放时长(单位:毫秒)
223
130
  */
224
- RequestId?: string;
225
- }
226
- /**
227
- * CreateTranscode返回参数结构体
228
- */
229
- export interface CreateTranscodeResponse {
131
+ VideoDuration: number;
230
132
  /**
231
- * 文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果
133
+ * 视频文件URL
232
134
  */
233
- TaskId?: string;
135
+ VideoUrl: string;
234
136
  /**
235
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
137
+ * 视频文件Id
236
138
  */
237
- RequestId?: string;
238
- }
239
- /**
240
- * DescribeUserResources返回参数结构体
241
- */
242
- export interface DescribeUserResourcesResponse {
139
+ VideoId: string;
243
140
  /**
244
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
141
+ * 视频流类型
142
+ - 0:摄像头视频
143
+ - 1:屏幕分享视频
144
+ - 2:白板视频
145
+ - 3:混流视频
146
+ - 4:纯音频(mp3)
245
147
  */
246
- RequestId?: string;
247
- }
248
- /**
249
- * 日志查询里返回的白板用户数据
250
- */
251
- export interface UserListItem {
148
+ VideoType: number;
252
149
  /**
253
- * 房间内的用户ID
150
+ * 摄像头/屏幕分享视频所属用户的 Id(白板视频为空、混流视频tic_mixstream_房间号_混流布局类型、辅路视频tic_substream_用户Id)
254
151
  */
255
152
  UserId: string;
256
153
  /**
257
- * 用户在查询时间段内最早出现的时间,Unix时间戳,单位毫秒
154
+ * 视频分辨率的宽
258
155
  */
259
- StartTime: number;
156
+ Width: number;
260
157
  /**
261
- * 用户在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒
158
+ * 视频分辨率的高
262
159
  */
263
- EndTime: number;
160
+ Height: number;
264
161
  }
265
162
  /**
266
163
  * DescribePPTCheck返回参数结构体
@@ -331,733 +228,415 @@ export interface Interrupt {
331
228
  Count: number;
332
229
  }
333
230
  /**
334
- * CreateApplication请求参数结构体
231
+ * DescribeOnlineRecord请求参数结构体
335
232
  */
336
- export interface CreateApplicationRequest {
233
+ export interface DescribeOnlineRecordRequest {
337
234
  /**
338
- * 应用SdkAppId
235
+ * 客户的SdkAppId
339
236
  */
340
237
  SdkAppId: number;
341
238
  /**
342
- * App名字
343
- */
344
- AppName?: string;
345
- /**
346
- * 创建IM应用需要的SKey
347
- */
348
- SKey?: string;
349
- /**
350
- * 创建IM应用需要的TinyId
351
- */
352
- TinyId?: string;
353
- /**
354
- * 需要绑定的标签列表
239
+ * 实时录制任务Id
355
240
  */
356
- TagList?: Array<Tag>;
241
+ TaskId: string;
357
242
  }
358
243
  /**
359
- * 日志查询里返回的白板房间数据
244
+ * SetOnlineRecordCallbackKey返回参数结构体
360
245
  */
361
- export interface RoomListItem {
362
- /**
363
- * 房间ID
364
- */
365
- RoomId: string;
246
+ export interface SetOnlineRecordCallbackKeyResponse {
366
247
  /**
367
- * 房间在查询时间段内最早出现的时间,Unix时间戳,单位毫秒
248
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
368
249
  */
369
- StartTime: number;
250
+ RequestId?: string;
251
+ }
252
+ /**
253
+ * StopOnlineRecord返回参数结构体
254
+ */
255
+ export interface StopOnlineRecordResponse {
370
256
  /**
371
- * 房间在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒
257
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
372
258
  */
373
- EndTime: number;
259
+ RequestId?: string;
260
+ }
261
+ /**
262
+ * DescribeTranscodeCallback请求参数结构体
263
+ */
264
+ export interface DescribeTranscodeCallbackRequest {
374
265
  /**
375
- * 房间里成员数
266
+ * 应用的SdkAppId
376
267
  */
377
- UserNumber: number;
268
+ SdkAppId: number;
378
269
  }
379
270
  /**
380
- * ModifyWhiteboardBucketConfig请求参数结构体
271
+ * ResumeOnlineRecord请求参数结构体
381
272
  */
382
- export interface ModifyWhiteboardBucketConfigRequest {
273
+ export interface ResumeOnlineRecordRequest {
383
274
  /**
384
275
  * 客户的SdkAppId
385
276
  */
386
277
  SdkAppId: number;
387
278
  /**
388
- * 需要查询的任务类型
389
- recording: 实时录制
390
- transcode: 文档转码
391
- */
392
- TaskType: string;
393
- /**
394
- * COS存储桶名字
395
- */
396
- BucketName: string;
397
- /**
398
- * COS存储桶地域
399
- */
400
- BucketLocation: string;
401
- /**
402
- * 存储桶里资源前缀
279
+ * 恢复录制的实时录制任务 Id
403
280
  */
404
- BucketPrefix: string;
281
+ TaskId: string;
282
+ }
283
+ /**
284
+ * SetWhiteboardPushCallbackKey返回参数结构体
285
+ */
286
+ export interface SetWhiteboardPushCallbackKeyResponse {
405
287
  /**
406
- * 返回Url域名
288
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
407
289
  */
408
- ResultDomain: string;
290
+ RequestId?: string;
409
291
  }
410
292
  /**
411
- * SetOnlineRecordCallbackKey返回参数结构体
293
+ * SetWhiteboardPushCallback返回参数结构体
412
294
  */
413
- export interface SetOnlineRecordCallbackKeyResponse {
295
+ export interface SetWhiteboardPushCallbackResponse {
414
296
  /**
415
297
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
416
298
  */
417
299
  RequestId?: string;
418
300
  }
419
301
  /**
420
- * DescribeRecordSearch返回参数结构体
302
+ * 拼接视频中被忽略的时间段
421
303
  */
422
- export interface DescribeRecordSearchResponse {
304
+ export interface OmittedDuration {
423
305
  /**
424
- * 录制任务搜索结果集合
306
+ * 录制暂停时间戳对应的视频播放时间(单位: 毫秒)
425
307
  */
426
- RecordTaskSet: Array<RecordTaskSearchResult>;
308
+ VideoTime: number;
427
309
  /**
428
- * 录制总任务数
310
+ * 录制暂停时间戳(单位: 毫秒)
429
311
  */
430
- TotalCount: number;
312
+ PauseTime: number;
431
313
  /**
432
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
314
+ * 录制恢复时间戳(单位: 毫秒)
433
315
  */
434
- RequestId?: string;
316
+ ResumeTime: number;
435
317
  }
436
318
  /**
437
- * DescribeAPIService请求参数结构体
319
+ * PPT错误页面列表
438
320
  */
439
- export interface DescribeAPIServiceRequest {
321
+ export interface PPTErrSlide {
440
322
  /**
441
- * 目前支持的Service为cos:GetService,cdn:DescribeDomainsConfig
323
+ * 异常元素存在的页面,由页面类型+页码组成,页码类型包括:幻灯片、幻灯片母版、幻灯片布局等
324
+ 注意:此字段可能返回 null,表示取不到有效值。
442
325
  */
443
- Service: string;
326
+ Page?: string;
444
327
  /**
445
- * JSON格式的请求参数
328
+ * 错误元素列表
329
+ 注意:此字段可能返回 null,表示取不到有效值。
446
330
  */
447
- Data?: string;
331
+ Errs?: Array<PPTErr>;
448
332
  }
449
333
  /**
450
- * DescribeQualityMetrics请求参数结构体
334
+ * PauseOnlineRecord请求参数结构体
451
335
  */
452
- export interface DescribeQualityMetricsRequest {
336
+ export interface PauseOnlineRecordRequest {
453
337
  /**
454
- * 白板应用的SdkAppId
338
+ * 客户的SdkAppId
455
339
  */
456
340
  SdkAppId: number;
457
341
  /**
458
- * 开始时间,Unix时间戳,单位秒,时间跨度不能超过7天
342
+ * 实时录制任务 Id
459
343
  */
460
- StartTime: number;
344
+ TaskId: string;
345
+ }
346
+ /**
347
+ * DescribeRunningTasks返回参数结构体
348
+ */
349
+ export interface DescribeRunningTasksResponse {
461
350
  /**
462
- * 结束时间,Unix时间戳,单位秒,时间跨度不能超过7天
351
+ * 当前正在执行中的任务总数
463
352
  */
464
- EndTime: number;
353
+ Total?: number;
465
354
  /**
466
- * 查询的指标,目前支持以下值
467
- - image_load_total_count: 图片加载总数(单位,次)
468
- - image_load_fail_count: 图片加载失败数量(单位,次)
469
- - image_load_success_rate: 图片加载成功率(百分比)
470
- - ppt_load_total_count: PPT加载总数(单位,次)
471
- - ppt_load_fail_count: PPT加载失败总数(单位,次)
472
- - ppt_load_success_rate: PPT加载成功率(单位,百分比)
473
- - verify_sdk_total_count: 白板鉴权总次数(单位,次)
474
- - verify_sdk_fail_count: 白板鉴权失败次数(单位,次)
475
- - verify_sdk_success_rate: 白板鉴权成功率(单位,百分比)
476
- - verify_sdk_in_one_second_rate: 白板鉴权秒开率(单位,百分比)
477
- - verify_sdk_cost_avg: 白板鉴权耗时平均时间(单位,毫秒)
355
+ * 任务信息列表
478
356
  */
479
- Metric: string;
357
+ Tasks?: Array<RunningTaskItem>;
480
358
  /**
481
- * 聚合的时间维度,目前只支持1小时,输入值为"1h"
359
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
482
360
  */
483
- Interval?: string;
361
+ RequestId?: string;
484
362
  }
485
363
  /**
486
- * CreateVideoGenerationTask请求参数结构体
364
+ * DescribeWhiteboardPush返回参数结构体
487
365
  */
488
- export interface CreateVideoGenerationTaskRequest {
366
+ export interface DescribeWhiteboardPushResponse {
489
367
  /**
490
- * 录制任务的TaskId
368
+ * 推流结束原因,
369
+ - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
370
+ - USER_CALL: 主动调用了停止推流接口
371
+ - EXCEPTION: 推流异常结束
491
372
  */
492
- OnlineRecordTaskId: string;
373
+ FinishReason?: string;
493
374
  /**
494
- * 客户的SdkAppId
375
+ * 需要查询结果的白板推流任务Id
495
376
  */
496
- SdkAppId: number;
377
+ TaskId?: string;
497
378
  /**
498
- * 视频生成的白板参数,例如白板宽高等。
499
-
500
- 此参数与开始录制接口提供的Whiteboard参数互斥,在本接口与开始录制接口都提供了Whiteboard参数时,优先使用本接口指定的Whiteboard参数进行视频生成,否则使用开始录制接口提供的Whiteboard参数进行视频生成。
379
+ * 推流任务状态
380
+ - PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
381
+ - PUSHING: 表示推流已开始
382
+ - STOPPED: 表示推流已停止
501
383
  */
502
- Whiteboard?: Whiteboard;
384
+ Status?: string;
503
385
  /**
504
- * 视频拼接参数
505
-
506
- 此参数与开始录制接口提供的Concat参数互斥,在本接口与开始录制接口都提供了Concat参数时,优先使用本接口指定的Concat参数进行视频拼接,否则使用开始录制接口提供的Concat参数进行视频拼接。
386
+ * 房间号
507
387
  */
508
- Concat?: Concat;
388
+ RoomId?: number;
509
389
  /**
510
- * 视频生成混流参数
511
-
512
- 此参数与开始录制接口提供的MixStream参数互斥,在本接口与开始录制接口都提供了MixStream参数时,优先使用本接口指定的MixStream参数进行视频混流,否则使用开始录制接口提供的MixStream参数进行视频拼混流。
390
+ * 白板的群组 Id
513
391
  */
514
- MixStream?: MixStream;
392
+ GroupId?: string;
515
393
  /**
516
- * 视频生成控制参数,用于更精细地指定需要生成哪些流,某一路流是否禁用音频,是否只录制小画面等
517
-
518
- 此参数与开始录制接口提供的RecordControl参数互斥,在本接口与开始录制接口都提供了RecordControl参数时,优先使用本接口指定的RecordControl参数进行视频生成控制,否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。
394
+ * 推流用户Id
519
395
  */
520
- RecordControl?: RecordControl;
396
+ PushUserId?: string;
521
397
  /**
522
- * 内部参数
398
+ * 实际开始推流时间,Unix 时间戳,单位秒
523
399
  */
524
- ExtraData?: string;
525
- }
526
- /**
527
- * DescribeTranscodeCallback请求参数结构体
528
- */
529
- export interface DescribeTranscodeCallbackRequest {
400
+ PushStartTime?: number;
530
401
  /**
531
- * 应用的SdkAppId
402
+ * 实际停止推流时间,Unix 时间戳,单位秒
532
403
  */
533
- SdkAppId: number;
534
- }
535
- /**
536
- * DescribeTranscodeSearch返回参数结构体
537
- */
538
- export interface DescribeTranscodeSearchResponse {
404
+ PushStopTime?: number;
405
+ /**
406
+ * 推流过程中出现异常的次数
407
+ */
408
+ ExceptionCnt?: number;
539
409
  /**
540
- * 转码任务搜索结果集合
410
+ * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
541
411
  */
542
- TranscodeTaskSet: Array<TranscodeTaskSearchResult>;
412
+ IMSyncTime?: number;
543
413
  /**
544
- * 转码总任务数
414
+ * 备份推流任务结果信息
415
+ 注意:此字段可能返回 null,表示取不到有效值。
545
416
  */
546
- TotalCount: number;
417
+ Backup?: string;
547
418
  /**
548
419
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
549
420
  */
550
421
  RequestId?: string;
551
422
  }
552
423
  /**
553
- * ResumeOnlineRecord请求参数结构体
424
+ * SetVideoGenerationTaskCallback请求参数结构体
554
425
  */
555
- export interface ResumeOnlineRecordRequest {
426
+ export interface SetVideoGenerationTaskCallbackRequest {
556
427
  /**
557
428
  * 客户的SdkAppId
558
429
  */
559
430
  SdkAppId: number;
560
431
  /**
561
- * 恢复录制的实时录制任务 Id
562
- */
563
- TaskId: string;
564
- }
565
- /**
566
- * SetWhiteboardPushCallbackKey返回参数结构体
567
- */
568
- export interface SetWhiteboardPushCallbackKeyResponse {
569
- /**
570
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
432
+ * 课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头
571
433
  */
572
- RequestId?: string;
434
+ Callback: string;
573
435
  }
574
436
  /**
575
- * DescribeRoomList请求参数结构体
437
+ * DescribeWarningCallback返回参数结构体
576
438
  */
577
- export interface DescribeRoomListRequest {
578
- /**
579
- * 白板应用的SdkAppId
580
- */
581
- SdkAppId: number;
582
- /**
583
- * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
584
- */
585
- TimeRange: Array<number | bigint>;
439
+ export interface DescribeWarningCallbackResponse {
586
440
  /**
587
- * 额外的查询条件
441
+ * 告警事件回调地址,如果未设置回调地址,该字段为空字符串
588
442
  */
589
- Query?: string;
443
+ Callback?: string;
590
444
  /**
591
- * 返回最大的数据条数,默认1000
445
+ * 告警回调鉴权密钥
592
446
  */
593
- MaxSize?: number;
594
- }
595
- /**
596
- * SetWhiteboardPushCallback返回参数结构体
597
- */
598
- export interface SetWhiteboardPushCallbackResponse {
447
+ CallbackKey?: string;
599
448
  /**
600
449
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
601
450
  */
602
451
  RequestId?: string;
603
452
  }
604
453
  /**
605
- * ApplyTiwTrial返回参数结构体
454
+ * DescribeRunningTasks请求参数结构体
606
455
  */
607
- export interface ApplyTiwTrialResponse {
456
+ export interface DescribeRunningTasksRequest {
608
457
  /**
609
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
458
+ * 应用的SdkAppID
610
459
  */
611
- RequestId?: string;
612
- }
613
- /**
614
- * 拼接视频中被忽略的时间段
615
- */
616
- export interface OmittedDuration {
460
+ SdkAppID: number;
617
461
  /**
618
- * 录制暂停时间戳对应的视频播放时间(单位: 毫秒)
462
+ * 指定需要获取的任务类型。
463
+ 有效取值如下:
464
+ - TranscodeH5: 动态转码任务,文档转HTML5页面
465
+ - TranscodeJPG: 静态转码任务,文档转图片
466
+ - WhiteboardPush: 白板推流任务
467
+ - OnlineRecord: 实时录制任务
619
468
  */
620
- VideoTime: number;
469
+ TaskType: string;
621
470
  /**
622
- * 录制暂停时间戳(单位: 毫秒)
471
+ * 分页获取时的任务偏移量,默认为0。
623
472
  */
624
- PauseTime: number;
473
+ Offset?: number;
625
474
  /**
626
- * 录制恢复时间戳(单位: 毫秒)
475
+ * 每次获取任务列表时最大获取任务数,默认值为100。
476
+ 有效取值范围:[1, 500]
627
477
  */
628
- ResumeTime: number;
478
+ Limit?: number;
629
479
  }
630
480
  /**
631
- * PPT错误页面列表
481
+ * 白板板书结果
632
482
  */
633
- export interface PPTErrSlide {
483
+ export interface SnapshotResult {
634
484
  /**
635
- * 异常元素存在的页面,由页面类型+页码组成,页码类型包括:幻灯片、幻灯片母版、幻灯片布局等
485
+ * 任务执行错误码
636
486
  注意:此字段可能返回 null,表示取不到有效值。
637
487
  */
638
- Page?: string;
488
+ ErrorCode: string;
639
489
  /**
640
- * 错误元素列表
490
+ * 任务执行错误信息
641
491
  注意:此字段可能返回 null,表示取不到有效值。
642
492
  */
643
- Errs?: Array<PPTErr>;
493
+ ErrorMessage: string;
494
+ /**
495
+ * 快照生成图片总数
496
+ 注意:此字段可能返回 null,表示取不到有效值。
497
+ */
498
+ Total: number;
499
+ /**
500
+ * 快照图片链接列表
501
+ 注意:此字段可能返回 null,表示取不到有效值。
502
+ */
503
+ Snapshots: Array<string>;
644
504
  }
645
505
  /**
646
- * PauseOnlineRecord请求参数结构体
506
+ * DescribeVideoGenerationTask请求参数结构体
647
507
  */
648
- export interface PauseOnlineRecordRequest {
508
+ export interface DescribeVideoGenerationTaskRequest {
649
509
  /**
650
510
  * 客户的SdkAppId
651
511
  */
652
512
  SdkAppId: number;
653
513
  /**
654
- * 实时录制任务 Id
514
+ * 录制视频生成的任务Id
655
515
  */
656
516
  TaskId: string;
657
517
  }
658
518
  /**
659
- * DescribeRunningTasks返回参数结构体
519
+ * SetVideoGenerationTaskCallbackKey返回参数结构体
660
520
  */
661
- export interface DescribeRunningTasksResponse {
662
- /**
663
- * 当前正在执行中的任务总数
664
- */
665
- Total?: number;
666
- /**
667
- * 任务信息列表
668
- */
669
- Tasks?: Array<RunningTaskItem>;
521
+ export interface SetVideoGenerationTaskCallbackKeyResponse {
670
522
  /**
671
523
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
672
524
  */
673
525
  RequestId?: string;
674
526
  }
675
527
  /**
676
- * DescribeApplicationUsage返回参数结构体
528
+ * DescribeVideoGenerationTask返回参数结构体
677
529
  */
678
- export interface DescribeApplicationUsageResponse {
530
+ export interface DescribeVideoGenerationTaskResponse {
679
531
  /**
680
- * 画图所需的用量数据
532
+ * 任务对应的群组Id
681
533
  */
682
- Data: Array<DataItem>;
534
+ GroupId?: string;
683
535
  /**
684
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
536
+ * 任务对应的房间号
685
537
  */
686
- RequestId?: string;
687
- }
688
- /**
689
- * DescribeAPIService返回参数结构体
690
- */
691
- export interface DescribeAPIServiceResponse {
538
+ RoomId?: number;
692
539
  /**
693
- * Json格式的响应数据
540
+ * 任务的Id
694
541
  */
695
- ResponseData?: string;
542
+ TaskId?: string;
696
543
  /**
697
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
544
+ * 已废弃
698
545
  */
699
- RequestId?: string;
700
- }
701
- /**
702
- * 查询指标返回的时间序列
703
- */
704
- export interface TimeValue {
546
+ Progress?: number;
547
+ /**
548
+ * 录制视频生成任务状态
549
+ - QUEUED: 正在排队
550
+ - PROCESSING: 正在生成视频
551
+ - FINISHED: 生成视频结束(成功完成或失败结束,可以通过错误码和错误信息进一步判断)
552
+ */
553
+ Status?: string;
705
554
  /**
706
- * Unix时间戳,单位秒
555
+ * 回放视频总时长,单位:毫秒
707
556
  */
708
- Time: number;
557
+ TotalTime?: number;
709
558
  /**
710
- * 查询指标对应当前时间的值
559
+ * 已废弃,请使用`VideoInfoList`参数
711
560
  */
712
- Value: number;
713
- }
714
- /**
715
- * DescribeWarningCallback返回参数结构体
716
- */
717
- export interface DescribeWarningCallbackResponse {
561
+ VideoInfos?: VideoInfo;
718
562
  /**
719
- * 告警事件回调地址,如果未设置回调地址,该字段为空字符串
563
+ * 录制视频生成视频列表
720
564
  */
721
- Callback?: string;
565
+ VideoInfoList?: Array<VideoInfo>;
722
566
  /**
723
- * 告警回调鉴权密钥
567
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
724
568
  */
725
- CallbackKey?: string;
569
+ RequestId?: string;
570
+ }
571
+ /**
572
+ * SetWarningCallback返回参数结构体
573
+ */
574
+ export interface SetWarningCallbackResponse {
726
575
  /**
727
576
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
728
577
  */
729
578
  RequestId?: string;
730
579
  }
731
580
  /**
732
- * 实时录制结果
581
+ * DescribeWhiteboardPushCallback请求参数结构体
582
+ */
583
+ export interface DescribeWhiteboardPushCallbackRequest {
584
+ /**
585
+ * 应用的SdkAppId
586
+ */
587
+ SdkAppId: number;
588
+ }
589
+ /**
590
+ * DescribeOnlineRecord返回参数结构体
733
591
  */
734
- export interface RecordTaskResult {
592
+ export interface DescribeOnlineRecordResponse {
735
593
  /**
736
- * AUTO - 自动停止录制, USER_CALL - 用户主动调用停止录制
594
+ * 录制结束原因,
595
+ - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制
596
+ - USER_CALL: 主动调用了停止录制接口
597
+ - EXCEPTION: 录制异常结束
598
+ - FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。
737
599
  */
738
600
  FinishReason: string;
739
601
  /**
740
- * 异常数
602
+ * 需要查询结果的录制任务Id
741
603
  */
742
- ExceptionCnt: number;
604
+ TaskId: string;
605
+ /**
606
+ * 录制任务状态
607
+ - PREPARED: 表示录制正在准备中(进房/启动录制服务等操作)
608
+ - RECORDING: 表示录制已开始
609
+ - PAUSED: 表示录制已暂停
610
+ - STOPPED: 表示录制已停止,正在处理并上传视频
611
+ - FINISHED: 表示视频处理并上传完成,成功生成录制结果
612
+ */
613
+ Status: string;
743
614
  /**
744
615
  * 房间号
745
616
  */
746
617
  RoomId: number;
747
618
  /**
748
- * 分组
619
+ * 白板的群组 Id
749
620
  */
750
621
  GroupId: string;
751
622
  /**
752
- * 录制真实开始时间
623
+ * 录制用户Id
624
+ */
625
+ RecordUserId: string;
626
+ /**
627
+ * 实际开始录制时间,Unix 时间戳,单位秒
753
628
  */
754
629
  RecordStartTime: number;
755
630
  /**
756
- * 录制结束时间
631
+ * 实际停止录制时间,Unix 时间戳,单位秒
757
632
  */
758
633
  RecordStopTime: number;
759
634
  /**
760
- * 录制总时长
635
+ * 回放视频总时长(单位:毫秒)
761
636
  */
762
637
  TotalTime: number;
763
638
  /**
764
- * 视频信息列表
765
- */
766
- VideoInfos: Array<VideoInfo>;
767
- /**
768
- * 被忽略的视频时间段
769
- */
770
- OmittedDurations: Array<OmittedDuration>;
771
- /**
772
- * 详情
773
- */
774
- Details: string;
775
- /**
776
- * 任务失败错误码
777
- */
778
- ErrorCode: number;
779
- /**
780
- * 错误信息
781
- */
782
- ErrorMsg: string;
783
- }
784
- /**
785
- * DescribeWhiteboardBucketConfig请求参数结构体
786
- */
787
- export interface DescribeWhiteboardBucketConfigRequest {
788
- /**
789
- * 客户的SdkAppId
790
- */
791
- SdkAppId: number;
792
- /**
793
- * 需要查询的任务类型
794
- recording: 实时录制
795
- transcode: 文档转码
796
- */
797
- TaskType: string;
798
- }
799
- /**
800
- * DescribeUsageSummary返回参数结构体
801
- */
802
- export interface DescribeUsageSummaryResponse {
803
- /**
804
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
805
- */
806
- RequestId?: string;
807
- }
808
- /**
809
- * DescribeRunningTasks请求参数结构体
810
- */
811
- export interface DescribeRunningTasksRequest {
812
- /**
813
- * 应用的SdkAppID
814
- */
815
- SdkAppID: number;
816
- /**
817
- * 指定需要获取的任务类型。
818
- 有效取值如下:
819
- - TranscodeH5: 动态转码任务,文档转HTML5页面
820
- - TranscodeJPG: 静态转码任务,文档转图片
821
- - WhiteboardPush: 白板推流任务
822
- - OnlineRecord: 实时录制任务
823
- */
824
- TaskType: string;
825
- /**
826
- * 分页获取时的任务偏移量,默认为0。
827
- */
828
- Offset?: number;
829
- /**
830
- * 每次获取任务列表时最大获取任务数,默认值为100。
831
- 有效取值范围:[1, 500]
832
- */
833
- Limit?: number;
834
- }
835
- /**
836
- * DescribeApplicationUsage请求参数结构体
837
- */
838
- export interface DescribeApplicationUsageRequest {
839
- /**
840
- * 用量开始时间(包括该时间点)
841
- */
842
- BeginTime: string;
843
- /**
844
- * 用量结束时间(不包括该时间点)
845
- */
846
- EndTime: string;
847
- /**
848
- * 白板子产品名
849
- */
850
- SubProduct: string;
851
- /**
852
- * 时间跨度单位
853
- - MONTHLY:月
854
- - DAILY:天
855
- - MINUTELY:分钟
856
- */
857
- TimeLevel: string;
858
- /**
859
- * 白板应用的SdkAppId
860
- */
861
- SdkAppId?: number;
862
- /**
863
- * true: 返回加权求和后的用量数据
864
- false: 返回原始用量数据
865
- */
866
- IsWeighted?: boolean;
867
- }
868
- /**
869
- * 白板板书结果
870
- */
871
- export interface SnapshotResult {
872
- /**
873
- * 任务执行错误码
874
- 注意:此字段可能返回 null,表示取不到有效值。
875
- */
876
- ErrorCode: string;
877
- /**
878
- * 任务执行错误信息
879
- 注意:此字段可能返回 null,表示取不到有效值。
880
- */
881
- ErrorMessage: string;
882
- /**
883
- * 快照生成图片总数
884
- 注意:此字段可能返回 null,表示取不到有效值。
885
- */
886
- Total: number;
887
- /**
888
- * 快照图片链接列表
889
- 注意:此字段可能返回 null,表示取不到有效值。
890
- */
891
- Snapshots: Array<string>;
892
- }
893
- /**
894
- * SetWarningCallback返回参数结构体
895
- */
896
- export interface SetWarningCallbackResponse {
897
- /**
898
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
899
- */
900
- RequestId?: string;
901
- }
902
- /**
903
- * SetVideoGenerationTaskCallbackKey返回参数结构体
904
- */
905
- export interface SetVideoGenerationTaskCallbackKeyResponse {
906
- /**
907
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
908
- */
909
- RequestId?: string;
910
- }
911
- /**
912
- * DescribeVideoGenerationTask返回参数结构体
913
- */
914
- export interface DescribeVideoGenerationTaskResponse {
915
- /**
916
- * 任务对应的群组Id
917
- */
918
- GroupId?: string;
919
- /**
920
- * 任务对应的房间号
921
- */
922
- RoomId?: number;
923
- /**
924
- * 任务的Id
925
- */
926
- TaskId?: string;
927
- /**
928
- * 已废弃
929
- */
930
- Progress?: number;
931
- /**
932
- * 录制视频生成任务状态
933
- - QUEUED: 正在排队
934
- - PROCESSING: 正在生成视频
935
- - FINISHED: 生成视频结束(成功完成或失败结束,可以通过错误码和错误信息进一步判断)
936
- */
937
- Status?: string;
938
- /**
939
- * 回放视频总时长,单位:毫秒
940
- */
941
- TotalTime?: number;
942
- /**
943
- * 已废弃,请使用`VideoInfoList`参数
944
- */
945
- VideoInfos?: VideoInfo;
946
- /**
947
- * 录制视频生成视频列表
948
- */
949
- VideoInfoList?: Array<VideoInfo>;
950
- /**
951
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
952
- */
953
- RequestId?: string;
954
- }
955
- /**
956
- * SetPPTCheckCallbackKey请求参数结构体
957
- */
958
- export interface SetPPTCheckCallbackKeyRequest {
959
- /**
960
- * 应用的SdkAppId
961
- */
962
- SdkAppId: number;
963
- /**
964
- * 设置回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
965
- */
966
- CallbackKey: string;
967
- }
968
- /**
969
- * 画图数据,Time/Value/Details
970
- */
971
- export interface DataItem {
972
- /**
973
- * 时间
974
- 按月格式yyyy-mm
975
- 按天格式yyyy-mm-dd
976
- 按分钟格式 yyyy-mm-dd HH:MM:SS
977
- */
978
- Time: string;
979
- /**
980
- * 画图所需要的值
981
- */
982
- Value: number;
983
- /**
984
- * 各个具体指标的详情
985
- */
986
- Details: Array<Detail>;
987
- }
988
- /**
989
- * DescribeVideoGenerationTask请求参数结构体
990
- */
991
- export interface DescribeVideoGenerationTaskRequest {
992
- /**
993
- * 客户的SdkAppId
994
- */
995
- SdkAppId: number;
996
- /**
997
- * 录制视频生成的任务Id
998
- */
999
- TaskId: string;
1000
- }
1001
- /**
1002
- * DescribeWhiteboardPushCallback请求参数结构体
1003
- */
1004
- export interface DescribeWhiteboardPushCallbackRequest {
1005
- /**
1006
- * 应用的SdkAppId
1007
- */
1008
- SdkAppId: number;
1009
- }
1010
- /**
1011
- * DescribeOnlineRecord返回参数结构体
1012
- */
1013
- export interface DescribeOnlineRecordResponse {
1014
- /**
1015
- * 录制结束原因,
1016
- - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制
1017
- - USER_CALL: 主动调用了停止录制接口
1018
- - EXCEPTION: 录制异常结束
1019
- - FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。
1020
- */
1021
- FinishReason: string;
1022
- /**
1023
- * 需要查询结果的录制任务Id
1024
- */
1025
- TaskId: string;
1026
- /**
1027
- * 录制任务状态
1028
- - PREPARED: 表示录制正在准备中(进房/启动录制服务等操作)
1029
- - RECORDING: 表示录制已开始
1030
- - PAUSED: 表示录制已暂停
1031
- - STOPPED: 表示录制已停止,正在处理并上传视频
1032
- - FINISHED: 表示视频处理并上传完成,成功生成录制结果
1033
- */
1034
- Status: string;
1035
- /**
1036
- * 房间号
1037
- */
1038
- RoomId: number;
1039
- /**
1040
- * 白板的群组 Id
1041
- */
1042
- GroupId: string;
1043
- /**
1044
- * 录制用户Id
1045
- */
1046
- RecordUserId: string;
1047
- /**
1048
- * 实际开始录制时间,Unix 时间戳,单位秒
1049
- */
1050
- RecordStartTime: number;
1051
- /**
1052
- * 实际停止录制时间,Unix 时间戳,单位秒
1053
- */
1054
- RecordStopTime: number;
1055
- /**
1056
- * 回放视频总时长(单位:毫秒)
1057
- */
1058
- TotalTime: number;
1059
- /**
1060
- * 录制过程中出现异常的次数
639
+ * 录制过程中出现异常的次数
1061
640
  */
1062
641
  ExceptionCnt: number;
1063
642
  /**
@@ -1096,31 +675,6 @@ export interface DescribeTranscodeRequest {
1096
675
  */
1097
676
  TaskId: string;
1098
677
  }
1099
- /**
1100
- * DescribeBoardSDKLog返回参数结构体
1101
- */
1102
- export interface DescribeBoardSDKLogResponse {
1103
- /**
1104
- * 总共能查到日志条数
1105
- */
1106
- Total: number;
1107
- /**
1108
- * 日志详细内容
1109
- */
1110
- Sources: Array<string>;
1111
- /**
1112
- * 按时间段聚合后每个时间段的日志条数
1113
- */
1114
- Buckets: Array<string>;
1115
- /**
1116
- * 用于递归拉取的上下文Key,下一次请求的时候带上
1117
- */
1118
- Context: string;
1119
- /**
1120
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1121
- */
1122
- RequestId?: string;
1123
- }
1124
678
  /**
1125
679
  * SetOnlineRecordCallback返回参数结构体
1126
680
  */
@@ -1165,79 +719,17 @@ export interface DescribeTranscodeCallbackResponse {
1165
719
  RequestId?: string;
1166
720
  }
1167
721
  /**
1168
- * DescribeUserList返回参数结构体
1169
- */
1170
- export interface DescribeUserListResponse {
1171
- /**
1172
- * 房间内的用户列表
1173
- */
1174
- UserList: Array<UserListItem>;
1175
- /**
1176
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1177
- */
1178
- RequestId?: string;
1179
- }
1180
- /**
1181
- * ModifyAutoRenewFlag返回参数结构体
1182
- */
1183
- export interface ModifyAutoRenewFlagResponse {
1184
- /**
1185
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1186
- */
1187
- RequestId?: string;
1188
- }
1189
- /**
1190
- * DescribeApplicationInfos返回参数结构体
1191
- */
1192
- export interface DescribeApplicationInfosResponse {
1193
- /**
1194
- * 应用列表
1195
- */
1196
- ApplicationInfos: Array<ApplicationItem>;
1197
- /**
1198
- * 是否包含所有的应用,0-不包含,1-包含
1199
- */
1200
- AllOption: number;
1201
- /**
1202
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1203
- */
1204
- RequestId?: string;
1205
- }
1206
- /**
1207
- * DescribeTIWDailyUsage请求参数结构体
722
+ * SetOnlineRecordCallback请求参数结构体
1208
723
  */
1209
- export interface DescribeTIWDailyUsageRequest {
724
+ export interface SetOnlineRecordCallbackRequest {
1210
725
  /**
1211
- * 互动白板应用SdkAppId
726
+ * 客户的SdkAppId
1212
727
  */
1213
728
  SdkAppId: number;
1214
729
  /**
1215
- * 需要查询的子产品用量,支持传入以下值
1216
- - sp_tiw_board: 互动白板时长,单位为分钟
1217
- - sp_tiw_dt: 动态转码页数,单位页
1218
- - sp_tiw_st: 静态转码页数,单位页
1219
- - sp_tiw_ric: 实时录制时长,单位分钟
1220
-
1221
- 注意:动态转码以1:8的比例计算文档转码页数,静态转码以1:1的比例计算文档转码页数
1222
- */
1223
- SubProduct: string;
1224
- /**
1225
- * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
1226
- */
1227
- StartTime: string;
1228
- /**
1229
- * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
1230
- */
1231
- EndTime: string;
1232
- }
1233
- /**
1234
- * DescribeWhiteboardBucketConfig返回参数结构体
1235
- */
1236
- export interface DescribeWhiteboardBucketConfigResponse {
1237
- /**
1238
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
730
+ * 实时录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40258
1239
731
  */
1240
- RequestId?: string;
732
+ Callback: string;
1241
733
  }
1242
734
  /**
1243
735
  * 混流配置
@@ -1268,43 +760,6 @@ export interface MixStream {
1268
760
  */
1269
761
  Custom?: CustomLayout;
1270
762
  }
1271
- /**
1272
- * DescribeBoardSDKLog请求参数结构体
1273
- */
1274
- export interface DescribeBoardSDKLogRequest {
1275
- /**
1276
- * 白板应用的SdkAppId
1277
- */
1278
- SdkAppId: number;
1279
- /**
1280
- * 需要查询日志的白板房间号
1281
- */
1282
- RoomId: string;
1283
- /**
1284
- * 需要查询日志的用户ID
1285
- */
1286
- UserId: string;
1287
- /**
1288
- * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
1289
- */
1290
- TimeRange: Array<number | bigint>;
1291
- /**
1292
- * 聚合日志条数查询的桶的时间范围,如5m, 1h, 4h等
1293
- */
1294
- AggregationInterval: string;
1295
- /**
1296
- * 额外的查询条件
1297
- */
1298
- Query?: string;
1299
- /**
1300
- * 是否按时间升序排列
1301
- */
1302
- Ascending?: boolean;
1303
- /**
1304
- * 用于递归拉取的上下文Key,在上一次请求中返回
1305
- */
1306
- Context?: string;
1307
- }
1308
763
  /**
1309
764
  * DescribeVideoGenerationTaskCallback请求参数结构体
1310
765
  */
@@ -1314,19 +769,6 @@ export interface DescribeVideoGenerationTaskCallbackRequest {
1314
769
  */
1315
770
  SdkAppId: number;
1316
771
  }
1317
- /**
1318
- * SetVideoGenerationTaskCallback请求参数结构体
1319
- */
1320
- export interface SetVideoGenerationTaskCallbackRequest {
1321
- /**
1322
- * 客户的SdkAppId
1323
- */
1324
- SdkAppId: number;
1325
- /**
1326
- * 课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头
1327
- */
1328
- Callback: string;
1329
- }
1330
772
  /**
1331
773
  * SetWhiteboardPushCallbackKey请求参数结构体
1332
774
  */
@@ -1340,14 +782,6 @@ export interface SetWhiteboardPushCallbackKeyRequest {
1340
782
  */
1341
783
  CallbackKey: string;
1342
784
  }
1343
- /**
1344
- * DescribeTranscodeSearch请求参数结构体
1345
- */
1346
- export declare type DescribeTranscodeSearchRequest = null;
1347
- /**
1348
- * ApplyTiwTrial请求参数结构体
1349
- */
1350
- export declare type ApplyTiwTrialRequest = null;
1351
785
  /**
1352
786
  * 鉴权参数
1353
787
  */
@@ -1365,23 +799,6 @@ export interface AuthParam {
1365
799
  */
1366
800
  UserSig: string;
1367
801
  }
1368
- /**
1369
- * 计费用量数据里,带不同指标Tag的详情
1370
- */
1371
- export interface Detail {
1372
- /**
1373
- * 用量指标
1374
- */
1375
- TagName: string;
1376
- /**
1377
- * 用量权重
1378
- */
1379
- Weight: number;
1380
- /**
1381
- * 用量的值
1382
- */
1383
- Value: number;
1384
- }
1385
802
  /**
1386
803
  * StartWhiteboardPush请求参数结构体
1387
804
  */
@@ -1399,7 +816,7 @@ export interface StartWhiteboardPushRequest {
1399
816
  RoomId: number;
1400
817
  /**
1401
818
  * 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。
1402
- 用户ID最大长度不能大于60个字节,该用户ID必须是一个单独的未同时在其他地方使用的用户ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该用户ID和其他地方同时在使用的用户ID重复,会导致白板推流服务与其他使用场景帐号互踢,影响正常推流。
819
+ 用户ID最大长度不能大于60个字节,该用户ID必须是一个单独的未同时在其他地方使用的用户ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该用户ID和其他地方同时在使用的用户ID重复,会导致白板推流服务与其他使用场景账号互踢,影响正常推流。
1403
820
  */
1404
821
  PushUserId: string;
1405
822
  /**
@@ -1526,29 +943,11 @@ export interface StartWhiteboardPushRequest {
1526
943
  */
1527
944
  TRTCEnterRoomMode?: string;
1528
945
  /**
1529
- * 白板进行信令同步的 IM 群组 ID。
1530
- 在没有指定`GroupId`的情况下,白板推流服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。
1531
- 在指定了`GroupId`的情况下,白板推流将优先`GroupId`作为同步白板信令的群组ID。请在开始推流前确保指定的IM群组已创建完成,否则会导致推流失败。
1532
- */
1533
- GroupId?: string;
1534
- }
1535
- /**
1536
- * SetWarningCallback请求参数结构体
1537
- */
1538
- export interface SetWarningCallbackRequest {
1539
- /**
1540
- * 客户的SdkAppId
1541
- */
1542
- SdkAppId: number;
1543
- /**
1544
- * 告警回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持http或https协议,即回调地址以http://或https://开头。
1545
- 回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/90112
1546
- */
1547
- Callback: string;
1548
- /**
1549
- * 设置告警回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
946
+ * 白板进行信令同步的 IM 群组 ID。
947
+ 在没有指定`GroupId`的情况下,白板推流服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。
948
+ 在指定了`GroupId`的情况下,白板推流将优先`GroupId`作为同步白板信令的群组ID。请在开始推流前确保指定的IM群组已创建完成,否则会导致推流失败。
1550
949
  */
1551
- CallbackKey: string;
950
+ GroupId?: string;
1552
951
  }
1553
952
  /**
1554
953
  * DescribeVideoGenerationTaskCallback返回参数结构体
@@ -1567,55 +966,6 @@ export interface DescribeVideoGenerationTaskCallbackResponse {
1567
966
  */
1568
967
  RequestId?: string;
1569
968
  }
1570
- /**
1571
- * 实时录制任务搜索结果
1572
- */
1573
- export interface WhiteboardPushTaskSearchResult {
1574
- /**
1575
- * 任务唯一ID
1576
- */
1577
- TaskId: string;
1578
- /**
1579
- * 白板推流任务状态
1580
- - PREPARED: 推流在准备阶段
1581
- - PUSHING: 正在推流
1582
- - STOPPED:推流已停止
1583
- */
1584
- Status: string;
1585
- /**
1586
- * 白板推流房间号
1587
- */
1588
- RoomId: number;
1589
- /**
1590
- * 任务创建时间
1591
- */
1592
- CreateTime: string;
1593
- /**
1594
- * 用户应用SdkAppId
1595
- */
1596
- SdkAppId: number;
1597
- /**
1598
- * 白板推流结果
1599
- */
1600
- Result: WhiteboardPushResult;
1601
- /**
1602
- * 白板推流用户ID
1603
- */
1604
- PushUserId: string;
1605
- }
1606
- /**
1607
- * ModifyWhiteboardApplicationConfig请求参数结构体
1608
- */
1609
- export interface ModifyWhiteboardApplicationConfigRequest {
1610
- /**
1611
- * 客户的SdkAppId
1612
- */
1613
- SdkAppId: number;
1614
- /**
1615
- * 白板应用任务相关配置
1616
- */
1617
- Configs: Array<WhiteboardApplicationConfig>;
1618
- }
1619
969
  /**
1620
970
  * 白板推流备份相关请求参数
1621
971
  */
@@ -1654,7 +1004,7 @@ export interface StartOnlineRecordRequest {
1654
1004
  /**
1655
1005
  * 需要录制的白板房间号,取值范围: (1, 4294967295)。
1656
1006
 
1657
- 1. 在没有指定`GroupId`的情况下,实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID(比如`RoomId`为1234,则IM群组ID为"1234"),并加群进行信令同步,请在开始录制前确保相应IM群组已创建完成,否则会导致录制失败。
1007
+ 1. 在没有指定`GroupId`的情况下,实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID(比如`RoomId`为12358,则IM群组ID为"12358"),并加群进行信令同步,请在开始录制前确保相应IM群组已创建完成,否则会导致录制失败。
1658
1008
  2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下,默认会以`RoomId`作为TRTC房间号进房拉流进行录制。
1659
1009
  */
1660
1010
  RoomId: number;
@@ -1716,366 +1066,143 @@ export interface StartOnlineRecordRequest {
1716
1066
  */
1717
1067
  ChatGroupId?: string;
1718
1068
  /**
1719
- * 自动停止录制超时时间,单位秒,取值范围[300, 86400], 默认值为300秒。
1720
-
1721
- 当超过设定时间房间内没有音视频上行且没有白板操作的时候,录制服务会自动停止当前录制任务。
1722
- */
1723
- AutoStopTimeout?: number;
1724
- /**
1725
- * 内部参数,可忽略
1726
- */
1727
- ExtraData?: string;
1728
- /**
1729
- * TRTC数字类型房间号,取值范围: (1, 4294967295)。
1730
-
1731
- 在同时指定了`RoomId`与`TRTCRoomId`的情况下,优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。
1732
-
1733
- 当指定了`TRTCRoomIdStr`的情况下,此字段将被忽略。
1734
- */
1735
- TRTCRoomId?: number;
1736
- /**
1737
- * TRTC字符串类型房间号。
1738
-
1739
- 在指定了`TRTCRoomIdStr`的情况下,会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。
1740
- */
1741
- TRTCRoomIdStr?: string;
1742
- }
1743
- /**
1744
- * DescribeUserStatus请求参数结构体
1745
- */
1746
- export declare type DescribeUserStatusRequest = null;
1747
- /**
1748
- * DescribeOnlineRecordCallback请求参数结构体
1749
- */
1750
- export interface DescribeOnlineRecordCallbackRequest {
1751
- /**
1752
- * 应用的SdkAppId
1753
- */
1754
- SdkAppId: number;
1755
- }
1756
- /**
1757
- * 实时录制任务搜索结果
1758
- */
1759
- export interface RecordTaskSearchResult {
1760
- /**
1761
- * 任务唯一ID
1762
- */
1763
- TaskId: string;
1764
- /**
1765
- * 实时录制任务状态
1766
- - PAUSED: 录制已暂停
1767
- - PREPARED: 录制在准备阶段
1768
- - RECORDING: 正在录制
1769
- - STOPPED:录制已停止
1770
- - FINISHED: 录制已结束
1771
- */
1772
- Status: string;
1773
- /**
1774
- * 实时录制房间号
1775
- */
1776
- RoomId: number;
1777
- /**
1778
- * 任务创建时间
1779
- */
1780
- CreateTime: string;
1781
- /**
1782
- * 用户应用SdkAppId
1783
- */
1784
- SdkAppId: number;
1785
- /**
1786
- * 实时录制结果
1787
- */
1788
- Result: RecordTaskResult;
1789
- }
1790
- /**
1791
- * DescribeWarningCallback请求参数结构体
1792
- */
1793
- export interface DescribeWarningCallbackRequest {
1794
- /**
1795
- * 应用的SdkAppId
1796
- */
1797
- SdkAppId: number;
1798
- }
1799
- /**
1800
- * SetTranscodeCallback返回参数结构体
1801
- */
1802
- export interface SetTranscodeCallbackResponse {
1803
- /**
1804
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1805
- */
1806
- RequestId?: string;
1807
- }
1808
- /**
1809
- * StopOnlineRecord请求参数结构体
1810
- */
1811
- export interface StopOnlineRecordRequest {
1812
- /**
1813
- * 客户的SdkAppId
1814
- */
1815
- SdkAppId: number;
1816
- /**
1817
- * 需要停止录制的任务 Id
1818
- */
1819
- TaskId: string;
1820
- }
1821
- /**
1822
- * SetVideoGenerationTaskCallback返回参数结构体
1823
- */
1824
- export interface SetVideoGenerationTaskCallbackResponse {
1825
- /**
1826
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1827
- */
1828
- RequestId?: string;
1829
- }
1830
- /**
1831
- * 白板应用
1832
- */
1833
- export interface ApplicationItem {
1834
- /**
1835
- * 应用SdkAppId
1836
- */
1837
- SdkAppId: number;
1838
- /**
1839
- * 应用名
1840
- */
1841
- AppName: string;
1842
- /**
1843
- * 创建时间
1844
- */
1845
- CreateTime: string;
1846
- /**
1847
- * 标签列表
1848
- */
1849
- TagList: Array<Tag>;
1850
- }
1851
- /**
1852
- * DescribeTranscodeByUrl返回参数结构体
1853
- */
1854
- export interface DescribeTranscodeByUrlResponse {
1855
- /**
1856
- * 转码的当前进度,取值范围为0~100
1857
- */
1858
- Progress?: number;
1859
- /**
1860
- * 任务的当前状态
1861
- - QUEUED: 正在排队等待转换
1862
- - PROCESSING: 转换中
1863
- - FINISHED: 转换完成
1864
- - EXCEPTION: 转换异常
1865
- */
1866
- Status?: string;
1867
- /**
1868
- * 转码任务的唯一标识Id
1869
- */
1870
- TaskId?: string;
1871
- /**
1872
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1873
- */
1874
- RequestId?: string;
1875
- }
1876
- /**
1877
- * CreatePPTCheckTask请求参数结构体
1878
- */
1879
- export interface CreatePPTCheckTaskRequest {
1880
- /**
1881
- * 客户的SdkAppId
1882
- */
1883
- SdkAppId: number;
1884
- /**
1885
- * 经过URL编码后的PPT文件地址。URL 编码会将字符转换为可通过因特网传输的格式,例如文档地址为http://example.com/测试.pptx,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pptx。为了提高URL解析的成功率,请对URL进行编码。
1886
- */
1887
- Url: string;
1888
- /**
1889
- * 是否对不支持元素开启自动处理的功能,默认不开启。
1890
- true -- 开启
1891
- false -- 不开启
1892
-
1893
- 当设置为`true`时,可配合`AutoHandleUnsupportedElementTypes`参数使用,具体有哪些不兼容元素类型,可参考`AutoHandleUnsupportedElementTypes`参数的说明。
1894
- */
1895
- AutoHandleUnsupportedElement?: boolean;
1896
- /**
1897
- * 此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。
1898
-
1899
- 指定需要自动处理的不兼容元素类型,默认对所有不兼容的元素进行自动处理。
1900
-
1901
- 目前支持检测的不兼容元素类型及对应的自动处理方式如下:
1902
- 0: 不支持的墨迹类型
1903
- -- 自动处理方式:移除墨迹
1904
-
1905
- 1: 自动翻页
1906
- -- 自动处理方式:移除自动翻页设置,并修改为单击切换
1907
-
1908
- 2: 已损坏音视频
1909
- -- 自动处理方式:移除对损坏音视频的引用
1910
-
1911
- 3: 不可访问资源
1912
- -- 自动处理方式:移除对不可访问的资源的引用
1913
-
1914
- 4: 只读文件
1915
- -- 自动处理方式:移除只读设置
1916
-
1917
- 5: 不支持的元素编辑锁定状态
1918
- -- 自动处理方式:移除锁定状态
1919
-
1920
- 6: 可能有兼容问题的字体
1921
- -- 自动处理方式: 不支持处理
1922
-
1923
- 7: 设置了柔化边缘的GIF图片
1924
- -- 自动处理方式:移除柔化边缘设置
1925
-
1926
- 8: 存在不兼容的空格下划线
1927
- -- 自动处理方式:通过调整空格下划线前后文本的字体语言体系,保证空格下划线表现正常
1928
-
1929
- 9: 存在设置了分段动画的数学公式和文本混合内容
1930
- -- 自动处理方式: 不支持处理
1931
-
1932
- 10: 存在设置了分段动画的渐变色文本
1933
- -- 自动处理方式: 不支持处理
1934
-
1935
- 11: 存在不兼容的分散对齐方式
1936
- -- 自动处理方式: 不支持处理
1937
-
1938
- 12: 存在不兼容的多倍行距设置
1939
- -- 自动处理方式: 不支持处理
1940
- */
1941
- AutoHandleUnsupportedElementTypes?: Array<number | bigint>;
1942
- }
1943
- /**
1944
- * 视频信息
1945
- */
1946
- export interface VideoInfo {
1947
- /**
1948
- * 视频开始播放的时间(单位:毫秒)
1949
- */
1950
- VideoPlayTime: number;
1951
- /**
1952
- * 视频大小(字节)
1953
- */
1954
- VideoSize: number;
1955
- /**
1956
- * 视频格式
1957
- */
1958
- VideoFormat: string;
1959
- /**
1960
- * 视频播放时长(单位:毫秒)
1069
+ * 自动停止录制超时时间,单位秒,取值范围[300, 86400], 默认值为300秒。
1070
+
1071
+ 当超过设定时间房间内没有音视频上行且没有白板操作的时候,录制服务会自动停止当前录制任务。
1961
1072
  */
1962
- VideoDuration: number;
1073
+ AutoStopTimeout?: number;
1963
1074
  /**
1964
- * 视频文件URL
1075
+ * 内部参数,可忽略
1965
1076
  */
1966
- VideoUrl: string;
1077
+ ExtraData?: string;
1967
1078
  /**
1968
- * 视频文件Id
1079
+ * TRTC数字类型房间号,取值范围: (1, 4294967295)。
1080
+
1081
+ 在同时指定了`RoomId`与`TRTCRoomId`的情况下,优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。
1082
+
1083
+ 当指定了`TRTCRoomIdStr`的情况下,此字段将被忽略。
1969
1084
  */
1970
- VideoId: string;
1085
+ TRTCRoomId?: number;
1971
1086
  /**
1972
- * 视频流类型
1973
- - 0:摄像头视频
1974
- - 1:屏幕分享视频
1975
- - 2:白板视频
1976
- - 3:混流视频
1977
- - 4:纯音频(mp3)
1087
+ * TRTC字符串类型房间号。
1088
+
1089
+ 在指定了`TRTCRoomIdStr`的情况下,会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。
1978
1090
  */
1979
- VideoType: number;
1091
+ TRTCRoomIdStr?: string;
1092
+ }
1093
+ /**
1094
+ * DescribeOnlineRecordCallback请求参数结构体
1095
+ */
1096
+ export interface DescribeOnlineRecordCallbackRequest {
1980
1097
  /**
1981
- * 摄像头/屏幕分享视频所属用户的 Id(白板视频为空、混流视频tic_mixstream_房间号_混流布局类型、辅路视频tic_substream_用户Id)
1098
+ * 应用的SdkAppId
1982
1099
  */
1983
- UserId: string;
1100
+ SdkAppId: number;
1101
+ }
1102
+ /**
1103
+ * DescribeWarningCallback请求参数结构体
1104
+ */
1105
+ export interface DescribeWarningCallbackRequest {
1984
1106
  /**
1985
- * 视频分辨率的宽
1107
+ * 应用的SdkAppId
1986
1108
  */
1987
- Width: number;
1109
+ SdkAppId: number;
1110
+ }
1111
+ /**
1112
+ * SetTranscodeCallback返回参数结构体
1113
+ */
1114
+ export interface SetTranscodeCallbackResponse {
1988
1115
  /**
1989
- * 视频分辨率的高
1116
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1990
1117
  */
1991
- Height: number;
1118
+ RequestId?: string;
1992
1119
  }
1993
1120
  /**
1994
- * SetWhiteboardPushCallback请求参数结构体
1121
+ * StopOnlineRecord请求参数结构体
1995
1122
  */
1996
- export interface SetWhiteboardPushCallbackRequest {
1123
+ export interface StopOnlineRecordRequest {
1997
1124
  /**
1998
1125
  * 客户的SdkAppId
1999
1126
  */
2000
1127
  SdkAppId: number;
2001
1128
  /**
2002
- * 白板推流任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40257
1129
+ * 需要停止录制的任务 Id
2003
1130
  */
2004
- Callback: string;
1131
+ TaskId: string;
2005
1132
  }
2006
1133
  /**
2007
- * DescribeTIWDailyUsage返回参数结构体
1134
+ * SetVideoGenerationTaskCallback返回参数结构体
2008
1135
  */
2009
- export interface DescribeTIWDailyUsageResponse {
2010
- /**
2011
- * 指定区间指定产品的用量汇总
2012
- */
2013
- Usages: Array<UsageDataItem>;
1136
+ export interface SetVideoGenerationTaskCallbackResponse {
2014
1137
  /**
2015
1138
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2016
1139
  */
2017
1140
  RequestId?: string;
2018
1141
  }
2019
1142
  /**
2020
- * 实时录制视频拼接参数
1143
+ * DescribeTranscodeByUrl返回参数结构体
2021
1144
  */
2022
- export interface Concat {
1145
+ export interface DescribeTranscodeByUrlResponse {
2023
1146
  /**
2024
- * 是否开启拼接功能
2025
- 在开启了视频拼接功能的情况下,实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频
1147
+ * 转码的当前进度,取值范围为0~100
2026
1148
  */
2027
- Enabled: boolean;
1149
+ Progress?: number;
2028
1150
  /**
2029
- * 视频拼接时使用的垫片图片下载地址,不填默认用全黑的图片进行视频垫片
1151
+ * 任务的当前状态
1152
+ - QUEUED: 正在排队等待转换
1153
+ - PROCESSING: 转换中
1154
+ - FINISHED: 转换完成
1155
+ - EXCEPTION: 转换异常
2030
1156
  */
2031
- Image?: string;
1157
+ Status?: string;
1158
+ /**
1159
+ * 转码任务的唯一标识Id
1160
+ */
1161
+ TaskId?: string;
1162
+ /**
1163
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1164
+ */
1165
+ RequestId?: string;
2032
1166
  }
2033
1167
  /**
2034
- * DescribeWhiteboardApplicationConfig请求参数结构体
1168
+ * StopWhiteboardPush请求参数结构体
2035
1169
  */
2036
- export interface DescribeWhiteboardApplicationConfigRequest {
1170
+ export interface StopWhiteboardPushRequest {
2037
1171
  /**
2038
1172
  * 客户的SdkAppId
2039
1173
  */
2040
1174
  SdkAppId: number;
2041
1175
  /**
2042
- * 需要查询的任务类型
2043
- recording: 实时录制
2044
- transcode: 文档转码
2045
- */
2046
- TaskTypes: Array<string>;
2047
- /**
2048
- * 需要查询配置的SdkAppId列表
1176
+ * 需要停止的白板推流任务 Id
2049
1177
  */
2050
- SdkAppIds?: Array<number | bigint>;
1178
+ TaskId: string;
2051
1179
  }
2052
1180
  /**
2053
- * 互动白板房间用量信息
1181
+ * SetWhiteboardPushCallback请求参数结构体
2054
1182
  */
2055
- export interface RoomUsageDataItem {
2056
- /**
2057
- * 日期,格式为YYYY-MM-DD
2058
- */
2059
- Time: string;
1183
+ export interface SetWhiteboardPushCallbackRequest {
2060
1184
  /**
2061
- * 白板应用SDKAppID
1185
+ * 客户的SdkAppId
2062
1186
  */
2063
1187
  SdkAppId: number;
2064
1188
  /**
2065
- * 互动白板子产品,请求参数传入的一致
2066
- - sp_tiw_board: 互动白板时长
2067
- - sp_tiw_ric: 实时录制时长
1189
+ * 白板推流任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40257
2068
1190
  */
2069
- SubProduct: string;
1191
+ Callback: string;
1192
+ }
1193
+ /**
1194
+ * 实时录制视频拼接参数
1195
+ */
1196
+ export interface Concat {
2070
1197
  /**
2071
- * 用量值
2072
- - 白板时长、实时录制时长单位为分钟
1198
+ * 是否开启拼接功能
1199
+ 在开启了视频拼接功能的情况下,实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频
2073
1200
  */
2074
- Value: number;
1201
+ Enabled: boolean;
2075
1202
  /**
2076
- * 互动白板房间号
1203
+ * 视频拼接时使用的垫片图片下载地址,不填默认用全黑的图片进行视频垫片
2077
1204
  */
2078
- RoomID: number;
1205
+ Image?: string;
2079
1206
  }
2080
1207
  /**
2081
1208
  * 板书文件存储cos参数
@@ -2125,35 +1252,79 @@ export interface DescribePPTCheckCallbackRequest {
2125
1252
  SdkAppId: number;
2126
1253
  }
2127
1254
  /**
2128
- * 实时录制白板参数,例如白板宽高等
1255
+ * CreatePPTCheckTask请求参数结构体
2129
1256
  */
2130
- export interface Whiteboard {
1257
+ export interface CreatePPTCheckTaskRequest {
2131
1258
  /**
2132
- * 实时录制结果里白板视频宽,取值必须大于等于2,默认为1280
1259
+ * 客户的SdkAppId
2133
1260
  */
2134
- Width?: number;
1261
+ SdkAppId: number;
2135
1262
  /**
2136
- * 实时录制结果里白板视频高,取值必须大于等于2,默认为960
1263
+ * 经过URL编码后的PPT文件地址。URL 编码会将字符转换为可通过因特网传输的格式,例如文档地址为http://example.com/测试.pptx,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pptx。为了提高URL解析的成功率,请对URL进行编码。
2137
1264
  */
2138
- Height?: number;
1265
+ Url: string;
2139
1266
  /**
2140
- * 白板初始化参数,透传到白板 SDK
1267
+ * 是否对不支持元素开启自动处理的功能,默认不开启。
1268
+ true -- 开启
1269
+ false -- 不开启
1270
+
1271
+ 当设置为`true`时,可配合`AutoHandleUnsupportedElementTypes`参数使用,具体有哪些不兼容元素类型,可参考`AutoHandleUnsupportedElementTypes`参数的说明。
2141
1272
  */
2142
- InitParam?: string;
2143
- }
2144
- /**
2145
- * PauseOnlineRecord返回参数结构体
2146
- */
2147
- export interface PauseOnlineRecordResponse {
1273
+ AutoHandleUnsupportedElement?: boolean;
2148
1274
  /**
2149
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1275
+ * 此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。
1276
+
1277
+ 指定需要自动处理的不兼容元素类型,默认对所有不兼容的元素进行自动处理。
1278
+
1279
+ 目前支持检测的不兼容元素类型及对应的自动处理方式如下:
1280
+ 0: 不支持的墨迹类型
1281
+ -- 自动处理方式:移除墨迹
1282
+
1283
+ 1: 自动翻页
1284
+ -- 自动处理方式:移除自动翻页设置,并修改为单击切换
1285
+
1286
+ 2: 已损坏音视频
1287
+ -- 自动处理方式:移除对损坏音视频的引用
1288
+
1289
+ 3: 不可访问资源
1290
+ -- 自动处理方式:移除对不可访问的资源的引用
1291
+
1292
+ 4: 只读文件
1293
+ -- 自动处理方式:移除只读设置
1294
+
1295
+ 5: 不支持的元素编辑锁定状态
1296
+ -- 自动处理方式:移除锁定状态
1297
+
1298
+ 6: 可能有兼容问题的字体
1299
+ -- 自动处理方式: 不支持处理
1300
+
1301
+ 7: 设置了柔化边缘的GIF图片
1302
+ -- 自动处理方式:移除柔化边缘设置
1303
+
1304
+ 8: 存在不兼容的空格下划线
1305
+ -- 自动处理方式:通过调整空格下划线前后文本的字体语言体系,保证空格下划线表现正常
1306
+
1307
+ 9: 存在设置了分段动画的数学公式和文本混合内容
1308
+ -- 自动处理方式: 不支持处理
1309
+
1310
+ 10: 存在设置了分段动画的渐变色文本
1311
+ -- 自动处理方式: 不支持处理
1312
+
1313
+ 11: 存在不兼容的分散对齐方式
1314
+ -- 自动处理方式: 不支持处理
1315
+
1316
+ 12: 存在不兼容的多倍行距设置
1317
+ -- 自动处理方式: 不支持处理
1318
+
1319
+ 13: 存在带有特殊符号内容的datetime类型的a:fld标签元素
1320
+ -- 自动处理方式: a:fld标签替换为普通文本
2150
1321
  */
2151
- RequestId?: string;
1322
+ AutoHandleUnsupportedElementTypes?: Array<number | bigint>;
2152
1323
  }
2153
1324
  /**
2154
- * ModifyWhiteboardApplicationConfig返回参数结构体
1325
+ * PauseOnlineRecord返回参数结构体
2155
1326
  */
2156
- export interface ModifyWhiteboardApplicationConfigResponse {
1327
+ export interface PauseOnlineRecordResponse {
2157
1328
  /**
2158
1329
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2159
1330
  */
@@ -2290,19 +1461,6 @@ export interface SetOnlineRecordCallbackKeyRequest {
2290
1461
  */
2291
1462
  CallbackKey: string;
2292
1463
  }
2293
- /**
2294
- * ModifyApplication请求参数结构体
2295
- */
2296
- export interface ModifyApplicationRequest {
2297
- /**
2298
- * 应用SdkAppId
2299
- */
2300
- SdkAppId: number;
2301
- /**
2302
- * App名字
2303
- */
2304
- AppName: string;
2305
- }
2306
1464
  /**
2307
1465
  * DescribeOnlineRecordCallback返回参数结构体
2308
1466
  */
@@ -2361,117 +1519,18 @@ export interface RecordControl {
2361
1519
  StreamControls?: Array<StreamControl>;
2362
1520
  }
2363
1521
  /**
2364
- * DescribeQualityMetrics返回参数结构体
2365
- */
2366
- export interface DescribeQualityMetricsResponse {
2367
- /**
2368
- * 输入的查询指标
2369
- */
2370
- Metric: string;
2371
- /**
2372
- * 时间序列
2373
- */
2374
- Content: Array<TimeValue>;
2375
- /**
2376
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2377
- */
2378
- RequestId?: string;
2379
- }
2380
- /**
2381
- * 转码任务结果
2382
- */
2383
- export interface TranscodeTaskResult {
2384
- /**
2385
- * 转码结果地址
2386
- */
2387
- ResultUrl: string;
2388
- /**
2389
- * 分辨率
2390
- */
2391
- Resolution: string;
2392
- /**
2393
- * 标题(一般为文件名)
2394
- */
2395
- Title: string;
2396
- /**
2397
- * 转码页数
2398
- */
2399
- Pages: number;
2400
- /**
2401
- * 缩略图URL前缀,比如,该URL前缀为http://example.com/g0jb42ps49vtebjshilb/,那么动态PPT第1页的缩略图URL为
2402
- http://example.com/g0jb42ps49vtebjshilb/1.jpg,其它页以此类推
2403
-
2404
- 如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串
2405
- */
2406
- ThumbnailUrl: string;
2407
- /**
2408
- * 动态转码缩略图生成分辨率
2409
- */
2410
- ThumbnailResolution: string;
2411
- /**
2412
- * 转码压缩文件下载的URL,如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式,该参数为空字符串
2413
- */
2414
- CompressFileUrl: string;
2415
- /**
2416
- * 任务失败错误码
2417
- */
2418
- ErrorCode: number;
2419
- /**
2420
- * 任务失败错误信息
2421
- */
2422
- ErrorMsg: string;
2423
- }
2424
- /**
2425
- * DescribeIMApplications返回参数结构体
2426
- */
2427
- export interface DescribeIMApplicationsResponse {
2428
- /**
2429
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2430
- */
2431
- RequestId?: string;
2432
- }
2433
- /**
2434
- * SetOnlineRecordCallback请求参数结构体
2435
- */
2436
- export interface SetOnlineRecordCallbackRequest {
2437
- /**
2438
- * 客户的SdkAppId
2439
- */
2440
- SdkAppId: number;
2441
- /**
2442
- * 实时录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40258
2443
- */
2444
- Callback: string;
2445
- }
2446
- /**
2447
- * DescribeUserList请求参数结构体
1522
+ * SetPPTCheckCallbackKey请求参数结构体
2448
1523
  */
2449
- export interface DescribeUserListRequest {
1524
+ export interface SetPPTCheckCallbackKeyRequest {
2450
1525
  /**
2451
- * 白板应用的SdkAppId
1526
+ * 应用的SdkAppId
2452
1527
  */
2453
1528
  SdkAppId: number;
2454
1529
  /**
2455
- * 需要查询用户列表的白板房间号
2456
- */
2457
- RoomId: string;
2458
- /**
2459
- * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
2460
- */
2461
- TimeRange: Array<number | bigint>;
2462
- /**
2463
- * 额外的查询条件
2464
- */
2465
- Query?: string;
2466
- /**
2467
- * 返回最大的数据条数,默认1000
1530
+ * 设置回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
2468
1531
  */
2469
- MaxSize?: number;
1532
+ CallbackKey: string;
2470
1533
  }
2471
- /**
2472
- * DescribeUserResources请求参数结构体
2473
- */
2474
- export declare type DescribeUserResourcesRequest = null;
2475
1534
  /**
2476
1535
  * SetPPTCheckCallback返回参数结构体
2477
1536
  */
@@ -2481,19 +1540,6 @@ export interface SetPPTCheckCallbackResponse {
2481
1540
  */
2482
1541
  RequestId?: string;
2483
1542
  }
2484
- /**
2485
- * DescribeOnlineRecord请求参数结构体
2486
- */
2487
- export interface DescribeOnlineRecordRequest {
2488
- /**
2489
- * 客户的SdkAppId
2490
- */
2491
- SdkAppId: number;
2492
- /**
2493
- * 实时录制任务Id
2494
- */
2495
- TaskId: string;
2496
- }
2497
1543
  /**
2498
1544
  * StopWhiteboardPush返回参数结构体
2499
1545
  */
@@ -2541,19 +1587,6 @@ export interface ExcelParam {
2541
1587
  */
2542
1588
  PaperDirection?: number;
2543
1589
  }
2544
- /**
2545
- * DescribePostpaidUsage请求参数结构体
2546
- */
2547
- export interface DescribePostpaidUsageRequest {
2548
- /**
2549
- * 开始时间
2550
- */
2551
- BeginTime: string;
2552
- /**
2553
- * 结束时间
2554
- */
2555
- EndTime: string;
2556
- }
2557
1590
  /**
2558
1591
  * 自定义混流配置布局参数
2559
1592
  */
@@ -2622,40 +1655,6 @@ export interface StreamControl {
2622
1655
  */
2623
1656
  PullSmallVideo?: boolean;
2624
1657
  }
2625
- /**
2626
- * DescribeRoomList返回参数结构体
2627
- */
2628
- export interface DescribeRoomListResponse {
2629
- /**
2630
- * 白板房间列表
2631
- */
2632
- RoomList: Array<RoomListItem>;
2633
- /**
2634
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2635
- */
2636
- RequestId?: string;
2637
- }
2638
- /**
2639
- * DescribeIMApplications请求参数结构体
2640
- */
2641
- export declare type DescribeIMApplicationsRequest = null;
2642
- /**
2643
- * ModifyAutoRenewFlag请求参数结构体
2644
- */
2645
- export interface ModifyAutoRenewFlagRequest {
2646
- /**
2647
- * 资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费的SubProduct,一般为sp_tiw_package
2648
- */
2649
- SubProduct: string;
2650
- /**
2651
- * 资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费资源Id
2652
- */
2653
- ResourceId: string;
2654
- /**
2655
- * 自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续 费,需要设置为0
2656
- */
2657
- AutoRenewFlag: number;
2658
- }
2659
1658
  /**
2660
1659
  * PPT错误元素
2661
1660
  */
@@ -2712,38 +1711,6 @@ export interface DescribeSnapshotTaskResponse {
2712
1711
  */
2713
1712
  RequestId?: string;
2714
1713
  }
2715
- /**
2716
- * DescribeUserStatus返回参数结构体
2717
- */
2718
- export interface DescribeUserStatusResponse {
2719
- /**
2720
- * 客户的AppId
2721
- */
2722
- AppId?: number;
2723
- /**
2724
- * 是否开通过白板(试用或正式)
2725
-
2726
- 0: 从未开通过白板服务
2727
- 1: 已经开通过白板服务
2728
- */
2729
- IsTiwUser?: number;
2730
- /**
2731
- * 是否开通过互动课堂(试用或正式)
2732
- */
2733
- IsSaaSUser?: number;
2734
- /**
2735
- * 是否使用白板的课后录制
2736
- */
2737
- IsTiwOfflineRecordUser?: number;
2738
- /**
2739
- * 用户是否实名认证
2740
- */
2741
- IsAuthenticated?: number;
2742
- /**
2743
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2744
- */
2745
- RequestId?: string;
2746
- }
2747
1714
  /**
2748
1715
  * 流布局参数
2749
1716
  */
@@ -2774,17 +1741,13 @@ export interface StreamLayout {
2774
1741
  FillMode?: number;
2775
1742
  }
2776
1743
  /**
2777
- * DescribeTIWRoomDailyUsage返回参数结构体
1744
+ * CreateSnapshotTask返回参数结构体
2778
1745
  */
2779
- export interface DescribeTIWRoomDailyUsageResponse {
2780
- /**
2781
- * 指定区间指定产品的房间用量列表
2782
- */
2783
- Usages: Array<RoomUsageDataItem>;
1746
+ export interface CreateSnapshotTaskResponse {
2784
1747
  /**
2785
- * 用量列表总数
1748
+ * 白板板书生成任务ID,只有任务创建成功的时候才会返回此字段
2786
1749
  */
2787
- Total: number;
1750
+ TaskID: string;
2788
1751
  /**
2789
1752
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2790
1753
  */
@@ -2807,14 +1770,6 @@ export interface DescribeWhiteboardPushCallbackResponse {
2807
1770
  */
2808
1771
  RequestId?: string;
2809
1772
  }
2810
- /**
2811
- * DescribeApplicationInfos请求参数结构体
2812
- */
2813
- export declare type DescribeApplicationInfosRequest = null;
2814
- /**
2815
- * DescribeWhiteboardPushSearch请求参数结构体
2816
- */
2817
- export declare type DescribeWhiteboardPushSearchRequest = null;
2818
1773
  /**
2819
1774
  * 正在运行的任务列表项
2820
1775
  */
@@ -2892,64 +1847,22 @@ export interface SetPPTCheckCallbackRequest {
2892
1847
  Callback: string;
2893
1848
  }
2894
1849
  /**
2895
- * DescribeWhiteboardPush返回参数结构体
1850
+ * SetWarningCallback请求参数结构体
2896
1851
  */
2897
- export interface DescribeWhiteboardPushResponse {
2898
- /**
2899
- * 推流结束原因,
2900
- - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
2901
- - USER_CALL: 主动调用了停止推流接口
2902
- - EXCEPTION: 推流异常结束
2903
- */
2904
- FinishReason?: string;
2905
- /**
2906
- * 需要查询结果的白板推流任务Id
2907
- */
2908
- TaskId?: string;
2909
- /**
2910
- * 推流任务状态
2911
- - PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
2912
- - PUSHING: 表示推流已开始
2913
- - STOPPED: 表示推流已停止
2914
- */
2915
- Status?: string;
2916
- /**
2917
- * 房间号
2918
- */
2919
- RoomId?: number;
2920
- /**
2921
- * 白板的群组 Id
2922
- */
2923
- GroupId?: string;
2924
- /**
2925
- * 推流用户Id
2926
- */
2927
- PushUserId?: string;
2928
- /**
2929
- * 实际开始推流时间,Unix 时间戳,单位秒
2930
- */
2931
- PushStartTime?: number;
2932
- /**
2933
- * 实际停止推流时间,Unix 时间戳,单位秒
2934
- */
2935
- PushStopTime?: number;
2936
- /**
2937
- * 推流过程中出现异常的次数
2938
- */
2939
- ExceptionCnt?: number;
1852
+ export interface SetWarningCallbackRequest {
2940
1853
  /**
2941
- * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
1854
+ * 客户的SdkAppId
2942
1855
  */
2943
- IMSyncTime?: number;
1856
+ SdkAppId: number;
2944
1857
  /**
2945
- * 备份推流任务结果信息
2946
- 注意:此字段可能返回 null,表示取不到有效值。
1858
+ * 告警回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持http或https协议,即回调地址以http://或https://开头。
1859
+ 回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/90112
2947
1860
  */
2948
- Backup?: string;
1861
+ Callback: string;
2949
1862
  /**
2950
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1863
+ * 设置告警回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
2951
1864
  */
2952
- RequestId?: string;
1865
+ CallbackKey: string;
2953
1866
  }
2954
1867
  /**
2955
1868
  * StartOnlineRecord返回参数结构体
@@ -2965,39 +1878,21 @@ export interface StartOnlineRecordResponse {
2965
1878
  RequestId?: string;
2966
1879
  }
2967
1880
  /**
2968
- * 标签
2969
- */
2970
- export interface Tag {
2971
- /**
2972
- * 标签键
2973
- */
2974
- TagKey: string;
2975
- /**
2976
- * 标签值
2977
- */
2978
- TagValue: string;
2979
- }
2980
- /**
2981
- * DescribeUsageSummary请求参数结构体
1881
+ * 实时录制白板参数,例如白板宽高等
2982
1882
  */
2983
- export interface DescribeUsageSummaryRequest {
2984
- /**
2985
- * 统计时间段的开始时间
2986
- */
2987
- BeginTime: string;
1883
+ export interface Whiteboard {
2988
1884
  /**
2989
- * 统计时间段的结束时间
1885
+ * 实时录制结果里白板视频宽,取值必须大于等于2,默认为1280
2990
1886
  */
2991
- EndTime: string;
1887
+ Width?: number;
2992
1888
  /**
2993
- * 需要获取用量的子产品列表
1889
+ * 实时录制结果里白板视频高,取值必须大于等于2,默认为960
2994
1890
  */
2995
- SubProducts: Array<string>;
1891
+ Height?: number;
2996
1892
  /**
2997
- * true: 返回加权后的数据
2998
- false: 返回原始数据
1893
+ * 白板初始化参数,透传到白板 SDK
2999
1894
  */
3000
- IsWeighted?: boolean;
1895
+ InitParam?: string;
3001
1896
  }
3002
1897
  /**
3003
1898
  * 生成白板板书时的白板参数,例如白板宽高等
@@ -3029,15 +1924,6 @@ export interface CreatePPTCheckTaskResponse {
3029
1924
  */
3030
1925
  RequestId?: string;
3031
1926
  }
3032
- /**
3033
- * ModifyWhiteboardBucketConfig返回参数结构体
3034
- */
3035
- export interface ModifyWhiteboardBucketConfigResponse {
3036
- /**
3037
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3038
- */
3039
- RequestId?: string;
3040
- }
3041
1927
  /**
3042
1928
  * CreateTranscode请求参数结构体
3043
1929
  */
@@ -3184,15 +2070,6 @@ export interface SetTranscodeCallbackRequest {
3184
2070
  */
3185
2071
  Callback: string;
3186
2072
  }
3187
- /**
3188
- * DescribePostpaidUsage返回参数结构体
3189
- */
3190
- export interface DescribePostpaidUsageResponse {
3191
- /**
3192
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3193
- */
3194
- RequestId?: string;
3195
- }
3196
2073
  /**
3197
2074
  * StartWhiteboardPush返回参数结构体
3198
2075
  */
@@ -3211,128 +2088,6 @@ export interface StartWhiteboardPushResponse {
3211
2088
  */
3212
2089
  RequestId?: string;
3213
2090
  }
3214
- /**
3215
- * 白板应用配置,包括资源存储桶,域名,回调地址,回调密钥等
3216
- */
3217
- export interface WhiteboardApplicationConfig {
3218
- /**
3219
- * 任务类型
3220
-
3221
- recording: 实时录制
3222
- transcode: 文档转码
3223
- */
3224
- TaskType: string;
3225
- /**
3226
- * 存储桶名字
3227
- */
3228
- BucketName: string;
3229
- /**
3230
- * 存储桶地域
3231
- */
3232
- BucketLocation: string;
3233
- /**
3234
- * 资源在存储桶中的前缀
3235
- */
3236
- BucketPrefix: string;
3237
- /**
3238
- * 目标CDN域名
3239
- */
3240
- ResultDomain: string;
3241
- /**
3242
- * 回调地址
3243
- */
3244
- Callback: string;
3245
- /**
3246
- * 回调鉴权密钥
3247
- */
3248
- CallbackKey: string;
3249
- /**
3250
- * 配置的应用SdkAppId
3251
- */
3252
- SdkAppId?: number;
3253
- /**
3254
- * IM管理员UserId
3255
- */
3256
- AdminUserId?: string;
3257
- /**
3258
- * IM管理员UserSig
3259
- */
3260
- AdminUserSig?: string;
3261
- }
3262
- /**
3263
- * 转码任务搜索结果
3264
- */
3265
- export interface TranscodeTaskSearchResult {
3266
- /**
3267
- * 任务创建时间
3268
- */
3269
- CreateTime: string;
3270
- /**
3271
- * 任务唯一ID
3272
- */
3273
- TaskId: string;
3274
- /**
3275
- * 任务的当前状态
3276
- - QUEUED: 正在排队等待转换
3277
- - PROCESSING: 转换中
3278
- - FINISHED: 转换完成
3279
- */
3280
- Status: string;
3281
- /**
3282
- * 转码文件原始名称
3283
- */
3284
- OriginalFilename: string;
3285
- /**
3286
- * 用户应用SdkAppId
3287
- */
3288
- SdkAppId: number;
3289
- /**
3290
- * 转码任务结果
3291
- */
3292
- Result: TranscodeTaskResult;
3293
- /**
3294
- * 是否静态转码
3295
- */
3296
- IsStatic: boolean;
3297
- }
3298
- /**
3299
- * CreateApplication返回参数结构体
3300
- */
3301
- export interface CreateApplicationResponse {
3302
- /**
3303
- * 客户的AppId
3304
- */
3305
- AppId?: number;
3306
- /**
3307
- * App名字
3308
- */
3309
- AppName?: string;
3310
- /**
3311
- * 应用SdkAppId
3312
- */
3313
- SdkAppId?: number;
3314
- /**
3315
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3316
- */
3317
- RequestId?: string;
3318
- }
3319
- /**
3320
- * StopWhiteboardPush请求参数结构体
3321
- */
3322
- export interface StopWhiteboardPushRequest {
3323
- /**
3324
- * 客户的SdkAppId
3325
- */
3326
- SdkAppId: number;
3327
- /**
3328
- * 需要停止的白板推流任务 Id
3329
- */
3330
- TaskId: string;
3331
- }
3332
- /**
3333
- * DescribeRecordSearch请求参数结构体
3334
- */
3335
- export declare type DescribeRecordSearchRequest = null;
3336
2091
  /**
3337
2092
  * DescribePPTCheck请求参数结构体
3338
2093
  */