版权音乐

createMusicPlayer

创建音乐播放器。

C++

virtual agora_refptr<IMusicPlayer> createMusicPlayer() = 0;

自从

v4.1.0

如果你需要播放音乐内容中心的音乐资源，你需要先调用该方法来创建一个音乐播放器。

返回值

• 方法调用成功：返回 IMusicPlayer 对象。

• 方法调用失败：返回空指针。

所属接口类

• IMusicContentCenter

getCaches

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

C++

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

自从

v4.2.0

调用该方法前，你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。

当你不再需要使用已缓存的音乐资源时，你需要及时释放内存以防止内存泄漏。

参数

参数名	描述
cacheInfo	输出参数，指向用于存储已缓存音乐资源的内存缓冲区的指针。
cacheInfoSize	输入和输出参数。 输入值：cacheInfo 数组的长度，即你所分配的 MusicCacheInfo 结构体的数量。 输出值：方法执行完毕后输出的 MusicCacheInfo 结构体的数量。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

getCount [2/2]

获取本次请求的音乐数量。

C++

virtual int getCount() = 0;

自从

v4.1.0

返回值

本次请求的音乐数量。

get

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

C++

virtual MusicChartInfo* get(int index) = 0;

自从

v4.1.0

参数

参数名	描述
index	MusicChartInfo 数组的索引。

返回值

MusicChartInfo，包含音乐榜单的详细信息。

getInternalSongCode

创建音乐资源的副歌片段编号。

C++

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

自从

v4.2.2

参数

参数名	描述
songCode	音乐资源编号，用于标识音乐资源。你可以通过调用 getMusicCollectionWithMusicChartId 或 searchMusic 方法来获取音乐资源，并通过由此触发的 onMusicCollectionResult 回调获取音乐资源的编号（songCode）。
jsonOption	扩展 JSON 字段，默认为 NULL。目前支持传入下列值： Key 值 Value 值 示例 sceneType 场景类型： 1：直播场景：K 歌及背景音乐播放。 2：直播场景：背景音乐播放。 3：（默认）语聊场景：K 歌。 4：语聊场景：背景音乐播放。 5：VR 场景：K 歌及背景音乐播放。 注： 声网会根据你在 sceneType 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 计费说明 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 sceneType 的值。 {"sceneType":1} highPart 副歌片段的索引。你可以从 onMusicCollectionResult 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 {"format": {"highpart": 0}}
internalSongCode	输出参数，音乐资源的内部歌曲编号。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

getLyric

获取音乐资源的歌词下载地址。

C++

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

自从

v4.1.0

成功调用该方法后，SDK 会触发 onLyricResult 回调报告歌词的下载地址。

参数

参数名	描述
songCode	音乐资源的编号，用于标识音乐资源。
LyricType	歌词类型： 0：xml 格式。 1：lrc 格式。
requestId	请求 ID。本次请求的唯一标识。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

getMusic

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

C++

virtual Music* getMusic(int32_t index) = 0;

自从

v4.1.0

参数

参数名	描述
index	Music 数组的索引。

返回值

一个 Music 实例。

getMusicCharts

获取全部音乐榜单。

C++

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

自从

v4.1.0

当你调用该方法后，SDK 会触发 onMusicChartsResult 回调报告音乐榜单的详细信息。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

getMusicCollectionWithMusicChartId

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

C++

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

自从

v4.1.0

成功调用该方法后，SDK 会触发 onMusicCollectionResult 回调报告榜单中音乐资源列表的详细信息。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
musicChartId	音乐榜单的 ID，可以通过 onMusicChartsResult 回调获取。你也可以通过 RESTful API 来获取曲库所有歌曲列表或获取增量歌曲列表。
page	当前页面编号，默认从 1 开始。
pageSize	当前音乐资源列表的总页面数量，最大值为 50。
jsonOption	扩展 JSON 字段，默认为 NULL。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段： Key 值 Value 值 示例 pitchType 是否支持打分： 1：支持打分的音乐资源。 2：不支持打分的音乐资源。 {"pitchType":1} needHighPart 是否需要副歌片段资源： true：需要副歌片段资源。 false：不需要副歌片段资源。 {"needHighPart":true}

所属接口类

• IMusicContentCenter

getPage

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

C++

virtual int getPage() = 0;

自从

v4.1.0

返回值

当前页的页码。

getPageSize

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

C++

virtual int getPageSize() = 0;

自从

v4.1.0

返回值

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

getTotal

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

C++

virtual int getTotal() = 0;

自从

v4.1.0

返回值

列表内音乐资源的总数量。

getSongSimpleInfo

获取某一音乐资源的详细信息。

C++

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

自从

v4.2.2

在调用该方法前，你需要先获取到对应的音乐资源的编号。你可以通过调用 getMusicCollectionWithMusicChartId 或 searchMusic 方法来获取音乐资源，并通过由此触发的 onMusicCollectionResult 回调获取音乐资源的编号（songCode）。

当你调用该方法后，SDK 会触发 onSongSimpleInfoResult 回调报告音乐资源的详细信息。

参数

参数名	描述
songCode	音乐资源的编号，用于标识音乐资源。
requestId	请求 ID。本次请求的唯一标识。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

initialize

初始化 IMusicContentCenter。

C++

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

自从

v4.1.0

在调用 IMusicContentCenter 类下的其他方法前，你需要先调用该方法初始化 IMusicContentCenter。

参数

参数名	描述
configuration	IMusicContentCenter 的设置，详见 MusicContentCenterConfiguration。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

isPreloaded

检测音乐资源是否已被预加载。

C++

virtual int isPreloaded(int64_t songCode) = 0;

自从

v4.1.0

该方法为同步调用。如需预加载新的音乐资源，可调用 preload [1/2]。

参数

参数名	描述
songCode	音乐资源的编号，用于标识一个音乐资源。

返回值

• 0: 方法调用成功，该音乐资源已被预加载。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

preload [1/2]

预加载音乐资源。

C++

virtual int preload(int64_t songCode, const char* jsonOption = nullptr) = 0;

弃用

该方法已废弃，请改用 preload [2/2]。

你可以调用该方法预先加载需要播放的音乐资源。成功调用该方法后，SDK 会触发 onPreLoadEvent 回调报告预加载音乐资源的事件。

在调用该方法来预加载音乐资源之前，你需要调用 getMusicCollectionWithMusicChartId 或 searchMusic 方法来获取你需要播放的音乐资源，并通过由此触发的 onMusicCollectionResult 回调获取音乐资源的编号（songCode）。

注意： 如需销毁 IRtcEngine 对象，请在收到 onPreloadEvent 回调后，再调用 release 方法。

参数

参数名	描述
songCode	音乐资源的编号，用于标识音乐资源。
jsonOption	扩展 JSON 字段。 声网会根据你在场景字段（sceneType）传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 计费说明 查看详细的计费。 1：直播场景：K 歌及背景音乐播放。 2：直播场景：背景音乐播放。 3：（默认）语聊场景：K 歌。 4：语聊场景：背景音乐播放。 5：VR 场景：K 歌及背景音乐播放。 如果需要切换到不同场景，需要重新调用此方法并在该字段中传入 sceneType 的值。 示例：{"sceneType":1}

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

preload [2/2]

预加载音乐资源。

C++

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

自从

v4.2.2

你可以调用该方法预先加载需要播放的音乐资源。成功调用该方法后，SDK 会触发 onPreLoadEvent 回调报告预加载音乐资源的事件。

在调用该方法来预加载音乐资源之前，你需要调用 getMusicCollectionWithMusicChartId 或 searchMusic 方法来获取你需要播放的音乐资源，并通过由此触发的 onMusicCollectionResult 回调获取音乐资源的编号（songCode）。

注意： 如需销毁 IRtcEngine 对象，请在收到 onPreloadEvent 回调后，再调用 release 方法。

参数

参数名	描述
songCode	音乐资源的编号，用于标识音乐资源。
requestId	输出参数，请求 ID。本次请求的唯一标识。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

registerEventHandler

注册音乐内容中心回调事件。

C++

virtual int registerEventHandler(IMusicContentCenterEventHandler* eventHandler) = 0;

自从

v4.1.0

参数

参数名	描述
eventHandler	待注册的回调事件，详见 IMusicContentCenterEventHandler。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

release

释放音乐内容中心所占用的所有资源。

C++

virtual void release() = 0;

自从

v4.1.0

该方法需要在 IRtcEngine 的 release 方法前调用。

所属接口类

• IMusicContentCenter

removeCache

删除已缓存的音乐资源。

C++

virtual int removeCache(int64_t songCode) = 0;

自从

v4.2.0

你可以调用该方法删除某一已缓存的音乐资源，如需删除多个音乐资源，你可以多次调用该方法。 注： 该方法不会删除正在播放中的已缓存音乐资源。

参数

参数名	描述
songCode	待删除的音乐资源的编号。

返回值

• 0: 方法调用成功，音乐资源已删除。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

renewToken

更新 Token。

C++

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

自从

v4.1.0

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

参数

参数名	描述
token	新的 Token。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

searchMusic

搜索音乐资源。

C++

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

自从

v4.1.0

成功调用该方法后，SDK 会触发 onMusicCollectionResult 回调报告检索到的音乐资源列表。

参数

参数名	描述
keyword	搜索关键词，支持歌曲名、歌手搜索。
page	想要获取的音乐资源列表的目标页编号。
pageSize	每页所展示的音乐资源的最大数量，最大值为 50。
jsonOption	扩展 JSON 字段，默认为 NULL。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段： Key 值 Value 值 示例 pitchType 是否支持打分： 1：支持打分的音乐资源。 2：不支持打分的音乐资源。 {"pitchType":1} needHighPart 是否需要副歌片段资源： true：需要副歌片段资源。 false：不需要副歌片段资源。 {"needHighPart":true}
requestId	请求 ID。本次请求的唯一标识。

所属接口类

• IMusicContentCenter

unregisterEventHandler

取消注册音乐内容中心事件回调。

C++

virtual int unregisterEventHandler() = 0;

自从

v4.1.0

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicContentCenter

onLyricResult

歌词下载地址回调。

C++

virtual void onLyricResult(const char* requestId, int64_t songCode, const char* lyricUrl, MusicContentCenterStatusCode errorCode) = 0;

自从

v4.1.0

当你调用 getLyric 获取指定歌曲的歌词下载地址后，SDK 会触发该回调。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
songCode	音乐资源的编号，用于标识音乐资源。
lyricUrl	歌词的下载地址。
errorCode	音乐内容中心的请求状态码，详见 MusicContentCenterStatusCode。

所属接口类

• IMusicContentCenterEventHandler

onMusicChartsResult

获取音乐榜单回调。

C++

virtual void onMusicChartsResult(const char* requestId, agora_refptr<MusicChartCollection> result, MusicContentCenterStatusCode errorCode) = 0;

自从

v4.1.0

当你调用 getMusicCharts 方法获取全部音乐榜单之后，SDK 会触发该回调。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
errorCode	音乐内容中心的请求状态码，详见 MusicContentCenterStatusCode。
result	当前可播放的音乐榜单列表。详见 MusicChartCollection。

所属接口类

• IMusicContentCenterEventHandler

onMusicCollectionResult

获取音乐资源列表回调。

C++

virtual void onMusicCollectionResult(const char* requestId, agora_refptr<MusicCollection> result, MusicContentCenterStatusCode errorCode) = 0;

自从

v4.1.0

当你调 getMusicCollectionWithMusicChartId 方法来获取指定榜单的音乐资源列表或调用 searchMusic 来搜索音乐资源时，SDK 会触发此回调报告榜单中音乐资源列表的详细信息。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
errorCode	音乐内容中心的请求状态码，详见 MusicContentCenterStatusCode。
result	音乐资源列表的详细信息。详见 MusicCollection。

所属接口类

• IMusicContentCenterEventHandler

onPreLoadEvent

报告预加载音乐资源的事件。

C++

virtual void onPreLoadEvent(const char* requestId, int64_t songCode, int percent, const char* lyricUrl, PreloadStatusCode status, MusicContentCenterStatusCode errorCode) = 0;

自从

v4.1.0

当你调用 preload [1/2] 方法预加载音乐资源后，SDK 会触发该回调。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
songCode	音乐资源的编号，用于标识一个音乐资源。
percent	音乐资源当前的加载进度，取值范围为 [0,100]。
lyricUrl	歌词下载地址。
status	当前音乐资源的加载状态。详见 PreloadStatusCode。
errorCode	音乐内容中心的请求状态码，详见 MusicContentCenterStatusCode。

所属接口类

• IMusicContentCenterEventHandler

onSongSimpleInfoResult

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

C++

virtual void onSongSimpleInfoResult(const char* requestId, int64_t songCode, const char* simpleInfo, MusicContentCenterStatusCode errorCode) = 0;

自从

v4.2.2

当你调用 getSongSimpleInfo 获取某一音乐资源的详细信息后，SDK 会触发该回调。

参数

参数名	描述
requestId	请求 ID。本次请求的唯一标识。
songCode	音乐资源的编号，用于标识音乐资源。
simpleInfo	音乐资源的相关信息，包含下列内容： 副歌片段的开始和结束的时间（ms） 副歌片段的歌词下载地址 副歌片段时长（ms） 歌曲名称 歌手名
errorCode	音乐内容中心的请求状态码，详见 MusicContentCenterStatusCode。

所属接口类

• IMusicContentCenterEventHandler

open

通过音乐资源编号打开音乐资源。

C++

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

自从

v4.1.0

注： 如果你想要打开的音乐资源受数字版权保护，则需要调用此方法打开。对于不受数字版权保护的音乐资源，你可以选择通过调用此方法或 IMediaPlayer 类下的 open 方法来打开。 在调用此方法之前，请确保需要播放的音乐资源已加载完成。你可以调用 isPreloaded 方法来检测音乐资源是否已被预加载，或通过 onPreLoadEvent 回调得知。

如需播放媒体文件，请在收到 onPlayerSourceStateChanged 回调报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后再调用 play 方法播放媒体文件。

参数

参数名	描述
songCode	音乐资源的编号，用于标识音乐资源。
startPos	设置起始播放位置（毫秒），默认值为 0。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMusicPlayer