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