API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 音速达直播音乐版权引擎 > 数据结构

数据结构

最近更新时间：2023-08-17 06:52:25

我的收藏

本页目录：

AMEMusicBaseInfo

AME 曲库歌曲基础信息。

被如下接口引用：DescribeKTVMatchMusics。

名称 类型 描述
MusicId String 歌曲 Id。
示例值：""
Name String 歌曲名称。
示例值：""
SingerSet Array of String 歌手列表。
示例值：""

ChorusClip

副歌片段信息。

被如下接口引用：BatchDescribeKTVMusicDetails。

名称 类型 描述
StartTime Integer 开始时间，单位：毫秒。
EndTime Integer 结束时间，单位：毫秒。

JoinRoomInput

直播进房输入参数

被如下接口引用：CreateKTVRobot, DescribeKTVRobots。

名称 类型 必选 描述
TRTCJoinRoomInput TRTCJoinRoomInput 是 TRTC进房参数

KTVBPMInfo

节拍信息。

被如下接口引用：BatchDescribeKTVMusicDetails。

名称 类型 描述
Type String 节拍类型，取值有：
  • Slow：慢；
  • Middle：中等；
  • Fast：快；
  • Unknown：未知。
    		•
    Value Integer BPM 值。

    KTVMatchMusic

    匹配歌曲信息。

    被如下接口引用：DescribeKTVMatchMusics。

    名称 类型 描述
    KTVMusicBaseInfo KTVMusicBaseInfo 匹配到的歌曲基础信息。
    示例值：""
    MatchRule KTVMatchRule 命中规则。
    示例值：""
    AMEMusicBaseInfo AMEMusicBaseInfo AME 歌曲基础信息，仅在使用音速达歌曲 Id 匹配 AME 曲库时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：""

    KTVMatchRule

    歌曲匹配规则。

    被如下接口引用：DescribeKTVMatchMusics。

    名称 类型 必选 描述
    AMEMusicId String 否 AME 曲库 Id。
    示例值：""
    MusicInfo KTVMatchRuleMusicInfo 否 歌曲匹配信息。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：""
    MusicIdToMatchAME String 否 音速达歌曲 Id，用于匹配 AME 曲库歌曲。
    示例值：""

    KTVMatchRuleMusicInfo

    歌曲信息匹配。

    被如下接口引用：DescribeKTVMatchMusics。

    名称 类型 必选 描述
    MusicName String 是 歌曲名称。
    示例值：""
    SingerSet Array of String 是 歌手列表。
    示例值：""

    KTVMusicBaseInfo

    歌曲基础信息。

    被如下接口引用：BatchDescribeKTVMusicDetails, DescribeKTVMatchMusics, DescribeKTVMusicsByTag, DescribeKTVPlaylistDetail, SearchKTVMusics。

    名称 类型 描述
    MusicId String 歌曲Id。
    Name String 歌曲名称。
    SingerSet Array of String 歌手名称。
    Duration Integer 播放时长。
    SingerImageUrl String 歌手图片链接。
    AlbumInfo MusicAlbumInfo 专辑信息。
    注意：此字段可能返回 null，表示取不到有效值。
    RightSet Array of String 权益列表，取值有：
  • Play：可播；
  • Sing：可唱。
    		•
    RecommendType String 推荐类型，取值有：
  • Featured：精选；
  • Other：其他。
    		•

    KTVMusicDetailInfo

    歌曲详细信息。

    被如下接口引用：BatchDescribeKTVMusicDetails。

    名称 类型 描述
    KTVMusicBaseInfo KTVMusicBaseInfo 歌曲基础信息。
    PlayToken String 播放凭证。
    LyricsUrl String 歌词下载链接。
    MidiUrl String 音高数据下载链接。
    ChorusClipSet Array of ChorusClip 副歌片段信息。
    PreludeInterval Integer 前奏间隔。
    示例值：0
    GenreSet Array of String 歌曲流派列表。
    BPMInfo KTVBPMInfo 节拍信息。
    注意：此字段可能返回 null，表示取不到有效值。

    KTVOtherSegments

    其它片段时间（可用于抢唱）

    被如下接口引用：DescribeKTVMusicAccompanySegmentUrl。

    名称 类型 描述
    SegmentBegin Integer 片段开始时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    SegmentEnd Integer 片段结束时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1

    KTVPlaylistBaseInfo

    歌单基础信息。

    被如下接口引用：DescribeKTVPlaylists。

    名称 类型 描述
    PlaylistId String 歌单Id。
    Title String 歌单标题。

    KTVRobotInfo

    机器人信息

    被如下接口引用：DescribeKTVRobots。

    名称 类型 描述
    RobotId String 机器人Id。
    示例值：xxxxx
    Status String 状态，取值有：
  • Play：播放
  • Pause：暂停
  • Destroy：销毁

    • 示例值：Play
    Playlists Array of String 播放列表。
    CurIndex Integer 当前歌单索引位置。
    示例值：1
    Position Integer 播放进度，单位：毫秒。
    示例值：120000
    SetAudioParamInput SetAudioParamCommandInput 音频参数。
    JoinRoomInput JoinRoomInput 进房信息。
    RTCSystem String RTC厂商类型，取值有：
  • TRTC

    • 示例值：TRTC
    SetPlayModeInput SetPlayModeCommandInput 播放模式，PlayMode取值有：
  • RepeatPlaylist：列表循环
  • Order：顺序播放
  • RepeatSingle：单曲循环
  • Shuffle：随机播放
    		•

    KTVSuggestionInfo

    联想词信息。

    被如下接口引用：DescribeKTVSuggestions。

    名称 类型 描述
    Suggestion String 联想词。

    KTVTagGroupInfo

    标签分组信息。

    被如下接口引用：DescribeKTVTags。

    名称 类型 描述
    GroupId String 分组 Id。
    Name String 分组名。
    TagInfoSet Array of KTVTagInfo 标签列表。

    KTVTagInfo

    标签信息。

    被如下接口引用：DescribeKTVTags。

    名称 类型 描述
    TagId String 标签 Id。
    Name String 标签名称。

    LiveVipTradeInfo

    充值直播会员流水信息

    被如下接口引用：DescribeLiveVipTradeInfos。

    名称 类型 描述
    TradeSerialNo String 交易流水号。
    AppName String 应用名称。
    UserId String 用户标识。
    RoomId String 房间标识。
    VipDays Integer 充值会员天数。
    取值有：
  • 31
  • 93
  • 186
  • 372
    		•
    Status String 订单状态。
    取值有：
  • Success：成功
  • Fail：失败
  • Processing：订单处理中
    		•
    CreateTime Timestamp ISO8601 创建时间。

    LiveVipUserInfo

    直播会员用户信息

    被如下接口引用：DescribeUserInfo, RechargeLiveVip。

    名称 类型 描述
    RoomId String 房间标识。
    LiveVipEndTime Timestamp ISO8601 直播会员结束时间。
    LiveVipStatus String 会员生效状态
  • Valid：生效
  • Invalid：无效
    		•

    MusicAlbumCoverInfo

    歌曲专辑封面信息。

    被如下接口引用：DescribeKTVMusicsByTag, DescribeKTVPlaylistDetail, SearchKTVMusics。

    名称 类型 描述
    Dimension String 尺寸规格，取值有：
  • Mini：150 x 150 尺寸；
  • Small：240 x 240 尺寸；
  • Medium：480 x 480 尺寸。
    		•
    Url String 下载链接。

    MusicAlbumInfo

    歌曲专辑信息。

    被如下接口引用：DescribeKTVMusicsByTag, DescribeKTVPlaylistDetail, SearchKTVMusics。

    名称 类型 描述
    Name String 专辑名称。
    CoverInfoSet Array of MusicAlbumCoverInfo 封面列表。

    PlayCommandInput

    播放指令输入参数

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Index Integer 是 歌曲位置索引。
    示例值：2

    SeekCommandInput

    调整播放进度指令参数

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Position Integer 是 播放位置，单位：毫秒。
    示例值：120

    SendMessageCommandInput

    发送自定义信息指令参数

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Message String 是 自定义消息，json格式字符串。
    示例值：{"field":"value"}
    Repeat Integer 否 消息重复次数，默认为 1。
    示例值：2

    SetAudioParamCommandInput

    音频参数信息

    被如下接口引用：CreateKTVRobot, DescribeKTVRobots, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Type String 否 音频类型，取值有：
  • Original：原唱
  • Accompaniment：伴奏

    • 示例值：Original

    SetDestroyModeCommandInput

    设置销毁模式

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    DestroyMode String 是 销毁模式，取值有：
  • Auto：房间没人时自动销毁
  • Expire：房间没人时过期自动销毁
  • Never：不自动销毁，需手动销毁
    • 默认为：Auto。
    示例值：Auto
    DestroyExpireTime Integer 否 过期销毁时间，单位：秒，当DestroyMode取Expire时必填。
    示例值：120

    SetPlayModeCommandInput

    设置播放模式

    被如下接口引用：CreateKTVRobot, DescribeKTVRobots, SyncKTVRobotCommand。

    名称 类型 必选 描述
    PlayMode String 是 播放模式，取值有：
  • RepeatPlaylist：列表循环
  • Order：顺序播放
  • RepeatSingle：单曲循环
  • Shuffle：随机播放

    • 示例值：RepeatPlaylist

    SetPlaylistCommandInput

    设置播放列表指令参数

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Type String 是 变更类型，取值有：
  • Add：添加
  • Delete：删除
  • ClearList：清空歌曲列表
  • Move：移动歌曲

    • 示例值：Add
    Index Integer 否 歌单索引位置，
    当 Type 取 Add 时，-1表示添加在列表最后位置，大于-1表示要添加的位置；
    当 Type 取 Delete 时，表示待删除歌曲的位置；
    当 Type 取 Move 时，表示待调整歌曲的位置。
    示例值：1
    ChangedIndex Integer 否 当 Type 取 Move 时，必填，表示移动歌曲的目标位置。
    示例值：2
    MusicIds Array of String 否 歌曲 ID 列表，当 Type 取 Add 时，必填。
    示例值：xxxxx

    SyncRobotCommand

    KTV 机器人初始化参数，在创建后自动完成相关初始化工作。

    被如下接口引用：CreateKTVRobot, SyncKTVRobotCommand。

    名称 类型 必选 描述
    Command String 是 可同时传入多个指令，顺序执行。取值有：
  • Play：播放
  • Pause：暂停
  • SwitchPrevious：上一首
  • SwitchNext：下一首
  • SetPlayMode：设置播放模式
  • Seek：调整播放进度
  • SetPlaylist：歌单变更
  • SetAudioParam：音频参数变更
  • SendMessage：发送自定义消息
  • SetDestroyMode：设置销毁模式
    		•
    PlayCommandInput PlayCommandInput 否 播放参数。
    SetPlaylistCommandInput SetPlaylistCommandInput 否 播放列表变更信息，当Command取SetPlaylist时，必填。
    SeekCommandInput SeekCommandInput 否 播放进度，当Command取Seek时，必填。
    SetAudioParamCommandInput SetAudioParamCommandInput 否 音频参数，当Command取SetAudioParam时，必填。
    SendMessageCommandInput SendMessageCommandInput 否 自定义消息，当Command取SendMessage时，必填。
    SetPlayModeCommandInput SetPlayModeCommandInput 否 播放模式，当Command取SetPlayMode时，必填。
    SetDestroyModeCommandInput SetDestroyModeCommandInput 否 销毁模式，当Command取SetDestroyMode时，必填。

    TRTCJoinRoomInput

    TRTC推流进房信息

    被如下接口引用：CreateKTVRobot。

    名称 类型 必选 描述
    Sign String 是 签名。
    示例值：xxxxxxx
    RoomId String 是 房间号。
    示例值：1234
    SdkAppId String 是 推流应用ID。
    示例值：140000001
    UserId String 是 用户唯一标识。
    示例值：tom
    RoomIdType String 否 TRTC房间号的类型：

    Integer：数字类型
    String：字符串类型
    默认为：Integer 。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：Integer

    TimeRange

    时间范围

    被如下接口引用：DescribeKTVRobots。

    名称 类型 必选 描述
    Before String 否
  • 大于等于此时间（起始时间）。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2020-12-10T07:25:52Z
    After String 否
  • 小于此时间（结束时间）。
  • 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。

    • 示例值：2020-12-10T07:25:52Z

    UserInfo

    用户信息

    被如下接口引用：DescribeUserInfo。

    名称 类型 描述
    AppName String 应用名称。
    UserId String 用户标识。
    LiveVipUserInfo LiveVipUserInfo 直播会员详细信息。
    注意：此字段可能返回 null，表示取不到有效值。
    UserType String 用户类型
  • Normal：普通用户
  • LiveVip：直播会员用户
    		•
    中国站