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