tencentcloud-sdk-nodejs 4.0.280 → 4.0.284

package/tencentcloud/services/ame/v20190916/ame_models.d.ts

@@ -1,17 +1,3 @@
-/**
- * Album
- */
-export interface Album {
-    /**
-      * 专辑名
-      */
-    AlbumName: string;
-    /**
-      * 专辑图片大小及类别
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-    ImagePathMap: Array<ImagePath>;
-}
 /**
  * DescribeMusic返回参数结构体
  */
@@ -27,76 +13,127 @@ export interface DescribeMusicResponse {
     RequestId?: string;
 }
 /**
- * DescribePkgOfflineMusic请求参数结构体
+ * 副歌片段信息
  */
-export interface DescribePkgOfflineMusicRequest {
+export interface ChorusClip {
     /**
-      * 订单id
+      * 副歌时间，单位：毫秒
       */
-    PackageOrderId: string;
+    StartTime: number;
     /**
-      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条(注：单次上限为100)。
+      * 副歌结束时间，单位：毫秒
       */
-    Limit?: number;
+    EndTime: number;
+}
+/**
+ * ModifyMusicOnShelves返回参数结构体
+ */
+export interface ModifyMusicOnShelvesResponse {
     /**
-      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Offset?: number;
+    RequestId?: string;
 }
 /**
- * 直播进房输入参数
+ * 分类内容
  */
-export interface JoinRoomInput {
+export interface Station {
     /**
-      * TRTC进房参数
+      * StationID
       */
-    TRTCJoinRoomInput?: TRTCJoinRoomInput;
+    CategoryID: string;
+    /**
+      * Station MCCode
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    CategoryCode: string;
+    /**
+      * Category Name
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Name: string;
+    /**
+      * Station的排序值，供参考（返回结果已按其升序）
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Rank: number;
+    /**
+      * station图片集合
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    ImagePathMap: Array<ImagePath>;
 }
 /**
- * DestroyKTVRobot返回参数结构体
+ * DescribeKTVMusicDetail请求参数结构体
  */
-export interface DestroyKTVRobotResponse {
+export interface DescribeKTVMusicDetailRequest {
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 曲目 Id
       */
-    RequestId?: string;
+    MusicId: string;
 }
 /**
- * DescribeLyric返回参数结构体
+ * 排行榜结构
  */
-export interface DescribeLyricResponse {
+export interface KTVMusicTopInfo {
     /**
-      * 歌词或者波形图详情
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲Id
       */
-    Lyric: Lyric;
+    MusicId: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 歌曲名称
       */
-    RequestId?: string;
+    Name: string;
+    /**
+      * 歌手名称列表
+      */
+    SingerInfoSet: Array<KTVSingerBaseInfo>;
+    /**
+      * 歌词名称列表
+      */
+    LyricistSet: Array<string>;
+    /**
+      * 作曲列表
+      */
+    ComposerSet: Array<string>;
+    /**
+      * 标签列表
+      */
+    TagSet: Array<string>;
+    /**
+      * 播放时长
+      */
+    Duration: number;
 }
 /**
- * ModifyMusicOnShelves返回参数结构体
+ * DescribeKTVSingerCategories请求参数结构体
  */
-export interface ModifyMusicOnShelvesResponse {
+export declare type DescribeKTVSingerCategoriesRequest = null;
+/**
+ * KTV 歌手基础信息
+ */
+export interface KTVSingerBaseInfo {
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 歌手id
       */
-    RequestId?: string;
+    SingerId: string;
+    /**
+      * 歌手名
+      */
+    Name: string;
 }
 /**
- * CreateKTVRobot请求参数结构体
+ * ModifyMusicOnShelves请求参数结构体
  */
-export interface CreateKTVRobotRequest {
+export interface ModifyMusicOnShelvesRequest {
     /**
-      * RTC厂商类型，取值有：
-<li>TRTC</li>
+      * 歌曲变更信息
       */
-    RTCSystem: string;
+    MusicDetailInfos: MusicDetailInfo;
     /**
-      * 进房参数。
+      * ame对接资源方密钥
       */
-    JoinRoomInput: JoinRoomInput;
+    AmeKey?: string;
 }
 /**
  * 播放指令输入参数
@@ -108,141 +145,86 @@ export interface PlayCommandInput {
     Index: number;
 }
 /**
- * SyncKTVRobotCommand请求参数结构体
+ * DescribeMusic请求参数结构体
  */
-export interface SyncKTVRobotCommandRequest {
-    /**
-      * 机器人Id。
-      */
-    RobotId: string;
-    /**
-      * 指令，取值有：
-<li>Play：播放</li>
-<li>Pause：暂停</li>
-<li>SwitchPrevious：上一首</li>
-<li>SwitchNext：下一首</li>
-<li>SetPlayMode：设置播放模式</li>
-<li>Seek：调整播放进度</li>
-<li>SetPlaylist：歌单变更</li>
-<li>SetAudioParam：音频参数变更</li>
-<li>SendMessage：发送自定义消息</li>
-      */
-    Command: string;
-    /**
-      * 播放参数。
-      */
-    PlayCommandInput?: PlayCommandInput;
-    /**
-      * 播放列表变更信息，当Command取SetPlaylist时，必填。
-      */
-    SetPlaylistCommandInput?: SetPlaylistCommandInput;
+export interface DescribeMusicRequest {
     /**
-      * 播放进度，当Command取Seek时，必填。
+      * 歌曲ID
       */
-    SeekCommandInput?: SeekCommandInput;
+    ItemId: string;
     /**
-      * 音频参数，当Command取SetAudioParam时，必填。
+      * 在应用前端播放音乐C端用户的唯一标识。无需是账户信息，用户唯一标识即可。
       */
-    SetAudioParamCommandInput?: SetAudioParamCommandInput;
+    IdentityId: string;
     /**
-      * 自定义消息，当Command取SendMessage时，必填。
+      * MP3-320K-FTD-P  为获取320kbps歌曲热门片段。
+MP3-320K-FTD 为获取320kbps已核验歌曲完整资源。
       */
-    SendMessageCommandInput?: SendMessageCommandInput;
+    SubItemType?: string;
     /**
-      * 播放模式，当Command取SetPlayMode时，必填。
+      * CDN URL Protocol:HTTP or HTTPS/SSL
+Values:Y , N(default)
       */
-    SetPlayModeCommandInput?: SetPlayModeCommandInput;
+    Ssl?: string;
 }
 /**
- * 音频参数信息
+ * DescribeMusicSaleStatus请求参数结构体
  */
-export interface SetAudioParamCommandInput {
+export interface DescribeMusicSaleStatusRequest {
     /**
-      * 规格，取值有：
-<li>audio/mi：低规格</li>
-<li>audio/lo：中规格</li>
-<li>audio/hi：高规格</li>
+      * 歌曲Id集合，可传单个，也可传多个，上线查询单次50个
       */
-    Definition?: string;
+    MusicIds: Array<string>;
     /**
-      * 音频类型，取值有：
-<li>Original：原唱</li>
-<li>Accompaniment：伴奏</li>
+      * 查询哪个渠道的数据，1为曲库包，2为单曲
       */
-    Type?: string;
+    PurchaseType: number;
 }
 /**
- * DescribeKTVPlaylistDetail请求参数结构体
+ * TakeMusicOffShelves请求参数结构体
  */
-export interface DescribeKTVPlaylistDetailRequest {
-    /**
-      * 歌单Id
-      */
-    PlaylistId: string;
-    /**
-      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
-      */
-    Offset?: number;
+export interface TakeMusicOffShelvesRequest {
     /**
-      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+      * 资源方下架必传结构
       */
-    Limit?: number;
+    TakeMusicOffShelves: Array<TakeMusicOffShelves>;
 }
 /**
- * 分类内容
+ * DescribeCloudMusic返回参数结构体
  */
-export interface Station {
+export interface DescribeCloudMusicResponse {
     /**
-      * StationID
+      * 歌曲Id
       */
-    CategoryID: string;
+    MusicId: string;
     /**
-      * Station MCCode
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲名称
       */
-    CategoryCode: string;
+    MusicName: string;
     /**
-      * Category Name
+      * 歌曲时长
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    Name: string;
+    Duration: number;
     /**
-      * Station的排序值，供参考（返回结果已按其升序）
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲链接
       */
-    Rank: number;
+    MusicUrl: string;
     /**
-      * station图片集合
+      * 歌曲图片
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    ImagePathMap: Array<ImagePath>;
-}
-/**
- * CreateKTVRobot返回参数结构体
- */
-export interface CreateKTVRobotResponse {
+    MusicImageUrl: string;
     /**
-      * 机器人Id。
+      * 歌手列表
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    RobotId: string;
+    Singers: Array<string>;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
-/**
- * 曲库包用途信息
- */
-export interface UseRange {
-    /**
-      * 用途id
-      */
-    UseRangeId: number;
-    /**
-      * 用途范围名称
-      */
-    Name: string;
-}
 /**
  * 歌曲变更细节
  */
@@ -297,130 +279,176 @@ export interface MusicDetailInfo {
     Channel?: string;
 }
 /**
- * DescribeKTVMusicDetail请求参数结构体
+ * 图片路径
  */
-export interface DescribeKTVMusicDetailRequest {
+export interface ImagePath {
     /**
-      * 曲目 Id
+      * station图片大小及类别
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    MusicId: string;
-}
-/**
- * DescribeStations返回参数结构体
- */
-export interface DescribeStationsResponse {
+    Key: string;
     /**
-      * 总数量
+      * station图片地址
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Total?: number;
+    Value: string;
+}
+/**
+ * DescribeMusicSaleStatus返回参数结构体
+ */
+export interface DescribeMusicSaleStatusResponse {
     /**
-      * 分页偏移量
+      * musicId对应歌曲状态
       */
-    Offset?: number;
+    MusicStatusSet: Array<MusicStatus>;
     /**
-      * 当前页station数量
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Size?: number;
+    RequestId?: string;
+}
+/**
+ * DestroyKTVRobot请求参数结构体
+ */
+export interface DestroyKTVRobotRequest {
     /**
-      * 剩余数量（total-offset-size），通过这个值判断是否还有下一页
+      * 机器人Id。
       */
-    HaveMore?: number;
+    RobotId: string;
+}
+/**
+ * DescribeAuthInfo返回参数结构体
+ */
+export interface DescribeAuthInfoResponse {
     /**
-      * Stations 素材库列表
-注意：此字段可能返回 null，表示取不到有效值。
+      * 授权项目列表
       */
-    Stations?: Array<Station>;
+    AuthInfo?: Array<AuthInfo>;
+    /**
+      * 总数
+      */
+    TotalCount?: number;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * DescribePackageItems返回参数结构体
+ * DescribeLyric请求参数结构体
  */
-export interface DescribePackageItemsResponse {
+export interface DescribeLyricRequest {
     /**
-      * 已核销歌曲信息列表
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲ID
       */
-    PackageItems?: Array<PackageItem>;
+    ItemId: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 格式，可选项，可不填写，默认值为：LRC-LRC。
+<li>LRC-LRC：歌词；</li>
+<li>JSON-ST：波形图。</li>
       */
-    RequestId?: string;
+    SubItemType?: string;
 }
 /**
- * DescribeCloudMusicPurchased请求参数结构体
+ * ReportData请求参数结构体
  */
-export interface DescribeCloudMusicPurchasedRequest {
+export interface ReportDataRequest {
     /**
-      * 授权项目Id
+      * 上报数据
+注:reportData为客户端压缩后的上报数据进行16进制转换的字符串数据
+压缩说明：
+a) 上报的json格式字符串通过流的转换（ByteArrayInputStream, java.util.zip.GZIPOutputStream），获取到压缩后的字节数组。
+b) 将压缩后的字节数组转成16进制字符串。
+
+reportData由两部分数据组成：
+1）report_type（上报类型）
+2）data（歌曲上报数据）
+不同的report_type对应的data数据结构不一样。
+
+详细说明请参考文档reportdata.docx：
+https://github.com/tencentyun/ame-documents
       */
-    AuthInfoId: string;
+    ReportData: string;
 }
 /**
- * 曲库包歌曲信息
+ * 调整播放进度指令参数
  */
-export interface PackageItem {
+export interface SeekCommandInput {
     /**
-      * 订单id
+      * 播放位置，单位：毫秒。
       */
-    OrderId: string;
+    Position: number;
+}
+/**
+ * DescribePkgOfflineMusic请求参数结构体
+ */
+export interface DescribePkgOfflineMusicRequest {
     /**
-      * 歌曲名
+      * 订单id
       */
-    TrackName: string;
+    PackageOrderId: string;
     /**
-      * 歌曲ID
+      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条(注：单次上限为100)。
       */
-    ItemID: string;
+    Limit?: number;
     /**
-      * 专辑图片
+      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
       */
-    Img: string;
+    Offset?: number;
+}
+/**
+ * 时间范围
+ */
+export interface TimeRange {
     /**
-      * 歌手名
+      * <li>大于等于此时间（起始时间）。</li>
+<li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
       */
-    ArtistName: string;
+    Before?: string;
     /**
-      * 歌曲时长
+      * <li>小于此时间（结束时间）。</li>
+<li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
       */
-    Duration: string;
+    After?: string;
+}
+/**
+ * CreateKTVRobot返回参数结构体
+ */
+export interface CreateKTVRobotResponse {
     /**
-      * 授权区域，global: 全球 CN: 中国
+      * 机器人Id。
       */
-    AuthorizedArea: string;
+    RobotId: string;
     /**
-      * 标签数组
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Tags: Array<string>;
+    RequestId?: string;
 }
 /**
- * DescribeCloudMusicPurchased返回参数结构体
+ * DescribePackageItems返回参数结构体
  */
-export interface DescribeCloudMusicPurchasedResponse {
+export interface DescribePackageItemsResponse {
     /**
-      * 云音乐列表
+      * 已核销歌曲信息列表
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    MusicOpenDetail: Array<MusicOpenDetail>;
+    PackageItems?: Array<PackageItem>;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * DescribeKTVPlaylists请求参数结构体
+ * DescribeCloudMusicPurchased返回参数结构体
  */
-export interface DescribeKTVPlaylistsRequest {
+export interface DescribeCloudMusicPurchasedResponse {
     /**
-      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
+      * 云音乐列表
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Offset?: number;
+    MusicOpenDetail: Array<MusicOpenDetail>;
     /**
-      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Limit?: number;
+    RequestId?: string;
 }
 /**
  * 数据信息
@@ -452,290 +480,330 @@ export interface DataInfo {
     TagNames: Array<string>;
 }
 /**
- * DescribeKTVPlaylistDetail返回参数结构体
+ * Artist
  */
-export interface DescribeKTVPlaylistDetailResponse {
-    /**
-      * 歌曲基础信息列表
-      */
-    KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
+export interface Artist {
     /**
-      * 歌单基础信息
+      * 歌手名
       */
-    PlaylistBaseInfo: KTVPlaylistBaseInfo;
+    ArtistName: string;
+}
+/**
+ * ReportData返回参数结构体
+ */
+export interface ReportDataResponse {
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * TRTC推流进房信息
+ * SearchKTVMusics返回参数结构体
  */
-export interface TRTCJoinRoomInput {
+export interface SearchKTVMusicsResponse {
     /**
-      * 签名。
+      * 总记录数
       */
-    Sign: string;
+    TotalCount: number;
     /**
-      * 房间号。
+      * KTV 曲目列表
       */
-    RoomId: string;
+    KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
     /**
-      * 推流应用ID。
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    SdkAppId: string;
+    RequestId?: string;
+}
+/**
+ * DescribeItemById请求参数结构体
+ */
+export interface DescribeItemByIdRequest {
     /**
-      * 用户唯一标识。
+      * 歌曲ID，目前暂不支持批量查询
       */
-    UserId: string;
+    ItemIDs: string;
 }
 /**
- * 曲库包信息
+ * PutMusicOnTheShelves返回参数结构体
  */
-export interface Package {
+export interface PutMusicOnTheShelvesResponse {
     /**
-      * 订单id
+      * 操作成功数量
       */
-    OrderId: string;
+    SuccessNum: number;
     /**
-      * 曲库包名称
+      * 操作失败数量
       */
-    Name: string;
+    FailedNum: number;
     /**
-      * 授权地区-global: 全球  CN: 中国
+      * 失败歌曲Id
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    AuthorizedArea: string;
+    FailedMusicIds: Array<string>;
     /**
-      * 授权次数
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    AuthorizedLimit: number;
+    RequestId?: string;
+}
+/**
+ * DescribeKTVSingerMusics返回参数结构体
+ */
+export interface DescribeKTVSingerMusicsResponse {
     /**
-      * 套餐有效期，单位:天
+      * 总曲目数
       */
-    TermOfValidity: number;
+    TotalCount: number;
     /**
-      * 0:不可商业化；1:可商业化
+      * KTV 曲目列表
       */
-    Commercial: number;
+    KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
     /**
-      * 套餐价格，单位：元
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    PackagePrice: number;
+    RequestId?: string;
+}
+/**
+ * DescribeItems返回参数结构体
+ */
+export interface DescribeItemsResponse {
     /**
-      * 生效开始时间,格式yyyy-MM-dd HH:mm:ss
+      * 分页偏移量
       */
-    EffectTime: string;
+    Offset?: number;
     /**
-      * 生效结束时间,格式yyyy-MM-dd HH:mm:ss
+      * 当前页歌曲数量
       */
-    ExpireTime: string;
+    Size?: number;
     /**
-      * 剩余授权次数
+      * 总数据条数
       */
-    UsedCount: number;
+    Total?: number;
     /**
-      * 曲库包用途信息
+      * 剩余数量（total-offset-size），通过这个值判断是否
+还有下一页
       */
-    UseRanges: Array<UseRange>;
-}
-/**
- * ReportData返回参数结构体
- */
-export interface ReportDataResponse {
+    HaveMore?: number;
+    /**
+      * Items 歌曲列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Items?: Array<Item>;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * ModifyMusicOnShelves请求参数结构体
+ * DescribePkgOfflineMusic返回参数结构体
  */
-export interface ModifyMusicOnShelvesRequest {
-    /**
-      * 歌曲变更信息
-      */
-    MusicDetailInfos: MusicDetailInfo;
-    /**
-      * ame对接资源方密钥
-      */
-    AmeKey?: string;
-}
-/**
- * DescribePackageItems请求参数结构体
- */
-export interface DescribePackageItemsRequest {
+export interface DescribePkgOfflineMusicResponse {
     /**
-      * 订单id，从获取已购曲库包列表中获取
+      * 曲库包中不可用歌曲信息
       */
-    OrderId: string;
+    OfflineMusicSet: Array<OfflineMusicDetail>;
     /**
-      * 默认0，Offset=Offset+Length
+      * 返回总量
       */
-    Offset?: number;
+    TotalCount: number;
     /**
-      * 默认20
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Length?: number;
+    RequestId?: string;
 }
 /**
- * AuthInfo集合
+ * 直播互动歌曲的歌手信息。
  */
-export interface AuthInfo {
-    /**
-      * 主体名称
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-    SubjectName: string;
-    /**
-      * 项目名称
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-    ProjectName: string;
+export interface KTVSingerInfo {
     /**
-      * 应用场景
+      * 歌手id
       */
-    AppScene: number;
+    SingerId: string;
     /**
-      * 应用地域
+      * 歌手名
       */
-    AppRegion: number;
+    Name: string;
     /**
-      * 授权时间
+      * 歌手性别: 男，女，组合
       */
-    AuthPeriod: number;
+    Gender: string;
     /**
-      * 是否可商业化
+      * 地区: 大陆，港台，欧美，日本
       */
-    Commercialization: number;
+    Area: string;
     /**
-      * 是否可跨平台
+      * 歌曲数
       */
-    Platform: number;
+    MusicCount: number;
     /**
-      * 加密后Id
+      * 歌曲总播放次数
       */
-    Id: string;
+    PlayCount: number;
 }
 /**
- * TakeMusicOffShelves请求参数结构体
+ * PutMusicOnTheShelves请求参数结构体
  */
-export interface TakeMusicOffShelvesRequest {
+export interface PutMusicOnTheShelvesRequest {
     /**
-      * 资源方下架必传结构
+      * 资源方歌曲Id
       */
-    TakeMusicOffShelves: Array<TakeMusicOffShelves>;
+    MusicIds: Array<string>;
 }
 /**
- * DescribeKTVRobots返回参数结构体
+ * DescribeCloudMusic请求参数结构体
  */
-export interface DescribeKTVRobotsResponse {
-    /**
-      * 机器人总数。
-      */
-    TotalCount: number;
+export interface DescribeCloudMusicRequest {
     /**
-      * 机器人信息集合。
+      * 歌曲Id
       */
-    KTVRobotInfoSet: Array<KTVRobotInfo>;
+    MusicId: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 歌曲类型，可选值有：
+<li>MP3-128K-FTW：含有水印的试听资源；</li>
+<li>MP3-320K-FTD-P：320kbps歌曲热门片段；</li>
+<li>MP3-320K-FTD：320kbps已核验歌曲完整资源。</li>
+默认为：MP3-128K-FTW
       */
-    RequestId?: string;
+    MusicType?: string;
 }
 /**
- * 下架歌曲复合结构
+ * 排序依据
  */
-export interface TakeMusicOffShelves {
+export interface SortBy {
     /**
-      * 资源方对应音乐Id
+      * 排序字段
       */
-    MusicIds: string;
+    Field: string;
     /**
-      * 当曲目临时下架时：已订购客户无影响，无需消息通知。当曲目封杀下架后，推送消息至已订购老客户，枚举值，判断是否上/下架
-在售状态，0在售，1临时下架，2永久下架
+      * 排序方式，可选值：Asc（升序）、Desc（降序）
       */
-    SaleStatus: string;
+    Order: string;
 }
 /**
- * 歌词信息
+ * DescribeKTVMusicDetail返回参数结构体
  */
-export interface Lyric {
+export interface DescribeKTVMusicDetailResponse {
     /**
-      * 歌词cdn地址
+      * 歌曲基础信息
       */
-    Url: string;
+    KTVMusicBaseInfo: KTVMusicBaseInfo;
     /**
-      * 歌词后缀名
+      * 播放凭证
       */
-    FileNameExt: string;
+    PlayToken: string;
     /**
-      * 歌词类型
+      * 歌词下载地址
       */
-    SubItemType: string;
+    LyricsUrl: string;
+    /**
+      * 歌曲规格信息列表
+      */
+    DefinitionInfoSet: Array<KTVMusicDefinitionInfo>;
+    /**
+      * 音高数据文件下载地址
+      */
+    MidiJsonUrl: string;
+    /**
+      * 副歌片段数据列表
+      */
+    ChorusClipSet: Array<ChorusClip>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
 }
 /**
- * 曲库包已下架歌曲详细信息
+ * DescribeKTVRobots请求参数结构体
  */
-export interface OfflineMusicDetail {
+export interface DescribeKTVRobotsRequest {
     /**
-      * 歌曲Id
+      * 机器人Id列表。
       */
-    ItemId: string;
+    RobotIds?: Array<string>;
     /**
-      * 歌曲名称
+      * 机器人状态，取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>Destroy：销毁</li>
       */
-    MusicName: string;
+    Statuses?: Array<string>;
     /**
-      * 不可用原因
+      * 匹配创建时间在此时间段内的机器人。
+<li>包含所指定的头尾时间点。</li>
       */
-    OffRemark: string;
+    CreateTime?: TimeRange;
     /**
-      * 不可用时间
+      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
       */
-    OffTime: string;
+    Offset?: number;
+    /**
+      * 分页返回的起始偏移量，默认值：10。
+      */
+    Limit?: number;
 }
 /**
- * DescribeItemById请求参数结构体
+ * 直播进房输入参数
  */
-export interface DescribeItemByIdRequest {
+export interface JoinRoomInput {
     /**
-      * 歌曲ID，目前暂不支持批量查询
+      * TRTC进房参数
       */
-    ItemIDs: string;
+    TRTCJoinRoomInput?: TRTCJoinRoomInput;
 }
 /**
- * DescribeAuthInfo请求参数结构体
+ * DestroyKTVRobot返回参数结构体
  */
-export interface DescribeAuthInfoRequest {
+export interface DestroyKTVRobotResponse {
     /**
-      * 偏移量：Offset=Offset+Limit
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Offset?: number;
+    RequestId?: string;
+}
+/**
+ * CreateKTVRobot请求参数结构体
+ */
+export interface CreateKTVRobotRequest {
     /**
-      * 数据条数
+      * RTC厂商类型，取值有：
+<li>TRTC</li>
       */
-    Limit?: number;
+    RTCSystem: string;
     /**
-      * 搜索关键字
+      * 进房参数。
       */
-    Key?: string;
+    JoinRoomInput: JoinRoomInput;
 }
 /**
- * DescribeKTVPlaylists返回参数结构体
+ * DescribeKTVTopList请求参数结构体
  */
-export interface DescribeKTVPlaylistsResponse {
+export interface DescribeKTVTopListRequest {
     /**
-      * 推荐歌单列表
+      * 榜单类型。默认Hot
+<li> Hot, 热歌榜。</li>
       */
-    PlaylistBaseInfoSet: Array<KTVPlaylistBaseInfo>;
+    Type?: string;
     /**
-      * 推荐歌单列表总数
+      * 榜单周期 默认为Week
+<li> Week, 周榜。</li>
+<li> Month, 月榜。</li>
       */
-    TotalCount: number;
+    Period?: string;
+}
+/**
+ * DescribeKTVPlaylistDetail请求参数结构体
+ */
+export interface DescribeKTVPlaylistDetailRequest {
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 歌单Id
       */
-    RequestId?: string;
+    PlaylistId: string;
+    /**
+      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
+      */
+    Offset?: number;
+    /**
+      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+      */
+    Limit?: number;
 }
 /**
  * 音乐详情
@@ -770,232 +838,282 @@ Unit :ms
     FullUrl: string;
 }
 /**
- * Artist
+ * DescribeStations返回参数结构体
  */
-export interface Artist {
+export interface DescribeStationsResponse {
     /**
-      * 歌手名
+      * 总数量
       */
-    ArtistName: string;
-}
-/**
- * DescribeStations请求参数结构体
- */
-export interface DescribeStationsRequest {
+    Total?: number;
     /**
-      * 条数，必须大于0
+      * 分页偏移量
       */
-    Limit: number;
+    Offset?: number;
     /**
-      * offset (Default = 0)，Offset=Offset+Limit
+      * 当前页station数量
       */
-    Offset: number;
-}
-/**
- * 对外开放信息
- */
-export interface MusicOpenDetail {
+    Size?: number;
     /**
-      * 音乐Id
-注意：此字段可能返回 null，表示取不到有效值。
+      * 剩余数量（total-offset-size），通过这个值判断是否还有下一页
       */
-    MusicId: string;
+    HaveMore?: number;
     /**
-      * 专辑名称
+      * Stations 素材库列表
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    AlbumName: string;
+    Stations?: Array<Station>;
     /**
-      * 专辑图片路径
-注意：此字段可能返回 null，表示取不到有效值。
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    AlbumImageUrl: string;
+    RequestId?: string;
+}
+/**
+ * DescribeCloudMusicPurchased请求参数结构体
+ */
+export interface DescribeCloudMusicPurchasedRequest {
     /**
-      * 音乐名称
-注意：此字段可能返回 null，表示取不到有效值。
+      * 授权项目Id
       */
-    MusicName: string;
+    AuthInfoId: string;
+}
+/**
+ * 曲库包歌曲信息
+ */
+export interface PackageItem {
     /**
-      * 音乐图片路径
-注意：此字段可能返回 null，表示取不到有效值。
+      * 订单id
       */
-    MusicImageUrl: string;
+    OrderId: string;
     /**
-      * 歌手
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲名
       */
-    Singers: Array<string>;
+    TrackName: string;
     /**
-      * 播放时长
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌曲ID
       */
-    Duration: number;
+    ItemID: string;
     /**
-      * 标签
-注意：此字段可能返回 null，表示取不到有效值。
+      * 专辑图片
+      */
+    Img: string;
+    /**
+      * 歌手名
+      */
+    ArtistName: string;
+    /**
+      * 歌曲时长
+      */
+    Duration: string;
+    /**
+      * 授权区域，global: 全球 CN: 中国
+      */
+    AuthorizedArea: string;
+    /**
+      * 标签数组
       */
     Tags: Array<string>;
+}
+/**
+ * DescribeKTVPlaylists请求参数结构体
+ */
+export interface DescribeKTVPlaylistsRequest {
     /**
-      * 歌词url
-注意：此字段可能返回 null，表示取不到有效值。
+      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
       */
-    LyricUrl: string;
+    Offset?: number;
     /**
-      * 波形图url
-注意：此字段可能返回 null，表示取不到有效值。
+      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
       */
-    WaveformUrl: string;
+    Limit?: number;
 }
 /**
- * PutMusicOnTheShelves返回参数结构体
+ * TRTC推流进房信息
  */
-export interface PutMusicOnTheShelvesResponse {
+export interface TRTCJoinRoomInput {
     /**
-      * 操作成功数量
+      * 签名。
       */
-    SuccessNum: number;
+    Sign: string;
     /**
-      * 操作失败数量
+      * 房间号。
       */
-    FailedNum: number;
+    RoomId: string;
     /**
-      * 失败歌曲Id
-注意：此字段可能返回 null，表示取不到有效值。
+      * 推流应用ID。
       */
-    FailedMusicIds: Array<string>;
+    SdkAppId: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 用户唯一标识。
       */
-    RequestId?: string;
+    UserId: string;
 }
 /**
- * SearchKTVMusics返回参数结构体
+ * DescribePackageItems请求参数结构体
  */
-export interface SearchKTVMusicsResponse {
+export interface DescribePackageItemsRequest {
     /**
-      * 总记录数
+      * 订单id，从获取已购曲库包列表中获取
       */
-    TotalCount: number;
+    OrderId: string;
     /**
-      * KTV 曲目列表
+      * 默认0，Offset=Offset+Length
       */
-    KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
+    Offset?: number;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 默认20
       */
-    RequestId?: string;
+    Length?: number;
 }
 /**
- * 机器人信息
+ * AuthInfo集合
  */
-export interface KTVRobotInfo {
+export interface AuthInfo {
     /**
-      * 机器人Id。
+      * 主体名称
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    RobotId: string;
+    SubjectName: string;
     /**
-      * 状态，取值有：
-<li>Play：播放</li>
-<li>Pause：暂停</li>
-<li>Destroy：销毁</li>
+      * 项目名称
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Status: string;
+    ProjectName: string;
     /**
-      * 播放列表。
+      * 应用场景
       */
-    Playlists: Array<string>;
+    AppScene: number;
     /**
-      * 当前歌单索引位置。
+      * 应用地域
       */
-    CurIndex: number;
+    AppRegion: number;
     /**
-      * 播放进度，单位：毫秒。
+      * 授权时间
       */
-    Position: number;
+    AuthPeriod: number;
     /**
-      * 音频参数
+      * 是否可商业化
       */
-    SetAudioParamInput: SetAudioParamCommandInput;
+    Commercialization: number;
     /**
-      * 进房信息
+      * 是否可跨平台
       */
-    JoinRoomInput: JoinRoomInput;
+    Platform: number;
     /**
-      * RTC厂商类型，取值有：
-<li>TRTC</li>
+      * 加密后Id
       */
-    RTCSystem: string;
+    Id: string;
+}
+/**
+ * DescribeKTVRobots返回参数结构体
+ */
+export interface DescribeKTVRobotsResponse {
     /**
-      * 播放模式，PlayMode取值有：
-<li>RepeatPlaylist：列表循环</li>
-<li>Order：顺序播放</li>
-<li>RepeatSingle：单曲循环</li>
-<li>Shuffle：随机播放</li>
+      * 机器人总数。
       */
-    SetPlayModeInput: SetPlayModeCommandInput;
+    TotalCount: number;
+    /**
+      * 机器人信息集合。
+      */
+    KTVRobotInfoSet: Array<KTVRobotInfo>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
 }
 /**
- * DescribeItems请求参数结构体
+ * 曲库包用途信息
  */
-export interface DescribeItemsRequest {
+export interface UseRange {
     /**
-      * offset (Default = 0)，(当前页-1) * Limit
+      * 用途id
       */
-    Offset: number;
+    UseRangeId: number;
     /**
-      * 条数，必须大于0，最大值为30
+      * 用途范围名称
       */
-    Limit: number;
+    Name: string;
+}
+/**
+ * DescribeStations请求参数结构体
+ */
+export interface DescribeStationsRequest {
     /**
-      * （电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容（Station）列表接口</a>中获取。
+      * 条数，必须大于0
       */
-    CategoryId?: string;
+    Limit: number;
     /**
-      * （电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容（Station）列表接口</a>中获取。
+      * offset (Default = 0)，Offset=Offset+Limit
       */
-    CategoryCode?: string;
+    Offset: number;
 }
 /**
- * 歌曲信息
+ * DescribeKTVSingerMusics请求参数结构体
  */
-export interface Item {
+export interface DescribeKTVSingerMusicsRequest {
     /**
-      * Song ID
+      * 歌手id
       */
-    ItemID: string;
+    SingerId: string;
     /**
-      * Song info
-注意：此字段可能返回 null，表示取不到有效值。
+      * 分页偏移量，默认值：0。
       */
-    DataInfo: DataInfo;
+    Offset?: number;
     /**
-      * 专辑信息
-注意：此字段可能返回 null，表示取不到有效值。
+      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
       */
-    Album: Album;
+    Limit?: number;
+}
+/**
+ * DescribeKTVSingerCategories返回参数结构体
+ */
+export interface DescribeKTVSingerCategoriesResponse {
     /**
-      * 多个歌手集合
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌手性别分类列表
       */
-    Artists: Array<Artist>;
+    GenderSet: Array<KTVSingerCategoryInfo>;
     /**
-      * 歌曲状态，1:添加进购物车；2:核销进曲库包
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌手区域分类列表
       */
-    Status: number;
+    AreaSet: Array<KTVSingerCategoryInfo>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
 }
 /**
- * 设置播放模式
+ * DescribeKTVSingers请求参数结构体
  */
-export interface SetPlayModeCommandInput {
+export interface DescribeKTVSingersRequest {
     /**
-      * 播放模式，取值有：
-<li>RepeatPlaylist：列表循环</li>
-<li>Order：顺序播放</li>
-<li>RepeatSingle：单曲循环</li>
-<li>Shuffle：随机播放</li>
+      * 歌手id集合，精确匹配歌手id
+<li> 数组长度限制10</li>
       */
-    PlayMode: string;
+    SingerIds?: Array<string>;
+    /**
+      * 歌手性别集合，不传为全部，精确匹配歌手性别类型，
+<li>数组长度限制1</li>
+<li>取值范围：直播互动曲库歌手分类信息接口，返回性别分类信息列表中，分类英文名</li>
+      */
+    Genders?: Array<string>;
+    /**
+      * 歌手区域集合，不传为全部，精确匹配歌手区域
+<li>数组长度限制10</li>
+<li>取值范围：直播互动曲库歌手分类信息接口，返回的区域分类信息列表中，分类英文名</li>
+      */
+    Areas?: Array<string>;
+    /**
+      * 排序方式。默认按照播放数倒序
+<li> Sort.Field 可选 PlayCount。</li>
+      */
+    Sort?: SortBy;
+    /**
+      * 分页偏移量，默认值：0。
+      */
+    Offset?: number;
+    /**
+      * 分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+      */
+    Limit?: number;
 }
 /**
  * 设置播放列表指令参数
@@ -1028,478 +1146,646 @@ export interface SyncKTVRobotCommandResponse {
     RequestId?: string;
 }
 /**
- * DescribeCloudMusic返回参数结构体
+ * SearchKTVMusics请求参数结构体
  */
-export interface DescribeCloudMusicResponse {
+export interface SearchKTVMusicsRequest {
     /**
-      * 歌曲Id
+      * 搜索关键词
       */
-    MusicId: string;
+    KeyWord: string;
     /**
-      * 歌曲名称
+      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
+取值范围：Offset + Limit 不超过5000。取值范围：小于5000
       */
-    MusicName: string;
+    Offset: number;
     /**
-      * 歌曲时长
-注意：此字段可能返回 null，表示取不到有效值。
+      * 分页返回的起始偏移量，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
+取值范围：Offset + Limit 不超过5000。
       */
-    Duration: number;
+    Limit: number;
+}
+/**
+ * 推荐歌单基础信息
+ */
+export interface KTVPlaylistBaseInfo {
     /**
-      * 歌曲链接
+      * 歌单Id
       */
-    MusicUrl: string;
+    PlaylistId: string;
     /**
-      * 歌曲图片
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌单标题
       */
-    MusicImageUrl: string;
+    Title: string;
     /**
-      * 歌手列表
-注意：此字段可能返回 null，表示取不到有效值。
+      * 歌单介绍
       */
-    Singers: Array<string>;
+    Description: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 歌曲数量
       */
-    RequestId?: string;
+    MusicNum: number;
 }
 /**
- * KTV 曲目基础信息
+ * DescribeKTVSingers返回参数结构体
  */
-export interface KTVMusicBaseInfo {
+export interface DescribeKTVSingersResponse {
     /**
-      * 歌曲 Id
+      * 总歌手数
       */
-    MusicId: string;
+    TotalCount: number;
     /**
-      * 歌曲名称
+      * KTV歌手列表
       */
-    Name: string;
+    KTVSingerInfoSet: Array<KTVSingerInfo>;
     /**
-      * 演唱者列表
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    SingerSet: Array<string>;
+    RequestId?: string;
+}
+/**
+ * DescribeItemById返回参数结构体
+ */
+export interface DescribeItemByIdResponse {
     /**
-      * 作词者列表
+      * 歌曲信息
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    LyricistSet: Array<string>;
+    Items?: Array<Item>;
     /**
-      * 作曲者列表
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    ComposerSet: Array<string>;
+    RequestId?: string;
+}
+/**
+ * 返回单曲页面歌曲是否在售状态
+ */
+export interface MusicStatus {
     /**
-      * 标签列表
+      * 歌曲Id
       */
-    TagSet: Array<string>;
+    MusicId: string;
     /**
-      * 歌曲时长
+      * 在售状态,0为在售，1为临时下架，2为永久下架
       */
-    Duration: number;
+    SaleStatus: number;
 }
 /**
- * DescribePackages请求参数结构体
+ * KTV歌手分类信息
  */
-export interface DescribePackagesRequest {
+export interface KTVSingerCategoryInfo {
     /**
-      * 默认0，Offset=Offset+Length
+      * 分类中文名
       */
-    Offset?: number;
+    ChineseName: string;
     /**
-      * 默认20
+      * 分类英文名
       */
-    Length?: number;
+    EnglishName: string;
 }
 /**
- * DescribeMusicSaleStatus请求参数结构体
+ * 发送自定义信息指令参数
  */
-export interface DescribeMusicSaleStatusRequest {
+export interface SendMessageCommandInput {
     /**
-      * 歌曲Id集合，可传单个，也可传多个，上线查询单次50个
+      * 自定义消息，json格式字符串。
       */
-    MusicIds: Array<string>;
+    Message: string;
     /**
-      * 查询哪个渠道的数据，1为曲库包，2为单曲
+      * 消息重复次数，默认为 1。
       */
-    PurchaseType: number;
+    Repeat?: number;
 }
 /**
- * SearchKTVMusics请求参数结构体
+ * 直播互动歌曲规格信息。
  */
-export interface SearchKTVMusicsRequest {
+export interface KTVMusicDefinitionInfo {
     /**
-      * 搜索关键词
+      * 规格，取值有：
+<li>audio/mi：低规格；</li>
+<li>audio/lo：中规格；</li>
+<li>audio/hi：高规格。</li>
       */
-    KeyWord: string;
+    Definition: string;
     /**
-      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
-取值范围：Offset + Limit 不超过5000。取值范围：小于5000
+      * 码率，单位为 bps。
       */
-    Offset: number;
+    Bitrate: number;
     /**
-      * 分页返回的起始偏移量，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。
-取值范围：Offset + Limit 不超过5000。
+      * 文件大小，单位为字节。
       */
-    Limit: number;
+    Size: number;
 }
 /**
- * 图片路径
+ * Album
  */
-export interface ImagePath {
+export interface Album {
     /**
-      * station图片大小及类别
-注意：此字段可能返回 null，表示取不到有效值。
+      * 专辑名
       */
-    Key: string;
+    AlbumName: string;
     /**
-      * station图片地址
+      * 专辑图片大小及类别
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    Value: string;
+    ImagePathMap: Array<ImagePath>;
 }
 /**
- * DescribeItems返回参数结构体
+ * DescribeLyric返回参数结构体
  */
-export interface DescribeItemsResponse {
+export interface DescribeLyricResponse {
     /**
-      * 分页偏移量
+      * 歌词或者波形图详情
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Offset?: number;
+    Lyric: Lyric;
     /**
-      * 当前页歌曲数量
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    Size?: number;
+    RequestId?: string;
+}
+/**
+ * KTV 曲目基础信息
+ */
+export interface KTVMusicBaseInfo {
     /**
-      * 总数据条数
+      * 歌曲 Id
       */
-    Total?: number;
+    MusicId: string;
     /**
-      * 剩余数量（total-offset-size），通过这个值判断是否
-还有下一页
+      * 歌曲名称
       */
-    HaveMore?: number;
+    Name: string;
     /**
-      * Items 歌曲列表
-注意：此字段可能返回 null，表示取不到有效值。
+      * 演唱者基础信息列表
       */
-    Items?: Array<Item>;
+    SingerInfoSet: Array<KTVSingerBaseInfo>;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 已弃用，请使用SingerInfoSet
       */
-    RequestId?: string;
-}
-/**
- * DescribePkgOfflineMusic返回参数结构体
- */
-export interface DescribePkgOfflineMusicResponse {
+    SingerSet: Array<string>;
     /**
-      * 曲库包中不可用歌曲信息
+      * 作词者列表
       */
-    OfflineMusicSet: Array<OfflineMusicDetail>;
+    LyricistSet: Array<string>;
     /**
-      * 返回总量
+      * 作曲者列表
       */
-    TotalCount: number;
+    ComposerSet: Array<string>;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 标签列表
       */
-    RequestId?: string;
+    TagSet: Array<string>;
+    /**
+      * 歌曲时长
+      */
+    Duration: number;
 }
 /**
- * 推荐歌单基础信息
+ * SyncKTVRobotCommand请求参数结构体
  */
-export interface KTVPlaylistBaseInfo {
+export interface SyncKTVRobotCommandRequest {
     /**
-      * 歌单Id
+      * 机器人Id。
       */
-    PlaylistId: string;
+    RobotId: string;
     /**
-      * 歌单标题
+      * 指令，取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>SwitchPrevious：上一首</li>
+<li>SwitchNext：下一首</li>
+<li>SetPlayMode：设置播放模式</li>
+<li>Seek：调整播放进度</li>
+<li>SetPlaylist：歌单变更</li>
+<li>SetAudioParam：音频参数变更</li>
+<li>SendMessage：发送自定义消息</li>
       */
-    Title: string;
+    Command: string;
     /**
-      * 歌单介绍
+      * 播放参数。
       */
-    Description: string;
+    PlayCommandInput?: PlayCommandInput;
     /**
-      * 歌曲数量
+      * 播放列表变更信息，当Command取SetPlaylist时，必填。
       */
-    MusicNum: number;
-}
-/**
- * DescribeItemById返回参数结构体
- */
-export interface DescribeItemByIdResponse {
+    SetPlaylistCommandInput?: SetPlaylistCommandInput;
     /**
-      * 歌曲信息
-注意：此字段可能返回 null，表示取不到有效值。
+      * 播放进度，当Command取Seek时，必填。
       */
-    Items?: Array<Item>;
+    SeekCommandInput?: SeekCommandInput;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 音频参数，当Command取SetAudioParam时，必填。
       */
-    RequestId?: string;
-}
-/**
- * 返回单曲页面歌曲是否在售状态
- */
-export interface MusicStatus {
+    SetAudioParamCommandInput?: SetAudioParamCommandInput;
     /**
-      * 歌曲Id
+      * 自定义消息，当Command取SendMessage时，必填。
       */
-    MusicId: string;
+    SendMessageCommandInput?: SendMessageCommandInput;
     /**
-      * 在售状态,0为在售，1为临时下架，2为永久下架
+      * 播放模式，当Command取SetPlayMode时，必填。
       */
-    SaleStatus: number;
+    SetPlayModeCommandInput?: SetPlayModeCommandInput;
 }
 /**
- * DescribeMusicSaleStatus返回参数结构体
+ * DescribeKTVPlaylists返回参数结构体
  */
-export interface DescribeMusicSaleStatusResponse {
+export interface DescribeKTVPlaylistsResponse {
     /**
-      * musicId对应歌曲状态
+      * 推荐歌单列表
       */
-    MusicStatusSet: Array<MusicStatus>;
+    PlaylistBaseInfoSet: Array<KTVPlaylistBaseInfo>;
+    /**
+      * 推荐歌单列表总数
+      */
+    TotalCount: number;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * 发送自定义信息指令参数
+ * DescribeKTVPlaylistDetail返回参数结构体
  */
-export interface SendMessageCommandInput {
+export interface DescribeKTVPlaylistDetailResponse {
     /**
-      * 自定义消息，json格式字符串。
+      * 歌曲基础信息列表
       */
-    Message: string;
+    KTVMusicInfoSet: Array<KTVMusicBaseInfo>;
     /**
-      * 消息重复次数，默认为 1。
+      * 歌单基础信息
       */
-    Repeat?: number;
-}
-/**
- * PutMusicOnTheShelves请求参数结构体
- */
-export interface PutMusicOnTheShelvesRequest {
+    PlaylistBaseInfo: KTVPlaylistBaseInfo;
     /**
-      * 资源方歌曲Id
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
-    MusicIds: Array<string>;
+    RequestId?: string;
 }
 /**
- * DescribePackages返回参数结构体
+ * 音频参数信息
  */
-export interface DescribePackagesResponse {
+export interface SetAudioParamCommandInput {
     /**
-      * 已购曲库包列表
-注意：此字段可能返回 null，表示取不到有效值。
+      * 规格，取值有：
+<li>audio/mi：低规格</li>
+<li>audio/lo：中规格</li>
+<li>audio/hi：高规格</li>
       */
-    Packages?: Array<Package>;
+    Definition?: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 音频类型，取值有：
+<li>Original：原唱</li>
+<li>Accompaniment：伴奏</li>
       */
-    RequestId?: string;
+    Type?: string;
 }
 /**
- * DestroyKTVRobot请求参数结构体
+ * 下架歌曲复合结构
  */
-export interface DestroyKTVRobotRequest {
+export interface TakeMusicOffShelves {
     /**
-      * 机器人Id。
+      * 资源方对应音乐Id
       */
-    RobotId: string;
+    MusicIds: string;
+    /**
+      * 当曲目临时下架时：已订购客户无影响，无需消息通知。当曲目封杀下架后，推送消息至已订购老客户，枚举值，判断是否上/下架
+在售状态，0在售，1临时下架，2永久下架
+      */
+    SaleStatus: string;
 }
 /**
- * DescribeCloudMusic请求参数结构体
+ * 曲库包已下架歌曲详细信息
  */
-export interface DescribeCloudMusicRequest {
+export interface OfflineMusicDetail {
     /**
       * 歌曲Id
       */
-    MusicId: string;
+    ItemId: string;
     /**
-      * 歌曲类型，可选值有：
-<li>MP3-128K-FTW：含有水印的试听资源；</li>
-<li>MP3-320K-FTD-P：320kbps歌曲热门片段；</li>
-<li>MP3-320K-FTD：320kbps已核验歌曲完整资源。</li>
-默认为：MP3-128K-FTW
+      * 歌曲名称
       */
-    MusicType?: string;
+    MusicName: string;
+    /**
+      * 不可用原因
+      */
+    OffRemark: string;
+    /**
+      * 不可用时间
+      */
+    OffTime: string;
 }
 /**
- * DescribeAuthInfo返回参数结构体
+ * DescribeAuthInfo请求参数结构体
  */
-export interface DescribeAuthInfoResponse {
+export interface DescribeAuthInfoRequest {
     /**
-      * 授权项目列表
+      * 偏移量：Offset=Offset+Limit
       */
-    AuthInfo?: Array<AuthInfo>;
+    Offset?: number;
     /**
-      * 总数
+      * 数据条数
       */
-    TotalCount?: number;
+    Limit?: number;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 搜索关键字
       */
-    RequestId?: string;
+    Key?: string;
 }
 /**
- * TakeMusicOffShelves返回参数结构体
+ * 曲库包信息
  */
-export interface TakeMusicOffShelvesResponse {
+export interface Package {
     /**
-      * 返回成功数量
+      * 订单id
       */
-    SuccessNum: number;
+    OrderId: string;
     /**
-      * 返回失败数量
+      * 曲库包名称
       */
-    FailedNum: number;
+    Name: string;
     /**
-      * 返回失败歌曲musicId
-注意：此字段可能返回 null，表示取不到有效值。
+      * 授权地区-global: 全球  CN: 中国
       */
-    FailedMusicIds: Array<string>;
+    AuthorizedArea: string;
     /**
-      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      * 授权次数
       */
-    RequestId?: string;
+    AuthorizedLimit: number;
+    /**
+      * 套餐有效期，单位:天
+      */
+    TermOfValidity: number;
+    /**
+      * 0:不可商业化；1:可商业化
+      */
+    Commercial: number;
+    /**
+      * 套餐价格，单位：元
+      */
+    PackagePrice: number;
+    /**
+      * 生效开始时间,格式yyyy-MM-dd HH:mm:ss
+      */
+    EffectTime: string;
+    /**
+      * 生效结束时间,格式yyyy-MM-dd HH:mm:ss
+      */
+    ExpireTime: string;
+    /**
+      * 剩余授权次数
+      */
+    UsedCount: number;
+    /**
+      * 曲库包用途信息
+      */
+    UseRanges: Array<UseRange>;
 }
 /**
- * DescribeLyric请求参数结构体
+ * 设置播放模式
  */
-export interface DescribeLyricRequest {
+export interface SetPlayModeCommandInput {
     /**
-      * 歌曲ID
+      * 播放模式，取值有：
+<li>RepeatPlaylist：列表循环</li>
+<li>Order：顺序播放</li>
+<li>RepeatSingle：单曲循环</li>
+<li>Shuffle：随机播放</li>
       */
-    ItemId: string;
+    PlayMode: string;
+}
+/**
+ * 机器人信息
+ */
+export interface KTVRobotInfo {
     /**
-      * 格式，可选项，可不填写，默认值为：LRC-LRC。
-<li>LRC-LRC：歌词；</li>
-<li>JSON-ST：波形图。</li>
+      * 机器人Id。
       */
-    SubItemType?: string;
+    RobotId: string;
+    /**
+      * 状态，取值有：
+<li>Play：播放</li>
+<li>Pause：暂停</li>
+<li>Destroy：销毁</li>
+      */
+    Status: string;
+    /**
+      * 播放列表。
+      */
+    Playlists: Array<string>;
+    /**
+      * 当前歌单索引位置。
+      */
+    CurIndex: number;
+    /**
+      * 播放进度，单位：毫秒。
+      */
+    Position: number;
+    /**
+      * 音频参数
+      */
+    SetAudioParamInput: SetAudioParamCommandInput;
+    /**
+      * 进房信息
+      */
+    JoinRoomInput: JoinRoomInput;
+    /**
+      * RTC厂商类型，取值有：
+<li>TRTC</li>
+      */
+    RTCSystem: string;
+    /**
+      * 播放模式，PlayMode取值有：
+<li>RepeatPlaylist：列表循环</li>
+<li>Order：顺序播放</li>
+<li>RepeatSingle：单曲循环</li>
+<li>Shuffle：随机播放</li>
+      */
+    SetPlayModeInput: SetPlayModeCommandInput;
 }
 /**
- * DescribeKTVMusicDetail返回参数结构体
+ * DescribeItems请求参数结构体
  */
-export interface DescribeKTVMusicDetailResponse {
+export interface DescribeItemsRequest {
     /**
-      * 歌曲基础信息
+      * offset (Default = 0)，(当前页-1) * Limit
       */
-    KTVMusicBaseInfo: KTVMusicBaseInfo;
+    Offset: number;
     /**
-      * 播放凭证
+      * 条数，必须大于0，最大值为30
       */
-    PlayToken: string;
+    Limit: number;
     /**
-      * 歌词下载地址
+      * （电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容（Station）列表接口</a>中获取。
       */
-    LyricsUrl: string;
+    CategoryId?: string;
     /**
-      * 歌曲规格信息列表
+      * （电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从<a href="https://cloud.tencent.com/document/product/1155/40109">获取分类内容（Station）列表接口</a>中获取。
       */
-    DefinitionInfoSet: Array<KTVMusicDefinitionInfo>;
+    CategoryCode?: string;
+}
+/**
+ * 歌曲信息
+ */
+export interface Item {
+    /**
+      * Song ID
+      */
+    ItemID: string;
+    /**
+      * Song info
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    DataInfo: DataInfo;
+    /**
+      * 专辑信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Album: Album;
+    /**
+      * 多个歌手集合
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Artists: Array<Artist>;
+    /**
+      * 歌曲状态，1:添加进购物车；2:核销进曲库包
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Status: number;
+}
+/**
+ * DescribeKTVTopList返回参数结构体
+ */
+export interface DescribeKTVTopListResponse {
+    /**
+      * 歌曲基础信息列表
+      */
+    KTVMusicTopInfoSet: Array<KTVMusicTopInfo>;
+    /**
+      * 返回总条数
+      */
+    TotalCount: number;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
     RequestId?: string;
 }
 /**
- * DescribeKTVRobots请求参数结构体
+ * 对外开放信息
  */
-export interface DescribeKTVRobotsRequest {
+export interface MusicOpenDetail {
     /**
-      * 机器人Id列表。
+      * 音乐Id
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    RobotIds?: Array<string>;
+    MusicId: string;
     /**
-      * 机器人状态，取值有：
-<li>Play：播放</li>
-<li>Pause：暂停</li>
-<li>Destroy：销毁</li>
+      * 专辑名称
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Statuses?: Array<string>;
+    AlbumName: string;
     /**
-      * 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
+      * 专辑图片路径
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Offset?: number;
+    AlbumImageUrl: string;
     /**
-      * 分页返回的起始偏移量，默认值：10。
+      * 音乐名称
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Limit?: number;
-}
-/**
- * DescribeMusic请求参数结构体
- */
-export interface DescribeMusicRequest {
+    MusicName: string;
     /**
-      * 歌曲ID
+      * 音乐图片路径
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    ItemId: string;
+    MusicImageUrl: string;
     /**
-      * 在应用前端播放音乐C端用户的唯一标识。无需是账户信息，用户唯一标识即可。
+      * 歌手
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    IdentityId: string;
+    Singers: Array<string>;
     /**
-      * MP3-320K-FTD-P  为获取320kbps歌曲热门片段。
-MP3-320K-FTD 为获取320kbps已核验歌曲完整资源。
+      * 播放时长
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    SubItemType?: string;
+    Duration: number;
     /**
-      * CDN URL Protocol:HTTP or HTTPS/SSL
-Values:Y , N(default)
+      * 标签
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Ssl?: string;
+    Tags: Array<string>;
+    /**
+      * 歌词url
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    LyricUrl: string;
+    /**
+      * 波形图url
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    WaveformUrl: string;
 }
 /**
- * ReportData请求参数结构体
+ * DescribePackages请求参数结构体
  */
-export interface ReportDataRequest {
+export interface DescribePackagesRequest {
     /**
-      * 上报数据
-注:reportData为客户端压缩后的上报数据进行16进制转换的字符串数据
-压缩说明：
-a) 上报的json格式字符串通过流的转换（ByteArrayInputStream, java.util.zip.GZIPOutputStream），获取到压缩后的字节数组。
-b) 将压缩后的字节数组转成16进制字符串。
-
-reportData由两部分数据组成：
-1）report_type（上报类型）
-2）data（歌曲上报数据）
-不同的report_type对应的data数据结构不一样。
-
-详细说明请参考文档reportdata.docx：
-https://github.com/tencentyun/ame-documents
+      * 默认0，Offset=Offset+Length
       */
-    ReportData: string;
+    Offset?: number;
+    /**
+      * 默认20
+      */
+    Length?: number;
 }
 /**
- * 调整播放进度指令参数
+ * DescribePackages返回参数结构体
  */
-export interface SeekCommandInput {
+export interface DescribePackagesResponse {
     /**
-      * 播放位置，单位：毫秒。
+      * 已购曲库包列表
+注意：此字段可能返回 null，表示取不到有效值。
       */
-    Position: number;
+    Packages?: Array<Package>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
 }
 /**
- * 直播互动歌曲规格信息。
+ * 歌词信息
  */
-export interface KTVMusicDefinitionInfo {
+export interface Lyric {
     /**
-      * 规格，取值有：
-<li>audio/mi：低规格；</li>
-<li>audio/lo：中规格；</li>
-<li>audio/hi：高规格。</li>
+      * 歌词cdn地址
       */
-    Definition: string;
+    Url: string;
     /**
-      * 码率，单位为 bps。
+      * 歌词后缀名
       */
-    Bitrate: number;
+    FileNameExt: string;
     /**
-      * 文件大小，单位为字节。
+      * 歌词类型
       */
-    Size: number;
+    SubItemType: string;
+}
+/**
+ * TakeMusicOffShelves返回参数结构体
+ */
+export interface TakeMusicOffShelvesResponse {
+    /**
+      * 返回成功数量
+      */
+    SuccessNum: number;
+    /**
+      * 返回失败数量
+      */
+    FailedNum: number;
+    /**
+      * 返回失败歌曲musicId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    FailedMusicIds: Array<string>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
 }