tencentcloud-sdk-nodejs 4.0.281 → 4.0.285

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