tencentcloud-sdk-nodejs 4.0.278 → 4.0.282

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