tencentcloud-sdk-nodejs 4.0.565 → 4.0.567

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 (125) hide show
  1. package/CHANGELOG.md +624 -0
  2. package/SERVICE_CHANGELOG.md +722 -87
  3. package/package.json +1 -1
  4. package/products.md +45 -45
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_client.ts +0 -1
  7. package/src/services/as/v20180419/as_models.ts +23 -1
  8. package/src/services/asr/v20190614/asr_client.ts +2 -2
  9. package/src/services/asr/v20190614/asr_models.ts +3 -0
  10. package/src/services/batch/v20170312/batch_models.ts +6 -4
  11. package/src/services/billing/v20180709/billing_models.ts +18 -18
  12. package/src/services/ccc/v20200210/ccc_models.ts +8 -8
  13. package/src/services/cdb/v20170320/cdb_models.ts +7 -2
  14. package/src/services/ckafka/v20190819/ckafka_client.ts +44 -7
  15. package/src/services/ckafka/v20190819/ckafka_models.ts +411 -243
  16. package/src/services/clb/v20180317/clb_models.ts +5 -0
  17. package/src/services/cme/v20191029/cme_client.ts +41 -12
  18. package/src/services/cme/v20191029/cme_models.ts +228 -50
  19. package/src/services/cvm/v20170312/cvm_models.ts +38 -18
  20. package/src/services/dbbrain/v20210527/dbbrain_models.ts +23 -0
  21. package/src/services/dcdb/v20180411/dcdb_client.ts +17 -3
  22. package/src/services/dcdb/v20180411/dcdb_models.ts +403 -26
  23. package/src/services/dlc/v20210125/dlc_models.ts +6 -0
  24. package/src/services/eb/v20210416/eb_client.ts +32 -5
  25. package/src/services/eb/v20210416/eb_models.ts +277 -37
  26. package/src/services/emr/v20190103/emr_models.ts +6 -0
  27. package/src/services/ess/v20201111/ess_client.ts +14 -2
  28. package/src/services/ess/v20201111/ess_models.ts +128 -38
  29. package/src/services/essbasic/v20210526/essbasic_client.ts +49 -11
  30. package/src/services/essbasic/v20210526/essbasic_models.ts +472 -290
  31. package/src/services/mariadb/v20170312/mariadb_client.ts +12 -0
  32. package/src/services/mariadb/v20170312/mariadb_models.ts +308 -0
  33. package/src/services/monitor/v20180724/monitor_client.ts +2 -2
  34. package/src/services/monitor/v20180724/monitor_models.ts +5 -0
  35. package/src/services/ocr/v20181119/ocr_client.ts +23 -12
  36. package/src/services/ocr/v20181119/ocr_models.ts +2 -2
  37. package/src/services/redis/v20180412/redis_client.ts +17 -5
  38. package/src/services/redis/v20180412/redis_models.ts +190 -61
  39. package/src/services/scf/v20180416/scf_models.ts +9 -0
  40. package/src/services/tcb/v20180608/tcb_models.ts +7 -7
  41. package/src/services/tdid/v20210519/tdid_client.ts +133 -65
  42. package/src/services/tiw/v20190919/tiw_client.ts +403 -91
  43. package/src/services/tiw/v20190919/tiw_models.ts +2181 -976
  44. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  45. package/src/services/tsf/v20180326/tsf_client.ts +123 -26
  46. package/src/services/tsf/v20180326/tsf_models.ts +383 -81
  47. package/src/services/vod/v20180717/vod_models.ts +4 -4
  48. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  49. package/src/services/vpc/v20170312/vpc_models.ts +17 -16
  50. package/src/services/waf/v20180125/waf_client.ts +1 -1
  51. package/src/services/waf/v20180125/waf_models.ts +36 -6
  52. package/tencentcloud/common/sdk_version.d.ts +1 -1
  53. package/tencentcloud/common/sdk_version.js +1 -1
  54. package/tencentcloud/services/as/v20180419/as_client.d.ts +0 -1
  55. package/tencentcloud/services/as/v20180419/as_client.js +0 -1
  56. package/tencentcloud/services/as/v20180419/as_models.d.ts +19 -1
  57. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +2 -2
  58. package/tencentcloud/services/asr/v20190614/asr_client.js +2 -2
  59. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +3 -0
  60. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -0
  61. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +18 -18
  62. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +7 -7
  63. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +6 -2
  64. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +13 -1
  65. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +18 -0
  66. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +331 -189
  67. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -0
  68. package/tencentcloud/services/cme/v20191029/cme_client.d.ts +27 -9
  69. package/tencentcloud/services/cme/v20191029/cme_client.js +29 -9
  70. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +193 -43
  71. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +19 -0
  72. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +19 -0
  73. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +5 -1
  74. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +6 -0
  75. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +334 -25
  76. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +5 -0
  77. package/tencentcloud/services/eb/v20210416/eb_client.d.ts +9 -1
  78. package/tencentcloud/services/eb/v20210416/eb_client.js +12 -0
  79. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +238 -36
  80. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +5 -0
  81. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +6 -2
  82. package/tencentcloud/services/ess/v20201111/ess_client.js +7 -1
  83. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +110 -35
  84. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +15 -3
  85. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +21 -3
  86. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +356 -201
  87. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +5 -1
  88. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +6 -0
  89. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +252 -0
  90. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +2 -2
  91. package/tencentcloud/services/monitor/v20180724/monitor_client.js +2 -2
  92. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
  93. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +13 -2
  94. package/tencentcloud/services/ocr/v20181119/ocr_client.js +13 -2
  95. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -2
  96. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +8 -4
  97. package/tencentcloud/services/redis/v20180412/redis_client.js +9 -3
  98. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +159 -52
  99. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +8 -0
  100. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +7 -7
  101. package/tencentcloud/services/tdid/v20210519/tdid_client.d.ts +102 -34
  102. package/tencentcloud/services/tdid/v20210519/tdid_client.js +102 -34
  103. package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +114 -13
  104. package/tencentcloud/services/tiw/v20190919/tiw_client.js +169 -18
  105. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +1946 -922
  106. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  107. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +39 -7
  108. package/tencentcloud/services/tsf/v20180326/tsf_client.js +57 -9
  109. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +330 -70
  110. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -4
  111. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  112. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  113. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +15 -14
  114. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +1 -1
  115. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +31 -6
  116. package/test/ckafka.v20190819.test.js +30 -0
  117. package/test/cme.v20191029.test.js +12 -2
  118. package/test/dcdb.v20180411.test.js +10 -0
  119. package/test/eb.v20210416.test.js +20 -0
  120. package/test/ess.v20201111.test.js +10 -0
  121. package/test/essbasic.v20210526.test.js +32 -2
  122. package/test/mariadb.v20170312.test.js +10 -0
  123. package/test/redis.v20180412.test.js +10 -0
  124. package/test/tiw.v20190919.test.js +262 -12
  125. package/test/tsf.v20180326.test.js +86 -6
@@ -15,6 +15,16 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
+ /**
19
+ * DescribeOfflineRecordCallback请求参数结构体
20
+ */
21
+ export interface DescribeOfflineRecordCallbackRequest {
22
+ /**
23
+ * 应用的SdkAppId
24
+ */
25
+ SdkAppId: number
26
+ }
27
+
18
28
  /**
19
29
  * 混流画布参数
20
30
  */
@@ -31,131 +41,111 @@ export interface Canvas {
31
41
  }
32
42
 
33
43
  /**
34
- * SetWhiteboardPushCallbackKey请求参数结构体
44
+ * StopOnlineRecord返回参数结构体
35
45
  */
36
- export interface SetWhiteboardPushCallbackKeyRequest {
46
+ export interface StopOnlineRecordResponse {
47
+ /**
48
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
49
+ */
50
+ RequestId?: string
51
+ }
52
+
53
+ /**
54
+ * SetVideoGenerationTaskCallbackKey请求参数结构体
55
+ */
56
+ export interface SetVideoGenerationTaskCallbackKeyRequest {
37
57
  /**
38
58
  * 应用的SdkAppId
39
59
  */
40
60
  SdkAppId: number
41
61
 
42
62
  /**
43
- * 设置白板推流回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
63
+ * 设置视频生成回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥
44
64
  */
45
65
  CallbackKey: string
46
66
  }
47
67
 
48
68
  /**
49
- * 查询指标返回的时间序列
69
+ * DescribeTIWRoomDailyUsage请求参数结构体
50
70
  */
51
- export interface TimeValue {
71
+ export interface DescribeTIWRoomDailyUsageRequest {
52
72
  /**
53
- * Unix时间戳,单位秒
73
+ * 互动白板应用SdkAppId
54
74
  */
55
- Time: number
75
+ SdkAppId: number
56
76
 
57
77
  /**
58
- * 查询指标对应当前时间的值
59
- */
60
- Value: number
61
- }
78
+ * 需要查询的子产品用量,支持传入以下值
79
+ - sp_tiw_board: 互动白板时长,单位为分钟
80
+ - sp_tiw_ric: 实时录制时长,单位分钟
81
+ */
82
+ SubProduct: string
62
83
 
63
- /**
64
- * 自定义混流配置布局参数
65
- */
66
- export interface LayoutParams {
67
84
  /**
68
- * 流画面宽,取值范围[2,3000]
85
+ * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
69
86
  */
70
- Width: number
87
+ StartTime: string
71
88
 
72
89
  /**
73
- * 流画面高,取值范围[2,3000]
90
+ * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
74
91
  */
75
- Height: number
92
+ EndTime: string
76
93
 
77
94
  /**
78
- * 当前画面左上角顶点相对于Canvas左上角顶点的x轴偏移量,默认为0,取值范围[0,3000]
95
+ * 需要查询的房间ID列表,不填默认查询全部房间
79
96
  */
80
- X?: number
97
+ RoomIDs?: Array<number>
81
98
 
82
99
  /**
83
- * 当前画面左上角顶点相对于Canvas左上角顶点的y轴偏移量,默认为0, 取值范围[0,3000]
100
+ * 查询偏移量,默认为0
84
101
  */
85
- Y?: number
102
+ Offset?: number
86
103
 
87
104
  /**
88
- * 画面z轴位置,默认为0
89
- z轴确定了重叠画面的遮盖顺序,z轴值大的画面处于顶层
90
- */
91
- ZOrder?: number
105
+ * 每次查询返回条目限制,默认为20
106
+ */
107
+ Limit?: number
92
108
  }
93
109
 
94
110
  /**
95
- * SetVideoGenerationTaskCallback请求参数结构体
111
+ * DescribeWhiteboardPush请求参数结构体
96
112
  */
97
- export interface SetVideoGenerationTaskCallbackRequest {
113
+ export interface DescribeWhiteboardPushRequest {
98
114
  /**
99
115
  * 客户的SdkAppId
100
116
  */
101
117
  SdkAppId: number
102
118
 
103
119
  /**
104
- * 课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头
120
+ * 白板推流任务Id
105
121
  */
106
- Callback: string
122
+ TaskId: string
107
123
  }
108
124
 
109
125
  /**
110
- * 指定流录制的控制参数,比如是否禁用音频、视频是录制大画面还是录制小画面等
126
+ * DescribeWhiteboardPushSearch返回参数结构体
111
127
  */
112
- export interface StreamControl {
113
- /**
114
- * 视频流ID
115
- 视频流ID的取值含义如下:
116
- 1. tic_record_user - 表示白板视频流
117
- 2. tic_substream - 表示辅路视频流
118
- 3. 特定用户ID - 表示指定用户的视频流
119
-
120
- 在实际录制过程中,视频流ID的匹配规则为前缀匹配,只要真实流ID的前缀与指定的流ID一致就认为匹配成功。
121
- */
122
- StreamId: string
123
-
128
+ export interface DescribeWhiteboardPushSearchResponse {
124
129
  /**
125
- * 设置是否对此路流开启录制。
126
-
127
- true - 表示不对这路流进行录制,录制结果将不包含这路流的视频。
128
- false - 表示需要对这路流进行录制,录制结果会包含这路流的视频。
129
-
130
- 默认为 false。
131
- */
132
- DisableRecord?: boolean
130
+ * 推流任务搜索结果集合
131
+ */
132
+ WhiteboardPushTaskSet: Array<WhiteboardPushTaskSearchResult>
133
133
 
134
134
  /**
135
- * 设置是否禁用这路流的音频录制。
136
-
137
- true - 表示不对这路流的音频进行录制,录制结果里这路流的视频将会没有声音。
138
- false - 录制视频会保留音频,如果设置为true,则录制视频会丢弃这路流的音频。
139
-
140
- 默认为 false。
141
- */
142
- DisableAudio?: boolean
135
+ * 推流总任务数
136
+ */
137
+ TotalCount: number
143
138
 
144
139
  /**
145
- * 设置当前流录制视频是否只录制小画面。
146
-
147
- true - 录制小画面。设置为true时,请确保上行端同时上行了小画面,否则录制视频可能是黑屏。
148
- false - 录制大画面。
149
-
150
- 默认为 false。
151
- */
152
- PullSmallVideo?: boolean
140
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
141
+ */
142
+ RequestId?: string
153
143
  }
154
144
 
155
145
  /**
156
- * StopOnlineRecord返回参数结构体
146
+ * ResumeOnlineRecord返回参数结构体
157
147
  */
158
- export interface StopOnlineRecordResponse {
148
+ export interface ResumeOnlineRecordResponse {
159
149
  /**
160
150
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
161
151
  */
@@ -163,126 +153,1385 @@ export interface StopOnlineRecordResponse {
163
153
  }
164
154
 
165
155
  /**
166
- * 鉴权参数
156
+ * 互动白板用量信息
167
157
  */
168
- export interface AuthParam {
158
+ export interface UsageDataItem {
169
159
  /**
170
- * 应用SdkAppId
160
+ * 日期,格式为YYYY-MM-DD
171
161
  */
172
- SdkAppId: number
162
+ Time: string
173
163
 
174
164
  /**
175
- * 用户ID
165
+ * 白板应用SDKAppID
176
166
  */
177
- UserId: string
167
+ SdkAppId: number
178
168
 
179
169
  /**
180
- * 用户ID对应的签名
181
- */
182
- UserSig: string
170
+ * 互动白板子产品,请求参数传入的一致
171
+ - sp_tiw_board: 互动白板时长
172
+ - sp_tiw_dt: 动态转码页数
173
+ - sp_tiw_st: 静态转码页数
174
+ - sp_tiw_ric: 实时录制时长
175
+ */
176
+ SubProduct: string
177
+
178
+ /**
179
+ * 用量值
180
+ - 静态转码、动态转码单位为页
181
+ - 白板时长、实时录制时长单位为分钟
182
+ */
183
+ Value: number
183
184
  }
184
185
 
185
186
  /**
186
- * SetVideoGenerationTaskCallbackKey请求参数结构体
187
+ * DescribeWhiteboardApplicationConfig返回参数结构体
187
188
  */
188
- export interface SetVideoGenerationTaskCallbackKeyRequest {
189
+ export interface DescribeWhiteboardApplicationConfigResponse {
189
190
  /**
190
- * 应用的SdkAppId
191
+ * 客户的SdkAppId
191
192
  */
192
193
  SdkAppId: number
193
194
 
194
195
  /**
195
- * 设置视频生成回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥
196
+ * 白板应用任务相关配置
196
197
  */
197
- CallbackKey: string
198
+ Configs: Array<WhiteboardApplicationConfig>
199
+
200
+ /**
201
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
202
+ */
203
+ RequestId?: string
198
204
  }
199
205
 
200
206
  /**
201
- * StartWhiteboardPush请求参数结构体
207
+ * 白板推流任务结果
202
208
  */
203
- export interface StartWhiteboardPushRequest {
209
+ export interface WhiteboardPushResult {
204
210
  /**
205
- * 客户的SdkAppId
211
+ * AUTO - 自动停止推流, USER_CALL - 用户主动调用停止推流
206
212
  */
207
- SdkAppId: number
213
+ FinishReason: string
208
214
 
209
215
  /**
210
- * 需要推流的白板房间号,取值范围: (1, 4294967295)。
216
+ * 异常数
217
+ */
218
+ ExceptionCnt: number
211
219
 
212
- 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID(比如RoomId为1234,则IM群组的GroupID为"1234")加群进行信令同步,请在开始推流前确保相应IM群组已创建完成,否则会导致推流失败。
213
- 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下,默认会以RoomId作为白板流进行推流的TRTC房间号。
214
- */
220
+ /**
221
+ * 房间号
222
+ */
215
223
  RoomId: number
216
224
 
217
225
  /**
218
- * 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。
219
- 用户ID最大长度不能大于60个字节,该用户ID必须是一个单独的未同时在其他地方使用的用户ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该用户ID和其他地方同时在使用的用户ID重复,会导致白板推流服务与其他使用场景帐号互踢,影响正常推流。
220
- */
221
- PushUserId: string
226
+ * IM群组ID
227
+ */
228
+ GroupId: string
222
229
 
223
230
  /**
224
- * 与PushUserId对应的IM签名(usersig)。
231
+ * 推流真实开始时间
225
232
  */
226
- PushUserSig: string
233
+ PushStartTime: number
227
234
 
228
235
  /**
229
- * 白板参数,例如白板宽高、背景颜色等
236
+ * 推流结束时间
230
237
  */
231
- Whiteboard?: Whiteboard
238
+ PushStopTime: number
232
239
 
233
240
  /**
234
- * 自动停止推流超时时间,单位秒,取值范围[300, 259200], 默认值为1800秒。
235
-
236
- 当白板超过设定时间没有操作的时候,白板推流服务会自动停止白板推流。
237
- */
238
- AutoStopTimeout?: number
241
+ * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
242
+ */
243
+ IMSyncTime: number
239
244
 
240
245
  /**
241
- * 对主白板推流任务进行操作时,是否同时同步操作备份任务
246
+ * 任务失败错误码
242
247
  */
243
- AutoManageBackup?: boolean
248
+ ErrorCode: number
244
249
 
245
250
  /**
246
- * 备份白板推流相关参数。
247
-
248
- 指定了备份参数的情况下,白板推流服务会在房间内新增一路白板画面视频流,即同一个房间内会有两路白板画面推流。
249
- */
250
- Backup?: WhiteboardPushBackupParam
251
+ * 错误信息
252
+ */
253
+ ErrorMsg: string
254
+ }
251
255
 
256
+ /**
257
+ * CreateSnapshotTask返回参数结构体
258
+ */
259
+ export interface CreateSnapshotTaskResponse {
252
260
  /**
253
- * TRTC高级权限控制参数,如果在实时音视频开启了高级权限控制功能,必须提供PrivateMapKey才能保证正常推流。
261
+ * 白板板书生成任务ID,只有任务创建成功的时候才会返回此字段
254
262
  */
255
- PrivateMapKey?: string
263
+ TaskID: string
256
264
 
257
265
  /**
258
- * 白板推流视频帧率,取值范围[0, 30],默认20fps
266
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
259
267
  */
260
- VideoFPS?: number
268
+ RequestId?: string
269
+ }
261
270
 
271
+ /**
272
+ * DescribeOfflineRecord返回参数结构体
273
+ */
274
+ export interface DescribeOfflineRecordResponse {
262
275
  /**
263
- * 白板推流码率, 取值范围[0, 2000],默认1200kbps
264
-
265
- 这里的码率设置是一个参考值,实际推流的时候使用的是动态码率,所以真实码率不会固定为指定值,会在指定值附近波动。
266
- */
267
- VideoBitrate?: number
276
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
277
+ */
278
+ RequestId?: string
279
+ }
268
280
 
281
+ /**
282
+ * ModifyApplication返回参数结构体
283
+ */
284
+ export interface ModifyApplicationResponse {
269
285
  /**
270
- * 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。
271
-
272
- 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下,不会自动进行白板推流录制,如果希望进行白板推流录制,请将此参数设置为true。
273
-
274
- 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式,可忽略此参数。
275
- */
276
- AutoRecord?: boolean
286
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
287
+ */
288
+ RequestId?: string
289
+ }
277
290
 
291
+ /**
292
+ * CreateTranscode返回参数结构体
293
+ */
294
+ export interface CreateTranscodeResponse {
278
295
  /**
279
- * 指定白板推流录制的RecordID,指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容,便于您更方便的识别录制回调,以及在点播媒体资源管理中查找相应的录制视频文件。
280
-
281
- 限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
296
+ * 文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果
297
+ */
298
+ TaskId: string
282
299
 
283
- 此字段设置后,不管`AutoRecord`字段取值如何,都将自动进行白板推流录制。
300
+ /**
301
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
302
+ */
303
+ RequestId?: string
304
+ }
284
305
 
285
- 默认RecordId生成规则如下:
306
+ /**
307
+ * DescribeUserResources返回参数结构体
308
+ */
309
+ export interface DescribeUserResourcesResponse {
310
+ /**
311
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
312
+ */
313
+ RequestId?: string
314
+ }
315
+
316
+ /**
317
+ * 视频信息
318
+ */
319
+ export interface VideoInfo {
320
+ /**
321
+ * 视频开始播放的时间(单位:毫秒)
322
+ */
323
+ VideoPlayTime: number
324
+
325
+ /**
326
+ * 视频大小(字节)
327
+ */
328
+ VideoSize: number
329
+
330
+ /**
331
+ * 视频格式
332
+ */
333
+ VideoFormat: string
334
+
335
+ /**
336
+ * 视频播放时长(单位:毫秒)
337
+ */
338
+ VideoDuration: number
339
+
340
+ /**
341
+ * 视频文件URL
342
+ */
343
+ VideoUrl: string
344
+
345
+ /**
346
+ * 视频文件Id
347
+ */
348
+ VideoId: string
349
+
350
+ /**
351
+ * 视频流类型
352
+ - 0:摄像头视频
353
+ - 1:屏幕分享视频
354
+ - 2:白板视频
355
+ - 3:混流视频
356
+ - 4:纯音频(mp3)
357
+ */
358
+ VideoType: number
359
+
360
+ /**
361
+ * 摄像头/屏幕分享视频所属用户的 Id(白板视频为空、混流视频tic_mixstream_房间号_混流布局类型、辅路视频tic_substream_用户Id)
362
+ */
363
+ UserId: string
364
+
365
+ /**
366
+ * 视频分辨率的宽
367
+ */
368
+ Width: number
369
+
370
+ /**
371
+ * 视频分辨率的高
372
+ */
373
+ Height: number
374
+ }
375
+
376
+ /**
377
+ * 自定义混流布局参数
378
+ */
379
+ export interface CustomLayout {
380
+ /**
381
+ * 混流画布参数
382
+ */
383
+ Canvas: Canvas
384
+
385
+ /**
386
+ * 流布局参数,每路流的布局不能超出画布区域
387
+ */
388
+ InputStreamList: Array<StreamLayout>
389
+ }
390
+
391
+ /**
392
+ * 实时录制中出现的用户视频流断流次数统计
393
+ */
394
+ export interface Interrupt {
395
+ /**
396
+ * 用户ID
397
+ 注意:此字段可能返回 null,表示取不到有效值。
398
+ */
399
+ UserId: string
400
+
401
+ /**
402
+ * 视频流断流次数
403
+ 注意:此字段可能返回 null,表示取不到有效值。
404
+ */
405
+ Count: number
406
+ }
407
+
408
+ /**
409
+ * DescribeOnlineRecord请求参数结构体
410
+ */
411
+ export interface DescribeOnlineRecordRequest {
412
+ /**
413
+ * 客户的SdkAppId
414
+ */
415
+ SdkAppId: number
416
+
417
+ /**
418
+ * 实时录制任务Id
419
+ */
420
+ TaskId: string
421
+ }
422
+
423
+ /**
424
+ * 日志查询里返回的白板房间数据
425
+ */
426
+ export interface RoomListItem {
427
+ /**
428
+ * 房间ID
429
+ */
430
+ RoomId: string
431
+
432
+ /**
433
+ * 房间在查询时间段内最早出现的时间,Unix时间戳,单位毫秒
434
+ */
435
+ StartTime: number
436
+
437
+ /**
438
+ * 房间在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒
439
+ */
440
+ EndTime: number
441
+
442
+ /**
443
+ * 房间里成员数
444
+ */
445
+ UserNumber: number
446
+ }
447
+
448
+ /**
449
+ * ModifyWhiteboardBucketConfig请求参数结构体
450
+ */
451
+ export interface ModifyWhiteboardBucketConfigRequest {
452
+ /**
453
+ * 客户的SdkAppId
454
+ */
455
+ SdkAppId: number
456
+
457
+ /**
458
+ * 需要查询的任务类型
459
+ recording: 实时录制
460
+ transcode: 文档转码
461
+ */
462
+ TaskType: string
463
+
464
+ /**
465
+ * COS存储桶名字
466
+ */
467
+ BucketName: string
468
+
469
+ /**
470
+ * COS存储桶地域
471
+ */
472
+ BucketLocation: string
473
+
474
+ /**
475
+ * 存储桶里资源前缀
476
+ */
477
+ BucketPrefix: string
478
+
479
+ /**
480
+ * 返回Url域名
481
+ */
482
+ ResultDomain: string
483
+ }
484
+
485
+ /**
486
+ * SetOnlineRecordCallbackKey返回参数结构体
487
+ */
488
+ export interface SetOnlineRecordCallbackKeyResponse {
489
+ /**
490
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
491
+ */
492
+ RequestId?: string
493
+ }
494
+
495
+ /**
496
+ * 互动白板房间用量信息
497
+ */
498
+ export interface RoomUsageDataItem {
499
+ /**
500
+ * 日期,格式为YYYY-MM-DD
501
+ */
502
+ Time: string
503
+
504
+ /**
505
+ * 白板应用SDKAppID
506
+ */
507
+ SdkAppId: number
508
+
509
+ /**
510
+ * 互动白板子产品,请求参数传入的一致
511
+ - sp_tiw_board: 互动白板时长
512
+ - sp_tiw_ric: 实时录制时长
513
+ */
514
+ SubProduct: string
515
+
516
+ /**
517
+ * 用量值
518
+ - 白板时长、实时录制时长单位为分钟
519
+ */
520
+ Value: number
521
+
522
+ /**
523
+ * 互动白板房间号
524
+ */
525
+ RoomID: number
526
+ }
527
+
528
+ /**
529
+ * DescribeAPIService请求参数结构体
530
+ */
531
+ export interface DescribeAPIServiceRequest {
532
+ /**
533
+ * 目前支持的Service为cos:GetService,cdn:DescribeDomainsConfig
534
+ */
535
+ Service: string
536
+
537
+ /**
538
+ * JSON格式的请求参数
539
+ */
540
+ Data?: string
541
+ }
542
+
543
+ /**
544
+ * DescribeQualityMetrics请求参数结构体
545
+ */
546
+ export interface DescribeQualityMetricsRequest {
547
+ /**
548
+ * 白板应用的SdkAppId
549
+ */
550
+ SdkAppId: number
551
+
552
+ /**
553
+ * 开始时间,Unix时间戳,单位秒,时间跨度不能超过7天
554
+ */
555
+ StartTime: number
556
+
557
+ /**
558
+ * 结束时间,Unix时间戳,单位秒,时间跨度不能超过7天
559
+ */
560
+ EndTime: number
561
+
562
+ /**
563
+ * 查询的指标,目前支持以下值
564
+ - image_load_total_count: 图片加载总数(单位,次)
565
+ - image_load_fail_count: 图片加载失败数量(单位,次)
566
+ - image_load_success_rate: 图片加载成功率(百分比)
567
+ - ppt_load_total_count: PPT加载总数(单位,次)
568
+ - ppt_load_fail_count: PPT加载失败总数(单位,次)
569
+ - ppt_load_success_rate: PPT加载成功率(单位,百分比)
570
+ - verify_sdk_total_count: 白板鉴权总次数(单位,次)
571
+ - verify_sdk_fail_count: 白板鉴权失败次数(单位,次)
572
+ - verify_sdk_success_rate: 白板鉴权成功率(单位,百分比)
573
+ - verify_sdk_in_one_second_rate: 白板鉴权秒开率(单位,百分比)
574
+ - verify_sdk_cost_avg: 白板鉴权耗时平均时间(单位,毫秒)
575
+ */
576
+ Metric: string
577
+
578
+ /**
579
+ * 聚合的时间维度,目前只支持1小时,输入值为"1h"
580
+ */
581
+ Interval?: string
582
+ }
583
+
584
+ /**
585
+ * CreateVideoGenerationTask请求参数结构体
586
+ */
587
+ export interface CreateVideoGenerationTaskRequest {
588
+ /**
589
+ * 录制任务的TaskId
590
+ */
591
+ OnlineRecordTaskId: string
592
+
593
+ /**
594
+ * 客户的SdkAppId
595
+ */
596
+ SdkAppId: number
597
+
598
+ /**
599
+ * 视频生成的白板参数,例如白板宽高等。
600
+
601
+ 此参数与开始录制接口提供的Whiteboard参数互斥,在本接口与开始录制接口都提供了Whiteboard参数时,优先使用本接口指定的Whiteboard参数进行视频生成,否则使用开始录制接口提供的Whiteboard参数进行视频生成。
602
+ */
603
+ Whiteboard?: Whiteboard
604
+
605
+ /**
606
+ * 视频拼接参数
607
+
608
+ 此参数与开始录制接口提供的Concat参数互斥,在本接口与开始录制接口都提供了Concat参数时,优先使用本接口指定的Concat参数进行视频拼接,否则使用开始录制接口提供的Concat参数进行视频拼接。
609
+ */
610
+ Concat?: Concat
611
+
612
+ /**
613
+ * 视频生成混流参数
614
+
615
+ 此参数与开始录制接口提供的MixStream参数互斥,在本接口与开始录制接口都提供了MixStream参数时,优先使用本接口指定的MixStream参数进行视频混流,否则使用开始录制接口提供的MixStream参数进行视频拼混流。
616
+ */
617
+ MixStream?: MixStream
618
+
619
+ /**
620
+ * 视频生成控制参数,用于更精细地指定需要生成哪些流,某一路流是否禁用音频,是否只录制小画面等
621
+
622
+ 此参数与开始录制接口提供的RecordControl参数互斥,在本接口与开始录制接口都提供了RecordControl参数时,优先使用本接口指定的RecordControl参数进行视频生成控制,否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。
623
+ */
624
+ RecordControl?: RecordControl
625
+
626
+ /**
627
+ * 内部参数
628
+ */
629
+ ExtraData?: string
630
+ }
631
+
632
+ /**
633
+ * DescribeTranscodeCallback请求参数结构体
634
+ */
635
+ export interface DescribeTranscodeCallbackRequest {
636
+ /**
637
+ * 应用的SdkAppId
638
+ */
639
+ SdkAppId: number
640
+ }
641
+
642
+ /**
643
+ * DescribeTranscodeSearch返回参数结构体
644
+ */
645
+ export interface DescribeTranscodeSearchResponse {
646
+ /**
647
+ * 转码任务搜索结果集合
648
+ */
649
+ TranscodeTaskSet: Array<TranscodeTaskSearchResult>
650
+
651
+ /**
652
+ * 转码总任务数
653
+ */
654
+ TotalCount: number
655
+
656
+ /**
657
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
658
+ */
659
+ RequestId?: string
660
+ }
661
+
662
+ /**
663
+ * ResumeOnlineRecord请求参数结构体
664
+ */
665
+ export interface ResumeOnlineRecordRequest {
666
+ /**
667
+ * 客户的SdkAppId
668
+ */
669
+ SdkAppId: number
670
+
671
+ /**
672
+ * 恢复录制的实时录制任务 Id
673
+ */
674
+ TaskId: string
675
+ }
676
+
677
+ /**
678
+ * SetWhiteboardPushCallbackKey返回参数结构体
679
+ */
680
+ export interface SetWhiteboardPushCallbackKeyResponse {
681
+ /**
682
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
683
+ */
684
+ RequestId?: string
685
+ }
686
+
687
+ /**
688
+ * DescribeRoomList请求参数结构体
689
+ */
690
+ export interface DescribeRoomListRequest {
691
+ /**
692
+ * 白板应用的SdkAppId
693
+ */
694
+ SdkAppId: number
695
+
696
+ /**
697
+ * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
698
+ */
699
+ TimeRange: Array<number>
700
+
701
+ /**
702
+ * 额外的查询条件
703
+ */
704
+ Query?: string
705
+
706
+ /**
707
+ * 返回最大的数据条数,默认1000
708
+ */
709
+ MaxSize?: number
710
+ }
711
+
712
+ /**
713
+ * SetWhiteboardPushCallback返回参数结构体
714
+ */
715
+ export interface SetWhiteboardPushCallbackResponse {
716
+ /**
717
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
718
+ */
719
+ RequestId?: string
720
+ }
721
+
722
+ /**
723
+ * ApplyTiwTrial返回参数结构体
724
+ */
725
+ export interface ApplyTiwTrialResponse {
726
+ /**
727
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
728
+ */
729
+ RequestId?: string
730
+ }
731
+
732
+ /**
733
+ * 拼接视频中被忽略的时间段
734
+ */
735
+ export interface OmittedDuration {
736
+ /**
737
+ * 录制暂停时间戳对应的视频播放时间(单位: 毫秒)
738
+ */
739
+ VideoTime: number
740
+
741
+ /**
742
+ * 录制暂停时间戳(单位: 毫秒)
743
+ */
744
+ PauseTime: number
745
+
746
+ /**
747
+ * 录制恢复时间戳(单位: 毫秒)
748
+ */
749
+ ResumeTime: number
750
+ }
751
+
752
+ /**
753
+ * PauseOnlineRecord请求参数结构体
754
+ */
755
+ export interface PauseOnlineRecordRequest {
756
+ /**
757
+ * 客户的SdkAppId
758
+ */
759
+ SdkAppId: number
760
+
761
+ /**
762
+ * 实时录制任务 Id
763
+ */
764
+ TaskId: string
765
+ }
766
+
767
+ /**
768
+ * DescribeApplicationInfos返回参数结构体
769
+ */
770
+ export interface DescribeApplicationInfosResponse {
771
+ /**
772
+ * 应用列表
773
+ */
774
+ ApplicationInfos: Array<ApplicationItem>
775
+
776
+ /**
777
+ * 是否包含所有的应用,0-不包含,1-包含
778
+ */
779
+ AllOption: number
780
+
781
+ /**
782
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
783
+ */
784
+ RequestId?: string
785
+ }
786
+
787
+ /**
788
+ * DescribeApplicationUsage返回参数结构体
789
+ */
790
+ export interface DescribeApplicationUsageResponse {
791
+ /**
792
+ * 画图所需的用量数据
793
+ */
794
+ Data: Array<DataItem>
795
+
796
+ /**
797
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
798
+ */
799
+ RequestId?: string
800
+ }
801
+
802
+ /**
803
+ * DescribeAPIService返回参数结构体
804
+ */
805
+ export interface DescribeAPIServiceResponse {
806
+ /**
807
+ * Json格式的响应数据
808
+ */
809
+ ResponseData?: string
810
+
811
+ /**
812
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
813
+ */
814
+ RequestId?: string
815
+ }
816
+
817
+ /**
818
+ * 查询指标返回的时间序列
819
+ */
820
+ export interface TimeValue {
821
+ /**
822
+ * Unix时间戳,单位秒
823
+ */
824
+ Time: number
825
+
826
+ /**
827
+ * 查询指标对应当前时间的值
828
+ */
829
+ Value: number
830
+ }
831
+
832
+ /**
833
+ * DescribeWhiteboardBucketConfig请求参数结构体
834
+ */
835
+ export interface DescribeWhiteboardBucketConfigRequest {
836
+ /**
837
+ * 客户的SdkAppId
838
+ */
839
+ SdkAppId: number
840
+
841
+ /**
842
+ * 需要查询的任务类型
843
+ recording: 实时录制
844
+ transcode: 文档转码
845
+ */
846
+ TaskType: string
847
+ }
848
+
849
+ /**
850
+ * DescribeUsageSummary返回参数结构体
851
+ */
852
+ export interface DescribeUsageSummaryResponse {
853
+ /**
854
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
855
+ */
856
+ RequestId?: string
857
+ }
858
+
859
+ /**
860
+ * DescribeApplicationInfos请求参数结构体
861
+ */
862
+ export type DescribeApplicationInfosRequest = null
863
+
864
+ /**
865
+ * DescribeApplicationUsage请求参数结构体
866
+ */
867
+ export interface DescribeApplicationUsageRequest {
868
+ /**
869
+ * 用量开始时间(包括该时间点)
870
+ */
871
+ BeginTime: string
872
+
873
+ /**
874
+ * 用量结束时间(不包括该时间点)
875
+ */
876
+ EndTime: string
877
+
878
+ /**
879
+ * 白板子产品名
880
+ */
881
+ SubProduct: string
882
+
883
+ /**
884
+ * 时间跨度单位
885
+ - MONTHLY:月
886
+ - DAILY:天
887
+ - MINUTELY:分钟
888
+ */
889
+ TimeLevel: string
890
+
891
+ /**
892
+ * 白板应用的SdkAppId
893
+ */
894
+ SdkAppId?: number
895
+
896
+ /**
897
+ * true: 返回加权求和后的用量数据
898
+ false: 返回原始用量数据
899
+ */
900
+ IsWeighted?: boolean
901
+ }
902
+
903
+ /**
904
+ * 白板板书结果
905
+ */
906
+ export interface SnapshotResult {
907
+ /**
908
+ * 任务执行错误码
909
+ 注意:此字段可能返回 null,表示取不到有效值。
910
+ */
911
+ ErrorCode: string
912
+
913
+ /**
914
+ * 任务执行错误信息
915
+ 注意:此字段可能返回 null,表示取不到有效值。
916
+ */
917
+ ErrorMessage: string
918
+
919
+ /**
920
+ * 快照生成图片总数
921
+ 注意:此字段可能返回 null,表示取不到有效值。
922
+ */
923
+ Total: number
924
+
925
+ /**
926
+ * 快照图片链接列表
927
+ 注意:此字段可能返回 null,表示取不到有效值。
928
+ */
929
+ Snapshots: Array<string>
930
+ }
931
+
932
+ /**
933
+ * DescribeOfflineRecordCallback返回参数结构体
934
+ */
935
+ export interface DescribeOfflineRecordCallbackResponse {
936
+ /**
937
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
938
+ */
939
+ RequestId?: string
940
+ }
941
+
942
+ /**
943
+ * CreateOfflineRecord返回参数结构体
944
+ */
945
+ export interface CreateOfflineRecordResponse {
946
+ /**
947
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
948
+ */
949
+ RequestId?: string
950
+ }
951
+
952
+ /**
953
+ * SetVideoGenerationTaskCallbackKey返回参数结构体
954
+ */
955
+ export interface SetVideoGenerationTaskCallbackKeyResponse {
956
+ /**
957
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
958
+ */
959
+ RequestId?: string
960
+ }
961
+
962
+ /**
963
+ * DescribeVideoGenerationTask返回参数结构体
964
+ */
965
+ export interface DescribeVideoGenerationTaskResponse {
966
+ /**
967
+ * 任务对应的群组Id
968
+ */
969
+ GroupId?: string
970
+
971
+ /**
972
+ * 任务对应的房间号
973
+ */
974
+ RoomId?: number
975
+
976
+ /**
977
+ * 任务的Id
978
+ */
979
+ TaskId?: string
980
+
981
+ /**
982
+ * 已废弃
983
+ */
984
+ Progress?: number
985
+
986
+ /**
987
+ * 录制视频生成任务状态
988
+ - QUEUED: 正在排队
989
+ - PROCESSING: 正在生成视频
990
+ - FINISHED: 生成视频结束(成功完成或失败结束,可以通过错误码和错误信息进一步判断)
991
+ */
992
+ Status?: string
993
+
994
+ /**
995
+ * 回放视频总时长,单位:毫秒
996
+ */
997
+ TotalTime?: number
998
+
999
+ /**
1000
+ * 已废弃,请使用`VideoInfoList`参数
1001
+ */
1002
+ VideoInfos?: VideoInfo
1003
+
1004
+ /**
1005
+ * 录制视频生成视频列表
1006
+ */
1007
+ VideoInfoList?: Array<VideoInfo>
1008
+
1009
+ /**
1010
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1011
+ */
1012
+ RequestId?: string
1013
+ }
1014
+
1015
+ /**
1016
+ * 画图数据,Time/Value/Details
1017
+ */
1018
+ export interface DataItem {
1019
+ /**
1020
+ * 时间
1021
+ 按月格式yyyy-mm
1022
+ 按天格式yyyy-mm-dd
1023
+ 按分钟格式 yyyy-mm-dd HH:MM:SS
1024
+ */
1025
+ Time: string
1026
+
1027
+ /**
1028
+ * 画图所需要的值
1029
+ */
1030
+ Value: number
1031
+
1032
+ /**
1033
+ * 各个具体指标的详情
1034
+ */
1035
+ Details: Array<Detail>
1036
+ }
1037
+
1038
+ /**
1039
+ * DescribeVideoGenerationTask请求参数结构体
1040
+ */
1041
+ export interface DescribeVideoGenerationTaskRequest {
1042
+ /**
1043
+ * 客户的SdkAppId
1044
+ */
1045
+ SdkAppId: number
1046
+
1047
+ /**
1048
+ * 录制视频生成的任务Id
1049
+ */
1050
+ TaskId: string
1051
+ }
1052
+
1053
+ /**
1054
+ * DescribeWhiteboardPushCallback请求参数结构体
1055
+ */
1056
+ export interface DescribeWhiteboardPushCallbackRequest {
1057
+ /**
1058
+ * 应用的SdkAppId
1059
+ */
1060
+ SdkAppId: number
1061
+ }
1062
+
1063
+ /**
1064
+ * DescribeOnlineRecord返回参数结构体
1065
+ */
1066
+ export interface DescribeOnlineRecordResponse {
1067
+ /**
1068
+ * 录制结束原因,
1069
+ - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制
1070
+ - USER_CALL: 主动调用了停止录制接口
1071
+ - EXCEPTION: 录制异常结束
1072
+ - FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。
1073
+ */
1074
+ FinishReason: string
1075
+
1076
+ /**
1077
+ * 需要查询结果的录制任务Id
1078
+ */
1079
+ TaskId: string
1080
+
1081
+ /**
1082
+ * 录制任务状态
1083
+ - PREPARED: 表示录制正在准备中(进房/启动录制服务等操作)
1084
+ - RECORDING: 表示录制已开始
1085
+ - PAUSED: 表示录制已暂停
1086
+ - STOPPED: 表示录制已停止,正在处理并上传视频
1087
+ - FINISHED: 表示视频处理并上传完成,成功生成录制结果
1088
+ */
1089
+ Status: string
1090
+
1091
+ /**
1092
+ * 房间号
1093
+ */
1094
+ RoomId: number
1095
+
1096
+ /**
1097
+ * 白板的群组 Id
1098
+ */
1099
+ GroupId: string
1100
+
1101
+ /**
1102
+ * 录制用户Id
1103
+ */
1104
+ RecordUserId: string
1105
+
1106
+ /**
1107
+ * 实际开始录制时间,Unix 时间戳,单位秒
1108
+ */
1109
+ RecordStartTime: number
1110
+
1111
+ /**
1112
+ * 实际停止录制时间,Unix 时间戳,单位秒
1113
+ */
1114
+ RecordStopTime: number
1115
+
1116
+ /**
1117
+ * 回放视频总时长(单位:毫秒)
1118
+ */
1119
+ TotalTime: number
1120
+
1121
+ /**
1122
+ * 录制过程中出现异常的次数
1123
+ */
1124
+ ExceptionCnt: number
1125
+
1126
+ /**
1127
+ * 拼接视频中被忽略的时间段,只有开启视频拼接功能的时候,这个参数才是有效的
1128
+ */
1129
+ OmittedDurations: Array<OmittedDuration>
1130
+
1131
+ /**
1132
+ * 录制视频列表
1133
+ */
1134
+ VideoInfos: Array<VideoInfo>
1135
+
1136
+ /**
1137
+ * 回放URL,需配合信令播放器使用。此字段仅适用于`视频生成模式`
1138
+ 注意:此字段可能返回 null,表示取不到有效值。
1139
+ */
1140
+ ReplayUrl: string
1141
+
1142
+ /**
1143
+ * 视频流在录制过程中断流次数
1144
+ 注意:此字段可能返回 null,表示取不到有效值。
1145
+ */
1146
+ Interrupts: Array<Interrupt>
1147
+
1148
+ /**
1149
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1150
+ */
1151
+ RequestId?: string
1152
+ }
1153
+
1154
+ /**
1155
+ * DescribeTranscode请求参数结构体
1156
+ */
1157
+ export interface DescribeTranscodeRequest {
1158
+ /**
1159
+ * 客户的SdkAppId
1160
+ */
1161
+ SdkAppId: number
1162
+
1163
+ /**
1164
+ * 文档转码任务的唯一标识Id
1165
+ */
1166
+ TaskId: string
1167
+ }
1168
+
1169
+ /**
1170
+ * DescribeBoardSDKLog返回参数结构体
1171
+ */
1172
+ export interface DescribeBoardSDKLogResponse {
1173
+ /**
1174
+ * 总共能查到日志条数
1175
+ */
1176
+ Total: number
1177
+
1178
+ /**
1179
+ * 日志详细内容
1180
+ */
1181
+ Sources: Array<string>
1182
+
1183
+ /**
1184
+ * 按时间段聚合后每个时间段的日志条数
1185
+ */
1186
+ Buckets: Array<string>
1187
+
1188
+ /**
1189
+ * 用于递归拉取的上下文Key,下一次请求的时候带上
1190
+ */
1191
+ Context: string
1192
+
1193
+ /**
1194
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1195
+ */
1196
+ RequestId?: string
1197
+ }
1198
+
1199
+ /**
1200
+ * SetOnlineRecordCallback返回参数结构体
1201
+ */
1202
+ export interface SetOnlineRecordCallbackResponse {
1203
+ /**
1204
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1205
+ */
1206
+ RequestId?: string
1207
+ }
1208
+
1209
+ /**
1210
+ * ApplyTiwTrial请求参数结构体
1211
+ */
1212
+ export type ApplyTiwTrialRequest = null
1213
+
1214
+ /**
1215
+ * DescribeTranscodeCallback返回参数结构体
1216
+ */
1217
+ export interface DescribeTranscodeCallbackResponse {
1218
+ /**
1219
+ * 文档转码回调地址
1220
+ */
1221
+ Callback: string
1222
+
1223
+ /**
1224
+ * 文档转码回调鉴权密钥
1225
+ */
1226
+ CallbackKey: string
1227
+
1228
+ /**
1229
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1230
+ */
1231
+ RequestId?: string
1232
+ }
1233
+
1234
+ /**
1235
+ * DescribeUserList返回参数结构体
1236
+ */
1237
+ export interface DescribeUserListResponse {
1238
+ /**
1239
+ * 房间内的用户列表
1240
+ */
1241
+ UserList: Array<UserListItem>
1242
+
1243
+ /**
1244
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1245
+ */
1246
+ RequestId?: string
1247
+ }
1248
+
1249
+ /**
1250
+ * ModifyAutoRenewFlag返回参数结构体
1251
+ */
1252
+ export interface ModifyAutoRenewFlagResponse {
1253
+ /**
1254
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1255
+ */
1256
+ RequestId?: string
1257
+ }
1258
+
1259
+ /**
1260
+ * DescribeTIWDailyUsage请求参数结构体
1261
+ */
1262
+ export interface DescribeTIWDailyUsageRequest {
1263
+ /**
1264
+ * 互动白板应用SdkAppId
1265
+ */
1266
+ SdkAppId: number
1267
+
1268
+ /**
1269
+ * 需要查询的子产品用量,支持传入以下值
1270
+ - sp_tiw_board: 互动白板时长,单位为分钟
1271
+ - sp_tiw_dt: 动态转码页数,单位页
1272
+ - sp_tiw_st: 静态转码页数,单位页
1273
+ - sp_tiw_ric: 实时录制时长,单位分钟
1274
+
1275
+ 注意:动态转码以1:8的比例计算文档转码页数,静态转码以1:1的比例计算文档转码页数
1276
+ */
1277
+ SubProduct: string
1278
+
1279
+ /**
1280
+ * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
1281
+ */
1282
+ StartTime: string
1283
+
1284
+ /**
1285
+ * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
1286
+ */
1287
+ EndTime: string
1288
+ }
1289
+
1290
+ /**
1291
+ * DescribeWhiteboardBucketConfig返回参数结构体
1292
+ */
1293
+ export interface DescribeWhiteboardBucketConfigResponse {
1294
+ /**
1295
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1296
+ */
1297
+ RequestId?: string
1298
+ }
1299
+
1300
+ /**
1301
+ * 混流配置
1302
+ */
1303
+ export interface MixStream {
1304
+ /**
1305
+ * 是否开启混流
1306
+ */
1307
+ Enabled: boolean
1308
+
1309
+ /**
1310
+ * 是否禁用音频混流
1311
+ */
1312
+ DisableAudio?: boolean
1313
+
1314
+ /**
1315
+ * 内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明
1316
+ 在没有填Custom字段时候,ModelId是必填的
1317
+ */
1318
+ ModelId?: number
1319
+
1320
+ /**
1321
+ * 老师用户ID
1322
+ 此字段只有在ModelId填了的情况下生效
1323
+ 填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中
1324
+ */
1325
+ TeacherId?: string
1326
+
1327
+ /**
1328
+ * 自定义混流布局参数
1329
+ 当此字段存在时,ModelId 及 TeacherId 字段将被忽略
1330
+ */
1331
+ Custom?: CustomLayout
1332
+ }
1333
+
1334
+ /**
1335
+ * DescribeBoardSDKLog请求参数结构体
1336
+ */
1337
+ export interface DescribeBoardSDKLogRequest {
1338
+ /**
1339
+ * 白板应用的SdkAppId
1340
+ */
1341
+ SdkAppId: number
1342
+
1343
+ /**
1344
+ * 需要查询日志的白板房间号
1345
+ */
1346
+ RoomId: string
1347
+
1348
+ /**
1349
+ * 需要查询日志的用户ID
1350
+ */
1351
+ UserId: string
1352
+
1353
+ /**
1354
+ * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
1355
+ */
1356
+ TimeRange: Array<number>
1357
+
1358
+ /**
1359
+ * 聚合日志条数查询的桶的时间范围,如5m, 1h, 4h等
1360
+ */
1361
+ AggregationInterval: string
1362
+
1363
+ /**
1364
+ * 额外的查询条件
1365
+ */
1366
+ Query?: string
1367
+
1368
+ /**
1369
+ * 是否按时间升序排列
1370
+ */
1371
+ Ascending?: boolean
1372
+
1373
+ /**
1374
+ * 用于递归拉取的上下文Key,在上一次请求中返回
1375
+ */
1376
+ Context?: string
1377
+ }
1378
+
1379
+ /**
1380
+ * DescribeVideoGenerationTaskCallback请求参数结构体
1381
+ */
1382
+ export interface DescribeVideoGenerationTaskCallbackRequest {
1383
+ /**
1384
+ * 应用的SdkAppId
1385
+ */
1386
+ SdkAppId: number
1387
+ }
1388
+
1389
+ /**
1390
+ * SetWhiteboardPushCallbackKey请求参数结构体
1391
+ */
1392
+ export interface SetWhiteboardPushCallbackKeyRequest {
1393
+ /**
1394
+ * 应用的SdkAppId
1395
+ */
1396
+ SdkAppId: number
1397
+
1398
+ /**
1399
+ * 设置白板推流回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
1400
+ */
1401
+ CallbackKey: string
1402
+ }
1403
+
1404
+ /**
1405
+ * DescribeTranscodeSearch请求参数结构体
1406
+ */
1407
+ export type DescribeTranscodeSearchRequest = null
1408
+
1409
+ /**
1410
+ * 鉴权参数
1411
+ */
1412
+ export interface AuthParam {
1413
+ /**
1414
+ * 应用SdkAppId
1415
+ */
1416
+ SdkAppId: number
1417
+
1418
+ /**
1419
+ * 用户ID
1420
+ */
1421
+ UserId: string
1422
+
1423
+ /**
1424
+ * 用户ID对应的签名
1425
+ */
1426
+ UserSig: string
1427
+ }
1428
+
1429
+ /**
1430
+ * 计费用量数据里,带不同指标Tag的详情
1431
+ */
1432
+ export interface Detail {
1433
+ /**
1434
+ * 用量指标
1435
+ */
1436
+ TagName: string
1437
+
1438
+ /**
1439
+ * 用量权重
1440
+ */
1441
+ Weight: number
1442
+
1443
+ /**
1444
+ * 用量的值
1445
+ */
1446
+ Value: number
1447
+ }
1448
+
1449
+ /**
1450
+ * StartWhiteboardPush请求参数结构体
1451
+ */
1452
+ export interface StartWhiteboardPushRequest {
1453
+ /**
1454
+ * 客户的SdkAppId
1455
+ */
1456
+ SdkAppId: number
1457
+
1458
+ /**
1459
+ * 需要推流的白板房间号,取值范围: (1, 4294967295)。
1460
+
1461
+ 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID(比如RoomId为1234,则IM群组的GroupID为"1234")加群进行信令同步,请在开始推流前确保相应IM群组已创建完成,否则会导致推流失败。
1462
+ 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下,默认会以RoomId作为白板流进行推流的TRTC房间号。
1463
+ */
1464
+ RoomId: number
1465
+
1466
+ /**
1467
+ * 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下,这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。
1468
+ 用户ID最大长度不能大于60个字节,该用户ID必须是一个单独的未同时在其他地方使用的用户ID,白板推流服务使用这个用户ID进入房间进行白板音视频推流,若该用户ID和其他地方同时在使用的用户ID重复,会导致白板推流服务与其他使用场景帐号互踢,影响正常推流。
1469
+ */
1470
+ PushUserId: string
1471
+
1472
+ /**
1473
+ * 与PushUserId对应的IM签名(usersig)。
1474
+ */
1475
+ PushUserSig: string
1476
+
1477
+ /**
1478
+ * 白板参数,例如白板宽高、背景颜色等
1479
+ */
1480
+ Whiteboard?: Whiteboard
1481
+
1482
+ /**
1483
+ * 自动停止推流超时时间,单位秒,取值范围[300, 259200], 默认值为1800秒。
1484
+
1485
+ 当白板超过设定时间没有操作的时候,白板推流服务会自动停止白板推流。
1486
+ */
1487
+ AutoStopTimeout?: number
1488
+
1489
+ /**
1490
+ * 对主白板推流任务进行操作时,是否同时同步操作备份任务
1491
+ */
1492
+ AutoManageBackup?: boolean
1493
+
1494
+ /**
1495
+ * 备份白板推流相关参数。
1496
+
1497
+ 指定了备份参数的情况下,白板推流服务会在房间内新增一路白板画面视频流,即同一个房间内会有两路白板画面推流。
1498
+ */
1499
+ Backup?: WhiteboardPushBackupParam
1500
+
1501
+ /**
1502
+ * TRTC高级权限控制参数,如果在实时音视频开启了高级权限控制功能,必须提供PrivateMapKey才能保证正常推流。
1503
+ */
1504
+ PrivateMapKey?: string
1505
+
1506
+ /**
1507
+ * 白板推流视频帧率,取值范围[0, 30],默认20fps
1508
+ */
1509
+ VideoFPS?: number
1510
+
1511
+ /**
1512
+ * 白板推流码率, 取值范围[0, 2000],默认1200kbps。
1513
+
1514
+ 这里的码率设置是一个参考值,实际推流的时候使用的是动态码率,所以真实码率不会固定为指定值,会在指定值附近波动。
1515
+ */
1516
+ VideoBitrate?: number
1517
+
1518
+ /**
1519
+ * 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。
1520
+
1521
+ 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下,不会自动进行白板推流录制,如果希望进行白板推流录制,请将此参数设置为true。
1522
+
1523
+ 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式,可忽略此参数。
1524
+ */
1525
+ AutoRecord?: boolean
1526
+
1527
+ /**
1528
+ * 指定白板推流录制的RecordID,指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容,便于您更方便的识别录制回调,以及在点播媒体资源管理中查找相应的录制视频文件。
1529
+
1530
+ 限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
1531
+
1532
+ 此字段设置后,不管`AutoRecord`字段取值如何,都将自动进行白板推流录制。
1533
+
1534
+ 默认RecordId生成规则如下:
286
1535
  urlencode(SdkAppID_RoomID_PushUserID)
287
1536
 
288
1537
  例如:
@@ -365,75 +1614,69 @@ TRTCAppSceneLIVE - 直播场景,即绝大多数时间都是一人直播,偶
365
1614
  }
366
1615
 
367
1616
  /**
368
- * DescribeTIWRoomDailyUsage请求参数结构体
1617
+ * CreateOfflineRecord请求参数结构体
369
1618
  */
370
- export interface DescribeTIWRoomDailyUsageRequest {
1619
+ export interface CreateOfflineRecordRequest {
371
1620
  /**
372
- * 互动白板应用SdkAppId
1621
+ * 客户的SdkAppId
373
1622
  */
374
1623
  SdkAppId: number
375
1624
 
376
1625
  /**
377
- * 需要查询的子产品用量,支持传入以下值
378
- - sp_tiw_board: 互动白板时长,单位为分钟
379
- - sp_tiw_ric: 实时录制时长,单位分钟
380
- */
381
- SubProduct: string
382
-
383
- /**
384
- * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
385
- */
386
- StartTime: string
387
-
388
- /**
389
- * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
1626
+ * 录制任务对应的房间号
390
1627
  */
391
- EndTime: string
1628
+ RoomId: number
392
1629
 
393
1630
  /**
394
- * 需要查询的房间ID列表,不填默认查询全部房间
1631
+ * 录制任务对应的群组Id
395
1632
  */
396
- RoomIDs?: Array<number>
1633
+ GroupId?: string
397
1634
 
398
1635
  /**
399
- * 查询偏移量,默认为0
400
- */
401
- Offset?: number
1636
+ * 混流参数配置
1637
+ 目前课后录制暂未支持自定义混流布局Custom参数
1638
+ */
1639
+ MixStream?: MixStream
402
1640
 
403
1641
  /**
404
- * 每次查询返回条目限制,默认为20
1642
+ * 白板参数配置
405
1643
  */
406
- Limit?: number
1644
+ Whiteboard?: Whiteboard
407
1645
  }
408
1646
 
409
1647
  /**
410
- * DescribeWhiteboardPush请求参数结构体
1648
+ * 日志查询里返回的白板用户数据
411
1649
  */
412
- export interface DescribeWhiteboardPushRequest {
1650
+ export interface UserListItem {
413
1651
  /**
414
- * 客户的SdkAppId
1652
+ * 房间内的用户ID
415
1653
  */
416
- SdkAppId: number
1654
+ UserId: string
417
1655
 
418
1656
  /**
419
- * 白板推流任务Id
1657
+ * 用户在查询时间段内最早出现的时间,Unix时间戳,单位毫秒
420
1658
  */
421
- TaskId: string
1659
+ StartTime: number
1660
+
1661
+ /**
1662
+ * 用户在查询时间段内最晚出现的时间,Unix时间戳,单位毫秒
1663
+ */
1664
+ EndTime: number
422
1665
  }
423
1666
 
424
1667
  /**
425
- * DescribeQualityMetrics返回参数结构体
1668
+ * DescribeVideoGenerationTaskCallback返回参数结构体
426
1669
  */
427
- export interface DescribeQualityMetricsResponse {
1670
+ export interface DescribeVideoGenerationTaskCallbackResponse {
428
1671
  /**
429
- * 输入的查询指标
1672
+ * 录制视频生成回调地址
430
1673
  */
431
- Metric: string
1674
+ Callback?: string
432
1675
 
433
1676
  /**
434
- * 时间序列
1677
+ * 录制视频生成回调鉴权密钥
435
1678
  */
436
- Content: Array<TimeValue>
1679
+ CallbackKey?: string
437
1680
 
438
1681
  /**
439
1682
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -442,53 +1685,61 @@ export interface DescribeQualityMetricsResponse {
442
1685
  }
443
1686
 
444
1687
  /**
445
- * DescribeTIWRoomDailyUsage返回参数结构体
1688
+ * 实时录制任务搜索结果
446
1689
  */
447
- export interface DescribeTIWRoomDailyUsageResponse {
1690
+ export interface WhiteboardPushTaskSearchResult {
448
1691
  /**
449
- * 指定区间指定产品的房间用量列表
1692
+ * 任务唯一ID
450
1693
  */
451
- Usages: Array<RoomUsageDataItem>
1694
+ TaskId: string
452
1695
 
453
1696
  /**
454
- * 用量列表总数
1697
+ * 白板推流任务状态
1698
+ - PREPARED: 推流在准备阶段
1699
+ - PUSHING: 正在推流
1700
+ - STOPPED:推流已停止
1701
+ */
1702
+ Status: string
1703
+
1704
+ /**
1705
+ * 白板推流房间号
455
1706
  */
456
- Total: number
1707
+ RoomId: number
457
1708
 
458
1709
  /**
459
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1710
+ * 任务创建时间
460
1711
  */
461
- RequestId?: string
462
- }
1712
+ CreateTime: string
463
1713
 
464
- /**
465
- * ResumeOnlineRecord返回参数结构体
466
- */
467
- export interface ResumeOnlineRecordResponse {
468
1714
  /**
469
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1715
+ * 用户应用SdkAppId
470
1716
  */
471
- RequestId?: string
472
- }
1717
+ SdkAppId: number
473
1718
 
474
- /**
475
- * SetVideoGenerationTaskCallback返回参数结构体
476
- */
477
- export interface SetVideoGenerationTaskCallbackResponse {
478
1719
  /**
479
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1720
+ * 白板推流结果
480
1721
  */
481
- RequestId?: string
1722
+ Result: WhiteboardPushResult
1723
+
1724
+ /**
1725
+ * 白板推流用户ID
1726
+ */
1727
+ PushUserId: string
482
1728
  }
483
1729
 
484
1730
  /**
485
- * SetWhiteboardPushCallbackKey返回参数结构体
1731
+ * ModifyWhiteboardApplicationConfig请求参数结构体
486
1732
  */
487
- export interface SetWhiteboardPushCallbackKeyResponse {
1733
+ export interface ModifyWhiteboardApplicationConfigRequest {
488
1734
  /**
489
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1735
+ * 客户的SdkAppId
490
1736
  */
491
- RequestId?: string
1737
+ SdkAppId: number
1738
+
1739
+ /**
1740
+ * 白板应用任务相关配置
1741
+ */
1742
+ Configs: Array<WhiteboardApplicationConfig>
492
1743
  }
493
1744
 
494
1745
  /**
@@ -616,80 +1867,143 @@ VIDEO_GENERATION_MODE - 视频生成模式(内测中,需邮件申请开通
616
1867
  }
617
1868
 
618
1869
  /**
619
- * DescribeVideoGenerationTaskCallback返回参数结构体
1870
+ * DescribeUserStatus请求参数结构体
620
1871
  */
621
- export interface DescribeVideoGenerationTaskCallbackResponse {
1872
+ export type DescribeUserStatusRequest = null
1873
+
1874
+ /**
1875
+ * DescribeOnlineRecordCallback请求参数结构体
1876
+ */
1877
+ export interface DescribeOnlineRecordCallbackRequest {
1878
+ /**
1879
+ * 应用的SdkAppId
1880
+ */
1881
+ SdkAppId: number
1882
+ }
1883
+
1884
+ /**
1885
+ * SetTranscodeCallback返回参数结构体
1886
+ */
1887
+ export interface SetTranscodeCallbackResponse {
1888
+ /**
1889
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1890
+ */
1891
+ RequestId?: string
1892
+ }
1893
+
1894
+ /**
1895
+ * StopOnlineRecord请求参数结构体
1896
+ */
1897
+ export interface StopOnlineRecordRequest {
1898
+ /**
1899
+ * 客户的SdkAppId
1900
+ */
1901
+ SdkAppId: number
1902
+
1903
+ /**
1904
+ * 需要停止录制的任务 Id
1905
+ */
1906
+ TaskId: string
1907
+ }
1908
+
1909
+ /**
1910
+ * SetOfflineRecordCallback请求参数结构体
1911
+ */
1912
+ export interface SetOfflineRecordCallbackRequest {
1913
+ /**
1914
+ * 客户的SdkAppId
1915
+ */
1916
+ SdkAppId: number
1917
+
1918
+ /**
1919
+ * 课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头
1920
+ */
1921
+ Callback: string
1922
+ }
1923
+
1924
+ /**
1925
+ * SetVideoGenerationTaskCallback返回参数结构体
1926
+ */
1927
+ export interface SetVideoGenerationTaskCallbackResponse {
1928
+ /**
1929
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1930
+ */
1931
+ RequestId?: string
1932
+ }
1933
+
1934
+ /**
1935
+ * 白板应用
1936
+ */
1937
+ export interface ApplicationItem {
1938
+ /**
1939
+ * 应用SdkAppId
1940
+ */
1941
+ SdkAppId: number
1942
+
622
1943
  /**
623
- * 录制视频生成回调地址
1944
+ * 应用名
624
1945
  */
625
- Callback?: string
1946
+ AppName: string
626
1947
 
627
1948
  /**
628
- * 录制视频生成回调鉴权密钥
1949
+ * 创建时间
629
1950
  */
630
- CallbackKey?: string
1951
+ CreateTime: string
631
1952
 
632
1953
  /**
633
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1954
+ * 标签列表
634
1955
  */
635
- RequestId?: string
1956
+ TagList: Array<Tag>
636
1957
  }
637
1958
 
638
1959
  /**
639
- * 拼接视频中被忽略的时间段
1960
+ * ModifyWhiteboardApplicationConfig返回参数结构体
640
1961
  */
641
- export interface OmittedDuration {
1962
+ export interface ModifyWhiteboardApplicationConfigResponse {
642
1963
  /**
643
- * 录制暂停时间戳对应的视频播放时间(单位: 毫秒)
1964
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
644
1965
  */
645
- VideoTime: number
1966
+ RequestId?: string
1967
+ }
646
1968
 
1969
+ /**
1970
+ * SetVideoGenerationTaskCallback请求参数结构体
1971
+ */
1972
+ export interface SetVideoGenerationTaskCallbackRequest {
647
1973
  /**
648
- * 录制暂停时间戳(单位: 毫秒)
1974
+ * 客户的SdkAppId
649
1975
  */
650
- PauseTime: number
1976
+ SdkAppId: number
651
1977
 
652
1978
  /**
653
- * 录制恢复时间戳(单位: 毫秒)
1979
+ * 课后录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头
654
1980
  */
655
- ResumeTime: number
1981
+ Callback: string
656
1982
  }
657
1983
 
658
1984
  /**
659
- * DescribeSnapshotTask返回参数结构体
1985
+ * SetWhiteboardPushCallback请求参数结构体
660
1986
  */
661
- export interface DescribeSnapshotTaskResponse {
662
- /**
663
- * 任务ID
664
- 注意:此字段可能返回 null,表示取不到有效值。
665
- */
666
- TaskID: string
667
-
668
- /**
669
- * 任务状态
670
- Running - 任务执行中
671
- Finished - 任务已结束
672
- 注意:此字段可能返回 null,表示取不到有效值。
673
- */
674
- Status: string
675
-
1987
+ export interface SetWhiteboardPushCallbackRequest {
676
1988
  /**
677
- * 任务创建时间,单位s
678
- 注意:此字段可能返回 null,表示取不到有效值。
679
- */
680
- CreateTime: number
1989
+ * 客户的SdkAppId
1990
+ */
1991
+ SdkAppId: number
681
1992
 
682
1993
  /**
683
- * 任务完成时间,单位s
684
- 注意:此字段可能返回 null,表示取不到有效值。
685
- */
686
- FinishTime: number
1994
+ * 白板推流任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40257
1995
+ */
1996
+ Callback: string
1997
+ }
687
1998
 
1999
+ /**
2000
+ * DescribeTIWDailyUsage返回参数结构体
2001
+ */
2002
+ export interface DescribeTIWDailyUsageResponse {
688
2003
  /**
689
- * 任务结果信息
690
- 注意:此字段可能返回 null,表示取不到有效值。
691
- */
692
- Result: SnapshotResult
2004
+ * 指定区间指定产品的用量汇总
2005
+ */
2006
+ Usages: Array<UsageDataItem>
693
2007
 
694
2008
  /**
695
2009
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -698,49 +2012,41 @@ Finished - 任务已结束
698
2012
  }
699
2013
 
700
2014
  /**
701
- * StartWhiteboardPush返回参数结构体
2015
+ * 实时录制视频拼接参数
702
2016
  */
703
- export interface StartWhiteboardPushResponse {
704
- /**
705
- * 推流任务Id
706
- */
707
- TaskId?: string
708
-
2017
+ export interface Concat {
709
2018
  /**
710
- * 备份任务结果参数
711
- 注意:此字段可能返回 null,表示取不到有效值。
2019
+ * 是否开启拼接功能
2020
+ 在开启了视频拼接功能的情况下,实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频
712
2021
  */
713
- Backup?: string
2022
+ Enabled: boolean
714
2023
 
715
2024
  /**
716
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2025
+ * 视频拼接时使用的垫片图片下载地址,不填默认用全黑的图片进行视频垫片
717
2026
  */
718
- RequestId?: string
2027
+ Image?: string
719
2028
  }
720
2029
 
721
2030
  /**
722
- * ResumeOnlineRecord请求参数结构体
2031
+ * DescribeWhiteboardApplicationConfig请求参数结构体
723
2032
  */
724
- export interface ResumeOnlineRecordRequest {
2033
+ export interface DescribeWhiteboardApplicationConfigRequest {
725
2034
  /**
726
2035
  * 客户的SdkAppId
727
2036
  */
728
2037
  SdkAppId: number
729
2038
 
730
2039
  /**
731
- * 恢复录制的实时录制任务 Id
732
- */
733
- TaskId: string
734
- }
2040
+ * 需要查询的任务类型
2041
+ recording: 实时录制
2042
+ transcode: 文档转码
2043
+ */
2044
+ TaskTypes: Array<string>
735
2045
 
736
- /**
737
- * DescribeOnlineRecordCallback请求参数结构体
738
- */
739
- export interface DescribeOnlineRecordCallbackRequest {
740
2046
  /**
741
- * 应用的SdkAppId
2047
+ * 需要查询配置的SdkAppId列表
742
2048
  */
743
- SdkAppId: number
2049
+ SdkAppIds?: Array<number>
744
2050
  }
745
2051
 
746
2052
  /**
@@ -774,129 +2080,175 @@ export interface SnapshotCOS {
774
2080
  }
775
2081
 
776
2082
  /**
777
- * StopWhiteboardPush请求参数结构体
2083
+ * CreateVideoGenerationTask返回参数结构体
778
2084
  */
779
- export interface StopWhiteboardPushRequest {
2085
+ export interface CreateVideoGenerationTaskResponse {
780
2086
  /**
781
- * 客户的SdkAppId
2087
+ * 视频生成的任务Id
782
2088
  */
783
- SdkAppId: number
2089
+ TaskId?: string
784
2090
 
785
2091
  /**
786
- * 需要停止的白板推流任务 Id
2092
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
787
2093
  */
788
- TaskId: string
2094
+ RequestId?: string
789
2095
  }
790
2096
 
791
2097
  /**
792
- * SetTranscodeCallback返回参数结构体
2098
+ * 实时录制白板参数,例如白板宽高等
793
2099
  */
794
- export interface SetTranscodeCallbackResponse {
2100
+ export interface Whiteboard {
795
2101
  /**
796
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2102
+ * 实时录制结果里白板视频宽,取值必须大于等于2,默认为1280
797
2103
  */
798
- RequestId?: string
2104
+ Width?: number
2105
+
2106
+ /**
2107
+ * 实时录制结果里白板视频高,取值必须大于等于2,默认为960
2108
+ */
2109
+ Height?: number
2110
+
2111
+ /**
2112
+ * 白板初始化参数,透传到白板 SDK
2113
+ */
2114
+ InitParam?: string
799
2115
  }
800
2116
 
801
2117
  /**
802
- * StopOnlineRecord请求参数结构体
2118
+ * PauseOnlineRecord返回参数结构体
803
2119
  */
804
- export interface StopOnlineRecordRequest {
2120
+ export interface PauseOnlineRecordResponse {
805
2121
  /**
806
- * 客户的SdkAppId
2122
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
807
2123
  */
808
- SdkAppId: number
2124
+ RequestId?: string
2125
+ }
809
2126
 
2127
+ /**
2128
+ * ModifyWhiteboardBucketConfig返回参数结构体
2129
+ */
2130
+ export interface ModifyWhiteboardBucketConfigResponse {
810
2131
  /**
811
- * 需要停止录制的任务 Id
2132
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
812
2133
  */
813
- TaskId: string
2134
+ RequestId?: string
814
2135
  }
815
2136
 
816
2137
  /**
817
- * 生成白板板书时的白板参数,例如白板宽高等
2138
+ * CreateSnapshotTask请求参数结构体
818
2139
  */
819
- export interface SnapshotWhiteboard {
2140
+ export interface CreateSnapshotTaskRequest {
820
2141
  /**
821
- * 白板宽度大小,默认为1280,有效取值范围[0,2560]
2142
+ * 白板相关参数
822
2143
  */
823
- Width?: number
2144
+ Whiteboard: SnapshotWhiteboard
824
2145
 
825
2146
  /**
826
- * 白板高度大小,默认为720,有效取值范围[0,2560]
2147
+ * 白板房间 `SdkAppId`
827
2148
  */
828
- Height?: number
2149
+ SdkAppId: number
829
2150
 
830
2151
  /**
831
- * 白板初始化参数的JSON转义字符串,透传到白板 SDK
2152
+ * 白板房间号
832
2153
  */
833
- InitParams?: string
2154
+ RoomId: number
2155
+
2156
+ /**
2157
+ * 白板板书生成结果通知回调地址
2158
+ */
2159
+ CallbackURL?: string
2160
+
2161
+ /**
2162
+ * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
2163
+ */
2164
+ COS?: SnapshotCOS
2165
+
2166
+ /**
2167
+ * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
2168
+
2169
+ `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
2170
+
2171
+ `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
2172
+
2173
+ (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
2174
+ */
2175
+ SnapshotMode?: string
834
2176
  }
835
2177
 
836
2178
  /**
837
- * 互动白板用量信息
2179
+ * DescribeTranscode返回参数结构体
838
2180
  */
839
- export interface UsageDataItem {
2181
+ export interface DescribeTranscodeResponse {
840
2182
  /**
841
- * 日期,格式为YYYY-MM-DD
2183
+ * 文档的总页数
842
2184
  */
843
- Time: string
2185
+ Pages?: number
844
2186
 
845
2187
  /**
846
- * 白板应用SDKAppID
2188
+ * 转码的当前进度,取值范围为0~100
847
2189
  */
848
- SdkAppId: number
2190
+ Progress?: number
849
2191
 
850
2192
  /**
851
- * 互动白板子产品,请求参数传入的一致
852
- - sp_tiw_board: 互动白板时长
853
- - sp_tiw_dt: 动态转码页数
854
- - sp_tiw_st: 静态转码页数
855
- - sp_tiw_ric: 实时录制时长
2193
+ * 文档的分辨率
2194
+ */
2195
+ Resolution?: string
2196
+
2197
+ /**
2198
+ * 转码完成后结果的URL
2199
+ 动态转码:PPT转动态H5的链接
2200
+ 静态转码:文档每一页的图片URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`,那么文档第1页的图片URL为
2201
+ `http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推
856
2202
  */
857
- SubProduct: string
2203
+ ResultUrl?: string
858
2204
 
859
2205
  /**
860
- * 用量值
861
- - 静态转码、动态转码单位为页
862
- - 白板时长、实时录制时长单位为分钟
2206
+ * 任务的当前状态
2207
+ - QUEUED: 正在排队等待转换
2208
+ - PROCESSING: 转换中
2209
+ - FINISHED: 转换完成
863
2210
  */
864
- Value: number
865
- }
2211
+ Status?: string
866
2212
 
867
- /**
868
- * SetVideoGenerationTaskCallbackKey返回参数结构体
869
- */
870
- export interface SetVideoGenerationTaskCallbackKeyResponse {
871
2213
  /**
872
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2214
+ * 转码任务的唯一标识Id
873
2215
  */
874
- RequestId?: string
875
- }
2216
+ TaskId?: string
876
2217
 
877
- /**
878
- * CreateTranscode返回参数结构体
879
- */
880
- export interface CreateTranscodeResponse {
881
2218
  /**
882
- * 文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果
2219
+ * 文档的文件名
2220
+ */
2221
+ Title?: string
2222
+
2223
+ /**
2224
+ * 缩略图URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `,那么动态PPT第1页的缩略图URL为
2225
+ `http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推
2226
+
2227
+ 如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串
2228
+ */
2229
+ ThumbnailUrl?: string
2230
+
2231
+ /**
2232
+ * 动态转码缩略图生成分辨率
2233
+ */
2234
+ ThumbnailResolution?: string
2235
+
2236
+ /**
2237
+ * 转码压缩文件下载的URL,如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式,该参数为空字符串
883
2238
  */
884
- TaskId: string
2239
+ CompressFileUrl?: string
885
2240
 
886
2241
  /**
887
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
888
- */
889
- RequestId?: string
890
- }
2242
+ * 资源清单文件下载URL(内测体验)
2243
+ 注意:此字段可能返回 null,表示取不到有效值。
2244
+ */
2245
+ ResourceListUrl?: string
891
2246
 
892
- /**
893
- * CreateSnapshotTask返回参数结构体
894
- */
895
- export interface CreateSnapshotTaskResponse {
896
2247
  /**
897
- * 白板板书生成任务ID,只有任务创建成功的时候才会返回此字段
898
- */
899
- TaskID: string
2248
+ * 文档制作方式(内测体验)
2249
+ 注意:此字段可能返回 null,表示取不到有效值。
2250
+ */
2251
+ Ext?: string
900
2252
 
901
2253
  /**
902
2254
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -905,51 +2257,48 @@ export interface CreateSnapshotTaskResponse {
905
2257
  }
906
2258
 
907
2259
  /**
908
- * DescribeVideoGenerationTask返回参数结构体
2260
+ * SetOnlineRecordCallbackKey请求参数结构体
909
2261
  */
910
- export interface DescribeVideoGenerationTaskResponse {
911
- /**
912
- * 任务对应的群组Id
913
- */
914
- GroupId?: string
915
-
2262
+ export interface SetOnlineRecordCallbackKeyRequest {
916
2263
  /**
917
- * 任务对应的房间号
2264
+ * 应用的SdkAppId
918
2265
  */
919
- RoomId?: number
2266
+ SdkAppId: number
920
2267
 
921
2268
  /**
922
- * 任务的Id
2269
+ * 设置实时录制回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
923
2270
  */
924
- TaskId?: string
2271
+ CallbackKey: string
2272
+ }
925
2273
 
2274
+ /**
2275
+ * ModifyApplication请求参数结构体
2276
+ */
2277
+ export interface ModifyApplicationRequest {
926
2278
  /**
927
- * 已废弃
2279
+ * 应用SdkAppId
928
2280
  */
929
- Progress?: number
930
-
931
- /**
932
- * 录制视频生成任务状态
933
- - QUEUED: 正在排队
934
- - PROCESSING: 正在生成视频
935
- - FINISHED: 生成视频结束(成功完成或失败结束,可以通过错误码和错误信息进一步判断)
936
- */
937
- Status?: string
2281
+ SdkAppId: number
938
2282
 
939
2283
  /**
940
- * 回放视频总时长,单位:毫秒
2284
+ * App名字
941
2285
  */
942
- TotalTime?: number
2286
+ AppName: string
2287
+ }
943
2288
 
2289
+ /**
2290
+ * DescribeOnlineRecordCallback返回参数结构体
2291
+ */
2292
+ export interface DescribeOnlineRecordCallbackResponse {
944
2293
  /**
945
- * 已废弃,请使用`VideoInfoList`参数
2294
+ * 实时录制事件回调地址,如果未设置回调地址,该字段为空字符串
946
2295
  */
947
- VideoInfos?: VideoInfo
2296
+ Callback: string
948
2297
 
949
2298
  /**
950
- * 录制视频生成视频列表
2299
+ * 实时录制回调鉴权密钥
951
2300
  */
952
- VideoInfoList?: Array<VideoInfo>
2301
+ CallbackKey: string
953
2302
 
954
2303
  /**
955
2304
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -958,19 +2307,9 @@ export interface DescribeVideoGenerationTaskResponse {
958
2307
  }
959
2308
 
960
2309
  /**
961
- * DescribeWhiteboardPushCallback返回参数结构体
2310
+ * SetOfflineRecordCallback返回参数结构体
962
2311
  */
963
- export interface DescribeWhiteboardPushCallbackResponse {
964
- /**
965
- * 白板推流事件回调地址,如果未设置回调地址,该字段为空字符串
966
- */
967
- Callback: string
968
-
969
- /**
970
- * 白板推流回调鉴权密钥
971
- */
972
- CallbackKey: string
973
-
2312
+ export interface SetOfflineRecordCallbackResponse {
974
2313
  /**
975
2314
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
976
2315
  */
@@ -978,215 +2317,189 @@ export interface DescribeWhiteboardPushCallbackResponse {
978
2317
  }
979
2318
 
980
2319
  /**
981
- * 自定义混流布局参数
2320
+ * 录制控制参数, 用于指定全局录制控制及具体流录制控制参数,比如设置需要对哪些流进行录制,是否只录制小画面等
982
2321
  */
983
- export interface CustomLayout {
2322
+ export interface RecordControl {
984
2323
  /**
985
- * 混流画布参数
2324
+ * 设置是否开启录制控制参数,只有设置为true的时候,录制控制参数才生效。
986
2325
  */
987
- Canvas: Canvas
2326
+ Enabled: boolean
988
2327
 
989
2328
  /**
990
- * 流布局参数,每路流的布局不能超出画布区域
991
- */
992
- InputStreamList: Array<StreamLayout>
993
- }
2329
+ * 设置是否禁用录制的全局控制参数。一般与`StreamControls`参数配合使用。
2330
+
2331
+ true - 所有流都不录制。
2332
+ false - 所有流都录制。默认为false。
2333
+
2334
+ 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
2335
+ */
2336
+ DisableRecord?: boolean
994
2337
 
995
- /**
996
- * 实时录制中出现的用户视频流断流次数统计
997
- */
998
- export interface Interrupt {
999
2338
  /**
1000
- * 用户ID
1001
- 注意:此字段可能返回 null,表示取不到有效值。
2339
+ * 设置是否禁用所有流的音频录制的全局控制参数。一般与`StreamControls`参数配合使用。
2340
+
2341
+ true - 所有流的录制都不对音频进行录制。
2342
+ false - 所有流的录制都需要对音频进行录制。默认为false。
2343
+
2344
+ 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
1002
2345
  */
1003
- UserId: string
2346
+ DisableAudio?: boolean
1004
2347
 
1005
2348
  /**
1006
- * 视频流断流次数
1007
- 注意:此字段可能返回 null,表示取不到有效值。
2349
+ * 设置是否所有流都只录制小画面的全局控制参数。一般与`StreamControls`参数配合使用。
2350
+
2351
+ true - 所有流都只录制小画面。设置为true时,请确保上行端在推流的时候同时上行了小画面,否则录制视频可能是黑屏。
2352
+ false - 所有流都录制大画面,默认为false。
2353
+
2354
+ 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
1008
2355
  */
1009
- Count: number
2356
+ PullSmallVideo?: boolean
2357
+
2358
+ /**
2359
+ * 针对具体流指定控制参数,如果列表为空,则所有流采用全局配置的控制参数进行录制。列表不为空,则列表中指定的流将优先按此列表指定的控制参数进行录制。
2360
+ */
2361
+ StreamControls?: Array<StreamControl>
1010
2362
  }
1011
2363
 
1012
2364
  /**
1013
- * 视频信息
2365
+ * DescribeQualityMetrics返回参数结构体
1014
2366
  */
1015
- export interface VideoInfo {
2367
+ export interface DescribeQualityMetricsResponse {
1016
2368
  /**
1017
- * 视频开始播放的时间(单位:毫秒)
2369
+ * 输入的查询指标
1018
2370
  */
1019
- VideoPlayTime: number
2371
+ Metric: string
1020
2372
 
1021
2373
  /**
1022
- * 视频大小(字节)
2374
+ * 时间序列
1023
2375
  */
1024
- VideoSize: number
2376
+ Content: Array<TimeValue>
1025
2377
 
1026
2378
  /**
1027
- * 视频格式
2379
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1028
2380
  */
1029
- VideoFormat: string
2381
+ RequestId?: string
2382
+ }
1030
2383
 
2384
+ /**
2385
+ * 转码任务结果
2386
+ */
2387
+ export interface TranscodeTaskResult {
1031
2388
  /**
1032
- * 视频播放时长(单位:毫秒)
2389
+ * 转码结果地址
1033
2390
  */
1034
- VideoDuration: number
2391
+ ResultUrl: string
1035
2392
 
1036
2393
  /**
1037
- * 视频文件URL
2394
+ * 分辨率
1038
2395
  */
1039
- VideoUrl: string
2396
+ Resolution: string
1040
2397
 
1041
2398
  /**
1042
- * 视频文件Id
2399
+ * 标题(一般为文件名)
1043
2400
  */
1044
- VideoId: string
1045
-
1046
- /**
1047
- * 视频流类型
1048
- - 0:摄像头视频
1049
- - 1:屏幕分享视频
1050
- - 2:白板视频
1051
- - 3:混流视频
1052
- - 4:纯音频(mp3)
1053
- */
1054
- VideoType: number
2401
+ Title: string
1055
2402
 
1056
2403
  /**
1057
- * 摄像头/屏幕分享视频所属用户的 Id(白板视频为空、混流视频tic_mixstream_房间号_混流布局类型、辅路视频tic_substream_用户Id)
2404
+ * 转码页数
1058
2405
  */
1059
- UserId: string
2406
+ Pages: number
1060
2407
 
1061
2408
  /**
1062
- * 视频分辨率的宽
1063
- */
1064
- Width: number
2409
+ * 缩略图URL前缀,比如,该URL前缀为http://example.com/g0jb42ps49vtebjshilb/,那么动态PPT第1页的缩略图URL为
2410
+ http://example.com/g0jb42ps49vtebjshilb/1.jpg,其它页以此类推
2411
+
2412
+ 如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串
2413
+ */
2414
+ ThumbnailUrl: string
1065
2415
 
1066
2416
  /**
1067
- * 视频分辨率的高
2417
+ * 动态转码缩略图生成分辨率
1068
2418
  */
1069
- Height: number
1070
- }
2419
+ ThumbnailResolution: string
1071
2420
 
1072
- /**
1073
- * SetTranscodeCallbackKey返回参数结构体
1074
- */
1075
- export interface SetTranscodeCallbackKeyResponse {
1076
2421
  /**
1077
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2422
+ * 转码压缩文件下载的URL,如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式,该参数为空字符串
1078
2423
  */
1079
- RequestId?: string
1080
- }
2424
+ CompressFileUrl: string
1081
2425
 
1082
- /**
1083
- * DescribeTIWDailyUsage返回参数结构体
1084
- */
1085
- export interface DescribeTIWDailyUsageResponse {
1086
2426
  /**
1087
- * 指定区间指定产品的用量汇总
2427
+ * 任务失败错误码
1088
2428
  */
1089
- Usages: Array<UsageDataItem>
2429
+ ErrorCode: number
1090
2430
 
1091
2431
  /**
1092
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2432
+ * 任务失败错误信息
1093
2433
  */
1094
- RequestId?: string
2434
+ ErrorMsg: string
1095
2435
  }
1096
2436
 
1097
2437
  /**
1098
- * 实时录制视频拼接参数
2438
+ * DescribeIMApplications返回参数结构体
1099
2439
  */
1100
- export interface Concat {
1101
- /**
1102
- * 是否开启拼接功能
1103
- 在开启了视频拼接功能的情况下,实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频
1104
- */
1105
- Enabled: boolean
1106
-
2440
+ export interface DescribeIMApplicationsResponse {
1107
2441
  /**
1108
- * 视频拼接时使用的垫片图片下载地址,不填默认用全黑的图片进行视频垫片
2442
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1109
2443
  */
1110
- Image?: string
2444
+ RequestId?: string
1111
2445
  }
1112
2446
 
1113
2447
  /**
1114
- * DescribeOnlineRecord请求参数结构体
2448
+ * SetOnlineRecordCallback请求参数结构体
1115
2449
  */
1116
- export interface DescribeOnlineRecordRequest {
2450
+ export interface SetOnlineRecordCallbackRequest {
1117
2451
  /**
1118
2452
  * 客户的SdkAppId
1119
2453
  */
1120
2454
  SdkAppId: number
1121
2455
 
1122
2456
  /**
1123
- * 实时录制任务Id
2457
+ * 实时录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40258
1124
2458
  */
1125
- TaskId: string
2459
+ Callback: string
1126
2460
  }
1127
2461
 
1128
2462
  /**
1129
- * DescribeWhiteboardPush返回参数结构体
2463
+ * DescribeUserList请求参数结构体
1130
2464
  */
1131
- export interface DescribeWhiteboardPushResponse {
1132
- /**
1133
- * 推流结束原因,
1134
- - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
1135
- - USER_CALL: 主动调用了停止推流接口
1136
- - EXCEPTION: 推流异常结束
1137
- */
1138
- FinishReason?: string
1139
-
1140
- /**
1141
- * 需要查询结果的白板推流任务Id
1142
- */
1143
- TaskId?: string
1144
-
1145
- /**
1146
- * 推流任务状态
1147
- - PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
1148
- - PUSHING: 表示推流已开始
1149
- - STOPPED: 表示推流已停止
1150
- */
1151
- Status?: string
1152
-
1153
- /**
1154
- * 房间号
1155
- */
1156
- RoomId?: number
1157
-
2465
+ export interface DescribeUserListRequest {
1158
2466
  /**
1159
- * 白板的群组 Id
2467
+ * 白板应用的SdkAppId
1160
2468
  */
1161
- GroupId?: string
2469
+ SdkAppId: number
1162
2470
 
1163
2471
  /**
1164
- * 推流用户Id
2472
+ * 需要查询用户列表的白板房间号
1165
2473
  */
1166
- PushUserId?: string
2474
+ RoomId: string
1167
2475
 
1168
2476
  /**
1169
- * 实际开始推流时间,Unix 时间戳,单位秒
2477
+ * 查询时间段,Unix时间戳,单位毫秒,第一个值为开始时间戳,第二个值为结束时间
1170
2478
  */
1171
- PushStartTime?: number
2479
+ TimeRange: Array<number>
1172
2480
 
1173
2481
  /**
1174
- * 实际停止推流时间,Unix 时间戳,单位秒
2482
+ * 额外的查询条件
1175
2483
  */
1176
- PushStopTime?: number
2484
+ Query?: string
1177
2485
 
1178
2486
  /**
1179
- * 推流过程中出现异常的次数
2487
+ * 返回最大的数据条数,默认1000
1180
2488
  */
1181
- ExceptionCnt?: number
2489
+ MaxSize?: number
2490
+ }
1182
2491
 
1183
- /**
1184
- * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
1185
- */
1186
- IMSyncTime?: number
2492
+ /**
2493
+ * DescribeUserResources请求参数结构体
2494
+ */
2495
+ export type DescribeUserResourcesRequest = null
1187
2496
 
2497
+ /**
2498
+ * StopWhiteboardPush返回参数结构体
2499
+ */
2500
+ export interface StopWhiteboardPushResponse {
1188
2501
  /**
1189
- * 备份推流任务结果信息
2502
+ * 备份任务相关参数
1190
2503
  注意:此字段可能返回 null,表示取不到有效值。
1191
2504
  */
1192
2505
  Backup?: string
@@ -1198,82 +2511,105 @@ export interface DescribeWhiteboardPushResponse {
1198
2511
  }
1199
2512
 
1200
2513
  /**
1201
- * StartOnlineRecord返回参数结构体
2514
+ * DescribePostpaidUsage请求参数结构体
1202
2515
  */
1203
- export interface StartOnlineRecordResponse {
2516
+ export interface DescribePostpaidUsageRequest {
1204
2517
  /**
1205
- * 录制任务Id
2518
+ * 开始时间
1206
2519
  */
1207
- TaskId: string
2520
+ BeginTime: string
1208
2521
 
1209
2522
  /**
1210
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2523
+ * 结束时间
1211
2524
  */
1212
- RequestId?: string
2525
+ EndTime: string
1213
2526
  }
1214
2527
 
1215
2528
  /**
1216
- * SetOnlineRecordCallbackKey返回参数结构体
2529
+ * 自定义混流配置布局参数
1217
2530
  */
1218
- export interface SetOnlineRecordCallbackKeyResponse {
2531
+ export interface LayoutParams {
1219
2532
  /**
1220
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2533
+ * 流画面宽,取值范围[2,3000]
1221
2534
  */
1222
- RequestId?: string
1223
- }
2535
+ Width: number
1224
2536
 
1225
- /**
1226
- * DescribeVideoGenerationTask请求参数结构体
1227
- */
1228
- export interface DescribeVideoGenerationTaskRequest {
1229
2537
  /**
1230
- * 客户的SdkAppId
2538
+ * 流画面高,取值范围[2,3000]
1231
2539
  */
1232
- SdkAppId: number
2540
+ Height: number
1233
2541
 
1234
2542
  /**
1235
- * 录制视频生成的任务Id
2543
+ * 当前画面左上角顶点相对于Canvas左上角顶点的x轴偏移量,默认为0,取值范围[0,3000]
1236
2544
  */
1237
- TaskId: string
2545
+ X?: number
2546
+
2547
+ /**
2548
+ * 当前画面左上角顶点相对于Canvas左上角顶点的y轴偏移量,默认为0, 取值范围[0,3000]
2549
+ */
2550
+ Y?: number
2551
+
2552
+ /**
2553
+ * 画面z轴位置,默认为0
2554
+ z轴确定了重叠画面的遮盖顺序,z轴值大的画面处于顶层
2555
+ */
2556
+ ZOrder?: number
1238
2557
  }
1239
2558
 
1240
2559
  /**
1241
- * 白板板书结果
2560
+ * 指定流录制的控制参数,比如是否禁用音频、视频是录制大画面还是录制小画面等
1242
2561
  */
1243
- export interface SnapshotResult {
2562
+ export interface StreamControl {
1244
2563
  /**
1245
- * 任务执行错误码
1246
- 注意:此字段可能返回 null,表示取不到有效值。
2564
+ * 视频流ID
2565
+ 视频流ID的取值含义如下:
2566
+ 1. tic_record_user - 表示白板视频流
2567
+ 2. tic_substream - 表示辅路视频流
2568
+ 3. 特定用户ID - 表示指定用户的视频流
2569
+
2570
+ 在实际录制过程中,视频流ID的匹配规则为前缀匹配,只要真实流ID的前缀与指定的流ID一致就认为匹配成功。
1247
2571
  */
1248
- ErrorCode: string
2572
+ StreamId: string
1249
2573
 
1250
2574
  /**
1251
- * 任务执行错误信息
1252
- 注意:此字段可能返回 null,表示取不到有效值。
2575
+ * 设置是否对此路流开启录制。
2576
+
2577
+ true - 表示不对这路流进行录制,录制结果将不包含这路流的视频。
2578
+ false - 表示需要对这路流进行录制,录制结果会包含这路流的视频。
2579
+
2580
+ 默认为 false。
1253
2581
  */
1254
- ErrorMessage: string
2582
+ DisableRecord?: boolean
1255
2583
 
1256
2584
  /**
1257
- * 快照生成图片总数
1258
- 注意:此字段可能返回 null,表示取不到有效值。
2585
+ * 设置是否禁用这路流的音频录制。
2586
+
2587
+ true - 表示不对这路流的音频进行录制,录制结果里这路流的视频将会没有声音。
2588
+ false - 录制视频会保留音频,如果设置为true,则录制视频会丢弃这路流的音频。
2589
+
2590
+ 默认为 false。
1259
2591
  */
1260
- Total: number
2592
+ DisableAudio?: boolean
1261
2593
 
1262
2594
  /**
1263
- * 快照图片链接列表
1264
- 注意:此字段可能返回 null,表示取不到有效值。
2595
+ * 设置当前流录制视频是否只录制小画面。
2596
+
2597
+ true - 录制小画面。设置为true时,请确保上行端同时上行了小画面,否则录制视频可能是黑屏。
2598
+ false - 录制大画面。
2599
+
2600
+ 默认为 false。
1265
2601
  */
1266
- Snapshots: Array<string>
2602
+ PullSmallVideo?: boolean
1267
2603
  }
1268
2604
 
1269
2605
  /**
1270
- * CreateVideoGenerationTask返回参数结构体
2606
+ * DescribeRoomList返回参数结构体
1271
2607
  */
1272
- export interface CreateVideoGenerationTaskResponse {
2608
+ export interface DescribeRoomListResponse {
1273
2609
  /**
1274
- * 视频生成的任务Id
2610
+ * 白板房间列表
1275
2611
  */
1276
- TaskId?: string
2612
+ RoomList: Array<RoomListItem>
1277
2613
 
1278
2614
  /**
1279
2615
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1282,184 +2618,156 @@ export interface CreateVideoGenerationTaskResponse {
1282
2618
  }
1283
2619
 
1284
2620
  /**
1285
- * PauseOnlineRecord返回参数结构体
2621
+ * DescribeIMApplications请求参数结构体
1286
2622
  */
1287
- export interface PauseOnlineRecordResponse {
1288
- /**
1289
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1290
- */
1291
- RequestId?: string
1292
- }
2623
+ export type DescribeIMApplicationsRequest = null
1293
2624
 
1294
2625
  /**
1295
- * CreateTranscode请求参数结构体
2626
+ * ModifyAutoRenewFlag请求参数结构体
1296
2627
  */
1297
- export interface CreateTranscodeRequest {
2628
+ export interface ModifyAutoRenewFlagRequest {
1298
2629
  /**
1299
- * 客户的SdkAppId
2630
+ * 资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费的SubProduct,一般为sp_tiw_package
1300
2631
  */
1301
- SdkAppId: number
2632
+ SubProduct: string
1302
2633
 
1303
2634
  /**
1304
- * 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
2635
+ * 资源Id,从DescribeUserResources接口中获取Level=1的正式月功能费资源Id
1305
2636
  */
1306
- Url: string
1307
-
1308
- /**
1309
- * 是否为静态PPT,默认为False;
1310
- 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
1311
- */
1312
- IsStaticPPT?: boolean
1313
-
1314
- /**
1315
- * 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率
1316
-
1317
- 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率
1318
-
1319
- 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
1320
- */
1321
- MinResolution?: string
2637
+ ResourceId: string
1322
2638
 
1323
2639
  /**
1324
- * 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
2640
+ * 自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续 费,需要设置为0
1325
2641
  */
1326
- ThumbnailResolution?: string
2642
+ AutoRenewFlag: number
2643
+ }
1327
2644
 
2645
+ /**
2646
+ * DescribeSnapshotTask返回参数结构体
2647
+ */
2648
+ export interface DescribeSnapshotTaskResponse {
1328
2649
  /**
1329
- * 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式:
1330
-
1331
- zip: 生成`.zip`压缩包
1332
- tar.gz: 生成`.tar.gz`压缩包
2650
+ * 任务ID
2651
+ 注意:此字段可能返回 null,表示取不到有效值。
1333
2652
  */
1334
- CompressFileType?: string
2653
+ TaskID: string
1335
2654
 
1336
2655
  /**
1337
- * 内部参数
1338
- */
1339
- ExtraData?: string
2656
+ * 任务状态
2657
+ Running - 任务执行中
2658
+ Finished - 任务已结束
2659
+ 注意:此字段可能返回 null,表示取不到有效值。
2660
+ */
2661
+ Status: string
1340
2662
 
1341
2663
  /**
1342
- * 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:<br/>
1343
- - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。<br/>
1344
- - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
1345
- <br/>
1346
- 注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
2664
+ * 任务创建时间,单位s
2665
+ 注意:此字段可能返回 null,表示取不到有效值。
1347
2666
  */
1348
- Priority?: string
2667
+ CreateTime: number
1349
2668
 
1350
2669
  /**
1351
- * 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。
1352
- 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。
1353
-
1354
- 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
2670
+ * 任务完成时间,单位s
2671
+ 注意:此字段可能返回 null,表示取不到有效值。
1355
2672
  */
1356
- MinScaleResolution?: string
2673
+ FinishTime: number
1357
2674
 
1358
2675
  /**
1359
- * 是否对不支持元素开启自动处理的功能。默认不开启。
1360
-
1361
- 在开启自动处理的情况下,会自动进行如下处理:
1362
- 1. 墨迹:移除不支持的墨迹(比如使用WPS画的)
1363
- 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页
1364
- 3. 已损坏音视频:移除PPT上对损坏音视频的引用
2676
+ * 任务结果信息
2677
+ 注意:此字段可能返回 null,表示取不到有效值。
1365
2678
  */
1366
- AutoHandleUnsupportedElement?: boolean
1367
- }
2679
+ Result: SnapshotResult
1368
2680
 
1369
- /**
1370
- * DescribeWhiteboardPushCallback请求参数结构体
1371
- */
1372
- export interface DescribeWhiteboardPushCallbackRequest {
1373
2681
  /**
1374
- * 应用的SdkAppId
2682
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1375
2683
  */
1376
- SdkAppId: number
2684
+ RequestId?: string
1377
2685
  }
1378
2686
 
1379
2687
  /**
1380
- * DescribeOnlineRecord返回参数结构体
2688
+ * DescribeUserStatus返回参数结构体
1381
2689
  */
1382
- export interface DescribeOnlineRecordResponse {
1383
- /**
1384
- * 录制结束原因,
1385
- - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制
1386
- - USER_CALL: 主动调用了停止录制接口
1387
- - EXCEPTION: 录制异常结束
1388
- - FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。
1389
- */
1390
- FinishReason: string
1391
-
2690
+ export interface DescribeUserStatusResponse {
1392
2691
  /**
1393
- * 需要查询结果的录制任务Id
2692
+ * 客户的AppId
1394
2693
  */
1395
- TaskId: string
2694
+ AppId?: number
1396
2695
 
1397
2696
  /**
1398
- * 录制任务状态
1399
- - PREPARED: 表示录制正在准备中(进房/启动录制服务等操作)
1400
- - RECORDING: 表示录制已开始
1401
- - PAUSED: 表示录制已暂停
1402
- - STOPPED: 表示录制已停止,正在处理并上传视频
1403
- - FINISHED: 表示视频处理并上传完成,成功生成录制结果
2697
+ * 是否开通过白板(试用或正式)
2698
+
2699
+ 0: 从未开通过白板服务
2700
+ 1: 已经开通过白板服务
1404
2701
  */
1405
- Status: string
2702
+ IsTiwUser?: number
1406
2703
 
1407
2704
  /**
1408
- * 房间号
2705
+ * 是否开通过互动课堂(试用或正式)
1409
2706
  */
1410
- RoomId: number
2707
+ IsSaaSUser?: number
1411
2708
 
1412
2709
  /**
1413
- * 白板的群组 Id
2710
+ * 是否使用白板的课后录制
1414
2711
  */
1415
- GroupId: string
2712
+ IsTiwOfflineRecordUser?: number
1416
2713
 
1417
2714
  /**
1418
- * 录制用户Id
2715
+ * 用户是否实名认证
1419
2716
  */
1420
- RecordUserId: string
2717
+ IsAuthenticated?: number
1421
2718
 
1422
2719
  /**
1423
- * 实际开始录制时间,Unix 时间戳,单位秒
2720
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1424
2721
  */
1425
- RecordStartTime: number
2722
+ RequestId?: string
2723
+ }
1426
2724
 
2725
+ /**
2726
+ * 流布局参数
2727
+ */
2728
+ export interface StreamLayout {
1427
2729
  /**
1428
- * 实际停止录制时间,Unix 时间戳,单位秒
2730
+ * 流布局配置参数
1429
2731
  */
1430
- RecordStopTime: number
2732
+ LayoutParams: LayoutParams
1431
2733
 
1432
2734
  /**
1433
- * 回放视频总时长(单位:毫秒)
1434
- */
1435
- TotalTime: number
2735
+ * 视频流ID
2736
+ 流ID的取值含义如下:
2737
+ 1. tic_record_user - 表示当前画面用于显示白板视频流
2738
+ 2. tic_substream - 表示当前画面用于显示辅路视频流
2739
+ 3. 特定用户ID - 表示当前画面用于显示指定用户的视频流
2740
+ 4. 不填 - 表示当前画面用于备选,当有新的视频流加入时,会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面
2741
+ */
2742
+ InputStreamId?: string
1436
2743
 
1437
2744
  /**
1438
- * 录制过程中出现异常的次数
2745
+ * 背景颜色,默认为黑色,格式为RGB格式,如红色为"#FF0000"
1439
2746
  */
1440
- ExceptionCnt: number
2747
+ BackgroundColor?: string
1441
2748
 
1442
2749
  /**
1443
- * 拼接视频中被忽略的时间段,只有开启视频拼接功能的时候,这个参数才是有效的
1444
- */
1445
- OmittedDurations: Array<OmittedDuration>
2750
+ * 视频画面填充模式。
1446
2751
 
1447
- /**
1448
- * 录制视频列表
1449
- */
1450
- VideoInfos: Array<VideoInfo>
2752
+ 0 - 自适应模式,对视频画面进行等比例缩放,在指定区域内显示完整的画面。此模式可能存在黑边。
2753
+ 1 - 全屏模式,对视频画面进行等比例缩放,让画面填充满整个指定区域。此模式不会存在黑边,但会将超出区域的那一部分画面裁剪掉。
2754
+ */
2755
+ FillMode?: number
2756
+ }
1451
2757
 
2758
+ /**
2759
+ * DescribeTIWRoomDailyUsage返回参数结构体
2760
+ */
2761
+ export interface DescribeTIWRoomDailyUsageResponse {
1452
2762
  /**
1453
- * 回放URL,需配合信令播放器使用。此字段仅适用于`视频生成模式`
1454
- 注意:此字段可能返回 null,表示取不到有效值。
1455
- */
1456
- ReplayUrl: string
2763
+ * 指定区间指定产品的房间用量列表
2764
+ */
2765
+ Usages: Array<RoomUsageDataItem>
1457
2766
 
1458
2767
  /**
1459
- * 视频流在录制过程中断流次数
1460
- 注意:此字段可能返回 null,表示取不到有效值。
1461
- */
1462
- Interrupts: Array<Interrupt>
2768
+ * 用量列表总数
2769
+ */
2770
+ Total: number
1463
2771
 
1464
2772
  /**
1465
2773
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1468,135 +2776,135 @@ export interface DescribeOnlineRecordResponse {
1468
2776
  }
1469
2777
 
1470
2778
  /**
1471
- * SetTranscodeCallbackKey请求参数结构体
2779
+ * DescribeWhiteboardPushCallback返回参数结构体
1472
2780
  */
1473
- export interface SetTranscodeCallbackKeyRequest {
2781
+ export interface DescribeWhiteboardPushCallbackResponse {
1474
2782
  /**
1475
- * 应用的SdkAppId
2783
+ * 白板推流事件回调地址,如果未设置回调地址,该字段为空字符串
1476
2784
  */
1477
- SdkAppId: number
2785
+ Callback: string
1478
2786
 
1479
2787
  /**
1480
- * 设置文档转码回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
2788
+ * 白板推流回调鉴权密钥
1481
2789
  */
1482
2790
  CallbackKey: string
1483
- }
1484
2791
 
1485
- /**
1486
- * CreateSnapshotTask请求参数结构体
1487
- */
1488
- export interface CreateSnapshotTaskRequest {
1489
2792
  /**
1490
- * 白板相关参数
2793
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1491
2794
  */
1492
- Whiteboard: SnapshotWhiteboard
2795
+ RequestId?: string
2796
+ }
1493
2797
 
2798
+ /**
2799
+ * CreateApplication请求参数结构体
2800
+ */
2801
+ export interface CreateApplicationRequest {
1494
2802
  /**
1495
- * 白板房间 `SdkAppId`
2803
+ * 应用SdkAppId
1496
2804
  */
1497
2805
  SdkAppId: number
1498
2806
 
1499
2807
  /**
1500
- * 白板房间号
2808
+ * App名字
1501
2809
  */
1502
- RoomId: number
2810
+ AppName?: string
1503
2811
 
1504
2812
  /**
1505
- * 白板板书生成结果通知回调地址
2813
+ * 创建IM应用需要的SKey
1506
2814
  */
1507
- CallbackURL?: string
2815
+ SKey?: string
1508
2816
 
1509
2817
  /**
1510
- * 白板板书文件 `COS` 存储参数, 不填默认存储在公共存储桶,公共存储桶的数据仅保存3天
2818
+ * 创建IM应用需要的TinyId
1511
2819
  */
1512
- COS?: SnapshotCOS
2820
+ TinyId?: string
1513
2821
 
1514
2822
  /**
1515
- * 白板板书生成模式,默认为 `AllMarks`。取值说明如下:
1516
-
1517
- `AllMarks` - 全量模式,即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。
1518
-
1519
- `LatestMarksOnly` - 单页去重模式,即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。
1520
-
1521
- (**注意:`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效,否则即使在调用本API是指定了 `LatestMarksOnly` 模式,服务后台会使用默认的 `AllMarks` 模式生成白板板书**)
1522
- */
1523
- SnapshotMode?: string
2823
+ * 需要绑定的标签列表
2824
+ */
2825
+ TagList?: Array<Tag>
1524
2826
  }
1525
2827
 
1526
2828
  /**
1527
- * DescribeTranscode返回参数结构体
2829
+ * DescribeWhiteboardPushSearch请求参数结构体
1528
2830
  */
1529
- export interface DescribeTranscodeResponse {
1530
- /**
1531
- * 文档的总页数
1532
- */
1533
- Pages?: number
2831
+ export type DescribeWhiteboardPushSearchRequest = null
1534
2832
 
2833
+ /**
2834
+ * SetTranscodeCallbackKey返回参数结构体
2835
+ */
2836
+ export interface SetTranscodeCallbackKeyResponse {
1535
2837
  /**
1536
- * 转码的当前进度,取值范围为0~100
2838
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1537
2839
  */
1538
- Progress?: number
2840
+ RequestId?: string
2841
+ }
1539
2842
 
2843
+ /**
2844
+ * DescribeWhiteboardPush返回参数结构体
2845
+ */
2846
+ export interface DescribeWhiteboardPushResponse {
1540
2847
  /**
1541
- * 文档的分辨率
1542
- */
1543
- Resolution?: string
2848
+ * 推流结束原因,
2849
+ - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
2850
+ - USER_CALL: 主动调用了停止推流接口
2851
+ - EXCEPTION: 推流异常结束
2852
+ */
2853
+ FinishReason?: string
1544
2854
 
1545
2855
  /**
1546
- * 转码完成后结果的URL
1547
- 动态转码:PPT转动态H5的链接
1548
- 静态转码:文档每一页的图片URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/`,那么文档第1页的图片URL为
1549
- `http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推
1550
- */
1551
- ResultUrl?: string
2856
+ * 需要查询结果的白板推流任务Id
2857
+ */
2858
+ TaskId?: string
1552
2859
 
1553
2860
  /**
1554
- * 任务的当前状态
1555
- - QUEUED: 正在排队等待转换
1556
- - PROCESSING: 转换中
1557
- - FINISHED: 转换完成
2861
+ * 推流任务状态
2862
+ - PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
2863
+ - PUSHING: 表示推流已开始
2864
+ - STOPPED: 表示推流已停止
1558
2865
  */
1559
2866
  Status?: string
1560
2867
 
1561
2868
  /**
1562
- * 转码任务的唯一标识Id
2869
+ * 房间号
1563
2870
  */
1564
- TaskId?: string
2871
+ RoomId?: number
1565
2872
 
1566
2873
  /**
1567
- * 文档的文件名
2874
+ * 白板的群组 Id
1568
2875
  */
1569
- Title?: string
2876
+ GroupId?: string
1570
2877
 
1571
2878
  /**
1572
- * 缩略图URL前缀,比如,该URL前缀为`http://example.com/g0jb42ps49vtebjshilb/ `,那么动态PPT第1页的缩略图URL为
1573
- `http://example.com/g0jb42ps49vtebjshilb/1.jpg`,其它页以此类推
2879
+ * 推流用户Id
2880
+ */
2881
+ PushUserId?: string
1574
2882
 
1575
- 如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串
1576
- */
1577
- ThumbnailUrl?: string
2883
+ /**
2884
+ * 实际开始推流时间,Unix 时间戳,单位秒
2885
+ */
2886
+ PushStartTime?: number
1578
2887
 
1579
2888
  /**
1580
- * 动态转码缩略图生成分辨率
2889
+ * 实际停止推流时间,Unix 时间戳,单位秒
1581
2890
  */
1582
- ThumbnailResolution?: string
2891
+ PushStopTime?: number
1583
2892
 
1584
2893
  /**
1585
- * 转码压缩文件下载的URL,如果发起文档转码请求参数中`CompressFileType`为空或者不是支持的压缩格式,该参数为空字符串
2894
+ * 推流过程中出现异常的次数
1586
2895
  */
1587
- CompressFileUrl?: string
2896
+ ExceptionCnt?: number
1588
2897
 
1589
2898
  /**
1590
- * 资源清单文件下载URL(内测体验)
1591
- 注意:此字段可能返回 null,表示取不到有效值。
1592
- */
1593
- ResourceListUrl?: string
2899
+ * 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
2900
+ */
2901
+ IMSyncTime?: number
1594
2902
 
1595
2903
  /**
1596
- * 文档制作方式(内测体验)
2904
+ * 备份推流任务结果信息
1597
2905
  注意:此字段可能返回 null,表示取不到有效值。
1598
2906
  */
1599
- Ext?: string
2907
+ Backup?: string
1600
2908
 
1601
2909
  /**
1602
2910
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1605,18 +2913,13 @@ export interface DescribeTranscodeResponse {
1605
2913
  }
1606
2914
 
1607
2915
  /**
1608
- * DescribeTranscodeCallback返回参数结构体
2916
+ * StartOnlineRecord返回参数结构体
1609
2917
  */
1610
- export interface DescribeTranscodeCallbackResponse {
1611
- /**
1612
- * 文档转码回调地址
1613
- */
1614
- Callback: string
1615
-
2918
+ export interface StartOnlineRecordResponse {
1616
2919
  /**
1617
- * 文档转码回调鉴权密钥
2920
+ * 录制任务Id
1618
2921
  */
1619
- CallbackKey: string
2922
+ TaskId: string
1620
2923
 
1621
2924
  /**
1622
2925
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1625,185 +2928,154 @@ export interface DescribeTranscodeCallbackResponse {
1625
2928
  }
1626
2929
 
1627
2930
  /**
1628
- * 流布局参数
2931
+ * 标签
1629
2932
  */
1630
- export interface StreamLayout {
2933
+ export interface Tag {
1631
2934
  /**
1632
- * 流布局配置参数
2935
+ * 标签键
1633
2936
  */
1634
- LayoutParams: LayoutParams
1635
-
1636
- /**
1637
- * 视频流ID
1638
- 流ID的取值含义如下:
1639
- 1. tic_record_user - 表示当前画面用于显示白板视频流
1640
- 2. tic_substream - 表示当前画面用于显示辅路视频流
1641
- 3. 特定用户ID - 表示当前画面用于显示指定用户的视频流
1642
- 4. 不填 - 表示当前画面用于备选,当有新的视频流加入时,会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面
1643
- */
1644
- InputStreamId?: string
2937
+ TagKey: string
1645
2938
 
1646
2939
  /**
1647
- * 背景颜色,默认为黑色,格式为RGB格式,如红色为"#FF0000"
2940
+ * 标签值
1648
2941
  */
1649
- BackgroundColor?: string
1650
-
1651
- /**
1652
- * 视频画面填充模式。
1653
-
1654
- 0 - 自适应模式,对视频画面进行等比例缩放,在指定区域内显示完整的画面。此模式可能存在黑边。
1655
- 1 - 全屏模式,对视频画面进行等比例缩放,让画面填充满整个指定区域。此模式不会存在黑边,但会将超出区域的那一部分画面裁剪掉。
1656
- */
1657
- FillMode?: number
2942
+ TagValue: string
1658
2943
  }
1659
2944
 
1660
2945
  /**
1661
- * DescribeQualityMetrics请求参数结构体
2946
+ * DescribeUsageSummary请求参数结构体
1662
2947
  */
1663
- export interface DescribeQualityMetricsRequest {
2948
+ export interface DescribeUsageSummaryRequest {
1664
2949
  /**
1665
- * 白板应用的SdkAppId
2950
+ * 统计时间段的开始时间
1666
2951
  */
1667
- SdkAppId: number
2952
+ BeginTime: string
1668
2953
 
1669
2954
  /**
1670
- * 开始时间,Unix时间戳,单位秒,时间跨度不能超过7天
2955
+ * 统计时间段的结束时间
1671
2956
  */
1672
- StartTime: number
2957
+ EndTime: string
1673
2958
 
1674
2959
  /**
1675
- * 结束时间,Unix时间戳,单位秒,时间跨度不能超过7天
2960
+ * 需要获取用量的子产品列表
1676
2961
  */
1677
- EndTime: number
2962
+ SubProducts: Array<string>
1678
2963
 
1679
2964
  /**
1680
- * 查询的指标,目前支持以下值
1681
- - image_load_total_count: 图片加载总数(单位,次)
1682
- - image_load_fail_count: 图片加载失败数量(单位,次)
1683
- - image_load_success_rate: 图片加载成功率(百分比)
1684
- - ppt_load_total_count: PPT加载总数(单位,次)
1685
- - ppt_load_fail_count: PPT加载失败总数(单位,次)
1686
- - ppt_load_success_rate: PPT加载成功率(单位,百分比)
1687
- - verify_sdk_total_count: 白板鉴权总次数(单位,次)
1688
- - verify_sdk_fail_count: 白板鉴权失败次数(单位,次)
1689
- - verify_sdk_success_rate: 白板鉴权成功率(单位,百分比)
1690
- - verify_sdk_in_one_second_rate: 白板鉴权秒开率(单位,百分比)
1691
- - verify_sdk_cost_avg: 白板鉴权耗时平均时间(单位,毫秒)
2965
+ * true: 返回加权后的数据
2966
+ false: 返回原始数据
1692
2967
  */
1693
- Metric: string
1694
-
1695
- /**
1696
- * 聚合的时间维度,目前只支持1小时,输入值为"1h"
1697
- */
1698
- Interval?: string
2968
+ IsWeighted?: boolean
1699
2969
  }
1700
2970
 
1701
2971
  /**
1702
- * SetOnlineRecordCallbackKey请求参数结构体
2972
+ * 生成白板板书时的白板参数,例如白板宽高等
1703
2973
  */
1704
- export interface SetOnlineRecordCallbackKeyRequest {
2974
+ export interface SnapshotWhiteboard {
1705
2975
  /**
1706
- * 应用的SdkAppId
2976
+ * 白板宽度大小,默认为1280,有效取值范围[0,2560]
1707
2977
  */
1708
- SdkAppId: number
2978
+ Width?: number
1709
2979
 
1710
2980
  /**
1711
- * 设置实时录制回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
2981
+ * 白板高度大小,默认为720,有效取值范围[0,2560]
1712
2982
  */
1713
- CallbackKey: string
1714
- }
2983
+ Height?: number
1715
2984
 
1716
- /**
1717
- * CreateVideoGenerationTask请求参数结构体
1718
- */
1719
- export interface CreateVideoGenerationTaskRequest {
1720
2985
  /**
1721
- * 录制任务的TaskId
2986
+ * 白板初始化参数的JSON转义字符串,透传到白板 SDK
1722
2987
  */
1723
- OnlineRecordTaskId: string
2988
+ InitParams?: string
2989
+ }
1724
2990
 
2991
+ /**
2992
+ * CreateTranscode请求参数结构体
2993
+ */
2994
+ export interface CreateTranscodeRequest {
1725
2995
  /**
1726
2996
  * 客户的SdkAppId
1727
2997
  */
1728
2998
  SdkAppId: number
1729
2999
 
1730
3000
  /**
1731
- * 视频生成的白板参数,例如白板宽高等。
3001
+ * 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
3002
+ */
3003
+ Url: string
1732
3004
 
1733
- 此参数与开始录制接口提供的Whiteboard参数互斥,在本接口与开始录制接口都提供了Whiteboard参数时,优先使用本接口指定的Whiteboard参数进行视频生成,否则使用开始录制接口提供的Whiteboard参数进行视频生成。
3005
+ /**
3006
+ * 是否为静态PPT,默认为False;
3007
+ 如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
1734
3008
  */
1735
- Whiteboard?: Whiteboard
3009
+ IsStaticPPT?: boolean
1736
3010
 
1737
3011
  /**
1738
- * 视频拼接参数
3012
+ * 注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ,使用 MinScaleResolution字段传递分辨率
1739
3013
 
1740
- 此参数与开始录制接口提供的Concat参数互斥,在本接口与开始录制接口都提供了Concat参数时,优先使用本接口指定的Concat参数进行视频拼接,否则使用开始录制接口提供的Concat参数进行视频拼接。
3014
+ 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率
3015
+
3016
+ 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
1741
3017
  */
1742
- Concat?: Concat
3018
+ MinResolution?: string
1743
3019
 
1744
3020
  /**
1745
- * 视频生成混流参数
1746
-
1747
- 此参数与开始录制接口提供的MixStream参数互斥,在本接口与开始录制接口都提供了MixStream参数时,优先使用本接口指定的MixStream参数进行视频混流,否则使用开始录制接口提供的MixStream参数进行视频拼混流。
1748
- */
1749
- MixStream?: MixStream
3021
+ * 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution
3022
+ */
3023
+ ThumbnailResolution?: string
1750
3024
 
1751
3025
  /**
1752
- * 视频生成控制参数,用于更精细地指定需要生成哪些流,某一路流是否禁用音频,是否只录制小画面等
3026
+ * 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式:
1753
3027
 
1754
- 此参数与开始录制接口提供的RecordControl参数互斥,在本接口与开始录制接口都提供了RecordControl参数时,优先使用本接口指定的RecordControl参数进行视频生成控制,否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。
3028
+ zip: 生成`.zip`压缩包
3029
+ tar.gz: 生成`.tar.gz`压缩包
1755
3030
  */
1756
- RecordControl?: RecordControl
3031
+ CompressFileType?: string
1757
3032
 
1758
3033
  /**
1759
3034
  * 内部参数
1760
3035
  */
1761
3036
  ExtraData?: string
1762
- }
1763
3037
 
1764
- /**
1765
- * DescribeTranscodeCallback请求参数结构体
1766
- */
1767
- export interface DescribeTranscodeCallbackRequest {
1768
3038
  /**
1769
- * 应用的SdkAppId
1770
- */
1771
- SdkAppId: number
1772
- }
3039
+ * 文档转码优先级, 只有对于PPT动态转码生效,支持填入以下值:<br/>
3040
+ - low: 低优先级转码,对于动态转码,能支持500MB(下载超时时间10分钟)以及2000页文档,但资源有限可能会有比较长时间的排队,请酌情使用该功能。<br/>
3041
+ - 不填表示正常优先级转码,支持200MB文件(下载超时时间2分钟),500页以内的文档进行转码
3042
+ <br/>
3043
+ 注意:对于PDF等静态文件转码,无论是正常优先级或者低优先级,最大只能支持200MB
3044
+ */
3045
+ Priority?: string
1773
3046
 
1774
- /**
1775
- * DescribeTranscode请求参数结构体
1776
- */
1777
- export interface DescribeTranscodeRequest {
1778
3047
  /**
1779
- * 客户的SdkAppId
1780
- */
1781
- SdkAppId: number
3048
+ * 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。
3049
+ 分辨率越高,效果越清晰,转出来的图片资源体积会越大,课件加载耗时会变长,请根据实际使用场景配置此参数。
3050
+
3051
+ 示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x"
3052
+ */
3053
+ MinScaleResolution?: string
1782
3054
 
1783
3055
  /**
1784
- * 文档转码任务的唯一标识Id
1785
- */
1786
- TaskId: string
3056
+ * 是否对不支持元素开启自动处理的功能。默认不开启。
3057
+
3058
+ 在开启自动处理的情况下,会自动进行如下处理:
3059
+ 1. 墨迹:移除不支持的墨迹(比如使用WPS画的)
3060
+ 2. 自动翻页:移除PPT上所有的自动翻页设置,并设置为单击鼠标翻页
3061
+ 3. 已损坏音视频:移除PPT上对损坏音视频的引用
3062
+ */
3063
+ AutoHandleUnsupportedElement?: boolean
1787
3064
  }
1788
3065
 
1789
3066
  /**
1790
- * DescribeOnlineRecordCallback返回参数结构体
3067
+ * SetTranscodeCallbackKey请求参数结构体
1791
3068
  */
1792
- export interface DescribeOnlineRecordCallbackResponse {
3069
+ export interface SetTranscodeCallbackKeyRequest {
1793
3070
  /**
1794
- * 实时录制事件回调地址,如果未设置回调地址,该字段为空字符串
3071
+ * 应用的SdkAppId
1795
3072
  */
1796
- Callback: string
3073
+ SdkAppId: number
1797
3074
 
1798
3075
  /**
1799
- * 实时录制回调鉴权密钥
3076
+ * 设置文档转码回调鉴权密钥,最长64字符,如果传入空字符串,那么删除现有的鉴权回调密钥,回调鉴权方式请参考文档:https://cloud.tencent.com/document/product/1137/40257
1800
3077
  */
1801
3078
  CallbackKey: string
1802
-
1803
- /**
1804
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1805
- */
1806
- RequestId?: string
1807
3079
  }
1808
3080
 
1809
3081
  /**
@@ -1823,57 +3095,30 @@ export interface SetTranscodeCallbackRequest {
1823
3095
  }
1824
3096
 
1825
3097
  /**
1826
- * 互动白板房间用量信息
3098
+ * DescribePostpaidUsage返回参数结构体
1827
3099
  */
1828
- export interface RoomUsageDataItem {
1829
- /**
1830
- * 日期,格式为YYYY-MM-DD
1831
- */
1832
- Time: string
1833
-
1834
- /**
1835
- * 白板应用SDKAppID
1836
- */
1837
- SdkAppId: number
1838
-
1839
- /**
1840
- * 互动白板子产品,请求参数传入的一致
1841
- - sp_tiw_board: 互动白板时长
1842
- - sp_tiw_ric: 实时录制时长
1843
- */
1844
- SubProduct: string
1845
-
3100
+ export interface DescribePostpaidUsageResponse {
1846
3101
  /**
1847
- * 用量值
1848
- - 白板时长、实时录制时长单位为分钟
1849
- */
1850
- Value: number
1851
-
1852
- /**
1853
- * 互动白板房间号
3102
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1854
3103
  */
1855
- RoomID: number
3104
+ RequestId?: string
1856
3105
  }
1857
3106
 
1858
3107
  /**
1859
- * SetWhiteboardPushCallback请求参数结构体
3108
+ * StartWhiteboardPush返回参数结构体
1860
3109
  */
1861
- export interface SetWhiteboardPushCallbackRequest {
3110
+ export interface StartWhiteboardPushResponse {
1862
3111
  /**
1863
- * 客户的SdkAppId
3112
+ * 推流任务Id
1864
3113
  */
1865
- SdkAppId: number
3114
+ TaskId?: string
1866
3115
 
1867
3116
  /**
1868
- * 白板推流任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40257
1869
- */
1870
- Callback: string
1871
- }
3117
+ * 备份任务结果参数
3118
+ 注意:此字段可能返回 null,表示取不到有效值。
3119
+ */
3120
+ Backup?: string
1872
3121
 
1873
- /**
1874
- * SetWhiteboardPushCallback返回参数结构体
1875
- */
1876
- export interface SetWhiteboardPushCallbackResponse {
1877
3122
  /**
1878
3123
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1879
3124
  */
@@ -1881,197 +3126,157 @@ export interface SetWhiteboardPushCallbackResponse {
1881
3126
  }
1882
3127
 
1883
3128
  /**
1884
- * 录制控制参数, 用于指定全局录制控制及具体流录制控制参数,比如设置需要对哪些流进行录制,是否只录制小画面等
3129
+ * 白板应用配置,包括资源存储桶,域名,回调地址,回调密钥等
1885
3130
  */
1886
- export interface RecordControl {
3131
+ export interface WhiteboardApplicationConfig {
1887
3132
  /**
1888
- * 设置是否开启录制控制参数,只有设置为true的时候,录制控制参数才生效。
1889
- */
1890
- Enabled: boolean
1891
-
1892
- /**
1893
- * 设置是否禁用录制的全局控制参数。一般与`StreamControls`参数配合使用。
1894
-
1895
- true - 所有流都不录制。
1896
- false - 所有流都录制。默认为false。
1897
-
1898
- 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
1899
- */
1900
- DisableRecord?: boolean
1901
-
1902
- /**
1903
- * 设置是否禁用所有流的音频录制的全局控制参数。一般与`StreamControls`参数配合使用。
3133
+ * 任务类型
1904
3134
 
1905
- true - 所有流的录制都不对音频进行录制。
1906
- false - 所有流的录制都需要对音频进行录制。默认为false。
1907
-
1908
- 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
3135
+ recording: 实时录制
3136
+ transcode: 文档转码
1909
3137
  */
1910
- DisableAudio?: boolean
3138
+ TaskType: string
1911
3139
 
1912
3140
  /**
1913
- * 设置是否所有流都只录制小画面的全局控制参数。一般与`StreamControls`参数配合使用。
1914
-
1915
- true - 所有流都只录制小画面。设置为true时,请确保上行端在推流的时候同时上行了小画面,否则录制视频可能是黑屏。
1916
- false - 所有流都录制大画面,默认为false。
1917
-
1918
- 这里的设置对所有流都生效,如果同时在 `StreamControls` 列表中针对指定流设置了控制参数,则优先采用`StreamControls`中设置的控制参数。
1919
- */
1920
- PullSmallVideo?: boolean
3141
+ * 存储桶名字
3142
+ */
3143
+ BucketName: string
1921
3144
 
1922
3145
  /**
1923
- * 针对具体流指定控制参数,如果列表为空,则所有流采用全局配置的控制参数进行录制。列表不为空,则列表中指定的流将优先按此列表指定的控制参数进行录制。
3146
+ * 存储桶地域
1924
3147
  */
1925
- StreamControls?: Array<StreamControl>
1926
- }
3148
+ BucketLocation: string
1927
3149
 
1928
- /**
1929
- * DescribeTIWDailyUsage请求参数结构体
1930
- */
1931
- export interface DescribeTIWDailyUsageRequest {
1932
3150
  /**
1933
- * 互动白板应用SdkAppId
3151
+ * 资源在存储桶中的前缀
1934
3152
  */
1935
- SdkAppId: number
3153
+ BucketPrefix: string
1936
3154
 
1937
3155
  /**
1938
- * 需要查询的子产品用量,支持传入以下值
1939
- - sp_tiw_board: 互动白板时长,单位为分钟
1940
- - sp_tiw_dt: 动态转码页数,单位页
1941
- - sp_tiw_st: 静态转码页数,单位页
1942
- - sp_tiw_ric: 实时录制时长,单位分钟
1943
-
1944
- 注意:动态转码以1:8的比例计算文档转码页数,静态转码以1:1的比例计算文档转码页数
1945
- */
1946
- SubProduct: string
3156
+ * 目标CDN域名
3157
+ */
3158
+ ResultDomain: string
1947
3159
 
1948
3160
  /**
1949
- * 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
3161
+ * 回调地址
1950
3162
  */
1951
- StartTime: string
3163
+ Callback: string
1952
3164
 
1953
3165
  /**
1954
- * 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
3166
+ * 回调鉴权密钥
1955
3167
  */
1956
- EndTime: string
1957
- }
3168
+ CallbackKey: string
1958
3169
 
1959
- /**
1960
- * 实时录制白板参数,例如白板宽高等
1961
- */
1962
- export interface Whiteboard {
1963
3170
  /**
1964
- * 实时录制结果里白板视频宽,取值必须大于等于2,默认为1280
3171
+ * 配置的应用SdkAppId
1965
3172
  */
1966
- Width?: number
3173
+ SdkAppId?: number
1967
3174
 
1968
3175
  /**
1969
- * 实时录制结果里白板视频高,取值必须大于等于2,默认为960
3176
+ * IM管理员UserId
1970
3177
  */
1971
- Height?: number
3178
+ AdminUserId?: string
1972
3179
 
1973
3180
  /**
1974
- * 白板初始化参数,透传到白板 SDK
3181
+ * IM管理员UserSig
1975
3182
  */
1976
- InitParam?: string
3183
+ AdminUserSig?: string
1977
3184
  }
1978
3185
 
1979
3186
  /**
1980
- * 混流配置
3187
+ * 转码任务搜索结果
1981
3188
  */
1982
- export interface MixStream {
3189
+ export interface TranscodeTaskSearchResult {
1983
3190
  /**
1984
- * 是否开启混流
3191
+ * 任务创建时间
1985
3192
  */
1986
- Enabled: boolean
3193
+ CreateTime: string
1987
3194
 
1988
3195
  /**
1989
- * 是否禁用音频混流
3196
+ * 任务唯一ID
1990
3197
  */
1991
- DisableAudio?: boolean
3198
+ TaskId: string
1992
3199
 
1993
3200
  /**
1994
- * 内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明
1995
- 在没有填Custom字段时候,ModelId是必填的
3201
+ * 任务的当前状态
3202
+ - QUEUED: 正在排队等待转换
3203
+ - PROCESSING: 转换中
3204
+ - FINISHED: 转换完成
1996
3205
  */
1997
- ModelId?: number
3206
+ Status: string
1998
3207
 
1999
3208
  /**
2000
- * 老师用户ID
2001
- 此字段只有在ModelId填了的情况下生效
2002
- 填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中
2003
- */
2004
- TeacherId?: string
3209
+ * 转码文件原始名称
3210
+ */
3211
+ OriginalFilename: string
2005
3212
 
2006
3213
  /**
2007
- * 自定义混流布局参数
2008
- 当此字段存在时,ModelId 及 TeacherId 字段将被忽略
2009
- */
2010
- Custom?: CustomLayout
2011
- }
3214
+ * 用户应用SdkAppId
3215
+ */
3216
+ SdkAppId: number
2012
3217
 
2013
- /**
2014
- * DescribeVideoGenerationTaskCallback请求参数结构体
2015
- */
2016
- export interface DescribeVideoGenerationTaskCallbackRequest {
2017
3218
  /**
2018
- * 应用的SdkAppId
3219
+ * 转码任务结果
2019
3220
  */
2020
- SdkAppId: number
3221
+ Result: TranscodeTaskResult
3222
+
3223
+ /**
3224
+ * 是否静态转码
3225
+ */
3226
+ IsStatic: boolean
2021
3227
  }
2022
3228
 
2023
3229
  /**
2024
- * SetOnlineRecordCallback请求参数结构体
3230
+ * CreateApplication返回参数结构体
2025
3231
  */
2026
- export interface SetOnlineRecordCallbackRequest {
3232
+ export interface CreateApplicationResponse {
2027
3233
  /**
2028
- * 客户的SdkAppId
3234
+ * 客户的AppId
2029
3235
  */
2030
- SdkAppId: number
3236
+ AppId?: number
2031
3237
 
2032
3238
  /**
2033
- * 实时录制任务结果回调地址,如果传空字符串会删除原来的回调地址配置,回调地址仅支持 http或https协议,即回调地址以http://或https://开头。回调数据格式请参考文档:https://cloud.tencent.com/document/product/1137/40258
3239
+ * App名字
2034
3240
  */
2035
- Callback: string
3241
+ AppName?: string
3242
+
3243
+ /**
3244
+ * 应用SdkAppId
3245
+ */
3246
+ SdkAppId?: number
3247
+
3248
+ /**
3249
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3250
+ */
3251
+ RequestId?: string
2036
3252
  }
2037
3253
 
2038
3254
  /**
2039
- * PauseOnlineRecord请求参数结构体
3255
+ * StopWhiteboardPush请求参数结构体
2040
3256
  */
2041
- export interface PauseOnlineRecordRequest {
3257
+ export interface StopWhiteboardPushRequest {
2042
3258
  /**
2043
3259
  * 客户的SdkAppId
2044
3260
  */
2045
3261
  SdkAppId: number
2046
3262
 
2047
3263
  /**
2048
- * 实时录制任务 Id
3264
+ * 需要停止的白板推流任务 Id
2049
3265
  */
2050
3266
  TaskId: string
2051
3267
  }
2052
3268
 
2053
3269
  /**
2054
- * StopWhiteboardPush返回参数结构体
3270
+ * DescribeOfflineRecord请求参数结构体
2055
3271
  */
2056
- export interface StopWhiteboardPushResponse {
2057
- /**
2058
- * 备份任务相关参数
2059
- 注意:此字段可能返回 null,表示取不到有效值。
2060
- */
2061
- Backup?: string
2062
-
3272
+ export interface DescribeOfflineRecordRequest {
2063
3273
  /**
2064
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3274
+ * 客户的SdkAppId
2065
3275
  */
2066
- RequestId?: string
2067
- }
3276
+ SdkAppId: number
2068
3277
 
2069
- /**
2070
- * SetOnlineRecordCallback返回参数结构体
2071
- */
2072
- export interface SetOnlineRecordCallbackResponse {
2073
3278
  /**
2074
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3279
+ * 课后录制任务的Id
2075
3280
  */
2076
- RequestId?: string
3281
+ TaskId: string
2077
3282
  }