logo
当前页

获取歌词分片


描述

当多人合唱一首歌曲时,通过获取歌词分片,将歌词加上分片标签后,每个人可以选择不同的歌词片段进行演唱。

注意

仅当传入的版权方 VendorId 为 “0(默认)” 或 “1” 时,才能使用本服务端接口;其余版权方不支持。版权方的详细信息,请联系 ZEGO 商务人员咨询。

接口原型

  • 请求方法:GET
  • 请求地址:https://ktv-api.zego.im/?Action=DescribeKrcSegment
  • 传输协议:HTTPS
  • 调用频率限制:200 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

说明

在线 KTV 服务端接口的公共请求参数与实时音视频、实时语音的不同,包含了 VendorId(版权方 ID),请务必阅读上述参考文档。

参数类型是否必选描述
SongIdString歌曲 ID。

请求示例

Untitled
https://ktv-api.zego.im/?Action=DescribeKrcSegment
&SongId=125282604
&<公共请求参数>
1
Copied!

响应参数

参数类型描述
CodeNumber返回码。
MessageString请求结果的说明信息。
RequestIdString请求 ID。
DataObject响应结果,详情可见 Data
Data
参数类型描述
TagsArray of Object歌词分片数据,详情可见 Tags
Tags
参数类型描述
StartNumber开始偏移量。
EndNumber结束偏移量。
TagsArray of String分片标签。

响应示例

Untitled
{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "74dffcf4-018b-44d1-b4c6-912d6b0fee57",
    "Data": {
        "Tags": [
            {
                "End": 20310,
                "Start": 710,
                "Tags": [
                    "1"
                ]
            },
            {
                "End": 35580,
                "Start": 20310,
                "Tags": [
                    "2"
                ]
            }
        ]
    }
}
1
Copied!

返回码

以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码

返回码说明处理建议
320000004参数非法。请根据 Message 提示判断非法参数,调整对应参数值。
320010000AppId 不可用请联系 ZEGO 技术支持开通版权音乐服务。
320010001不支持的付费类型。请联系 ZEGO 技术支持开通版权音乐对应的付费类型。
  • 按次计费
320050000系统错误。请联系 ZEGO 技术支持。
320050002系统繁忙。请稍后重试。
320050003未定义的引擎错误。请联系 ZEGO 技术支持。
320050004引擎内部错误。请联系 ZEGO 技术支持。

Previous

获取歌曲的歌词

Next

获取伴奏高潮时间点