/** * ApplyChorus返回参数结构体 */ export interface ApplyChorusResponse { /** * 合唱 Token。 */ ChorusToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 节拍信息。 */ export interface KTVBPMInfo { /** * 节拍类型,取值有:
  • Slow:慢;
  • Middle:中等;
  • Fast:快;
  • Unknown:未知。
  • */ Type?: string; /** * BPM 值。 */ Value?: number; } /** * DescribeKTVSuggestions返回参数结构体 */ export interface DescribeKTVSuggestionsResponse { /** * 联想词信息列表。 */ KTVSuggestionInfoSet: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌曲信息匹配。 */ export interface KTVMatchRuleMusicInfo { /** * 歌曲名称。 */ MusicName: string; /** * 歌手列表。 */ SingerSet: Array; } /** * 直播进房输入参数 */ export interface JoinRoomInput { /** * TRTC进房参数 */ TRTCJoinRoomInput: TRTCJoinRoomInput; } /** * DestroyKTVRobot返回参数结构体 */ export interface DestroyKTVRobotResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌曲专辑封面信息。 */ export interface MusicAlbumCoverInfo { /** * 尺寸规格,取值有:
  • Mini:150 x 150 尺寸;
  • Small:240 x 240 尺寸;
  • Medium:480 x 480 尺寸。
  • */ Dimension?: string; /** * 下载链接。 */ Url?: string; } /** * CreateKTVRobot请求参数结构体 */ export interface CreateKTVRobotRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * RTC厂商类型,取值有:
  • TRTC
  • */ RTCSystem: string; /** * 进房参数。 */ JoinRoomInput: JoinRoomInput; /** * 创建机器人时初始化参数。 */ SyncRobotCommands?: Array; } /** * 联想词信息。 */ export interface KTVSuggestionInfo { /** * 联想词。 */ Suggestion?: string; } /** * SyncKTVRobotCommand请求参数结构体 */ export interface SyncKTVRobotCommandRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 机器人Id。 */ RobotId: string; /** * 指令及指令参数数组。 */ SyncRobotCommands: Array; } /** * 标签信息。 */ export interface KTVTagInfo { /** * 标签 Id。 */ TagId?: string; /** * 标签名称。 */ Name?: string; } /** * DescribeKTVPlaylistDetail请求参数结构体 */ export interface DescribeKTVPlaylistDetailRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 歌单 Id。 */ PlaylistId: string; /** * 滚动标记。 */ ScrollToken?: string; /** * 返回条数,默认:20,最大:50。 */ Limit?: number; /** * 权益过滤,取值有:
  • Play:可播;
  • Sing:可唱。
  • */ RightFilters?: Array; /** * 播放场景。默认为Chat
  • Live:直播
  • Chat:语聊
  • */ PlayScene?: string; /** * 物料过滤,取值有:
  • Lyrics:含有歌词;
  • Midi:含有音高线。
  • */ MaterialFilters?: Array; } /** * SyncKTVRobotCommand返回参数结构体 */ export interface SyncKTVRobotCommandResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌曲详细信息。 */ export interface KTVMusicDetailInfo { /** * 歌曲基础信息。 */ KTVMusicBaseInfo?: KTVMusicBaseInfo; /** * 播放凭证。 */ PlayToken?: string; /** * 歌词下载链接。 */ LyricsUrl?: string; /** * 音高数据下载链接。 */ MidiUrl?: string; /** * 副歌片段信息。 */ ChorusClipSet?: Array; /** * 前奏间隔。 */ PreludeInterval?: number; /** * 歌曲流派列表。 */ GenreSet?: Array; /** * 节拍信息。 注意:此字段可能返回 null,表示取不到有效值。 */ BPMInfo?: KTVBPMInfo; } /** * CreateKTVRobot返回参数结构体 */ export interface CreateKTVRobotResponse { /** * 机器人Id。 */ RobotId: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKTVMusicAccompanySegmentUrlVip返回参数结构体 */ export interface DescribeKTVMusicAccompanySegmentUrlVipResponse { /** * 0:成功获取 1:歌曲下架 2:无权限 3: 非包月会员 4:没有对应的链接 */ Status?: number; /** * 伴奏链接 */ Url?: string; /** * 伴奏类型,如mkv,mp3等 */ ExtName?: string; /** * 高潮开始时间 */ SegmentBegin?: number; /** * 高潮结束时间 */ SegmentEnd?: number; /** * 链接文件大小 (单位:字节) */ FileSize?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播会员用户信息 */ export interface LiveVipUserInfo { /** * 房间标识。 */ RoomId?: string; /** * 直播会员结束时间。 */ LiveVipEndTime?: string; /** * 会员生效状态
  • Valid:生效
  • Invalid:无效
  • */ LiveVipStatus?: string; } /** * DescribeKTVSuggestions请求参数结构体 */ export interface DescribeKTVSuggestionsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 搜索词。 */ KeyWord: string; } /** * DescribeKTVMatchMusics请求参数结构体 */ export interface DescribeKTVMatchMusicsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 匹配规则列表。 */ Rules: Array; } /** * DescribeKTVPlaylists返回参数结构体 */ export interface DescribeKTVPlaylistsResponse { /** * 歌单基础信息。 */ PlaylistBaseInfoSet?: Array; /** * 歌单总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RechargeLiveVip返回参数结构体 */ export interface RechargeLiveVipResponse { /** * 直播会员信息。 */ LiveVipUserInfo?: LiveVipUserInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKTVPlaylists请求参数结构体 */ export interface DescribeKTVPlaylistsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 类型列表,取值有:
  • OfficialRec:官方推荐;
  • Customize:自定义。
  • 默认值为 OfficialRec。 */ Types?: Array; /** * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。 */ Offset?: number; /** * 分页返回的记录条数,默认值:20,最大值:50。 */ Limit?: number; } /** * DescribeKTVPlaylistDetail返回参数结构体 */ export interface DescribeKTVPlaylistDetailResponse { /** * 歌曲信息列表。 */ KTVMusicInfoSet?: Array; /** * 滚动标记,用于设置下次请求的 ScrollToken 参数。 */ ScrollToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveVipTradeInfos请求参数结构体 */ export interface DescribeLiveVipTradeInfosRequest { /** * 应用名称。 */ AppName: string; /** * 直播会员充值下单起始时间,格式为 ISO。默认为当前时间前一天。 */ StartTime?: string; /** * 直播会员充值下单截止时间,格式为 ISO。默认为当前时间。 EndTime不能小于StartTime */ EndTime?: string; /** * 交易流水号集合,匹配集合指定所有流水号 。
  • 数组长度限制:10。
  • */ TradeSerialNos?: Array; /** * 用户标识集合,匹配集合指定所有用户标识 。
  • 数组长度限制:10。
  • */ UserIds?: Array; /** * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。 */ Offset?: number; /** * 分页返回的记录条数,默认值:20,最大值:50。 */ Limit?: number; } /** * 设置销毁模式 */ export interface SetDestroyModeCommandInput { /** * 销毁模式,取值有:
  • Auto:房间没人时自动销毁
  • Expire:房间没人时过期自动销毁
  • Never:不自动销毁,需手动销毁
  • 默认为:Auto。 */ DestroyMode: string; /** * 过期销毁时间,单位:秒,当DestroyMode取Expire时必填。 */ DestroyExpireTime?: number; } /** * 音频参数信息 */ export interface SetAudioParamCommandInput { /** * 音频类型,取值有:
  • Original:原唱
  • Accompaniment:伴奏
  • 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; } /** * 匹配歌曲信息。 */ export interface KTVMatchMusic { /** * 匹配到的歌曲基础信息。 */ KTVMusicBaseInfo?: KTVMusicBaseInfo; /** * 命中规则。 */ MatchRule?: KTVMatchRule; /** * AME 歌曲基础信息,仅在使用音速达歌曲 Id 匹配 AME 曲库时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ AMEMusicBaseInfo?: AMEMusicBaseInfo; } /** * TRTC推流进房信息 */ export interface TRTCJoinRoomInput { /** * 签名。 */ Sign: string; /** * 房间号。 */ RoomId: string; /** * 推流应用ID。 */ SdkAppId: string; /** * 用户唯一标识。 */ UserId: string; /** * TRTC房间号的类型: Integer:数字类型 String:字符串类型 默认为:Integer 。 注意:此字段可能返回 null,表示取不到有效值。 */ RoomIdType?: string; } /** * RechargeVip返回参数结构体 */ export interface RechargeVipResponse { /** * 厂商订单号。 */ PartnerNo?: string; /** * TME订单号。 */ OrderNo?: string; /** * 订单创建时间。 */ CreateTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 其它片段时间(可用于抢唱) */ export interface KTVOtherSegments { /** * 片段开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ SegmentBegin?: number; /** * 片段结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ SegmentEnd?: number; } /** * DescribeKTVRobots返回参数结构体 */ export interface DescribeKTVRobotsResponse { /** * 机器人总数。 */ TotalCount?: number; /** * 机器人信息集合。 */ KTVRobotInfoSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKTVMusicAccompanySegmentUrl请求参数结构体 */ export interface DescribeKTVMusicAccompanySegmentUrlRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 歌曲 Id 。 */ MusicId: string; /** * 播放场景。默认为Chat
  • Live:直播
  • Chat:语聊
  • */ PlayScene?: string; /** * 房间Id */ RoomId?: string; } /** * 标签分组信息。 */ export interface KTVTagGroupInfo { /** * 分组 Id。 */ GroupId?: string; /** * 分组名。 */ Name?: string; /** * 标签列表。 */ TagInfoSet?: Array; } /** * DescribeVipUserInfo请求参数结构体 */ export interface DescribeVipUserInfoRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; } /** * BatchDescribeKTVMusicDetails请求参数结构体 */ export interface BatchDescribeKTVMusicDetailsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 歌曲 Id 列表。 */ MusicIds: Array; /** * 播放场景。默认为Chat
  • Live:直播
  • Chat:语聊
  • */ PlayScene?: string; /** * 玩家用户标识 */ GuestUserId?: string; /** * 房间Id */ RoomId?: string; } /** * AME 曲库歌曲基础信息。 */ export interface AMEMusicBaseInfo { /** * 歌曲 Id。 */ MusicId?: string; /** * 歌曲名称。 */ Name?: string; /** * 歌手列表。 */ SingerSet?: Array; } /** * DescribeKTVMusicsByTag返回参数结构体 */ export interface DescribeKTVMusicsByTagResponse { /** * 歌曲信息列表。 */ KTVMusicInfoSet?: Array; /** * 滚动标记,用于设置下次请求的 ScrollToken 参数。 */ ScrollToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveVipTradeInfos返回参数结构体 */ export interface DescribeLiveVipTradeInfosResponse { /** * 直播会员充值流水信息列表 */ LiveVipTradeInfoSet?: Array; /** * 直播会员充值流水总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌曲专辑信息。 */ export interface MusicAlbumInfo { /** * 专辑名称。 */ Name?: string; /** * 封面列表。 */ CoverInfoSet?: Array; } /** * 设置播放模式 */ export interface SetPlayModeCommandInput { /** * 播放模式,取值有:
  • RepeatPlaylist:列表循环
  • Order:顺序播放
  • RepeatSingle:单曲循环
  • Shuffle:随机播放
  • 注意:此字段可能返回 null,表示取不到有效值。 */ PlayMode: string; } /** * KTV 机器人初始化参数,在创建后自动完成相关初始化工作。 */ export interface SyncRobotCommand { /** * 可同时传入多个指令,顺序执行。取值有:
  • Play:播放
  • Pause:暂停
  • SwitchPrevious:上一首
  • SwitchNext:下一首
  • SetPlayMode:设置播放模式
  • Seek:调整播放进度
  • SetPlaylist:歌单变更
  • SetAudioParam:音频参数变更
  • SendMessage:发送自定义消息
  • SetDestroyMode:设置销毁模式
  • */ Command: string; /** * 播放参数。 */ PlayCommandInput?: PlayCommandInput; /** * 播放列表变更信息,当Command取SetPlaylist时,必填。 */ SetPlaylistCommandInput?: SetPlaylistCommandInput; /** * 播放进度,当Command取Seek时,必填。 */ SeekCommandInput?: SeekCommandInput; /** * 音频参数,当Command取SetAudioParam时,必填。 */ SetAudioParamCommandInput?: SetAudioParamCommandInput; /** * 自定义消息,当Command取SendMessage时,必填。 */ SendMessageCommandInput?: SendMessageCommandInput; /** * 播放模式,当Command取SetPlayMode时,必填。 */ SetPlayModeCommandInput?: SetPlayModeCommandInput; /** * 销毁模式,当Command取SetDestroyMode时,必填。 */ SetDestroyModeCommandInput?: SetDestroyModeCommandInput; } /** * DescribeVipUserInfo返回参数结构体 */ export interface DescribeVipUserInfoResponse { /** * 是否是会员。(0:不是会员 1:是会员) */ IsVip?: number; /** * 主播id */ AnchorId?: string; /** * 房间id */ RoomId?: string; /** * 会员过期时间 */ EndTime?: string; /** * 会员状态。(-1:未开通过;1:已开通,未过期;2:已开通,已过期) */ Status?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 机器人信息 */ export interface KTVRobotInfo { /** * 机器人Id。 */ RobotId?: string; /** * 状态,取值有:
  • Play:播放
  • Pause:暂停
  • Destroy:销毁
  • */ Status?: string; /** * 播放列表。 */ Playlists?: Array; /** * 当前歌单索引位置。 */ CurIndex?: number; /** * 播放进度,单位:毫秒。 */ Position?: number; /** * 音频参数。 */ SetAudioParamInput?: SetAudioParamCommandInput; /** * 进房信息。 */ JoinRoomInput?: JoinRoomInput; /** * RTC厂商类型,取值有:
  • TRTC
  • */ RTCSystem?: string; /** * 播放模式,PlayMode取值有:
  • RepeatPlaylist:列表循环
  • Order:顺序播放
  • RepeatSingle:单曲循环
  • Shuffle:随机播放
  • */ SetPlayModeInput?: SetPlayModeCommandInput; } /** * DescribeKTVMatchMusics返回参数结构体 */ export interface DescribeKTVMatchMusicsResponse { /** * 匹配到的歌曲列表。 */ MatchMusicSet?: Array; /** * 未匹配的规则列表。 */ NotMatchRuleSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKTVTags返回参数结构体 */ export interface DescribeKTVTagsResponse { /** * 标签分组列表。 */ TagGroupInfoSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RechargeLiveVip请求参数结构体 */ export interface RechargeLiveVipRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 交易流水号,用于标记此次充值记录,多次充值记录传入相同的 TradeSerialNo 会判断为失败,可用于防止重提提交造成重复计费。 */ TradeSerialNo: string; /** * 房间标识。 */ RoomId: string; /** * 充值会员天数。 取值有:
  • 31
  • 93
  • 186
  • 372
  • */ VipDays: number; /** * 充值分类。取值有:room_card-包月房卡; 其他-保留。 */ GiveType?: string; /** * 播放场景。默认为Live
  • Live:直播
  • Chat:语聊
  • */ PlayScene?: string; } /** * SearchKTVMusics返回参数结构体 */ export interface SearchKTVMusicsResponse { /** * 歌曲信息列表。 */ KTVMusicInfoSet?: Array; /** * 滚动标记,用于设置下次请求的 ScrollToken 参数。 */ ScrollToken?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 副歌片段信息。 */ export interface ChorusClip { /** * 开始时间,单位:毫秒。 */ StartTime?: number; /** * 结束时间,单位:毫秒。 */ EndTime?: number; } /** * RechargeVip请求参数结构体 */ export interface RechargeVipRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 房间Id。 */ RoomId: string; /** * 充值会员天数。(取值有:31、93、186、372) */ VipDays: number; /** * 主播id。 */ AnchorId: string; } /** * 设置播放列表指令参数 */ export interface SetPlaylistCommandInput { /** * 变更类型,取值有:
  • Add:添加
  • Delete:删除
  • ClearList:清空歌曲列表
  • Move:移动歌曲
  • */ Type: string; /** * 歌单索引位置, 当 Type 取 Add 时,-1表示添加在列表最后位置,大于-1表示要添加的位置; 当 Type 取 Delete 时,表示待删除歌曲的位置; 当 Type 取 Move 时,表示待调整歌曲的位置。 */ Index?: number; /** * 当 Type 取 Move 时,必填,表示移动歌曲的目标位置。 */ ChangedIndex?: number; /** * 歌曲 ID 列表,当 Type 取 Add 时,必填。 */ MusicIds?: Array; } /** * ApplyChorus请求参数结构体 */ export interface ApplyChorusRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 房间号。 */ RoomId: string; /** * 歌曲 Id。 */ MusicId: string; /** * 最大合唱人数,默认值为 8,最大值为 20。 */ MaxChorusNum?: number; /** * 合唱用户标识列表。 */ ChorusUserIds?: Array; } /** * BatchDescribeKTVMusicDetails返回参数结构体 */ export interface BatchDescribeKTVMusicDetailsResponse { /** * 歌曲详细信息列表。 */ KTVMusicDetailInfoSet?: Array; /** * 不存在歌曲Id列表。 */ NotExistMusicIdSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌曲匹配规则。 */ export interface KTVMatchRule { /** * AME 曲库 Id。 */ AMEMusicId?: string; /** * 歌曲匹配信息。 注意:此字段可能返回 null,表示取不到有效值。 */ MusicInfo?: KTVMatchRuleMusicInfo; /** * 音速达歌曲 Id,用于匹配 AME 曲库歌曲。 */ MusicIdToMatchAME?: string; } /** * 歌曲基础信息。 */ export interface KTVMusicBaseInfo { /** * 歌曲Id。 */ MusicId?: string; /** * 歌曲名称。 */ Name?: string; /** * 歌手名称。 */ SingerSet?: Array; /** * 播放时长。 */ Duration?: number; /** * 歌手图片链接。 */ SingerImageUrl?: string; /** * 专辑信息。 注意:此字段可能返回 null,表示取不到有效值。 */ AlbumInfo?: MusicAlbumInfo; /** * 权益列表,取值有:
  • Play:可播;
  • Sing:可唱。
  • */ RightSet?: Array; /** * 推荐类型,取值有:
  • Featured:精选;
  • Other:其他。
  • */ RecommendType?: string; } /** * DescribeKTVMusicsByTag请求参数结构体 */ export interface DescribeKTVMusicsByTagRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 标签 Id。 */ TagId: string; /** * 滚动标记。 */ ScrollToken?: string; /** * 返回条数限制,默认 20,最大 50。 */ Limit?: number; /** * 权益过滤,取值有:
  • Play:可播;
  • Sing:可唱。
  • */ RightFilters?: Array; /** * 物料过滤,取值有:
  • Lyrics:含有歌词;
  • Midi:含有音高线。
  • */ MaterialFilters?: Array; } /** * SearchKTVMusics请求参数结构体 */ export interface SearchKTVMusicsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 关键词。 */ KeyWord: string; /** * 滚动标记。 */ ScrollToken?: string; /** * 返回条数限制,默认 20,最大 50. */ Limit?: number; /** * 权益过滤,取值有:
  • Play:可播;
  • Sing:可唱。
  • */ RightFilters?: Array; /** * 播放场景。默认为Chat
  • Live:直播
  • Chat:语聊
  • */ PlayScene?: string; /** * 物料过滤,取值有:
  • Lyrics:含有歌词;
  • Midi:含有音高线。
  • */ MaterialFilters?: Array; } /** * 播放指令输入参数 */ export interface PlayCommandInput { /** * 歌曲位置索引。 */ Index: number; } /** * 时间范围 */ export interface TimeRange { /** *
  • 大于等于此时间(起始时间)。
  • 格式按照 ISO 8601标准表示,详见 ISO 日期格式说明
  • */ Before?: string; /** *
  • 小于此时间(结束时间)。
  • 格式按照 ISO 8601标准表示,详见 ISO 日期格式说明
  • */ After?: string; } /** * DescribeKTVMusicAccompanySegmentUrl返回参数结构体 */ export interface DescribeKTVMusicAccompanySegmentUrlResponse { /** * 歌曲状态。 0:可用 1:下线 2:没权限 3:没伴奏 当返回2时,其他参数有可能全部为空 */ Status?: number; /** * 伴奏链接 */ Url?: string; /** * 伴奏类型,如mkv,mp3等 */ ExtName?: string; /** * 高潮开始时间 */ SegmentBegin?: number; /** * 高潮结束时间 */ SegmentEnd?: number; /** * 链接文件大小 单位 字节 */ FileSize?: number; /** * 其它片段时间(可用于抢唱) 注意:此字段可能返回 null,表示取不到有效值。 */ OtherSegments?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 歌单基础信息。 */ export interface KTVPlaylistBaseInfo { /** * 歌单Id。 */ PlaylistId?: string; /** * 歌单标题。 */ Title?: string; } /** * DescribeUserInfo请求参数结构体 */ export interface DescribeUserInfoRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; } /** * 发送自定义信息指令参数 */ export interface SendMessageCommandInput { /** * 自定义消息,json格式字符串。 */ Message: string; /** * 消息重复次数,默认为 1。 */ Repeat?: number; } /** * DescribeKTVMusicAccompanySegmentUrlVip请求参数结构体 */ export interface DescribeKTVMusicAccompanySegmentUrlVipRequest { /** * 应用名称 */ AppName: string; /** * 用户标识 */ UserId: string; /** * 歌曲 Id */ MusicId: string; /** * 房间Id */ RoomId?: string; } /** * DestroyKTVRobot请求参数结构体 */ export interface DestroyKTVRobotRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 机器人Id。 */ RobotId: string; } /** * 充值直播会员流水信息 */ export interface LiveVipTradeInfo { /** * 交易流水号。 */ TradeSerialNo?: string; /** * 应用名称。 */ AppName?: string; /** * 用户标识。 */ UserId?: string; /** * 房间标识。 */ RoomId?: string; /** * 充值会员天数。 取值有:
  • 31
  • 93
  • 186
  • 372
  • */ VipDays?: number; /** * 订单状态。 取值有:
  • Success:成功
  • Fail:失败
  • Processing:订单处理中
  • */ Status?: string; /** * 创建时间。 */ CreateTime?: string; } /** * 用户信息 */ export interface UserInfo { /** * 应用名称。 */ AppName?: string; /** * 用户标识。 */ UserId?: string; /** * 直播会员详细信息。 注意:此字段可能返回 null,表示取不到有效值。 */ LiveVipUserInfo?: LiveVipUserInfo; /** * 用户类型
  • Normal:普通用户
  • LiveVip:直播会员用户
  • */ UserType?: string; } /** * DescribeUserInfo返回参数结构体 */ export interface DescribeUserInfoResponse { /** * 用户信息。 */ UserInfo?: UserInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKTVRobots请求参数结构体 */ export interface DescribeKTVRobotsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; /** * 机器人Id列表。 */ RobotIds?: Array; /** * 机器人状态,取值有:
  • Play:播放
  • Pause:暂停
  • Destroy:销毁
  • */ Statuses?: Array; /** * 匹配创建时间在此时间段内的机器人。
  • 包含所指定的头尾时间点。
  • */ CreateTime?: TimeRange; /** * 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。 */ Offset?: number; /** * 分页返回的起始偏移量,默认值:10。 */ Limit?: number; } /** * DescribeKTVTags请求参数结构体 */ export interface DescribeKTVTagsRequest { /** * 应用名称。 */ AppName: string; /** * 用户标识。 */ UserId: string; } /** * 调整播放进度指令参数 */ export interface SeekCommandInput { /** * 播放位置,单位:毫秒。 */ Position: number; }