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