获取歌曲与歌词资源接口说明

其中，获取歌曲伴奏资源、获取长分片高潮片段资源、获取短分片高潮片段资源 可获取的资源片段，区别如下：

1 获取歌曲资源

1.1 获取包含人声的歌曲资源

用户调用 requestResource 接口点歌，“资源类型”选择 ZegoCopyrightedMusicResourceSong，通过 ZegoCopyrightedMusicRequestResourceCallback 回调结果，可以获取 songID 对应歌曲的资源，包括歌曲时长、歌手名、resource_id 等。

接口调用示例

/** 配置 */
ZegoCopyrightedMusicRequestConfig *config = [ZegoCopyrightedMusicRequestConfig new];
/** 音乐 songID，从歌曲列表中获取*/
config.songID = songID;
/** 计费模式 */
config.mode = ZegoCopyrightedMusicBillingModeCount;
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
config.vendorID = ZegoCopyrightedMusicVendorDefault;
/** 场景 sceneID：1 语聊房、2 直播间在线 K 歌、3 直播间播放背景音乐、4 抢唱*/
/** 请联系 ZEGO 商务开通使用场景，使用过程请传入正确的场景 ID。*/
config.sceneID = 0;
/** 资源类型 */
ZegoCopyrightedMusicResourceType resourceType = ZegoCopyrightedMusicResourceSong;

[self.copyrightedMusic requestResource:config type:resourceType callback:^(int errorCode, NSString * _Nonnull resource) {

}];

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_accompany": 0,
    "song_name": "string",
    "singer_name": "string",
    "song_id": "string",
    "duration": 0,
    "token_ttl": 0,
    "resources_size": 1,
    "resources": [
      {
        "resource_id": "string",
        "size": 0,
        "quality": "string",
        "share_token": "string",
        "resource_ttl": 300000
      }
    ]
  }
}

1.2 获取歌曲伴奏资源

用户调用 requestResource 接口点伴奏，“资源类型”选择 ZegoCopyrightedMusicResourceAccompaniment，通过 ZegoCopyrightedMusicRequestResourceCallback 回调结果，可以获取 songID 对应歌曲的伴奏资源，包括歌曲资源个数、resource_id、krc_token 等。

接口调用示例

/** 配置 */
ZegoCopyrightedMusicRequestConfig *config = [ZegoCopyrightedMusicRequestConfig new];
/** 音乐 songID，从歌曲列表中获取*/
config.songID = songID;
/** 计费模式 */
config.mode = ZegoCopyrightedMusicBillingModeCount;
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
config.vendorID = ZegoCopyrightedMusicVendorDefault;
/** 场景 sceneID：1 语聊房、2 直播间在线 K 歌、3 直播间播放背景音乐、4 抢唱*/
/** 请联系 ZEGO 商务开通使用场景，使用过程请传入正确的场景 ID。*/
config.sceneID = 0;
/** 资源类型 */
ZegoCopyrightedMusicResourceType resourceType = ZegoCopyrightedMusicResourceAccompaniment;
[self.copyrightedMusic requestResource:config type:resourceType callback:^(int errorCode, NSString * _Nonnull resource) {

}];

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "has_original": 1,
    "is_accompany": 1,
    "song_id": "string",
    "share_token": "eyJhbGciOiJIUzI1NiIsInR5c",
    "duration": 0,
    "token_ttl": 0,
    "krc_token":"string",
    "krc_token_ttl":0,
    "resources_size": 1,
    "resources": [
      {
        "resource_id": "string",
        "size": 0,
        "quality": "string",
        "share_token": "string",
        "resource_ttl": 300000
      }
    ]
  }
}

1.3 获取长分片高潮片段资源

用户调用 requestResource 接口点高潮片段，“资源类型”选择 ZegoCopyrightedMusicResourceAccompanimentClip，通过 ZegoCopyrightedMusicRequestResourceCallback 回调结果，可以获取 songID 对应歌曲的伴奏资源，包括高潮片段的开始与结束时间、resource_id、krc_token 等。

接口调用示例

/** 配置 */
ZegoCopyrightedMusicRequestConfig *config = [ZegoCopyrightedMusicRequestConfig new];
/** 音乐 songID，从歌曲列表中获取*/
config.songID = songID;
/** 计费模式 */
config.mode = ZegoCopyrightedMusicBillingModeCount;
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
config.vendorID = ZegoCopyrightedMusicVendorDefault;
/** 场景 sceneID：1 语聊房、2 直播间在线 K 歌、3 直播间播放背景音乐、4 抢唱*/
/** 请联系 ZEGO 商务开通使用场景，使用过程请传入正确的场景 ID。*/
config.sceneID = 0;
/** 资源类型 */
ZegoCopyrightedMusicResourceType resourceType = ZegoCopyrightedMusicResourceAccompanimentClip;
[self.copyrightedMusic requestResource:config type:resourceType callback:^(int errorCode, NSString * _Nonnull resource) {

}];

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_clip":1,
    "is_accompany":0,
    "krc_token":"UQIFmNmY3NbjZggIwNzFl",
    "krc_token_ttl":43200000,
    "song_id":"300785364",
    "share_token_ttl":3600000,
    "token_ttl":3600000,
    "segment_begin":133157,
    "segment_end":235337,
    "prelude_duration":5000,
    "resources_size":1,
    "resources":[
        {
            "resource_id":"z_301215364_3",
            "size":0,
            "quality":"normal",
            "share_token":"7878787SDASDASDASDASD.SADSDASDASDASDSADSASDASDASDASD.V-sT427morLeej5sYUXgQzEgNjQ-YAoShYHGy5dGFKI",
            "resource_ttl": 300000
        }
    ]
  }
}

1.4 获取短分片高潮片段资源

用户调用 requestResource 接口点伴奏片段，“资源类型”选择 ZegoCopyrightedMusicResourceAccompanimentSegment，通过 ZegoCopyrightedMusicRequestResourceCallback 回调结果，可以获取 songID 对应歌曲的伴奏片段资源，包括高潮片段短分片的开始与结束时间、抢唱片段的开始与结束时间、resource_id、krc_token 等。

接口调用示例

/** 配置 */
ZegoCopyrightedMusicRequestConfig *config = [ZegoCopyrightedMusicRequestConfig new];
/** 音乐 songID，从歌曲列表中获取*/
config.songID = songID;
/** 计费模式 */
config.mode = ZegoCopyrightedMusicBillingModeCount;
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
config.vendorID = ZegoCopyrightedMusicVendorDefault;
/** 场景 sceneID：1 语聊房、2 直播间在线 K 歌、3 直播间播放背景音乐、4 抢唱*/
/** 请联系 ZEGO 商务开通使用场景，使用过程请传入正确的场景 ID。*/
config.sceneID = 0;
/** 资源类型 */
ZegoCopyrightedMusicResourceType resourceType = ZegoCopyrightedMusicResourceAccompanimentSegment;
[self.copyrightedMusic requestResource:config type:resourceType callback:^(int errorCode, NSString * _Nonnull resource) {

}];

回调结果

参数	类型	描述
code	Number	返回码，具体请参见 错误码，如查询不到可联系 ZEGO 技术支持。
message	String	操作结果描述。
request_id	String	请求 ID。
data	Object	响应数据。
is_clip	Int	是否为高潮片段。 0：否 1：是
is_accompany	Int	是否为伴奏。 0：歌曲 1：伴奏
krc_token	String	获取逐字歌词所需的 krc_token。
krc_token_ttl	Int	逐字歌词 krc_token 的有效期，默认值为 43200000 毫秒（12 小时）。
song_id	String	歌曲 ID。
share_token_ttl	Int	share_token 有效时长，默认值为 3600000 毫秒（1 小时）。该参数为新版参数，与 token_ttl 旧版参数含义相同，新接入用户主要使用该参数。
token_ttl	Int	share_token 有效时长，默认值为 3600000 毫秒（1 小时）。该参数为旧版参数，与 share_token_ttl 新版参数含义相同，为了兼容早期接入用户使用。
segment_begin	Int	“长分片高潮片段”相对于“原曲时长”的开始时间戳，单位：毫秒。
segment_end	Int	“长分片高潮片段”相对于“原曲时长”的结束时间戳，单位：毫秒。
other_segments	Array	短分片高潮片段的时间分片信息。仅当版权方 vendorID 取值为 0 或 1 时会返回此字段，其对应的枚举值信息，请联系 ZEGO 商务咨询。 “短分片高潮片段”的开始、结束时间，必须在 “长分片高潮片段” 的时长范围内。
begin	Int	“短分片高潮片段”相对于“长分片高潮片段”时长的开始时间戳，可以直接通过 seekTo 接口跳转到该时间点开始播放，单位：毫秒。
end	Int	“短分片高潮片段”相对于“长分片高潮片段”时长的结束时间戳，单位：毫秒。
prelude_duration	Int	长分片高潮片段的前奏时间，单位：毫秒。
resources_size	Int	歌曲资源数，resources 中资源个数。
resources	Object	歌曲资源信息。
resource_id	String	歌曲资源 ID。
size	Int	歌曲资源大小，单位：字节。
quality	String	歌曲音质，当前仅包含 normal（标准）音质的短分片高潮片段资源。
share_token	String	旧版参数。
resource_ttl	Int	该资源的剩余有效时长，单位：毫秒。

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_clip":1,
    "is_accompany":0,
    "krc_token":"UQIFmNmY3NbjZggIwNzFl",
    "krc_token_ttl":43200000,
    "song_id":"300785364",
    "share_token_ttl":3600000,
    "token_ttl":3600000,
    "segment_begin":133157,
    "segment_end":235337,
    "other_segments":[
        {
            "begin":59776,
            "end":73000
        }
    ],
    "prelude_duration":5000,
    "resources_size":1,
    "resources":[
        {
            "resource_id":"z_301215364_3",
            "size":0,
            "quality":"normal",
            "share_token":"7878787SDASDASDASDASD.SADSDASDASDASDSADSASDASDASDASD.V-sT427morLeej5sYUXgQzEgNjQ-YAoShYHGy5dGFKI",
            "resource_ttl": 300000
        }
    ]
  }
}

1.5 获取其他用户分享的歌曲资源

用户在获取歌曲/伴奏/高潮片段资源成功后，其他用户调用 getSharedResource 接口获取被分享的音乐资源，通过 ZegoCopyrightedMusicGetSharedResourceCallback 回调结果，可以获取对应歌曲的 resource_id。

接口调用示例

/** 点歌用户分享的歌曲资源对应的 songID */
ZegoCopyrightedMusicGetSharedConfig* config = [ZegoCopyrightedMusicGetSharedConfig new];
config.songID = @"";
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
config.vendorID = ZegoCopyrightedMusicVendorDefault;

/** 点歌用户分享的歌曲资源对应的资源类型 */
ZegoCopyrightedMusicResourceType resourceType = ZegoCopyrightedMusicResourceSong;

[self.copyrightedMusic getSharedResource:config type:resourceType callback:^(int errorCode, NSString * _Nonnull resource) {

}];

1.5.1 获取包含人声的歌曲资源

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_accompany": 0,
    "song_name": "string",
    "singer_name": "string",
    "song_id": "string",
    "duration": 0,
    "resources_size": 1,
    "resources": [
      {
        "resource_id": "string",
        "size": 0,
        "quality": "string",
        "resource_ttl": 300000
      }
    ]
  }
}

1.5.2 获取伴奏资源

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "has_original": 1,
    "is_accompany": 1,
    "song_id": "string",
    "duration": 0,
    "krc_token":"string",
    "krc_token_ttl":0,
    "resources_size": 1,
    "resources": [
      {
        "resource_id": "string",
        "size": 0,
        "quality": "string",
        "resource_ttl": 300000
      }
    ]
  }
}

1.5.3 获取长分片高潮片段资源

回调结果

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_clip":1,
    "is_accompany":0,
    "song_id":"300785364",
    "krc_token":"UQIFmNmY3NbjZggIwNzFl",
    "krc_token_ttl":43200000,
    "token_ttl":3600000,
    "share_token_ttl":3600000,
    "segment_begin":133157,
    "segment_end":235337,
    "prelude_duration":5000,
    "resources_size":1,
    "resources":[
        {
            "resource_id":"z_301215364_3",
            "size":0,
            "quality":"normal",
            "share_token":"7878787SDASDASDASDASD.SADSDASDASDASDSADSASDASDASDASD.V-sT427morLeej5sYUXgQzEgNjQ-YAoShYHGy5dGFKI",
            "resource_ttl": 300000
        }
    ]
  }
}

1.5.4 获取短分片高潮片段资源

回调结果

参数	类型	描述
code	Number	返回码，具体请参见 错误码，如查询不到可联系 ZEGO 技术支持。
message	String	操作结果描述。
request_id	String	请求 ID。
data	Object	响应数据。
is_clip	Int	是否为高潮片段。 0：否 1：是
is_accompany	Int	是否为伴奏。 0：歌曲 1：伴奏
song_id	String	歌曲 ID。
krc_token	String	获取逐字歌词所需的 krc_token。
krc_token_ttl	Int	逐字歌词 krc_token 的有效期，默认值为 43200000 毫秒（12 小时）。
token_ttl	Int	share_token 有效时长，默认值为 3600000 毫秒（1 小时）。该参数为旧版参数，与 share_token_ttl 新版参数含义相同，为了兼容早期接入客户使用。
share_token_ttl	Int	share_token 有效时长，默认值为 3600000 毫秒（1 小时）。该参数为新版参数，与 token_ttl 旧版参数含义相同，新接入客户主要使用该参数。
segment_begin	Int	“长分片高潮片段”相对于“原曲时长”的开始时间戳，单位：毫秒。
segment_end	Int	“长分片高潮片段”相对于“原曲时长”的结束时间戳，单位：毫秒。
other_segments	Array	短分片高潮片段的时间分片信息。仅当版权方 vendorID 取值为 0 或 1 时会返回此字段，其对应的枚举值信息，请联系 ZEGO 商务咨询。 “短分片高潮片段”的开始、结束时间，必须在 “长分片高潮片段” 的时长范围内。
begin	Int	“短分片高潮片段”相对于“长分片高潮片段”时长的开始时间戳，可以直接通过 seekTo 接口跳转到该时间点开始播放，单位：毫秒。
end	Int	“短分片高潮片段”相对于“长分片高潮片段”时长的结束时间戳，单位：毫秒。
prelude_duration	Int	长分片高潮片段的前奏时间，单位：毫秒。
resources_size	Int	歌曲资源数，resources 中资源个数。
resources	Object	歌曲资源信息。
resource_id	String	歌曲资源 ID。
size	Int	歌曲资源大小，单位：字节。
quality	String	歌曲音质，当前仅包含 normal（标准）音质的短分片高潮片段资源。
share_token	String	旧版参数。
resource_ttl	Int	该资源的剩余有效时长，单位：毫秒。

回调示例

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "data": {
    "is_clip":1,
    "is_accompany":0,
    "song_id":"300785364",
    "krc_token":"UQIFmNmY3NbjZggIwNzFl",
    "krc_token_ttl":43200000,
    "token_ttl":3600000,
    "share_token_ttl":3600000,
    "segment_begin":133157,
    "segment_end":235337,
    "other_segments":[
        {
            "begin":59776,
            "end":73000
        }
    ],
    "prelude_duration":5000,
    "resources_size":1,
    "resources":[
        {
            "resource_id":"z_301215364_3",
            "size":0,
            "quality":"normal",
            "share_token":"7878787SDASDASDASDASD.SADSDASDASDASDSADSASDASDASDASD.V-sT427morLeej5sYUXgQzEgNjQ-YAoShYHGy5dGFKI",
            "resource_ttl": 300000
        }
    ]
  }
}

2 获取歌词

2.1 获取逐行歌词

用户调用 getLrcLyric 接口，通过 ZegoCopyrightedMusicGetLrcLyricCallback 回调结果，可以获取逐行歌词信息。

接口调用示例

NSString *songID = @"";
/** 版权方，其对应的枚举值信息，请联系 ZEGO 商务咨询*/
ZegoCopyrightedMusicVendorID vendorID = ZegoCopyrightedMusicVendorDefault;

[self.copyrightedMusic getLrcLyric:songID vendorID:vendorID callback:^(int errorCode, NSString * _Nonnull lyrics) {

}];

回调结果

其他字段为歌词源文件中的 title 字段，不同的歌词文件中不一定存在，一般可以选择忽略。具体如下：

回调示例

{
  "lines": [
    {
      "begin_time": 0,
      "end_time": 0,
      "content": ""
    }
  ],
  "lrc_format": "string",
  "al": "",
  "ar": "",
  "au": "",
  "by": "",
  "offset": 0,
  "lenght": 0,
  "re": "",
  "ti": "",
  "ve": ""
}

2.2 获取逐字歌词

用户先通过 requestResource 或 getSharedResource 接口获取到 krc_token，再调用 getKrcLyricByToken 接口，通过 ZegoCopyrightedMusicGetKrcLyricByTokenCallback 回调结果，可以获取逐字歌词信息。

接口调用示例

NSString *krcToken = @"";

[self.copyrightedMusic getKrcLyricByToken:krcToken callback:^(int errorCode, NSString * _Nonnull lyrics) {

}];

回调结果

其他字段为歌词源文件中的 title 字段，不同的歌词文件中不一定存在，一般可以选择忽略。具体如下：

回调示例

{

  "lines": [
    {
      "begin_time": 12076,
      "duration": 6158,
      "content": "string",
      "words": [
        {
          "offset": 0,
          "duration": 496,
          "word": "string"
        }
      ]
    }
  ],
  "al": "",
  "ar": "",
  "au": "",
  "by": "",
  "lenght": 0,
  "re": "",
  "ti": "",
  "ve": "",
}