tencentcloud-sdk-nodejs 4.0.281 → 4.0.285

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 (43) hide show
  1. package/CHANGELOG.md +258 -0
  2. package/SERVICE_CHANGELOG.md +143 -80
  3. package/package.json +1 -1
  4. package/products.md +9 -8
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ame/v20190916/ame_client.ts +121 -64
  7. package/src/services/ame/v20190916/ame_models.ts +1141 -827
  8. package/src/services/cam/v20190116/cam_models.ts +6 -0
  9. package/src/services/ckafka/v20190819/ckafka_client.ts +12 -0
  10. package/src/services/ckafka/v20190819/ckafka_models.ts +30 -0
  11. package/src/services/cme/v20191029/cme_client.ts +17 -7
  12. package/src/services/cme/v20191029/cme_models.ts +415 -139
  13. package/src/services/index.ts +1 -0
  14. package/src/services/lowcode/index.ts +5 -0
  15. package/src/services/lowcode/v20210108/index.ts +6 -0
  16. package/src/services/lowcode/v20210108/lowcode_client.ts +48 -0
  17. package/src/services/lowcode/v20210108/lowcode_models.ts +359 -0
  18. package/src/services/partners/v20180321/partners_models.ts +4 -4
  19. package/tencentcloud/common/sdk_version.d.ts +1 -1
  20. package/tencentcloud/common/sdk_version.js +1 -1
  21. package/tencentcloud/services/ame/v20190916/ame_client.d.ts +24 -5
  22. package/tencentcloud/services/ame/v20190916/ame_client.js +33 -6
  23. package/tencentcloud/services/ame/v20190916/ame_models.d.ts +1006 -740
  24. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +5 -0
  25. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  26. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  27. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +26 -0
  28. package/tencentcloud/services/cme/v20191029/cme_client.d.ts +1 -1
  29. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +359 -123
  30. package/tencentcloud/services/index.d.ts +1 -0
  31. package/tencentcloud/services/index.js +2 -0
  32. package/tencentcloud/services/lowcode/index.d.ts +6 -0
  33. package/tencentcloud/services/lowcode/index.js +7 -0
  34. package/tencentcloud/services/lowcode/v20210108/index.d.ts +6 -0
  35. package/tencentcloud/services/lowcode/v20210108/index.js +9 -0
  36. package/tencentcloud/services/lowcode/v20210108/lowcode_client.d.ts +14 -0
  37. package/tencentcloud/services/lowcode/v20210108/lowcode_client.js +37 -0
  38. package/tencentcloud/services/lowcode/v20210108/lowcode_models.d.ts +287 -0
  39. package/tencentcloud/services/lowcode/v20210108/lowcode_models.js +18 -0
  40. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +4 -4
  41. package/test/ame.v20190916.test.js +44 -4
  42. package/test/ckafka.v20190819.test.js +10 -0
  43. package/test/lowcode.v20210108.test.js +31 -0
@@ -1,17 +1,3 @@
1
- /**
2
- * Album
3
- */
4
- export interface Album {
5
- /**
6
- * 专辑名
7
- */
8
- AlbumName: string;
9
- /**
10
- * 专辑图片大小及类别
11
- 注意:此字段可能返回 null,表示取不到有效值。
12
- */
13
- ImagePathMap: Array<ImagePath>;
14
- }
15
1
  /**
16
2
  * DescribeMusic返回参数结构体
17
3
  */
@@ -27,76 +13,127 @@ export interface DescribeMusicResponse {
27
13
  RequestId?: string;
28
14
  }
29
15
  /**
30
- * DescribePkgOfflineMusic请求参数结构体
16
+ * 副歌片段信息
31
17
  */
32
- export interface DescribePkgOfflineMusicRequest {
18
+ export interface ChorusClip {
33
19
  /**
34
- * 订单id
20
+ * 副歌时间,单位:毫秒
35
21
  */
36
- PackageOrderId: string;
22
+ StartTime: number;
37
23
  /**
38
- * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条(注:单次上限为100)。
24
+ * 副歌结束时间,单位:毫秒
39
25
  */
40
- Limit?: number;
26
+ EndTime: number;
27
+ }
28
+ /**
29
+ * ModifyMusicOnShelves返回参数结构体
30
+ */
31
+ export interface ModifyMusicOnShelvesResponse {
41
32
  /**
42
- * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
33
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
43
34
  */
44
- Offset?: number;
35
+ RequestId?: string;
45
36
  }
46
37
  /**
47
- * 直播进房输入参数
38
+ * 分类内容
48
39
  */
49
- export interface JoinRoomInput {
40
+ export interface Station {
50
41
  /**
51
- * TRTC进房参数
42
+ * StationID
52
43
  */
53
- TRTCJoinRoomInput?: TRTCJoinRoomInput;
44
+ CategoryID: string;
45
+ /**
46
+ * Station MCCode
47
+ 注意:此字段可能返回 null,表示取不到有效值。
48
+ */
49
+ CategoryCode: string;
50
+ /**
51
+ * Category Name
52
+ 注意:此字段可能返回 null,表示取不到有效值。
53
+ */
54
+ Name: string;
55
+ /**
56
+ * Station的排序值,供参考(返回结果已按其升序)
57
+ 注意:此字段可能返回 null,表示取不到有效值。
58
+ */
59
+ Rank: number;
60
+ /**
61
+ * station图片集合
62
+ 注意:此字段可能返回 null,表示取不到有效值。
63
+ */
64
+ ImagePathMap: Array<ImagePath>;
54
65
  }
55
66
  /**
56
- * DestroyKTVRobot返回参数结构体
67
+ * DescribeKTVMusicDetail请求参数结构体
57
68
  */
58
- export interface DestroyKTVRobotResponse {
69
+ export interface DescribeKTVMusicDetailRequest {
59
70
  /**
60
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
71
+ * 曲目 Id
61
72
  */
62
- RequestId?: string;
73
+ MusicId: string;
63
74
  }
64
75
  /**
65
- * DescribeLyric返回参数结构体
76
+ * 排行榜结构
66
77
  */
67
- export interface DescribeLyricResponse {
78
+ export interface KTVMusicTopInfo {
68
79
  /**
69
- * 歌词或者波形图详情
70
- 注意:此字段可能返回 null,表示取不到有效值。
80
+ * 歌曲Id
71
81
  */
72
- Lyric: Lyric;
82
+ MusicId: string;
73
83
  /**
74
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
84
+ * 歌曲名称
75
85
  */
76
- RequestId?: string;
86
+ Name: string;
87
+ /**
88
+ * 歌手名称列表
89
+ */
90
+ SingerInfoSet: Array<KTVSingerBaseInfo>;
91
+ /**
92
+ * 歌词名称列表
93
+ */
94
+ LyricistSet: Array<string>;
95
+ /**
96
+ * 作曲列表
97
+ */
98
+ ComposerSet: Array<string>;
99
+ /**
100
+ * 标签列表
101
+ */
102
+ TagSet: Array<string>;
103
+ /**
104
+ * 播放时长
105
+ */
106
+ Duration: number;
77
107
  }
78
108
  /**
79
- * ModifyMusicOnShelves返回参数结构体
109
+ * DescribeKTVSingerCategories请求参数结构体
80
110
  */
81
- export interface ModifyMusicOnShelvesResponse {
111
+ export declare type DescribeKTVSingerCategoriesRequest = null;
112
+ /**
113
+ * KTV 歌手基础信息
114
+ */
115
+ export interface KTVSingerBaseInfo {
82
116
  /**
83
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
117
+ * 歌手id
84
118
  */
85
- RequestId?: string;
119
+ SingerId: string;
120
+ /**
121
+ * 歌手名
122
+ */
123
+ Name: string;
86
124
  }
87
125
  /**
88
- * CreateKTVRobot请求参数结构体
126
+ * ModifyMusicOnShelves请求参数结构体
89
127
  */
90
- export interface CreateKTVRobotRequest {
128
+ export interface ModifyMusicOnShelvesRequest {
91
129
  /**
92
- * RTC厂商类型,取值有:
93
- <li>TRTC</li>
130
+ * 歌曲变更信息
94
131
  */
95
- RTCSystem: string;
132
+ MusicDetailInfos: MusicDetailInfo;
96
133
  /**
97
- * 进房参数。
134
+ * ame对接资源方密钥
98
135
  */
99
- JoinRoomInput: JoinRoomInput;
136
+ AmeKey?: string;
100
137
  }
101
138
  /**
102
139
  * 播放指令输入参数
@@ -108,141 +145,86 @@ export interface PlayCommandInput {
108
145
  Index: number;
109
146
  }
110
147
  /**
111
- * SyncKTVRobotCommand请求参数结构体
148
+ * DescribeMusic请求参数结构体
112
149
  */
113
- export interface SyncKTVRobotCommandRequest {
114
- /**
115
- * 机器人Id。
116
- */
117
- RobotId: string;
118
- /**
119
- * 指令,取值有:
120
- <li>Play:播放</li>
121
- <li>Pause:暂停</li>
122
- <li>SwitchPrevious:上一首</li>
123
- <li>SwitchNext:下一首</li>
124
- <li>SetPlayMode:设置播放模式</li>
125
- <li>Seek:调整播放进度</li>
126
- <li>SetPlaylist:歌单变更</li>
127
- <li>SetAudioParam:音频参数变更</li>
128
- <li>SendMessage:发送自定义消息</li>
129
- */
130
- Command: string;
131
- /**
132
- * 播放参数。
133
- */
134
- PlayCommandInput?: PlayCommandInput;
135
- /**
136
- * 播放列表变更信息,当Command取SetPlaylist时,必填。
137
- */
138
- SetPlaylistCommandInput?: SetPlaylistCommandInput;
150
+ export interface DescribeMusicRequest {
139
151
  /**
140
- * 播放进度,当Command取Seek时,必填。
152
+ * 歌曲ID
141
153
  */
142
- SeekCommandInput?: SeekCommandInput;
154
+ ItemId: string;
143
155
  /**
144
- * 音频参数,当Command取SetAudioParam时,必填。
156
+ * 在应用前端播放音乐C端用户的唯一标识。无需是账户信息,用户唯一标识即可。
145
157
  */
146
- SetAudioParamCommandInput?: SetAudioParamCommandInput;
158
+ IdentityId: string;
147
159
  /**
148
- * 自定义消息,当Command取SendMessage时,必填。
160
+ * MP3-320K-FTD-P 为获取320kbps歌曲热门片段。
161
+ MP3-320K-FTD 为获取320kbps已核验歌曲完整资源。
149
162
  */
150
- SendMessageCommandInput?: SendMessageCommandInput;
163
+ SubItemType?: string;
151
164
  /**
152
- * 播放模式,当Command取SetPlayMode时,必填。
165
+ * CDN URL Protocol:HTTP or HTTPS/SSL
166
+ Values:Y , N(default)
153
167
  */
154
- SetPlayModeCommandInput?: SetPlayModeCommandInput;
168
+ Ssl?: string;
155
169
  }
156
170
  /**
157
- * 音频参数信息
171
+ * DescribeMusicSaleStatus请求参数结构体
158
172
  */
159
- export interface SetAudioParamCommandInput {
173
+ export interface DescribeMusicSaleStatusRequest {
160
174
  /**
161
- * 规格,取值有:
162
- <li>audio/mi:低规格</li>
163
- <li>audio/lo:中规格</li>
164
- <li>audio/hi:高规格</li>
175
+ * 歌曲Id集合,可传单个,也可传多个,上线查询单次50个
165
176
  */
166
- Definition?: string;
177
+ MusicIds: Array<string>;
167
178
  /**
168
- * 音频类型,取值有:
169
- <li>Original:原唱</li>
170
- <li>Accompaniment:伴奏</li>
179
+ * 查询哪个渠道的数据,1为曲库包,2为单曲
171
180
  */
172
- Type?: string;
181
+ PurchaseType: number;
173
182
  }
174
183
  /**
175
- * DescribeKTVPlaylistDetail请求参数结构体
184
+ * TakeMusicOffShelves请求参数结构体
176
185
  */
177
- export interface DescribeKTVPlaylistDetailRequest {
178
- /**
179
- * 歌单Id
180
- */
181
- PlaylistId: string;
182
- /**
183
- * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
184
- */
185
- Offset?: number;
186
+ export interface TakeMusicOffShelvesRequest {
186
187
  /**
187
- * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
188
+ * 资源方下架必传结构
188
189
  */
189
- Limit?: number;
190
+ TakeMusicOffShelves: Array<TakeMusicOffShelves>;
190
191
  }
191
192
  /**
192
- * 分类内容
193
+ * DescribeCloudMusic返回参数结构体
193
194
  */
194
- export interface Station {
195
+ export interface DescribeCloudMusicResponse {
195
196
  /**
196
- * StationID
197
+ * 歌曲Id
197
198
  */
198
- CategoryID: string;
199
+ MusicId: string;
199
200
  /**
200
- * Station MCCode
201
- 注意:此字段可能返回 null,表示取不到有效值。
201
+ * 歌曲名称
202
202
  */
203
- CategoryCode: string;
203
+ MusicName: string;
204
204
  /**
205
- * Category Name
205
+ * 歌曲时长
206
206
  注意:此字段可能返回 null,表示取不到有效值。
207
207
  */
208
- Name: string;
208
+ Duration: number;
209
209
  /**
210
- * Station的排序值,供参考(返回结果已按其升序)
211
- 注意:此字段可能返回 null,表示取不到有效值。
210
+ * 歌曲链接
212
211
  */
213
- Rank: number;
212
+ MusicUrl: string;
214
213
  /**
215
- * station图片集合
214
+ * 歌曲图片
216
215
  注意:此字段可能返回 null,表示取不到有效值。
217
216
  */
218
- ImagePathMap: Array<ImagePath>;
219
- }
220
- /**
221
- * CreateKTVRobot返回参数结构体
222
- */
223
- export interface CreateKTVRobotResponse {
217
+ MusicImageUrl: string;
224
218
  /**
225
- * 机器人Id。
219
+ * 歌手列表
220
+ 注意:此字段可能返回 null,表示取不到有效值。
226
221
  */
227
- RobotId: string;
222
+ Singers: Array<string>;
228
223
  /**
229
224
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
230
225
  */
231
226
  RequestId?: string;
232
227
  }
233
- /**
234
- * 曲库包用途信息
235
- */
236
- export interface UseRange {
237
- /**
238
- * 用途id
239
- */
240
- UseRangeId: number;
241
- /**
242
- * 用途范围名称
243
- */
244
- Name: string;
245
- }
246
228
  /**
247
229
  * 歌曲变更细节
248
230
  */
@@ -297,130 +279,176 @@ export interface MusicDetailInfo {
297
279
  Channel?: string;
298
280
  }
299
281
  /**
300
- * DescribeKTVMusicDetail请求参数结构体
282
+ * 图片路径
301
283
  */
302
- export interface DescribeKTVMusicDetailRequest {
284
+ export interface ImagePath {
303
285
  /**
304
- * 曲目 Id
286
+ * station图片大小及类别
287
+ 注意:此字段可能返回 null,表示取不到有效值。
305
288
  */
306
- MusicId: string;
307
- }
308
- /**
309
- * DescribeStations返回参数结构体
310
- */
311
- export interface DescribeStationsResponse {
289
+ Key: string;
312
290
  /**
313
- * 总数量
291
+ * station图片地址
292
+ 注意:此字段可能返回 null,表示取不到有效值。
314
293
  */
315
- Total?: number;
294
+ Value: string;
295
+ }
296
+ /**
297
+ * DescribeMusicSaleStatus返回参数结构体
298
+ */
299
+ export interface DescribeMusicSaleStatusResponse {
316
300
  /**
317
- * 分页偏移量
301
+ * musicId对应歌曲状态
318
302
  */
319
- Offset?: number;
303
+ MusicStatusSet: Array<MusicStatus>;
320
304
  /**
321
- * 当前页station数量
305
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
322
306
  */
323
- Size?: number;
307
+ RequestId?: string;
308
+ }
309
+ /**
310
+ * DestroyKTVRobot请求参数结构体
311
+ */
312
+ export interface DestroyKTVRobotRequest {
324
313
  /**
325
- * 剩余数量(total-offset-size),通过这个值判断是否还有下一页
314
+ * 机器人Id。
326
315
  */
327
- HaveMore?: number;
316
+ RobotId: string;
317
+ }
318
+ /**
319
+ * DescribeAuthInfo返回参数结构体
320
+ */
321
+ export interface DescribeAuthInfoResponse {
328
322
  /**
329
- * Stations 素材库列表
330
- 注意:此字段可能返回 null,表示取不到有效值。
323
+ * 授权项目列表
331
324
  */
332
- Stations?: Array<Station>;
325
+ AuthInfo?: Array<AuthInfo>;
326
+ /**
327
+ * 总数
328
+ */
329
+ TotalCount?: number;
333
330
  /**
334
331
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
335
332
  */
336
333
  RequestId?: string;
337
334
  }
338
335
  /**
339
- * DescribePackageItems返回参数结构体
336
+ * DescribeLyric请求参数结构体
340
337
  */
341
- export interface DescribePackageItemsResponse {
338
+ export interface DescribeLyricRequest {
342
339
  /**
343
- * 已核销歌曲信息列表
344
- 注意:此字段可能返回 null,表示取不到有效值。
340
+ * 歌曲ID
345
341
  */
346
- PackageItems?: Array<PackageItem>;
342
+ ItemId: string;
347
343
  /**
348
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
344
+ * 格式,可选项,可不填写,默认值为:LRC-LRC
345
+ <li>LRC-LRC:歌词;</li>
346
+ <li>JSON-ST:波形图。</li>
349
347
  */
350
- RequestId?: string;
348
+ SubItemType?: string;
351
349
  }
352
350
  /**
353
- * DescribeCloudMusicPurchased请求参数结构体
351
+ * ReportData请求参数结构体
354
352
  */
355
- export interface DescribeCloudMusicPurchasedRequest {
353
+ export interface ReportDataRequest {
356
354
  /**
357
- * 授权项目Id
355
+ * 上报数据
356
+ 注:reportData为客户端压缩后的上报数据进行16进制转换的字符串数据
357
+ 压缩说明:
358
+ a) 上报的json格式字符串通过流的转换(ByteArrayInputStream, java.util.zip.GZIPOutputStream),获取到压缩后的字节数组。
359
+ b) 将压缩后的字节数组转成16进制字符串。
360
+
361
+ reportData由两部分数据组成:
362
+ 1)report_type(上报类型)
363
+ 2)data(歌曲上报数据)
364
+ 不同的report_type对应的data数据结构不一样。
365
+
366
+ 详细说明请参考文档reportdata.docx:
367
+ https://github.com/tencentyun/ame-documents
358
368
  */
359
- AuthInfoId: string;
369
+ ReportData: string;
360
370
  }
361
371
  /**
362
- * 曲库包歌曲信息
372
+ * 调整播放进度指令参数
363
373
  */
364
- export interface PackageItem {
374
+ export interface SeekCommandInput {
365
375
  /**
366
- * 订单id
376
+ * 播放位置,单位:毫秒。
367
377
  */
368
- OrderId: string;
378
+ Position: number;
379
+ }
380
+ /**
381
+ * DescribePkgOfflineMusic请求参数结构体
382
+ */
383
+ export interface DescribePkgOfflineMusicRequest {
369
384
  /**
370
- * 歌曲名
385
+ * 订单id
371
386
  */
372
- TrackName: string;
387
+ PackageOrderId: string;
373
388
  /**
374
- * 歌曲ID
389
+ * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条(注:单次上限为100)。
375
390
  */
376
- ItemID: string;
391
+ Limit?: number;
377
392
  /**
378
- * 专辑图片
393
+ * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
379
394
  */
380
- Img: string;
395
+ Offset?: number;
396
+ }
397
+ /**
398
+ * 时间范围
399
+ */
400
+ export interface TimeRange {
381
401
  /**
382
- * 歌手名
402
+ * <li>大于等于此时间(起始时间)。</li>
403
+ <li>格式按照 ISO 8601标准表示,详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
383
404
  */
384
- ArtistName: string;
405
+ Before?: string;
385
406
  /**
386
- * 歌曲时长
407
+ * <li>小于此时间(结束时间)。</li>
408
+ <li>格式按照 ISO 8601标准表示,详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
387
409
  */
388
- Duration: string;
410
+ After?: string;
411
+ }
412
+ /**
413
+ * CreateKTVRobot返回参数结构体
414
+ */
415
+ export interface CreateKTVRobotResponse {
389
416
  /**
390
- * 授权区域,global: 全球 CN: 中国
417
+ * 机器人Id。
391
418
  */
392
- AuthorizedArea: string;
419
+ RobotId: string;
393
420
  /**
394
- * 标签数组
421
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
395
422
  */
396
- Tags: Array<string>;
423
+ RequestId?: string;
397
424
  }
398
425
  /**
399
- * DescribeCloudMusicPurchased返回参数结构体
426
+ * DescribePackageItems返回参数结构体
400
427
  */
401
- export interface DescribeCloudMusicPurchasedResponse {
428
+ export interface DescribePackageItemsResponse {
402
429
  /**
403
- * 云音乐列表
430
+ * 已核销歌曲信息列表
404
431
  注意:此字段可能返回 null,表示取不到有效值。
405
432
  */
406
- MusicOpenDetail: Array<MusicOpenDetail>;
433
+ PackageItems?: Array<PackageItem>;
407
434
  /**
408
435
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
409
436
  */
410
437
  RequestId?: string;
411
438
  }
412
439
  /**
413
- * DescribeKTVPlaylists请求参数结构体
440
+ * DescribeCloudMusicPurchased返回参数结构体
414
441
  */
415
- export interface DescribeKTVPlaylistsRequest {
442
+ export interface DescribeCloudMusicPurchasedResponse {
416
443
  /**
417
- * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
444
+ * 云音乐列表
445
+ 注意:此字段可能返回 null,表示取不到有效值。
418
446
  */
419
- Offset?: number;
447
+ MusicOpenDetail: Array<MusicOpenDetail>;
420
448
  /**
421
- * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
449
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
422
450
  */
423
- Limit?: number;
451
+ RequestId?: string;
424
452
  }
425
453
  /**
426
454
  * 数据信息
@@ -452,305 +480,330 @@ export interface DataInfo {
452
480
  TagNames: Array<string>;
453
481
  }
454
482
  /**
455
- * DescribeKTVPlaylistDetail返回参数结构体
483
+ * Artist
456
484
  */
457
- export interface DescribeKTVPlaylistDetailResponse {
458
- /**
459
- * 歌曲基础信息列表
460
- */
461
- KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
485
+ export interface Artist {
462
486
  /**
463
- * 歌单基础信息
487
+ * 歌手名
464
488
  */
465
- PlaylistBaseInfo: KTVPlaylistBaseInfo;
489
+ ArtistName: string;
490
+ }
491
+ /**
492
+ * ReportData返回参数结构体
493
+ */
494
+ export interface ReportDataResponse {
466
495
  /**
467
496
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
468
497
  */
469
498
  RequestId?: string;
470
499
  }
471
500
  /**
472
- * TRTC推流进房信息
501
+ * SearchKTVMusics返回参数结构体
473
502
  */
474
- export interface TRTCJoinRoomInput {
503
+ export interface SearchKTVMusicsResponse {
475
504
  /**
476
- * 签名。
505
+ * 总记录数
477
506
  */
478
- Sign: string;
507
+ TotalCount: number;
479
508
  /**
480
- * 房间号。
509
+ * KTV 曲目列表
481
510
  */
482
- RoomId: string;
511
+ KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
483
512
  /**
484
- * 推流应用ID。
513
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
485
514
  */
486
- SdkAppId: string;
515
+ RequestId?: string;
516
+ }
517
+ /**
518
+ * DescribeItemById请求参数结构体
519
+ */
520
+ export interface DescribeItemByIdRequest {
487
521
  /**
488
- * 用户唯一标识。
522
+ * 歌曲ID,目前暂不支持批量查询
489
523
  */
490
- UserId: string;
524
+ ItemIDs: string;
491
525
  }
492
526
  /**
493
- * 曲库包信息
527
+ * PutMusicOnTheShelves返回参数结构体
494
528
  */
495
- export interface Package {
529
+ export interface PutMusicOnTheShelvesResponse {
496
530
  /**
497
- * 订单id
531
+ * 操作成功数量
498
532
  */
499
- OrderId: string;
533
+ SuccessNum: number;
500
534
  /**
501
- * 曲库包名称
535
+ * 操作失败数量
502
536
  */
503
- Name: string;
537
+ FailedNum: number;
504
538
  /**
505
- * 授权地区-global: 全球 CN: 中国
539
+ * 失败歌曲Id
540
+ 注意:此字段可能返回 null,表示取不到有效值。
506
541
  */
507
- AuthorizedArea: string;
542
+ FailedMusicIds: Array<string>;
508
543
  /**
509
- * 授权次数
544
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
510
545
  */
511
- AuthorizedLimit: number;
546
+ RequestId?: string;
547
+ }
548
+ /**
549
+ * DescribeKTVSingerMusics返回参数结构体
550
+ */
551
+ export interface DescribeKTVSingerMusicsResponse {
512
552
  /**
513
- * 套餐有效期,单位:天
553
+ * 总曲目数
514
554
  */
515
- TermOfValidity: number;
555
+ TotalCount: number;
516
556
  /**
517
- * 0:不可商业化;1:可商业化
557
+ * KTV 曲目列表
518
558
  */
519
- Commercial: number;
559
+ KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
520
560
  /**
521
- * 套餐价格,单位:元
561
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
522
562
  */
523
- PackagePrice: number;
563
+ RequestId?: string;
564
+ }
565
+ /**
566
+ * DescribeItems返回参数结构体
567
+ */
568
+ export interface DescribeItemsResponse {
524
569
  /**
525
- * 生效开始时间,格式yyyy-MM-dd HH:mm:ss
570
+ * 分页偏移量
526
571
  */
527
- EffectTime: string;
572
+ Offset?: number;
528
573
  /**
529
- * 生效结束时间,格式yyyy-MM-dd HH:mm:ss
574
+ * 当前页歌曲数量
530
575
  */
531
- ExpireTime: string;
576
+ Size?: number;
532
577
  /**
533
- * 剩余授权次数
578
+ * 总数据条数
534
579
  */
535
- UsedCount: number;
580
+ Total?: number;
536
581
  /**
537
- * 曲库包用途信息
582
+ * 剩余数量(total-offset-size),通过这个值判断是否
583
+ 还有下一页
538
584
  */
539
- UseRanges: Array<UseRange>;
540
- }
541
- /**
542
- * ReportData返回参数结构体
543
- */
544
- export interface ReportDataResponse {
585
+ HaveMore?: number;
545
586
  /**
546
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
547
- */
548
- RequestId?: string;
549
- }
550
- /**
551
- * ModifyMusicOnShelves请求参数结构体
552
- */
553
- export interface ModifyMusicOnShelvesRequest {
554
- /**
555
- * 歌曲变更信息
587
+ * Items 歌曲列表
588
+ 注意:此字段可能返回 null,表示取不到有效值。
556
589
  */
557
- MusicDetailInfos: MusicDetailInfo;
590
+ Items?: Array<Item>;
558
591
  /**
559
- * ame对接资源方密钥
592
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
560
593
  */
561
- AmeKey?: string;
594
+ RequestId?: string;
562
595
  }
563
596
  /**
564
- * DescribePackageItems请求参数结构体
597
+ * DescribePkgOfflineMusic返回参数结构体
565
598
  */
566
- export interface DescribePackageItemsRequest {
599
+ export interface DescribePkgOfflineMusicResponse {
567
600
  /**
568
- * 订单id,从获取已购曲库包列表中获取
601
+ * 曲库包中不可用歌曲信息
569
602
  */
570
- OrderId: string;
603
+ OfflineMusicSet: Array<OfflineMusicDetail>;
571
604
  /**
572
- * 默认0,Offset=Offset+Length
605
+ * 返回总量
573
606
  */
574
- Offset?: number;
607
+ TotalCount: number;
575
608
  /**
576
- * 默认20
609
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
577
610
  */
578
- Length?: number;
611
+ RequestId?: string;
579
612
  }
580
613
  /**
581
- * AuthInfo集合
614
+ * 直播互动歌曲的歌手信息。
582
615
  */
583
- export interface AuthInfo {
584
- /**
585
- * 主体名称
586
- 注意:此字段可能返回 null,表示取不到有效值。
587
- */
588
- SubjectName: string;
589
- /**
590
- * 项目名称
591
- 注意:此字段可能返回 null,表示取不到有效值。
592
- */
593
- ProjectName: string;
616
+ export interface KTVSingerInfo {
594
617
  /**
595
- * 应用场景
618
+ * 歌手id
596
619
  */
597
- AppScene: number;
620
+ SingerId: string;
598
621
  /**
599
- * 应用地域
622
+ * 歌手名
600
623
  */
601
- AppRegion: number;
624
+ Name: string;
602
625
  /**
603
- * 授权时间
626
+ * 歌手性别: 男,女,组合
604
627
  */
605
- AuthPeriod: number;
628
+ Gender: string;
606
629
  /**
607
- * 是否可商业化
630
+ * 地区: 大陆,港台,欧美,日本
608
631
  */
609
- Commercialization: number;
632
+ Area: string;
610
633
  /**
611
- * 是否可跨平台
634
+ * 歌曲数
612
635
  */
613
- Platform: number;
636
+ MusicCount: number;
614
637
  /**
615
- * 加密后Id
638
+ * 歌曲总播放次数
616
639
  */
617
- Id: string;
640
+ PlayCount: number;
618
641
  }
619
642
  /**
620
- * TakeMusicOffShelves请求参数结构体
643
+ * PutMusicOnTheShelves请求参数结构体
621
644
  */
622
- export interface TakeMusicOffShelvesRequest {
645
+ export interface PutMusicOnTheShelvesRequest {
623
646
  /**
624
- * 资源方下架必传结构
647
+ * 资源方歌曲Id
625
648
  */
626
- TakeMusicOffShelves: Array<TakeMusicOffShelves>;
649
+ MusicIds: Array<string>;
627
650
  }
628
651
  /**
629
- * DescribeKTVRobots返回参数结构体
652
+ * DescribeCloudMusic请求参数结构体
630
653
  */
631
- export interface DescribeKTVRobotsResponse {
632
- /**
633
- * 机器人总数。
634
- */
635
- TotalCount: number;
654
+ export interface DescribeCloudMusicRequest {
636
655
  /**
637
- * 机器人信息集合。
656
+ * 歌曲Id
638
657
  */
639
- KTVRobotInfoSet: Array<KTVRobotInfo>;
658
+ MusicId: string;
640
659
  /**
641
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
660
+ * 歌曲类型,可选值有:
661
+ <li>MP3-128K-FTW:含有水印的试听资源;</li>
662
+ <li>MP3-320K-FTD-P:320kbps歌曲热门片段;</li>
663
+ <li>MP3-320K-FTD:320kbps已核验歌曲完整资源。</li>
664
+ 默认为:MP3-128K-FTW
642
665
  */
643
- RequestId?: string;
666
+ MusicType?: string;
644
667
  }
645
668
  /**
646
- * 下架歌曲复合结构
669
+ * 排序依据
647
670
  */
648
- export interface TakeMusicOffShelves {
671
+ export interface SortBy {
649
672
  /**
650
- * 资源方对应音乐Id
673
+ * 排序字段
651
674
  */
652
- MusicIds: string;
675
+ Field: string;
653
676
  /**
654
- * 当曲目临时下架时:已订购客户无影响,无需消息通知。当曲目封杀下架后,推送消息至已订购老客户,枚举值,判断是否上/下架
655
- 在售状态,0在售,1临时下架,2永久下架
677
+ * 排序方式,可选值:Asc(升序)、Desc(降序)
656
678
  */
657
- SaleStatus: string;
679
+ Order: string;
658
680
  }
659
681
  /**
660
- * 歌词信息
682
+ * DescribeKTVMusicDetail返回参数结构体
661
683
  */
662
- export interface Lyric {
684
+ export interface DescribeKTVMusicDetailResponse {
663
685
  /**
664
- * 歌词cdn地址
686
+ * 歌曲基础信息
665
687
  */
666
- Url: string;
688
+ KTVMusicBaseInfo: KTVMusicBaseInfo;
667
689
  /**
668
- * 歌词后缀名
690
+ * 播放凭证
669
691
  */
670
- FileNameExt: string;
692
+ PlayToken: string;
671
693
  /**
672
- * 歌词类型
694
+ * 歌词下载地址
673
695
  */
674
- SubItemType: string;
696
+ LyricsUrl: string;
697
+ /**
698
+ * 歌曲规格信息列表
699
+ */
700
+ DefinitionInfoSet: Array<KTVMusicDefinitionInfo>;
701
+ /**
702
+ * 音高数据文件下载地址
703
+ */
704
+ MidiJsonUrl: string;
705
+ /**
706
+ * 副歌片段数据列表
707
+ */
708
+ ChorusClipSet: Array<ChorusClip>;
709
+ /**
710
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
711
+ */
712
+ RequestId?: string;
675
713
  }
676
714
  /**
677
- * 曲库包已下架歌曲详细信息
715
+ * DescribeKTVRobots请求参数结构体
678
716
  */
679
- export interface OfflineMusicDetail {
717
+ export interface DescribeKTVRobotsRequest {
680
718
  /**
681
- * 歌曲Id
719
+ * 机器人Id列表。
682
720
  */
683
- ItemId: string;
721
+ RobotIds?: Array<string>;
684
722
  /**
685
- * 歌曲名称
723
+ * 机器人状态,取值有:
724
+ <li>Play:播放</li>
725
+ <li>Pause:暂停</li>
726
+ <li>Destroy:销毁</li>
686
727
  */
687
- MusicName: string;
728
+ Statuses?: Array<string>;
688
729
  /**
689
- * 不可用原因
730
+ * 匹配创建时间在此时间段内的机器人。
731
+ <li>包含所指定的头尾时间点。</li>
690
732
  */
691
- OffRemark: string;
733
+ CreateTime?: TimeRange;
692
734
  /**
693
- * 不可用时间
735
+ * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
694
736
  */
695
- OffTime: string;
737
+ Offset?: number;
738
+ /**
739
+ * 分页返回的起始偏移量,默认值:10。
740
+ */
741
+ Limit?: number;
696
742
  }
697
743
  /**
698
- * DescribeItemById请求参数结构体
744
+ * 直播进房输入参数
699
745
  */
700
- export interface DescribeItemByIdRequest {
746
+ export interface JoinRoomInput {
701
747
  /**
702
- * 歌曲ID,目前暂不支持批量查询
748
+ * TRTC进房参数
703
749
  */
704
- ItemIDs: string;
750
+ TRTCJoinRoomInput?: TRTCJoinRoomInput;
705
751
  }
706
752
  /**
707
- * DescribeAuthInfo请求参数结构体
753
+ * DestroyKTVRobot返回参数结构体
708
754
  */
709
- export interface DescribeAuthInfoRequest {
755
+ export interface DestroyKTVRobotResponse {
710
756
  /**
711
- * 偏移量:Offset=Offset+Limit
757
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
712
758
  */
713
- Offset?: number;
759
+ RequestId?: string;
760
+ }
761
+ /**
762
+ * CreateKTVRobot请求参数结构体
763
+ */
764
+ export interface CreateKTVRobotRequest {
714
765
  /**
715
- * 数据条数
766
+ * RTC厂商类型,取值有:
767
+ <li>TRTC</li>
716
768
  */
717
- Limit?: number;
769
+ RTCSystem: string;
718
770
  /**
719
- * 搜索关键字
771
+ * 进房参数。
720
772
  */
721
- Key?: string;
773
+ JoinRoomInput: JoinRoomInput;
722
774
  }
723
775
  /**
724
- * DescribeKTVPlaylists返回参数结构体
776
+ * DescribeKTVTopList请求参数结构体
725
777
  */
726
- export interface DescribeKTVPlaylistsResponse {
727
- /**
728
- * 推荐歌单列表
729
- */
730
- PlaylistBaseInfoSet: Array<KTVPlaylistBaseInfo>;
778
+ export interface DescribeKTVTopListRequest {
731
779
  /**
732
- * 推荐歌单列表总数
780
+ * 榜单类型。默认Hot
781
+ <li> Hot, 热歌榜。</li>
733
782
  */
734
- TotalCount: number;
783
+ Type?: string;
735
784
  /**
736
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
785
+ * 榜单周期 默认为Week
786
+ <li> Week, 周榜。</li>
787
+ <li> Month, 月榜。</li>
737
788
  */
738
- RequestId?: string;
789
+ Period?: string;
739
790
  }
740
791
  /**
741
- * 时间范围
792
+ * DescribeKTVPlaylistDetail请求参数结构体
742
793
  */
743
- export interface TimeRange {
794
+ export interface DescribeKTVPlaylistDetailRequest {
744
795
  /**
745
- * <li>大于等于此时间(起始时间)。</li>
746
- <li>格式按照 ISO 8601标准表示,详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
796
+ * 歌单Id
747
797
  */
748
- Before?: string;
798
+ PlaylistId: string;
749
799
  /**
750
- * <li>小于此时间(结束时间)。</li>
751
- <li>格式按照 ISO 8601标准表示,详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
800
+ * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
752
801
  */
753
- After?: string;
802
+ Offset?: number;
803
+ /**
804
+ * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
805
+ */
806
+ Limit?: number;
754
807
  }
755
808
  /**
756
809
  * 音乐详情
@@ -785,232 +838,282 @@ Unit :ms
785
838
  FullUrl: string;
786
839
  }
787
840
  /**
788
- * Artist
841
+ * DescribeStations返回参数结构体
789
842
  */
790
- export interface Artist {
843
+ export interface DescribeStationsResponse {
791
844
  /**
792
- * 歌手名
845
+ * 总数量
793
846
  */
794
- ArtistName: string;
795
- }
796
- /**
797
- * DescribeStations请求参数结构体
798
- */
799
- export interface DescribeStationsRequest {
847
+ Total?: number;
800
848
  /**
801
- * 条数,必须大于0
849
+ * 分页偏移量
802
850
  */
803
- Limit: number;
851
+ Offset?: number;
804
852
  /**
805
- * offset (Default = 0),Offset=Offset+Limit
853
+ * 当前页station数量
806
854
  */
807
- Offset: number;
808
- }
809
- /**
810
- * 对外开放信息
811
- */
812
- export interface MusicOpenDetail {
855
+ Size?: number;
813
856
  /**
814
- * 音乐Id
815
- 注意:此字段可能返回 null,表示取不到有效值。
857
+ * 剩余数量(total-offset-size),通过这个值判断是否还有下一页
816
858
  */
817
- MusicId: string;
859
+ HaveMore?: number;
818
860
  /**
819
- * 专辑名称
861
+ * Stations 素材库列表
820
862
  注意:此字段可能返回 null,表示取不到有效值。
821
863
  */
822
- AlbumName: string;
864
+ Stations?: Array<Station>;
823
865
  /**
824
- * 专辑图片路径
825
- 注意:此字段可能返回 null,表示取不到有效值。
866
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
826
867
  */
827
- AlbumImageUrl: string;
868
+ RequestId?: string;
869
+ }
870
+ /**
871
+ * DescribeCloudMusicPurchased请求参数结构体
872
+ */
873
+ export interface DescribeCloudMusicPurchasedRequest {
828
874
  /**
829
- * 音乐名称
830
- 注意:此字段可能返回 null,表示取不到有效值。
875
+ * 授权项目Id
831
876
  */
832
- MusicName: string;
877
+ AuthInfoId: string;
878
+ }
879
+ /**
880
+ * 曲库包歌曲信息
881
+ */
882
+ export interface PackageItem {
833
883
  /**
834
- * 音乐图片路径
835
- 注意:此字段可能返回 null,表示取不到有效值。
884
+ * 订单id
836
885
  */
837
- MusicImageUrl: string;
886
+ OrderId: string;
838
887
  /**
839
- * 歌手
840
- 注意:此字段可能返回 null,表示取不到有效值。
888
+ * 歌曲名
841
889
  */
842
- Singers: Array<string>;
890
+ TrackName: string;
843
891
  /**
844
- * 播放时长
845
- 注意:此字段可能返回 null,表示取不到有效值。
892
+ * 歌曲ID
846
893
  */
847
- Duration: number;
894
+ ItemID: string;
848
895
  /**
849
- * 标签
850
- 注意:此字段可能返回 null,表示取不到有效值。
896
+ * 专辑图片
897
+ */
898
+ Img: string;
899
+ /**
900
+ * 歌手名
901
+ */
902
+ ArtistName: string;
903
+ /**
904
+ * 歌曲时长
905
+ */
906
+ Duration: string;
907
+ /**
908
+ * 授权区域,global: 全球 CN: 中国
909
+ */
910
+ AuthorizedArea: string;
911
+ /**
912
+ * 标签数组
851
913
  */
852
914
  Tags: Array<string>;
915
+ }
916
+ /**
917
+ * DescribeKTVPlaylists请求参数结构体
918
+ */
919
+ export interface DescribeKTVPlaylistsRequest {
853
920
  /**
854
- * 歌词url
855
- 注意:此字段可能返回 null,表示取不到有效值。
921
+ * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
856
922
  */
857
- LyricUrl: string;
923
+ Offset?: number;
858
924
  /**
859
- * 波形图url
860
- 注意:此字段可能返回 null,表示取不到有效值。
925
+ * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
861
926
  */
862
- WaveformUrl: string;
927
+ Limit?: number;
863
928
  }
864
929
  /**
865
- * PutMusicOnTheShelves返回参数结构体
930
+ * TRTC推流进房信息
866
931
  */
867
- export interface PutMusicOnTheShelvesResponse {
932
+ export interface TRTCJoinRoomInput {
868
933
  /**
869
- * 操作成功数量
934
+ * 签名。
870
935
  */
871
- SuccessNum: number;
936
+ Sign: string;
872
937
  /**
873
- * 操作失败数量
938
+ * 房间号。
874
939
  */
875
- FailedNum: number;
940
+ RoomId: string;
876
941
  /**
877
- * 失败歌曲Id
878
- 注意:此字段可能返回 null,表示取不到有效值。
942
+ * 推流应用ID。
879
943
  */
880
- FailedMusicIds: Array<string>;
944
+ SdkAppId: string;
881
945
  /**
882
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
946
+ * 用户唯一标识。
883
947
  */
884
- RequestId?: string;
948
+ UserId: string;
885
949
  }
886
950
  /**
887
- * SearchKTVMusics返回参数结构体
951
+ * DescribePackageItems请求参数结构体
888
952
  */
889
- export interface SearchKTVMusicsResponse {
953
+ export interface DescribePackageItemsRequest {
890
954
  /**
891
- * 总记录数
955
+ * 订单id,从获取已购曲库包列表中获取
892
956
  */
893
- TotalCount: number;
957
+ OrderId: string;
894
958
  /**
895
- * KTV 曲目列表
959
+ * 默认0,Offset=Offset+Length
896
960
  */
897
- KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
961
+ Offset?: number;
898
962
  /**
899
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
963
+ * 默认20
900
964
  */
901
- RequestId?: string;
965
+ Length?: number;
902
966
  }
903
967
  /**
904
- * 机器人信息
968
+ * AuthInfo集合
905
969
  */
906
- export interface KTVRobotInfo {
970
+ export interface AuthInfo {
907
971
  /**
908
- * 机器人Id。
972
+ * 主体名称
973
+ 注意:此字段可能返回 null,表示取不到有效值。
909
974
  */
910
- RobotId: string;
975
+ SubjectName: string;
911
976
  /**
912
- * 状态,取值有:
913
- <li>Play:播放</li>
914
- <li>Pause:暂停</li>
915
- <li>Destroy:销毁</li>
977
+ * 项目名称
978
+ 注意:此字段可能返回 null,表示取不到有效值。
916
979
  */
917
- Status: string;
980
+ ProjectName: string;
918
981
  /**
919
- * 播放列表。
982
+ * 应用场景
920
983
  */
921
- Playlists: Array<string>;
984
+ AppScene: number;
922
985
  /**
923
- * 当前歌单索引位置。
986
+ * 应用地域
924
987
  */
925
- CurIndex: number;
988
+ AppRegion: number;
926
989
  /**
927
- * 播放进度,单位:毫秒。
990
+ * 授权时间
928
991
  */
929
- Position: number;
992
+ AuthPeriod: number;
930
993
  /**
931
- * 音频参数
994
+ * 是否可商业化
932
995
  */
933
- SetAudioParamInput: SetAudioParamCommandInput;
996
+ Commercialization: number;
934
997
  /**
935
- * 进房信息
998
+ * 是否可跨平台
936
999
  */
937
- JoinRoomInput: JoinRoomInput;
1000
+ Platform: number;
938
1001
  /**
939
- * RTC厂商类型,取值有:
940
- <li>TRTC</li>
1002
+ * 加密后Id
941
1003
  */
942
- RTCSystem: string;
1004
+ Id: string;
1005
+ }
1006
+ /**
1007
+ * DescribeKTVRobots返回参数结构体
1008
+ */
1009
+ export interface DescribeKTVRobotsResponse {
943
1010
  /**
944
- * 播放模式,PlayMode取值有:
945
- <li>RepeatPlaylist:列表循环</li>
946
- <li>Order:顺序播放</li>
947
- <li>RepeatSingle:单曲循环</li>
948
- <li>Shuffle:随机播放</li>
1011
+ * 机器人总数。
949
1012
  */
950
- SetPlayModeInput: SetPlayModeCommandInput;
1013
+ TotalCount: number;
1014
+ /**
1015
+ * 机器人信息集合。
1016
+ */
1017
+ KTVRobotInfoSet: Array<KTVRobotInfo>;
1018
+ /**
1019
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1020
+ */
1021
+ RequestId?: string;
951
1022
  }
952
1023
  /**
953
- * DescribeItems请求参数结构体
1024
+ * 曲库包用途信息
954
1025
  */
955
- export interface DescribeItemsRequest {
1026
+ export interface UseRange {
956
1027
  /**
957
- * offset (Default = 0),(当前页-1) * Limit
1028
+ * 用途id
958
1029
  */
959
- Offset: number;
1030
+ UseRangeId: number;
960
1031
  /**
961
- * 条数,必须大于0,最大值为30
1032
+ * 用途范围名称
962
1033
  */
963
- Limit: number;
1034
+ Name: string;
1035
+ }
1036
+ /**
1037
+ * DescribeStations请求参数结构体
1038
+ */
1039
+ export interface DescribeStationsRequest {
964
1040
  /**
965
- * (电台/歌单)ID,CategoryId和CategoryCode两个必传1个,可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容(Station)列表接口</a>中获取。
1041
+ * 条数,必须大于0
966
1042
  */
967
- CategoryId?: string;
1043
+ Limit: number;
968
1044
  /**
969
- * (电台/歌单)ID,CategoryId和CategoryCode两个必传1个,可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容(Station)列表接口</a>中获取。
1045
+ * offset (Default = 0),Offset=Offset+Limit
970
1046
  */
971
- CategoryCode?: string;
1047
+ Offset: number;
972
1048
  }
973
1049
  /**
974
- * 歌曲信息
1050
+ * DescribeKTVSingerMusics请求参数结构体
975
1051
  */
976
- export interface Item {
1052
+ export interface DescribeKTVSingerMusicsRequest {
977
1053
  /**
978
- * Song ID
1054
+ * 歌手id
979
1055
  */
980
- ItemID: string;
1056
+ SingerId: string;
981
1057
  /**
982
- * Song info
983
- 注意:此字段可能返回 null,表示取不到有效值。
1058
+ * 分页偏移量,默认值:0。
984
1059
  */
985
- DataInfo: DataInfo;
1060
+ Offset?: number;
986
1061
  /**
987
- * 专辑信息
988
- 注意:此字段可能返回 null,表示取不到有效值。
1062
+ * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
989
1063
  */
990
- Album: Album;
1064
+ Limit?: number;
1065
+ }
1066
+ /**
1067
+ * DescribeKTVSingerCategories返回参数结构体
1068
+ */
1069
+ export interface DescribeKTVSingerCategoriesResponse {
991
1070
  /**
992
- * 多个歌手集合
993
- 注意:此字段可能返回 null,表示取不到有效值。
1071
+ * 歌手性别分类列表
994
1072
  */
995
- Artists: Array<Artist>;
1073
+ GenderSet: Array<KTVSingerCategoryInfo>;
996
1074
  /**
997
- * 歌曲状态,1:添加进购物车;2:核销进曲库包
998
- 注意:此字段可能返回 null,表示取不到有效值。
1075
+ * 歌手区域分类列表
999
1076
  */
1000
- Status: number;
1077
+ AreaSet: Array<KTVSingerCategoryInfo>;
1078
+ /**
1079
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1080
+ */
1081
+ RequestId?: string;
1001
1082
  }
1002
1083
  /**
1003
- * 设置播放模式
1084
+ * DescribeKTVSingers请求参数结构体
1004
1085
  */
1005
- export interface SetPlayModeCommandInput {
1086
+ export interface DescribeKTVSingersRequest {
1006
1087
  /**
1007
- * 播放模式,取值有:
1008
- <li>RepeatPlaylist:列表循环</li>
1009
- <li>Order:顺序播放</li>
1010
- <li>RepeatSingle:单曲循环</li>
1011
- <li>Shuffle:随机播放</li>
1088
+ * 歌手id集合,精确匹配歌手id
1089
+ <li> 数组长度限制10</li>
1012
1090
  */
1013
- PlayMode: string;
1091
+ SingerIds?: Array<string>;
1092
+ /**
1093
+ * 歌手性别集合,不传为全部,精确匹配歌手性别类型,
1094
+ <li>数组长度限制1</li>
1095
+ <li>取值范围:直播互动曲库歌手分类信息接口,返回性别分类信息列表中,分类英文名</li>
1096
+ */
1097
+ Genders?: Array<string>;
1098
+ /**
1099
+ * 歌手区域集合,不传为全部,精确匹配歌手区域
1100
+ <li>数组长度限制10</li>
1101
+ <li>取值范围:直播互动曲库歌手分类信息接口,返回的区域分类信息列表中,分类英文名</li>
1102
+ */
1103
+ Areas?: Array<string>;
1104
+ /**
1105
+ * 排序方式。默认按照播放数倒序
1106
+ <li> Sort.Field 可选 PlayCount。</li>
1107
+ */
1108
+ Sort?: SortBy;
1109
+ /**
1110
+ * 分页偏移量,默认值:0。
1111
+ */
1112
+ Offset?: number;
1113
+ /**
1114
+ * 分页返回的记录条数,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
1115
+ */
1116
+ Limit?: number;
1014
1117
  }
1015
1118
  /**
1016
1119
  * 设置播放列表指令参数
@@ -1043,483 +1146,646 @@ export interface SyncKTVRobotCommandResponse {
1043
1146
  RequestId?: string;
1044
1147
  }
1045
1148
  /**
1046
- * DescribeCloudMusic返回参数结构体
1149
+ * SearchKTVMusics请求参数结构体
1047
1150
  */
1048
- export interface DescribeCloudMusicResponse {
1151
+ export interface SearchKTVMusicsRequest {
1049
1152
  /**
1050
- * 歌曲Id
1153
+ * 搜索关键词
1051
1154
  */
1052
- MusicId: string;
1155
+ KeyWord: string;
1053
1156
  /**
1054
- * 歌曲名称
1157
+ * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
1158
+ 取值范围:Offset + Limit 不超过5000。取值范围:小于5000
1055
1159
  */
1056
- MusicName: string;
1160
+ Offset: number;
1057
1161
  /**
1058
- * 歌曲时长
1059
- 注意:此字段可能返回 null,表示取不到有效值。
1162
+ * 分页返回的起始偏移量,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
1163
+ 取值范围:Offset + Limit 不超过5000。
1060
1164
  */
1061
- Duration: number;
1165
+ Limit: number;
1166
+ }
1167
+ /**
1168
+ * 推荐歌单基础信息
1169
+ */
1170
+ export interface KTVPlaylistBaseInfo {
1062
1171
  /**
1063
- * 歌曲链接
1172
+ * 歌单Id
1064
1173
  */
1065
- MusicUrl: string;
1174
+ PlaylistId: string;
1066
1175
  /**
1067
- * 歌曲图片
1068
- 注意:此字段可能返回 null,表示取不到有效值。
1176
+ * 歌单标题
1069
1177
  */
1070
- MusicImageUrl: string;
1178
+ Title: string;
1071
1179
  /**
1072
- * 歌手列表
1073
- 注意:此字段可能返回 null,表示取不到有效值。
1180
+ * 歌单介绍
1074
1181
  */
1075
- Singers: Array<string>;
1182
+ Description: string;
1076
1183
  /**
1077
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1184
+ * 歌曲数量
1078
1185
  */
1079
- RequestId?: string;
1186
+ MusicNum: number;
1080
1187
  }
1081
1188
  /**
1082
- * KTV 曲目基础信息
1189
+ * DescribeKTVSingers返回参数结构体
1083
1190
  */
1084
- export interface KTVMusicBaseInfo {
1191
+ export interface DescribeKTVSingersResponse {
1085
1192
  /**
1086
- * 歌曲 Id
1193
+ * 总歌手数
1087
1194
  */
1088
- MusicId: string;
1195
+ TotalCount: number;
1089
1196
  /**
1090
- * 歌曲名称
1197
+ * KTV歌手列表
1091
1198
  */
1092
- Name: string;
1199
+ KTVSingerInfoSet: Array<KTVSingerInfo>;
1093
1200
  /**
1094
- * 演唱者列表
1201
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1095
1202
  */
1096
- SingerSet: Array<string>;
1203
+ RequestId?: string;
1204
+ }
1205
+ /**
1206
+ * DescribeItemById返回参数结构体
1207
+ */
1208
+ export interface DescribeItemByIdResponse {
1097
1209
  /**
1098
- * 作词者列表
1210
+ * 歌曲信息
1211
+ 注意:此字段可能返回 null,表示取不到有效值。
1099
1212
  */
1100
- LyricistSet: Array<string>;
1213
+ Items?: Array<Item>;
1101
1214
  /**
1102
- * 作曲者列表
1215
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1103
1216
  */
1104
- ComposerSet: Array<string>;
1217
+ RequestId?: string;
1218
+ }
1219
+ /**
1220
+ * 返回单曲页面歌曲是否在售状态
1221
+ */
1222
+ export interface MusicStatus {
1105
1223
  /**
1106
- * 标签列表
1224
+ * 歌曲Id
1107
1225
  */
1108
- TagSet: Array<string>;
1226
+ MusicId: string;
1109
1227
  /**
1110
- * 歌曲时长
1228
+ * 在售状态,0为在售,1为临时下架,2为永久下架
1111
1229
  */
1112
- Duration: number;
1230
+ SaleStatus: number;
1113
1231
  }
1114
1232
  /**
1115
- * DescribePackages请求参数结构体
1233
+ * KTV歌手分类信息
1116
1234
  */
1117
- export interface DescribePackagesRequest {
1235
+ export interface KTVSingerCategoryInfo {
1118
1236
  /**
1119
- * 默认0,Offset=Offset+Length
1237
+ * 分类中文名
1120
1238
  */
1121
- Offset?: number;
1239
+ ChineseName: string;
1122
1240
  /**
1123
- * 默认20
1241
+ * 分类英文名
1124
1242
  */
1125
- Length?: number;
1243
+ EnglishName: string;
1126
1244
  }
1127
1245
  /**
1128
- * DescribeMusicSaleStatus请求参数结构体
1246
+ * 发送自定义信息指令参数
1129
1247
  */
1130
- export interface DescribeMusicSaleStatusRequest {
1248
+ export interface SendMessageCommandInput {
1131
1249
  /**
1132
- * 歌曲Id集合,可传单个,也可传多个,上线查询单次50个
1250
+ * 自定义消息,json格式字符串。
1133
1251
  */
1134
- MusicIds: Array<string>;
1252
+ Message: string;
1135
1253
  /**
1136
- * 查询哪个渠道的数据,1为曲库包,2为单曲
1254
+ * 消息重复次数,默认为 1
1137
1255
  */
1138
- PurchaseType: number;
1256
+ Repeat?: number;
1139
1257
  }
1140
1258
  /**
1141
- * SearchKTVMusics请求参数结构体
1259
+ * 直播互动歌曲规格信息。
1142
1260
  */
1143
- export interface SearchKTVMusicsRequest {
1261
+ export interface KTVMusicDefinitionInfo {
1144
1262
  /**
1145
- * 搜索关键词
1263
+ * 规格,取值有:
1264
+ <li>audio/mi:低规格;</li>
1265
+ <li>audio/lo:中规格;</li>
1266
+ <li>audio/hi:高规格。</li>
1146
1267
  */
1147
- KeyWord: string;
1268
+ Definition: string;
1148
1269
  /**
1149
- * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
1150
- 取值范围:Offset + Limit 不超过5000。取值范围:小于5000
1270
+ * 码率,单位为 bps。
1151
1271
  */
1152
- Offset: number;
1272
+ Bitrate: number;
1153
1273
  /**
1154
- * 分页返回的起始偏移量,默认值:50。将返回第 Offset 到第 Offset+Limit-1 条。
1155
- 取值范围:Offset + Limit 不超过5000。
1274
+ * 文件大小,单位为字节。
1156
1275
  */
1157
- Limit: number;
1276
+ Size: number;
1158
1277
  }
1159
1278
  /**
1160
- * 图片路径
1279
+ * Album
1161
1280
  */
1162
- export interface ImagePath {
1281
+ export interface Album {
1163
1282
  /**
1164
- * station图片大小及类别
1283
+ * 专辑名
1284
+ */
1285
+ AlbumName: string;
1286
+ /**
1287
+ * 专辑图片大小及类别
1165
1288
  注意:此字段可能返回 null,表示取不到有效值。
1166
1289
  */
1167
- Key: string;
1290
+ ImagePathMap: Array<ImagePath>;
1291
+ }
1292
+ /**
1293
+ * DescribeLyric返回参数结构体
1294
+ */
1295
+ export interface DescribeLyricResponse {
1168
1296
  /**
1169
- * station图片地址
1297
+ * 歌词或者波形图详情
1170
1298
  注意:此字段可能返回 null,表示取不到有效值。
1171
1299
  */
1172
- Value: string;
1300
+ Lyric: Lyric;
1301
+ /**
1302
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1303
+ */
1304
+ RequestId?: string;
1173
1305
  }
1174
1306
  /**
1175
- * DescribeItems返回参数结构体
1307
+ * KTV 曲目基础信息
1176
1308
  */
1177
- export interface DescribeItemsResponse {
1309
+ export interface KTVMusicBaseInfo {
1178
1310
  /**
1179
- * 分页偏移量
1311
+ * 歌曲 Id
1180
1312
  */
1181
- Offset?: number;
1313
+ MusicId: string;
1182
1314
  /**
1183
- * 当前页歌曲数量
1315
+ * 歌曲名称
1184
1316
  */
1185
- Size?: number;
1317
+ Name: string;
1186
1318
  /**
1187
- * 总数据条数
1319
+ * 演唱者基础信息列表
1188
1320
  */
1189
- Total?: number;
1321
+ SingerInfoSet: Array<KTVSingerBaseInfo>;
1190
1322
  /**
1191
- * 剩余数量(total-offset-size),通过这个值判断是否
1192
- 还有下一页
1323
+ * 已弃用,请使用SingerInfoSet
1193
1324
  */
1194
- HaveMore?: number;
1325
+ SingerSet: Array<string>;
1195
1326
  /**
1196
- * Items 歌曲列表
1197
- 注意:此字段可能返回 null,表示取不到有效值。
1327
+ * 作词者列表
1198
1328
  */
1199
- Items?: Array<Item>;
1329
+ LyricistSet: Array<string>;
1200
1330
  /**
1201
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1331
+ * 作曲者列表
1202
1332
  */
1203
- RequestId?: string;
1333
+ ComposerSet: Array<string>;
1334
+ /**
1335
+ * 标签列表
1336
+ */
1337
+ TagSet: Array<string>;
1338
+ /**
1339
+ * 歌曲时长
1340
+ */
1341
+ Duration: number;
1204
1342
  }
1205
1343
  /**
1206
- * DescribePkgOfflineMusic返回参数结构体
1344
+ * SyncKTVRobotCommand请求参数结构体
1207
1345
  */
1208
- export interface DescribePkgOfflineMusicResponse {
1346
+ export interface SyncKTVRobotCommandRequest {
1209
1347
  /**
1210
- * 曲库包中不可用歌曲信息
1348
+ * 机器人Id。
1211
1349
  */
1212
- OfflineMusicSet: Array<OfflineMusicDetail>;
1350
+ RobotId: string;
1213
1351
  /**
1214
- * 返回总量
1352
+ * 指令,取值有:
1353
+ <li>Play:播放</li>
1354
+ <li>Pause:暂停</li>
1355
+ <li>SwitchPrevious:上一首</li>
1356
+ <li>SwitchNext:下一首</li>
1357
+ <li>SetPlayMode:设置播放模式</li>
1358
+ <li>Seek:调整播放进度</li>
1359
+ <li>SetPlaylist:歌单变更</li>
1360
+ <li>SetAudioParam:音频参数变更</li>
1361
+ <li>SendMessage:发送自定义消息</li>
1215
1362
  */
1216
- TotalCount: number;
1363
+ Command: string;
1217
1364
  /**
1218
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1365
+ * 播放参数。
1219
1366
  */
1220
- RequestId?: string;
1221
- }
1222
- /**
1223
- * 推荐歌单基础信息
1224
- */
1225
- export interface KTVPlaylistBaseInfo {
1367
+ PlayCommandInput?: PlayCommandInput;
1226
1368
  /**
1227
- * 歌单Id
1369
+ * 播放列表变更信息,当Command取SetPlaylist时,必填。
1228
1370
  */
1229
- PlaylistId: string;
1371
+ SetPlaylistCommandInput?: SetPlaylistCommandInput;
1230
1372
  /**
1231
- * 歌单标题
1373
+ * 播放进度,当Command取Seek时,必填。
1232
1374
  */
1233
- Title: string;
1375
+ SeekCommandInput?: SeekCommandInput;
1234
1376
  /**
1235
- * 歌单介绍
1377
+ * 音频参数,当Command取SetAudioParam时,必填。
1236
1378
  */
1237
- Description: string;
1379
+ SetAudioParamCommandInput?: SetAudioParamCommandInput;
1238
1380
  /**
1239
- * 歌曲数量
1381
+ * 自定义消息,当Command取SendMessage时,必填。
1240
1382
  */
1241
- MusicNum: number;
1383
+ SendMessageCommandInput?: SendMessageCommandInput;
1384
+ /**
1385
+ * 播放模式,当Command取SetPlayMode时,必填。
1386
+ */
1387
+ SetPlayModeCommandInput?: SetPlayModeCommandInput;
1242
1388
  }
1243
1389
  /**
1244
- * DescribeItemById返回参数结构体
1390
+ * DescribeKTVPlaylists返回参数结构体
1245
1391
  */
1246
- export interface DescribeItemByIdResponse {
1392
+ export interface DescribeKTVPlaylistsResponse {
1247
1393
  /**
1248
- * 歌曲信息
1249
- 注意:此字段可能返回 null,表示取不到有效值。
1394
+ * 推荐歌单列表
1250
1395
  */
1251
- Items?: Array<Item>;
1396
+ PlaylistBaseInfoSet: Array<KTVPlaylistBaseInfo>;
1397
+ /**
1398
+ * 推荐歌单列表总数
1399
+ */
1400
+ TotalCount: number;
1252
1401
  /**
1253
1402
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1254
1403
  */
1255
1404
  RequestId?: string;
1256
1405
  }
1257
1406
  /**
1258
- * 返回单曲页面歌曲是否在售状态
1407
+ * DescribeKTVPlaylistDetail返回参数结构体
1259
1408
  */
1260
- export interface MusicStatus {
1261
- /**
1262
- * 歌曲Id
1263
- */
1264
- MusicId: string;
1409
+ export interface DescribeKTVPlaylistDetailResponse {
1265
1410
  /**
1266
- * 在售状态,0为在售,1为临时下架,2为永久下架
1411
+ * 歌曲基础信息列表
1267
1412
  */
1268
- SaleStatus: number;
1269
- }
1270
- /**
1271
- * DescribeMusicSaleStatus返回参数结构体
1272
- */
1273
- export interface DescribeMusicSaleStatusResponse {
1413
+ KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
1274
1414
  /**
1275
- * musicId对应歌曲状态
1415
+ * 歌单基础信息
1276
1416
  */
1277
- MusicStatusSet: Array<MusicStatus>;
1417
+ PlaylistBaseInfo: KTVPlaylistBaseInfo;
1278
1418
  /**
1279
1419
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1280
1420
  */
1281
1421
  RequestId?: string;
1282
1422
  }
1283
1423
  /**
1284
- * 发送自定义信息指令参数
1424
+ * 音频参数信息
1285
1425
  */
1286
- export interface SendMessageCommandInput {
1426
+ export interface SetAudioParamCommandInput {
1287
1427
  /**
1288
- * 自定义消息,json格式字符串。
1428
+ * 规格,取值有:
1429
+ <li>audio/mi:低规格</li>
1430
+ <li>audio/lo:中规格</li>
1431
+ <li>audio/hi:高规格</li>
1289
1432
  */
1290
- Message: string;
1433
+ Definition?: string;
1291
1434
  /**
1292
- * 消息重复次数,默认为 1。
1435
+ * 音频类型,取值有:
1436
+ <li>Original:原唱</li>
1437
+ <li>Accompaniment:伴奏</li>
1293
1438
  */
1294
- Repeat?: number;
1439
+ Type?: string;
1295
1440
  }
1296
1441
  /**
1297
- * PutMusicOnTheShelves请求参数结构体
1442
+ * 下架歌曲复合结构
1298
1443
  */
1299
- export interface PutMusicOnTheShelvesRequest {
1444
+ export interface TakeMusicOffShelves {
1300
1445
  /**
1301
- * 资源方歌曲Id
1446
+ * 资源方对应音乐Id
1302
1447
  */
1303
- MusicIds: Array<string>;
1448
+ MusicIds: string;
1449
+ /**
1450
+ * 当曲目临时下架时:已订购客户无影响,无需消息通知。当曲目封杀下架后,推送消息至已订购老客户,枚举值,判断是否上/下架
1451
+ 在售状态,0在售,1临时下架,2永久下架
1452
+ */
1453
+ SaleStatus: string;
1304
1454
  }
1305
1455
  /**
1306
- * DescribePackages返回参数结构体
1456
+ * 曲库包已下架歌曲详细信息
1307
1457
  */
1308
- export interface DescribePackagesResponse {
1458
+ export interface OfflineMusicDetail {
1309
1459
  /**
1310
- * 已购曲库包列表
1311
- 注意:此字段可能返回 null,表示取不到有效值。
1460
+ * 歌曲Id
1312
1461
  */
1313
- Packages?: Array<Package>;
1462
+ ItemId: string;
1314
1463
  /**
1315
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1464
+ * 歌曲名称
1316
1465
  */
1317
- RequestId?: string;
1318
- }
1319
- /**
1320
- * DestroyKTVRobot请求参数结构体
1321
- */
1322
- export interface DestroyKTVRobotRequest {
1466
+ MusicName: string;
1323
1467
  /**
1324
- * 机器人Id。
1468
+ * 不可用原因
1325
1469
  */
1326
- RobotId: string;
1470
+ OffRemark: string;
1471
+ /**
1472
+ * 不可用时间
1473
+ */
1474
+ OffTime: string;
1327
1475
  }
1328
1476
  /**
1329
- * DescribeCloudMusic请求参数结构体
1477
+ * DescribeAuthInfo请求参数结构体
1330
1478
  */
1331
- export interface DescribeCloudMusicRequest {
1479
+ export interface DescribeAuthInfoRequest {
1332
1480
  /**
1333
- * 歌曲Id
1481
+ * 偏移量:Offset=Offset+Limit
1334
1482
  */
1335
- MusicId: string;
1483
+ Offset?: number;
1336
1484
  /**
1337
- * 歌曲类型,可选值有:
1338
- <li>MP3-128K-FTW:含有水印的试听资源;</li>
1339
- <li>MP3-320K-FTD-P:320kbps歌曲热门片段;</li>
1340
- <li>MP3-320K-FTD:320kbps已核验歌曲完整资源。</li>
1341
- 默认为:MP3-128K-FTW
1485
+ * 数据条数
1342
1486
  */
1343
- MusicType?: string;
1487
+ Limit?: number;
1488
+ /**
1489
+ * 搜索关键字
1490
+ */
1491
+ Key?: string;
1344
1492
  }
1345
1493
  /**
1346
- * DescribeAuthInfo返回参数结构体
1494
+ * 曲库包信息
1347
1495
  */
1348
- export interface DescribeAuthInfoResponse {
1496
+ export interface Package {
1349
1497
  /**
1350
- * 授权项目列表
1498
+ * 订单id
1351
1499
  */
1352
- AuthInfo?: Array<AuthInfo>;
1500
+ OrderId: string;
1353
1501
  /**
1354
- * 总数
1502
+ * 曲库包名称
1355
1503
  */
1356
- TotalCount?: number;
1504
+ Name: string;
1357
1505
  /**
1358
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1506
+ * 授权地区-global: 全球 CN: 中国
1359
1507
  */
1360
- RequestId?: string;
1508
+ AuthorizedArea: string;
1509
+ /**
1510
+ * 授权次数
1511
+ */
1512
+ AuthorizedLimit: number;
1513
+ /**
1514
+ * 套餐有效期,单位:天
1515
+ */
1516
+ TermOfValidity: number;
1517
+ /**
1518
+ * 0:不可商业化;1:可商业化
1519
+ */
1520
+ Commercial: number;
1521
+ /**
1522
+ * 套餐价格,单位:元
1523
+ */
1524
+ PackagePrice: number;
1525
+ /**
1526
+ * 生效开始时间,格式yyyy-MM-dd HH:mm:ss
1527
+ */
1528
+ EffectTime: string;
1529
+ /**
1530
+ * 生效结束时间,格式yyyy-MM-dd HH:mm:ss
1531
+ */
1532
+ ExpireTime: string;
1533
+ /**
1534
+ * 剩余授权次数
1535
+ */
1536
+ UsedCount: number;
1537
+ /**
1538
+ * 曲库包用途信息
1539
+ */
1540
+ UseRanges: Array<UseRange>;
1361
1541
  }
1362
1542
  /**
1363
- * TakeMusicOffShelves返回参数结构体
1543
+ * 设置播放模式
1364
1544
  */
1365
- export interface TakeMusicOffShelvesResponse {
1545
+ export interface SetPlayModeCommandInput {
1366
1546
  /**
1367
- * 返回成功数量
1547
+ * 播放模式,取值有:
1548
+ <li>RepeatPlaylist:列表循环</li>
1549
+ <li>Order:顺序播放</li>
1550
+ <li>RepeatSingle:单曲循环</li>
1551
+ <li>Shuffle:随机播放</li>
1368
1552
  */
1369
- SuccessNum: number;
1553
+ PlayMode: string;
1554
+ }
1555
+ /**
1556
+ * 机器人信息
1557
+ */
1558
+ export interface KTVRobotInfo {
1370
1559
  /**
1371
- * 返回失败数量
1560
+ * 机器人Id。
1372
1561
  */
1373
- FailedNum: number;
1562
+ RobotId: string;
1374
1563
  /**
1375
- * 返回失败歌曲musicId
1376
- 注意:此字段可能返回 null,表示取不到有效值。
1564
+ * 状态,取值有:
1565
+ <li>Play:播放</li>
1566
+ <li>Pause:暂停</li>
1567
+ <li>Destroy:销毁</li>
1377
1568
  */
1378
- FailedMusicIds: Array<string>;
1569
+ Status: string;
1379
1570
  /**
1380
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1571
+ * 播放列表。
1381
1572
  */
1382
- RequestId?: string;
1573
+ Playlists: Array<string>;
1574
+ /**
1575
+ * 当前歌单索引位置。
1576
+ */
1577
+ CurIndex: number;
1578
+ /**
1579
+ * 播放进度,单位:毫秒。
1580
+ */
1581
+ Position: number;
1582
+ /**
1583
+ * 音频参数
1584
+ */
1585
+ SetAudioParamInput: SetAudioParamCommandInput;
1586
+ /**
1587
+ * 进房信息
1588
+ */
1589
+ JoinRoomInput: JoinRoomInput;
1590
+ /**
1591
+ * RTC厂商类型,取值有:
1592
+ <li>TRTC</li>
1593
+ */
1594
+ RTCSystem: string;
1595
+ /**
1596
+ * 播放模式,PlayMode取值有:
1597
+ <li>RepeatPlaylist:列表循环</li>
1598
+ <li>Order:顺序播放</li>
1599
+ <li>RepeatSingle:单曲循环</li>
1600
+ <li>Shuffle:随机播放</li>
1601
+ */
1602
+ SetPlayModeInput: SetPlayModeCommandInput;
1383
1603
  }
1384
1604
  /**
1385
- * DescribeLyric请求参数结构体
1605
+ * DescribeItems请求参数结构体
1386
1606
  */
1387
- export interface DescribeLyricRequest {
1607
+ export interface DescribeItemsRequest {
1388
1608
  /**
1389
- * 歌曲ID
1609
+ * offset (Default = 0),(当前页-1) * Limit
1390
1610
  */
1391
- ItemId: string;
1611
+ Offset: number;
1392
1612
  /**
1393
- * 格式,可选项,可不填写,默认值为:LRC-LRC。
1394
- <li>LRC-LRC:歌词;</li>
1395
- <li>JSON-ST:波形图。</li>
1613
+ * 条数,必须大于0,最大值为30
1396
1614
  */
1397
- SubItemType?: string;
1615
+ Limit: number;
1616
+ /**
1617
+ * (电台/歌单)ID,CategoryId和CategoryCode两个必传1个,可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容(Station)列表接口</a>中获取。
1618
+ */
1619
+ CategoryId?: string;
1620
+ /**
1621
+ * (电台/歌单)ID,CategoryId和CategoryCode两个必传1个,可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容(Station)列表接口</a>中获取。
1622
+ */
1623
+ CategoryCode?: string;
1398
1624
  }
1399
1625
  /**
1400
- * DescribeKTVMusicDetail返回参数结构体
1626
+ * 歌曲信息
1401
1627
  */
1402
- export interface DescribeKTVMusicDetailResponse {
1628
+ export interface Item {
1403
1629
  /**
1404
- * 歌曲基础信息
1630
+ * Song ID
1405
1631
  */
1406
- KTVMusicBaseInfo: KTVMusicBaseInfo;
1632
+ ItemID: string;
1407
1633
  /**
1408
- * 播放凭证
1634
+ * Song info
1635
+ 注意:此字段可能返回 null,表示取不到有效值。
1409
1636
  */
1410
- PlayToken: string;
1637
+ DataInfo: DataInfo;
1411
1638
  /**
1412
- * 歌词下载地址
1639
+ * 专辑信息
1640
+ 注意:此字段可能返回 null,表示取不到有效值。
1413
1641
  */
1414
- LyricsUrl: string;
1642
+ Album: Album;
1415
1643
  /**
1416
- * 歌曲规格信息列表
1644
+ * 多个歌手集合
1645
+ 注意:此字段可能返回 null,表示取不到有效值。
1417
1646
  */
1418
- DefinitionInfoSet: Array<KTVMusicDefinitionInfo>;
1647
+ Artists: Array<Artist>;
1648
+ /**
1649
+ * 歌曲状态,1:添加进购物车;2:核销进曲库包
1650
+ 注意:此字段可能返回 null,表示取不到有效值。
1651
+ */
1652
+ Status: number;
1653
+ }
1654
+ /**
1655
+ * DescribeKTVTopList返回参数结构体
1656
+ */
1657
+ export interface DescribeKTVTopListResponse {
1658
+ /**
1659
+ * 歌曲基础信息列表
1660
+ */
1661
+ KTVMusicTopInfoSet: Array<KTVMusicTopInfo>;
1662
+ /**
1663
+ * 返回总条数
1664
+ */
1665
+ TotalCount: number;
1419
1666
  /**
1420
1667
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1421
1668
  */
1422
1669
  RequestId?: string;
1423
1670
  }
1424
1671
  /**
1425
- * DescribeKTVRobots请求参数结构体
1672
+ * 对外开放信息
1426
1673
  */
1427
- export interface DescribeKTVRobotsRequest {
1674
+ export interface MusicOpenDetail {
1428
1675
  /**
1429
- * 机器人Id列表。
1676
+ * 音乐Id
1677
+ 注意:此字段可能返回 null,表示取不到有效值。
1430
1678
  */
1431
- RobotIds?: Array<string>;
1679
+ MusicId: string;
1432
1680
  /**
1433
- * 机器人状态,取值有:
1434
- <li>Play:播放</li>
1435
- <li>Pause:暂停</li>
1436
- <li>Destroy:销毁</li>
1681
+ * 专辑名称
1682
+ 注意:此字段可能返回 null,表示取不到有效值。
1437
1683
  */
1438
- Statuses?: Array<string>;
1684
+ AlbumName: string;
1439
1685
  /**
1440
- * 匹配创建时间在此时间段内的机器人。
1441
- <li>包含所指定的头尾时间点。</li>
1686
+ * 专辑图片路径
1687
+ 注意:此字段可能返回 null,表示取不到有效值。
1442
1688
  */
1443
- CreateTime?: TimeRange;
1689
+ AlbumImageUrl: string;
1444
1690
  /**
1445
- * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
1691
+ * 音乐名称
1692
+ 注意:此字段可能返回 null,表示取不到有效值。
1446
1693
  */
1447
- Offset?: number;
1694
+ MusicName: string;
1448
1695
  /**
1449
- * 分页返回的起始偏移量,默认值:10。
1696
+ * 音乐图片路径
1697
+ 注意:此字段可能返回 null,表示取不到有效值。
1450
1698
  */
1451
- Limit?: number;
1452
- }
1453
- /**
1454
- * DescribeMusic请求参数结构体
1455
- */
1456
- export interface DescribeMusicRequest {
1699
+ MusicImageUrl: string;
1457
1700
  /**
1458
- * 歌曲ID
1701
+ * 歌手
1702
+ 注意:此字段可能返回 null,表示取不到有效值。
1459
1703
  */
1460
- ItemId: string;
1704
+ Singers: Array<string>;
1461
1705
  /**
1462
- * 在应用前端播放音乐C端用户的唯一标识。无需是账户信息,用户唯一标识即可。
1706
+ * 播放时长
1707
+ 注意:此字段可能返回 null,表示取不到有效值。
1463
1708
  */
1464
- IdentityId: string;
1709
+ Duration: number;
1465
1710
  /**
1466
- * MP3-320K-FTD-P 为获取320kbps歌曲热门片段。
1467
- MP3-320K-FTD 为获取320kbps已核验歌曲完整资源。
1711
+ * 标签
1712
+ 注意:此字段可能返回 null,表示取不到有效值。
1468
1713
  */
1469
- SubItemType?: string;
1714
+ Tags: Array<string>;
1470
1715
  /**
1471
- * CDN URL Protocol:HTTP or HTTPS/SSL
1472
- Values:Y , N(default)
1716
+ * 歌词url
1717
+ 注意:此字段可能返回 null,表示取不到有效值。
1473
1718
  */
1474
- Ssl?: string;
1719
+ LyricUrl: string;
1720
+ /**
1721
+ * 波形图url
1722
+ 注意:此字段可能返回 null,表示取不到有效值。
1723
+ */
1724
+ WaveformUrl: string;
1475
1725
  }
1476
1726
  /**
1477
- * ReportData请求参数结构体
1727
+ * DescribePackages请求参数结构体
1478
1728
  */
1479
- export interface ReportDataRequest {
1729
+ export interface DescribePackagesRequest {
1480
1730
  /**
1481
- * 上报数据
1482
- 注:reportData为客户端压缩后的上报数据进行16进制转换的字符串数据
1483
- 压缩说明:
1484
- a) 上报的json格式字符串通过流的转换(ByteArrayInputStream, java.util.zip.GZIPOutputStream),获取到压缩后的字节数组。
1485
- b) 将压缩后的字节数组转成16进制字符串。
1486
-
1487
- reportData由两部分数据组成:
1488
- 1)report_type(上报类型)
1489
- 2)data(歌曲上报数据)
1490
- 不同的report_type对应的data数据结构不一样。
1491
-
1492
- 详细说明请参考文档reportdata.docx:
1493
- https://github.com/tencentyun/ame-documents
1731
+ * 默认0,Offset=Offset+Length
1494
1732
  */
1495
- ReportData: string;
1733
+ Offset?: number;
1734
+ /**
1735
+ * 默认20
1736
+ */
1737
+ Length?: number;
1496
1738
  }
1497
1739
  /**
1498
- * 调整播放进度指令参数
1740
+ * DescribePackages返回参数结构体
1499
1741
  */
1500
- export interface SeekCommandInput {
1742
+ export interface DescribePackagesResponse {
1501
1743
  /**
1502
- * 播放位置,单位:毫秒。
1744
+ * 已购曲库包列表
1745
+ 注意:此字段可能返回 null,表示取不到有效值。
1503
1746
  */
1504
- Position: number;
1747
+ Packages?: Array<Package>;
1748
+ /**
1749
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1750
+ */
1751
+ RequestId?: string;
1505
1752
  }
1506
1753
  /**
1507
- * 直播互动歌曲规格信息。
1754
+ * 歌词信息
1508
1755
  */
1509
- export interface KTVMusicDefinitionInfo {
1756
+ export interface Lyric {
1510
1757
  /**
1511
- * 规格,取值有:
1512
- <li>audio/mi:低规格;</li>
1513
- <li>audio/lo:中规格;</li>
1514
- <li>audio/hi:高规格。</li>
1758
+ * 歌词cdn地址
1515
1759
  */
1516
- Definition: string;
1760
+ Url: string;
1517
1761
  /**
1518
- * 码率,单位为 bps。
1762
+ * 歌词后缀名
1519
1763
  */
1520
- Bitrate: number;
1764
+ FileNameExt: string;
1521
1765
  /**
1522
- * 文件大小,单位为字节。
1766
+ * 歌词类型
1523
1767
  */
1524
- Size: number;
1768
+ SubItemType: string;
1769
+ }
1770
+ /**
1771
+ * TakeMusicOffShelves返回参数结构体
1772
+ */
1773
+ export interface TakeMusicOffShelvesResponse {
1774
+ /**
1775
+ * 返回成功数量
1776
+ */
1777
+ SuccessNum: number;
1778
+ /**
1779
+ * 返回失败数量
1780
+ */
1781
+ FailedNum: number;
1782
+ /**
1783
+ * 返回失败歌曲musicId
1784
+ 注意:此字段可能返回 null,表示取不到有效值。
1785
+ */
1786
+ FailedMusicIds: Array<string>;
1787
+ /**
1788
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1789
+ */
1790
+ RequestId?: string;
1525
1791
  }