tencentcloud-sdk-nodejs 4.0.279 → 4.0.283

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