tencentcloud-sdk-nodejs 4.0.281 → 4.0.282

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