# 版权音乐 (/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_drm"></a>

<a id="api_imusiccontentcenter_createmusicplayer"></a>

<a id="ariaid-title2"></a>

## createMusicPlayer [#createmusicplayer]

创建一个音乐播放器。

<a id="api_imusiccontentcenter_createmusicplayer__prototype"></a>

```cpp
virtual agora_refptr<IMusicPlayer> createMusicPlayer() = 0;
```

<a id="api_imusiccontentcenter_createmusicplayer__detailed_desc"></a>

如果你需要播放来自声网 Music Content Center 的音乐资源，必须先调用 [createMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_createmusicplayer) 创建一个音乐播放器。

<a id="api_imusiccontentcenter_createmusicplayer__return_values"></a>

### 返回值 [#返回值]

- 方法调用成功，返回一个 [IMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusicplayer) 对象，详见 [IMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusicplayer)。
- 方法调用失败，返回 NULL。

### 所属接口类 [#所属接口类]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_destroymusicplayer"></a>

<a id="ariaid-title3"></a>

## destroyMusicPlayer [#destroymusicplayer]

销毁音乐播放器对象。

<a id="api_imusiccontentcenter_destroymusicplayer__prototype"></a>

```cpp
virtual int destroyMusicPlayer(agora_refptr<IMusicPlayer> music_player) = 0;
```

<a id="api_imusiccontentcenter_destroymusicplayer__detailed_desc"></a>

当你不再需要使用音乐播放器时，可以调用此方法销毁该对象。如果销毁后需要再次使用音乐播放器，请调用 [createMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_createmusicplayer) 重新创建。

<a id="api_imusiccontentcenter_destroymusicplayer__timing"></a>

### 调用时机 [#调用时机]

该方法可以在加入频道前或加入频道后调用，但必须在调用 [release](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法之前调用。

<a id="api_imusiccontentcenter_destroymusicplayer__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="music_player"></a>
<Parameter name="music_player">

音乐播放器对象。详见 [IMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusicplayer)。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_destroymusicplayer__return_values"></a>

### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_musicchartcollection_get"></a>

<a id="ariaid-title4"></a>

## get [#get]

获取指定音乐榜单的详细信息。

<a id="api_musicchartcollection_get__prototype"></a>

```cpp
virtual MusicChartInfo* get(int index) = 0;
```

<a id="api_musicchartcollection_get__detailed_desc"></a>

<a id="api_musicchartcollection_get__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="index"></a>
<Parameter name="index">

[MusicChartInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musicchartinfo) 数组中的索引。

</Parameter>
</ParameterList>

<a id="api_musicchartcollection_get__return_values"></a>

### 返回值 [#返回值-2]

- 方法调用成功，返回 [MusicChartInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musicchartinfo) 实例，详见 [MusicChartInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musicchartinfo)。
- 方法调用失败，返回 NULL。

### 所属接口类 [#所属接口类-2]

- [MusicChartCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_musicchartcollection)

<a id="api_imusiccontentcenter_getcaches"></a>

<a id="ariaid-title5"></a>

## getCaches [#getcaches]

获取已缓存的音乐资源信息。

<a id="api_imusiccontentcenter_getcaches__prototype"></a>

```cpp
virtual int getCaches(MusicCacheInfo *cacheInfo, int32_t* cacheInfoSize) = 0;
```

<a id="api_imusiccontentcenter_getcaches__detailed_desc"></a>

调用该方法前，需要预先分配内存用于存储已缓存音乐资源的信息。如果希望设置可缓存的音乐资源数量，可以通过 [initialize](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_initialize_imusiccontentcenter) 中的 `configuration` 参数进行配置。当不再需要这些缓存资源时，应及时释放内存以避免内存泄漏。

<a id="api_imusiccontentcenter_getcaches__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="cacheinfo"></a>
<Parameter name="cacheInfo">

输出参数，用于存储已缓存音乐资源信息的内存缓冲区指针。详见 [MusicCacheInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccacheinfo)。

</Parameter>
<a id="cacheinfosize"></a>
<Parameter name="cacheInfoSize">

输入和输出参数，表示 [MusicCacheInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccacheinfo) 数组的大小。

- 输入值：分配的 [MusicCacheInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccacheinfo) 结构体数量。
- 输出值：方法执行后返回的 [MusicCacheInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccacheinfo) 结构体数量。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getcaches__return_values"></a>

### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_musicchartcollection_getcount_musicchartcollection"></a>

<a id="ariaid-title6"></a>

## getCount [1/2] [#getcount-12]

获取当前请求中的音乐排行榜数量。

<a id="api_musicchartcollection_getcount_musicchartcollection__prototype"></a>

```cpp
virtual int getCount() = 0;
```

<a id="api_musicchartcollection_getcount_musicchartcollection__detailed_desc"></a>

<a id="api_musicchartcollection_getcount_musicchartcollection__return_values"></a>

### 返回值 [#返回值-4]

方法调用成功，返回当前请求中的音乐排行榜数量。

### 所属接口类 [#所属接口类-4]

- [MusicChartCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_musicchartcollection)

<a id="api_musiccollection_getcount_musiccollection"></a>

<a id="ariaid-title7"></a>

## getCount [2/2] [#getcount-22]

获取当前请求中的音乐项数量。

<a id="api_musiccollection_getcount_musiccollection__prototype"></a>

```cpp
virtual int getCount() = 0;
```

<a id="api_musiccollection_getcount_musiccollection__detailed_desc"></a>

<a id="api_musiccollection_getcount_musiccollection__return_values"></a>

### 返回值 [#返回值-5]

方法调用成功，返回当前请求中的音乐项数量。

### 所属接口类 [#所属接口类-5]

- [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)

<a id="api_imusiccontentcenter_getinternalsongcode"></a>

<a id="ariaid-title8"></a>

## getInternalSongCode [#getinternalsongcode]

创建音乐资源副歌片段的内部歌曲编码。

<a id="api_imusiccontentcenter_getinternalsongcode__prototype"></a>

```cpp
virtual int getInternalSongCode(int64_t songCode, const char* jsonOption, int64_t& internalSongCode) = 0;
```

<a id="api_imusiccontentcenter_getinternalsongcode__detailed_desc"></a>

在播放音乐资源的副歌片段前，需调用该方法，结合参数 `jsonOption` 和音乐资源的 `songCode` 创建副歌片段的内部歌曲编码。该编码作为资源的唯一标识。获取该编码后，在调用打开、预加载或移除资源的方法时，将其作为 `songCode` 参数传入。

<a id="api_imusiccontentcenter_getinternalsongcode__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="songcode"></a>
<Parameter name="songCode">

音乐资源的歌曲编码，用于标识资源。你可以通过调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 获取，并从这些方法触发的 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取该编码。

</Parameter>
<a id="jsonoption"></a>
<Parameter name="jsonOption">

扩展 JSON 字段，默认为 NULL。目前支持以下字段：

- sceneType：场景类型。1：直播场景，在线 K 歌房和背景音乐播放；2：直播场景，背景音乐播放；3：（默认）声动语聊场景，在线 K 歌房；4：声动语聊场景，背景音乐播放；5：VR 场景，在线 K 歌房和背景音乐播放。示例代码 `{"sceneType":1}`。
- highPart：副歌片段的索引，从 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取，索引从 0 开始。示例代码 `{"format": {"highpart": 0}}`。

</Parameter>
<a id="internalsongcode"></a>
<Parameter name="internalSongCode">

输出参数，音乐资源的内部歌曲编码。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getinternalsongcode__return_values"></a>

### 返回值 [#返回值-6]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。详见错误码及其解决建议。

### 所属接口类 [#所属接口类-6]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_getlyric"></a>

<a id="ariaid-title9"></a>

## getLyric [#getlyric]

获取音乐资源歌词的下载链接。

<a id="api_imusiccontentcenter_getlyric__prototype"></a>

```cpp
virtual int getLyric(agora::util::AString& requestId, int64_t songCode, int32_t lyricType = 0) = 0;
```

<a id="api_imusiccontentcenter_getlyric__detailed_desc"></a>

<a id="api_imusiccontentcenter_getlyric__related"></a>

### 相关回调 [#相关回调]

调用该方法后，SDK 会触发 [onLyricResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onlyricresult) 回调报告歌词下载链接。

<a id="api_imusiccontentcenter_getlyric__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="requestid"></a>
<Parameter name="requestId">

请求 ID，用于唯一标识该请求。

</Parameter>
<a id="songcode-1"></a>
<Parameter name="songCode">

音乐资源的 ID，用于标识音乐。

</Parameter>
<a id="lyrictype"></a>
<Parameter name="lyricType">

歌词类型：

- 0：XML 格式。
- 1：LRC 格式。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getlyric__return_values"></a>

### 返回值 [#返回值-7]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-7]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_musiccollection_getmusic_musiccollection"></a>

<a id="ariaid-title10"></a>

## getMusic [#getmusic]

获取当前页面中指定音乐资源的详细信息。

<a id="api_musiccollection_getmusic_musiccollection__prototype"></a>

```cpp
virtual Music* getMusic(int32_t index) = 0;
```

<a id="api_musiccollection_getmusic_musiccollection__detailed_desc"></a>

<a id="api_musiccollection_getmusic_musiccollection__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="index-1"></a>
<Parameter name="index">

[Music](/zh-CN/api-reference/rtc/cpp-all-platforms/class-music) 数组中的索引。

</Parameter>
</ParameterList>

<a id="api_musiccollection_getmusic_musiccollection__return_values"></a>

### 返回值 [#返回值-8]

- 方法调用成功，返回 [Music](/zh-CN/api-reference/rtc/cpp-all-platforms/class-music) 实例，详见 [Music](/zh-CN/api-reference/rtc/cpp-all-platforms/class-music)。
- 方法调用失败，返回 NULL。

### 所属接口类 [#所属接口类-8]

- [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)

<a id="api_imusiccontentcenter_getmusiccharts"></a>

<a id="ariaid-title11"></a>

## getMusicCharts [#getmusiccharts]

获取所有音乐排行榜。

<a id="api_imusiccontentcenter_getmusiccharts__prototype"></a>

```cpp
virtual int getMusicCharts(agora::util::AString& requestId) = 0;
```

<a id="api_imusiccontentcenter_getmusiccharts__detailed_desc"></a>

<a id="api_imusiccontentcenter_getmusiccharts__related"></a>

### 相关回调 [#相关回调-1]

成功调用该方法后，SDK 会触发 [onMusicChartsResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) 回调，报告音乐排行榜的详细信息。

<a id="api_imusiccontentcenter_getmusiccharts__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="requestid-1"></a>
<Parameter name="requestId">

用于标识此次请求的唯一标识符。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getmusiccharts__return_values"></a>

### 返回值 [#返回值-9]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-9]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_getmusiccollectionbymusicchartid"></a>

<a id="ariaid-title12"></a>

## getMusicCollectionByMusicChartId [#getmusiccollectionbymusicchartid]

获取指定音乐榜单 ID 的音乐资源列表。

<a id="api_imusiccontentcenter_getmusiccollectionbymusicchartid__prototype"></a>

```cpp
virtual int getMusicCollectionByMusicChartId(agora::util::AString& requestId, int32_t musicChartId, int32_t page, int32_t pageSize, const char* jsonOption = nullptr) = 0;
```

<a id="api_imusiccontentcenter_getmusiccollectionbymusicchartid__detailed_desc"></a>

调用该方法后，SDK 会触发 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调，报告该榜单中的音乐资源详情。

<a id="api_imusiccontentcenter_getmusiccollectionbymusicchartid__parameters"></a>

### 参数 [#参数-7]

<ParameterList>
<a id="requestid-2"></a>
<Parameter name="requestId">

请求 ID，用于标识该请求的唯一标识符。

</Parameter>
<a id="musicchartid"></a>
<Parameter name="musicChartId">

音乐榜单的 ID。你可以通过 [onMusicChartsResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) 回调获取该 ID，或通过 RESTful API 获取完整音乐库列表或增量音乐列表。

</Parameter>
<a id="page"></a>
<Parameter name="page">

当前页码，从 1 开始。

</Parameter>
<a id="pagesize"></a>
<Parameter name="pageSize">

每页返回的音乐资源数量，最大值为 50。

</Parameter>
<a id="jsonoption-1"></a>
<Parameter name="jsonOption">

扩展 JSON 字段，默认为 NULL。你可以使用该字段筛选所需的音乐资源。目前支持以下筛选项：

- `pitchType`：是否支持评分。

  - 1：可评分音乐。
  - 2：不可评分音乐。
- `needHighPart`：是否需要合唱片段。

  - true：需要合唱片段。
  - false：不需要合唱片段。

示例：

- `{ "pitchType": 1 }`
- `{ "needHighPart": true }`

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getmusiccollectionbymusicchartid__return_values"></a>

### 返回值 [#返回值-10]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。请参见错误码文档获取详细信息和解决方案。

### 所属接口类 [#所属接口类-10]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_musiccollection_getpage_musiccollection"></a>

<a id="ariaid-title13"></a>

## getPage [#getpage]

获取音乐资源列表当前的页码。

<a id="api_musiccollection_getpage_musiccollection__prototype"></a>

```cpp
virtual int getPage() = 0;
```

<a id="api_musiccollection_getpage_musiccollection__detailed_desc"></a>

<a id="api_musiccollection_getpage_musiccollection__return_values"></a>

### 返回值 [#返回值-11]

方法调用成功，返回当前页码。

### 所属接口类 [#所属接口类-11]

- [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)

<a id="api_musiccollection_getpagesize_musiccollection"></a>

<a id="ariaid-title14"></a>

## getPageSize [#getpagesize]

获取 SDK 实际返回的音乐资源数量。

<a id="api_musiccollection_getpagesize_musiccollection__prototype"></a>

```cpp
virtual int getPageSize() = 0;
```

<a id="api_musiccollection_getpagesize_musiccollection__detailed_desc"></a>

<a id="api_musiccollection_getpagesize_musiccollection__return_values"></a>

### 返回值 [#返回值-12]

方法调用成功，返回 SDK 实际返回的音乐资源数量。

### 所属接口类 [#所属接口类-12]

- [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)

<a id="api_imusiccontentcenter_getsongsimpleinfo"></a>

<a id="ariaid-title15"></a>

## getSongSimpleInfo [#getsongsimpleinfo]

获取指定音乐资源的详细信息。

<a id="api_imusiccontentcenter_getsongsimpleinfo__prototype"></a>

```cpp
virtual int getSongSimpleInfo(agora::util::AString& requestId, int64_t songCode) = 0;
```

<a id="api_imusiccontentcenter_getsongsimpleinfo__detailed_desc"></a>

调用该方法前，你需要先获取目标音乐资源的歌曲编号。你可以通过调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 方法，并从其触发的 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取歌曲编号。调用该方法后，SDK 会触发 [onSongSimpleInfoResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onsongsimpleinforesult) 回调，返回该音乐资源的详细信息。

<a id="api_imusiccontentcenter_getsongsimpleinfo__related"></a>

### 相关回调 [#相关回调-2]

成功调用该方法后，SDK 会触发 [onSongSimpleInfoResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onsongsimpleinforesult) 回调，返回音乐资源的详细信息。

<a id="api_imusiccontentcenter_getsongsimpleinfo__parameters"></a>

### 参数 [#参数-8]

<ParameterList>
<a id="requestid-3"></a>
<Parameter name="requestId">

请求 ID，用于唯一标识该请求。

</Parameter>
<a id="songcode-2"></a>
<Parameter name="songCode">

音乐资源的歌曲编号，用于标识音乐。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_getsongsimpleinfo__return_values"></a>

### 返回值 [#返回值-13]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-13]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_musiccollection_gettotal_musiccollection"></a>

<a id="ariaid-title16"></a>

## getTotal [#gettotal]

获取音乐资源列表中的总数。

<a id="api_musiccollection_gettotal_musiccollection__prototype"></a>

```cpp
virtual int getTotal() = 0;
```

<a id="api_musiccollection_gettotal_musiccollection__detailed_desc"></a>

<a id="api_musiccollection_gettotal_musiccollection__return_values"></a>

### 返回值 [#返回值-14]

方法调用成功，返回音乐资源的总数。

### 所属接口类 [#所属接口类-14]

- [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)

<a id="api_imusiccontentcenter_initialize_imusiccontentcenter"></a>

<a id="ariaid-title17"></a>

## initialize [#initialize]

初始化 [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)。

<a id="api_imusiccontentcenter_initialize_imusiccontentcenter__prototype"></a>

```cpp
virtual int initialize(const MusicContentCenterConfiguration & configuration) = 0;
```

<a id="api_imusiccontentcenter_initialize_imusiccontentcenter__detailed_desc"></a>

在调用 [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter) 中的其他方法前，必须先调用该方法初始化 [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)。

<a id="api_imusiccontentcenter_initialize_imusiccontentcenter__parameters"></a>

### 参数 [#参数-9]

<ParameterList>
<a id="configuration"></a>
<Parameter name="configuration">

用于初始化 [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter) 的配置。详见 [MusicContentCenterConfiguration](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccontentcenterconfiguration)。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_initialize_imusiccontentcenter__return_values"></a>

### 返回值 [#返回值-15]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-15]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_ispreloaded"></a>

<a id="ariaid-title18"></a>

## isPreloaded [#ispreloaded]

检查指定音乐资源是否已预加载。

<a id="api_imusiccontentcenter_ispreloaded__prototype"></a>

```cpp
virtual int isPreloaded(int64_t songCode) = 0;
```

<a id="api_imusiccontentcenter_ispreloaded__detailed_desc"></a>

该方法为同步调用。若需预加载新的音乐资源，请调用 `preload`。

<a id="api_imusiccontentcenter_ispreloaded__parameters"></a>

### 参数 [#参数-10]

<ParameterList>
<a id="songcode-3"></a>
<Parameter name="songCode">

音乐资源的 ID，用于标识一个音乐项。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_ispreloaded__return_values"></a>

### 返回值 [#返回值-16]

- 0：方法调用成功，音乐资源已预加载。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。详见错误码。

### 所属接口类 [#所属接口类-16]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusicplayer_open_imusicplayer"></a>

<a id="ariaid-title19"></a>

## open [#open]

通过歌曲编码打开音乐资源。

<a id="api_imusicplayer_open_imusicplayer__prototype"></a>

```cpp
virtual int open(int64_t songCode, int64_t startPos = 0) = 0;
```

<a id="api_imusicplayer_open_imusicplayer__detailed_desc"></a>

在调用该方法前，请确保要播放的音乐资源已加载。你可以调用 [isPreloaded](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_ispreloaded) 方法检查资源是否已预加载，或监听 [onPreLoadEvent](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调。
调用该方法后，SDK 会触发 [onPlayerSourceStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayersourcestatechanged) 回调。当你收到 `PLAYER_STATE_OPEN_COMPLETED` 播放状态后，可以调用 [play](/zh-CN/api-reference/rtc/cpp-all-platforms/play/mediaplayer/mediaplayer-control#api_imediaplayer_play) 方法播放媒体文件。

:::note
注： 如果要打开的音乐资源受数字版权管理（DRM）保护，必须使用该方法打开。对于非 DRM 保护的资源，你可以选择使用该方法或 [open](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusicplayer_open_imusicplayer) 方法打开。
:::

<a id="api_imusicplayer_open_imusicplayer__related"></a>

### 相关回调 [#相关回调-3]

成功调用该方法后，SDK 会触发 [onPlayerSourceStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayersourcestatechanged) 回调报告播放状态。

<a id="api_imusicplayer_open_imusicplayer__parameters"></a>

### 参数 [#参数-11]

<ParameterList>
<a id="songcode-4"></a>
<Parameter name="songCode">

音乐资源的歌曲编码，用于标识音乐。

</Parameter>
<a id="startpos"></a>
<Parameter name="startPos">

开始播放的位置，单位为毫秒。默认值为 0。

</Parameter>
</ParameterList>

<a id="api_imusicplayer_open_imusicplayer__return_values"></a>

### 返回值 [#返回值-17]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-17]

- [IMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusicplayer)

<a id="api_imusiccontentcenter_preload"></a>

<a id="ariaid-title20"></a>

## preload [1/2] [#preload-12]

预加载音乐资源。

<a id="api_imusiccontentcenter_preload__prototype"></a>

```cpp
virtual int preload(int64_t songCode, const char* jsonOption) __deprecated = 0;
```

<a id="api_imusiccontentcenter_preload__detailed_desc"></a>

<a id="废弃"></a>

:::error[废弃]
该方法已废弃，请改用 [preload [2/2]](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_preload2) 方法。
:::

你可以调用该方法预加载想要播放的音乐资源。成功调用该方法后，SDK 会触发 [onPreLoadEvent](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调报告预加载事件。在调用该方法之前，你需要先调用 `getMusicCollectionWithMusicChartId` 或 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 获取目标音乐资源，并从 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取歌曲编号 `songCode`。

:::note
注： 在销毁 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 对象前，请确保已收到 [onPreLoadEvent](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调后再调用 [release](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法。
:::

<a id="api_imusiccontentcenter_preload__parameters"></a>

### 参数 [#参数-12]

<ParameterList>
<a id="songcode-5"></a>
<Parameter name="songCode">

用于标识音乐资源的歌曲编号。

</Parameter>
<a id="jsonoption-2"></a>
<Parameter name="jsonOption">

扩展的 JSON 字段。声网会根据你在 `sceneType` 字段中传入的应用场景计费，不同场景的计费标准不同：

- 1：直播场景：在线 K 歌房和背景音乐播放。
- 2：直播场景：背景音乐播放。
- 3：（默认）声动语聊场景：在线 K 歌房。
- 4：声动语聊场景：背景音乐播放。
- 5：VR 场景：在线 K 歌房和背景音乐播放。

如果你需要切换到其他场景，请再次调用该方法并在该字段中传入新的 `sceneType` 值。示例：`{"sceneType":1}`。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_preload__return_values"></a>

### 返回值 [#返回值-18]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-18]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_preload2"></a>

<a id="ariaid-title21"></a>

## preload [2/2] [#preload-22]

预加载音乐资源。

<a id="api_imusiccontentcenter_preload2__prototype"></a>

```cpp
virtual int preload(agora::util::AString& requestId, int64_t songCode) = 0;
```

<a id="api_imusiccontentcenter_preload2__detailed_desc"></a>

调用该方法可以预加载想要播放的音乐资源。调用成功后，SDK 会触发 [onPreLoadEvent](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调报告预加载事件。在调用该方法之前，需要先调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 获取目标音乐资源，并从 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取歌曲编码（`songCode`）。

:::note
注： 在销毁 [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) 对象前，请确保已收到 [onPreLoadEvent](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调后再调用 [release](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法。
:::

<a id="api_imusiccontentcenter_preload2__parameters"></a>

### 参数 [#参数-13]

<ParameterList>
<a id="requestid-4"></a>
<Parameter name="requestId">

输出参数，请求 ID，用于唯一标识此次请求。

</Parameter>
<a id="songcode-6"></a>
<Parameter name="songCode">

音乐资源的歌曲编码，用于标识音乐。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_preload2__return_values"></a>

### 返回值 [#返回值-19]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-19]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_registereventhandler_imusiccontentcenter"></a>

<a id="ariaid-title22"></a>

## registerEventHandler [#registereventhandler]

注册 `MusicContentCenter` 的事件处理器。

<a id="api_imusiccontentcenter_registereventhandler_imusiccontentcenter__prototype"></a>

```cpp
virtual int registerEventHandler(IMusicContentCenterEventHandler* eventHandler) = 0;
```

<a id="api_imusiccontentcenter_registereventhandler_imusiccontentcenter__detailed_desc"></a>

<a id="api_imusiccontentcenter_registereventhandler_imusiccontentcenter__parameters"></a>

### 参数 [#参数-14]

<ParameterList>
<a id="eventhandler"></a>
<Parameter name="eventHandler">

要注册的事件处理器。详见 [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_registereventhandler_imusiccontentcenter__return_values"></a>

### 返回值 [#返回值-20]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-20]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_release_imusiccontentcenter"></a>

<a id="ariaid-title23"></a>

## release [#release]

释放 `MusicContentCenter` 使用的所有资源。

<a id="api_imusiccontentcenter_release_imusiccontentcenter__prototype"></a>

```cpp
virtual void release() = 0;
```

<a id="api_imusiccontentcenter_release_imusiccontentcenter__detailed_desc"></a>

该方法必须在调用 [release](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 之前调用。

### 所属接口类 [#所属接口类-21]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_removecache"></a>

<a id="ariaid-title24"></a>

## removeCache [#removecache]

删除已缓存的音乐资源。

<a id="api_imusiccontentcenter_removecache__prototype"></a>

```cpp
virtual int removeCache(int64_t songCode) = 0;
```

<a id="api_imusiccontentcenter_removecache__detailed_desc"></a>

你可以调用此方法删除指定的已缓存音乐资源。若需删除多个资源，请多次调用此方法。

:::note
注： 注意：此方法不会删除当前正在播放的已缓存音乐资源。
:::

<a id="api_imusiccontentcenter_removecache__parameters"></a>

### 参数 [#参数-15]

<ParameterList>
<a id="songcode-7"></a>
<Parameter name="songCode">

要删除的音乐资源的 ID。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_removecache__return_values"></a>

### 返回值 [#返回值-21]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-22]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_renewtoken_imusiccontentcenter"></a>

<a id="ariaid-title25"></a>

## renewToken [#renewtoken]

更新 Token。

<a id="api_imusiccontentcenter_renewtoken_imusiccontentcenter__prototype"></a>

```cpp
virtual int renewToken(const char* token) = 0;
```

<a id="api_imusiccontentcenter_renewtoken_imusiccontentcenter__detailed_desc"></a>

当用于鉴权的 Token 即将过期或已经过期时，你可以调用该方法传入新生成的 Token。

<a id="api_imusiccontentcenter_renewtoken_imusiccontentcenter__parameters"></a>

### 参数 [#参数-16]

<ParameterList>
<a id="token"></a>
<Parameter name="token">

新的 Token。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_renewtoken_imusiccontentcenter__return_values"></a>

### 返回值 [#返回值-22]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-23]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusiccontentcenter_searchmusic"></a>

<a id="ariaid-title26"></a>

## searchMusic [#searchmusic]

搜索音乐资源。

<a id="api_imusiccontentcenter_searchmusic__prototype"></a>

```cpp
virtual int searchMusic(agora::util::AString& requestId, const char* keyWord, int32_t page, int32_t pageSize, const char* jsonOption = nullptr) = 0;
```

<a id="api_imusiccontentcenter_searchmusic__detailed_desc"></a>

<a id="api_imusiccontentcenter_searchmusic__related"></a>

### 相关回调 [#相关回调-4]

成功调用该方法后，SDK 会触发 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调报告检索到的音乐资源列表。

<a id="api_imusiccontentcenter_searchmusic__parameters"></a>

### 参数 [#参数-17]

<ParameterList>
<a id="requestid-5"></a>
<Parameter name="requestId">

请求 ID，用于标识该请求的唯一标识符。

</Parameter>
<a id="keyword"></a>
<Parameter name="keyWord">

搜索关键词，支持按歌曲名称或歌手名称搜索。

</Parameter>
<a id="page-1"></a>
<Parameter name="page">

要获取的音乐资源列表的页码。

</Parameter>
<a id="pagesize-1"></a>
<Parameter name="pageSize">

每页返回的最大音乐资源数量，最大值为 50。

</Parameter>
<a id="jsonoption-3"></a>
<Parameter name="jsonOption">

扩展 JSON 字段，默认为 NULL。你可以使用该字段筛选所需的音乐资源。目前支持以下筛选项：

- `pitchType`：是否支持评分：

  - `1`：可评分音乐。
  - `2`：不可评分音乐。
- `needHighPart`：是否需要合唱片段：

  - true：需要合唱片段。
  - false：不需要合唱片段。

示例：`{"pitchType":1}`，`{"needHighPart":true}`。

</Parameter>
</ParameterList>

<a id="api_imusiccontentcenter_searchmusic__return_values"></a>

### 返回值 [#返回值-23]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-24]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="api_imusicplayer_setplaymode"></a>

<a id="ariaid-title27"></a>

## setPlayMode [#setplaymode]

设置音乐资源的播放模式。

<a id="api_imusicplayer_setplaymode__prototype"></a>

```cpp
virtual int setPlayMode(MusicPlayMode mode) = 0;
```

<a id="api_imusicplayer_setplaymode__detailed_desc"></a>

你可以调用该方法启用原唱、伴奏或导唱模式。如果不调用该方法，默认播放伴奏；若音乐资源不包含伴奏，则播放原唱。

:::note
注： 你可以通过 [onMusicCollectionResult](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调获取音乐资源的详细信息，并从 `result` 参数中判断该音乐资源支持的播放模式。
:::

<a id="api_imusicplayer_setplaymode__scenario"></a>

### 适用场景 [#适用场景]

在在线 K 歌或才艺展示等娱乐场景中，如果你需要播放由声网内容中心提供的版权音乐，可以调用该方法设置播放模式。

<a id="api_imusicplayer_setplaymode__timing"></a>

### 调用时机 [#调用时机-1]

该方法必须在调用 [createMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_createmusicplayer) 之后调用。

<a id="api_imusicplayer_setplaymode__parameters"></a>

### 参数 [#参数-18]

<ParameterList>
<a id="mode"></a>
<Parameter name="mode">

播放模式。详见 [MusicPlayMode](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musicplaymode)。

</Parameter>
</ParameterList>

<a id="api_imusicplayer_setplaymode__return_values"></a>

### 返回值 [#返回值-24]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -2：参数无效。请重新设置参数。

### 所属接口类 [#所属接口类-25]

- [IMusicPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusicplayer)

<a id="api_imusiccontentcenter_unregistereventhandler_imusiccontentcenter"></a>

<a id="ariaid-title28"></a>

## unregisterEventHandler [#unregistereventhandler]

取消注册 `MusicContentCenter` 的事件回调。

<a id="api_imusiccontentcenter_unregistereventhandler_imusiccontentcenter__prototype"></a>

```cpp
virtual int unregisterEventHandler() = 0;
```

<a id="api_imusiccontentcenter_unregistereventhandler_imusiccontentcenter__detailed_desc"></a>

<a id="api_imusiccontentcenter_unregistereventhandler_imusiccontentcenter__return_values"></a>

### 返回值 [#返回值-25]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-26]

- [IMusicContentCenter](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcenter)

<a id="callback_imusiccontentcentereventhandler_onlyricresult"></a>

<a id="ariaid-title29"></a>

## onLyricResult [#onlyricresult]

获取歌词下载链接的回调。

<a id="callback_imusiccontentcentereventhandler_onlyricresult__prototype"></a>

```cpp
virtual void onLyricResult(const char* requestId, int64_t songCode, const char* lyricUrl, MusicContentCenterStateReason reason) = 0;
```

<a id="callback_imusiccontentcentereventhandler_onlyricresult__detailed_desc"></a>

调用 [getLyric](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getlyric) 获取某首歌曲的歌词下载链接后，SDK 会触发该回调。

<a id="callback_imusiccontentcentereventhandler_onlyricresult__parameters"></a>

### 参数 [#参数-19]

<ParameterList>
<a id="requestid-6"></a>
<Parameter name="requestId">

请求 ID，用于标识此次请求的唯一标识符。

</Parameter>
<a id="songcode-8"></a>
<Parameter name="songCode">

音乐资源的 ID，用于标识歌曲。

</Parameter>
<a id="lyricurl"></a>
<Parameter name="lyricUrl">

歌词的下载链接。

</Parameter>
<a id="reason"></a>
<Parameter name="reason">

请求状态码，详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musiccontentcenterstatereason)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-27]

- [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)

<a id="callback_imusiccontentcentereventhandler_onmusicchartsresult"></a>

<a id="ariaid-title30"></a>

## onMusicChartsResult [#onmusicchartsresult]

获取音乐排行榜结果的回调。

<a id="callback_imusiccontentcentereventhandler_onmusicchartsresult__prototype"></a>

```cpp
virtual void onMusicChartsResult(const char* requestId, agora_refptr<MusicChartCollection> result, MusicContentCenterStateReason reason) = 0;
```

<a id="callback_imusiccontentcentereventhandler_onmusicchartsresult__detailed_desc"></a>

调用 [getMusicCharts](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccharts) 后，SDK 会触发该回调。

<a id="callback_imusiccontentcentereventhandler_onmusicchartsresult__parameters"></a>

### 参数 [#参数-20]

<ParameterList>
<a id="requestid-7"></a>
<Parameter name="requestId">

请求 ID，用于标识本次请求的唯一性。

</Parameter>
<a id="result"></a>
<Parameter name="result">

当前可播放的音乐排行榜列表。详见 [MusicChartCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_musicchartcollection)。

</Parameter>
<a id="reason-1"></a>
<Parameter name="reason">

请求的状态码。详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musiccontentcenterstatereason)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-28]

- [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)

<a id="callback_imusiccontentcentereventhandler_onmusiccollectionresult"></a>

<a id="ariaid-title31"></a>

## onMusicCollectionResult [#onmusiccollectionresult]

获取音乐资源列表的回调。

<a id="callback_imusiccontentcentereventhandler_onmusiccollectionresult__prototype"></a>

```cpp
virtual void onMusicCollectionResult(const char* requestId, agora_refptr<MusicCollection> result, MusicContentCenterStateReason reason) = 0;
```

<a id="callback_imusiccontentcentereventhandler_onmusiccollectionresult__detailed_desc"></a>

调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 获取某个榜单的音乐资源列表，或调用 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 搜索音乐资源时，SDK 会触发该回调，返回音乐资源列表的详细信息。

<a id="callback_imusiccontentcentereventhandler_onmusiccollectionresult__timing"></a>

### 触发时机 [#触发时机]

调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_searchmusic) 后触发。

<a id="callback_imusiccontentcentereventhandler_onmusiccollectionresult__parameters"></a>

### 参数 [#参数-21]

<ParameterList>
<a id="requestid-8"></a>
<Parameter name="requestId">

请求 ID，用于标识此次请求的唯一标识符。

</Parameter>
<a id="result-1"></a>
<Parameter name="result">

音乐资源列表的详细信息。详见 [MusicCollection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-musiccollection)。

</Parameter>
<a id="reason-2"></a>
<Parameter name="reason">

请求状态码。详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musiccontentcenterstatereason)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-29]

- [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)

<a id="callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler"></a>

<a id="ariaid-title32"></a>

## onPreLoadEvent [#onpreloadevent]

预加载音乐资源相关事件的回调。

<a id="callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler__prototype"></a>

```cpp
virtual void onPreLoadEvent(const char* requestId, int64_t songCode, int percent, const char* lyricUrl, PreloadState state, MusicContentCenterStateReason reason) = 0;
```

<a id="callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler__detailed_desc"></a>

调用 `preload` 预加载音乐资源后，SDK 会触发该回调。

<a id="callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler__parameters"></a>

### 参数 [#参数-22]

<ParameterList>
<a id="requestid-9"></a>
<Parameter name="requestId">

请求 ID，用于标识该次请求的唯一标识符。

</Parameter>
<a id="songcode-9"></a>
<Parameter name="songCode">

音乐资源的 ID，用于标识某个音乐项。

</Parameter>
<a id="percent"></a>
<Parameter name="percent">

音乐资源当前的加载进度，范围为 [0, 100]。

</Parameter>
<a id="lyricurl-1"></a>
<Parameter name="lyricUrl">

歌词的下载地址。

</Parameter>
<a id="state"></a>
<Parameter name="state">

音乐资源当前的加载状态，详见 [PreloadState](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-preloadstate)。

</Parameter>
<a id="reason-3"></a>
<Parameter name="reason">

来自音乐内容中心的请求状态码，详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musiccontentcenterstatereason)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-30]

- [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)

<a id="callback_imusiccontentcentereventhandler_onsongsimpleinforesult"></a>

<a id="ariaid-title33"></a>

## onSongSimpleInfoResult [#onsongsimpleinforesult]

获取音乐资源详细信息的回调。

<a id="callback_imusiccontentcentereventhandler_onsongsimpleinforesult__prototype"></a>

```cpp
virtual void onSongSimpleInfoResult(const char* requestId, int64_t songCode, const char* simpleInfo, MusicContentCenterStateReason reason) = 0;
```

<a id="callback_imusiccontentcentereventhandler_onsongsimpleinforesult__detailed_desc"></a>

调用 [getSongSimpleInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getsongsimpleinfo) 后，SDK 会触发该回调。

<a id="callback_imusiccontentcentereventhandler_onsongsimpleinforesult__timing"></a>

### 触发时机 [#触发时机-1]

调用 [getSongSimpleInfo](/zh-CN/api-reference/rtc/cpp-all-platforms/play/drm#api_imusiccontentcenter_getsongsimpleinfo) 后触发。

<a id="callback_imusiccontentcentereventhandler_onsongsimpleinforesult__parameters"></a>

### 参数 [#参数-23]

<ParameterList>
<a id="requestid-10"></a>
<Parameter name="requestId">

请求 ID，用于标识此次请求的唯一标识符。

</Parameter>
<a id="songcode-10"></a>
<Parameter name="songCode">

音乐资源的 ID，用于标识该音乐。

</Parameter>
<a id="simpleinfo"></a>
<Parameter name="simpleInfo">

音乐资源的相关信息，包括以下内容：

- 副歌片段的起止时间（毫秒）。
- 副歌歌词的下载链接。
- 副歌片段的时长（毫秒）。
- 歌曲名称。
- 艺术家名称。

</Parameter>
<a id="reason-4"></a>
<Parameter name="reason">

请求状态码，详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-musiccontentcenterstatereason)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-31]

- [IMusicContentCenterEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_imusiccontentcentereventhandler)