# 版权音乐 (/zh-CN/api-reference/rtc/flutter/play/drm) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## createMusicPlayer [#createmusicplayer] 创建音乐播放器。 ```dart Future createMusicPlayer(); ``` 如果你需要播放音乐内容中心的音乐资源,你需要先调用该方法来创建一个音乐播放器。 ### 返回值 [#返回值] - 方法调用成功:返回 [MusicPlayer](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusicplayer) 对象。 - 方法调用失败:返回空指针。 ### 所属接口类 [#所属接口类] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## destroyMusicPlayer [#destroymusicplayer] 销毁音乐播放器对象。 ```dart Future destroyMusicPlayer(MusicPlayer musicPlayer); ``` 当你不再需要使用音乐播放器时,你可以调用该方法来销毁音乐播放器对象。销毁之后如果需要重新使用音乐播放器,需要调用 [createMusicPlayer](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_createmusicplayer) 重新创建一个音乐播放器对象。 ### 调用时机 [#调用时机] 该方法在加入频道前后均可调用,但请确保在 [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) 的 [release](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法前调用。 ### 参数 [#参数] [MusicPlayer](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusicplayer) 对象。 ### 返回值 [#返回值-1] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## get [#get] 获取音乐榜单的详细信息。 ```dart Future get(int index); ``` ### 参数 [#参数-1] [MusicChartInfo](/zh-CN/api-reference/rtc/flutter/class-musicchartinfo) 数组的索引。 ### 返回值 [#返回值-2] [MusicChartInfo](/zh-CN/api-reference/rtc/flutter/class-musicchartinfo),包含音乐榜单的详细信息。 ### 所属接口类 [#所属接口类-2] - [MusicChartCollection](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_musicchartcollection) ## getCaches [#getcaches] 获取已缓存的音乐资源信息。 ```dart Future> getCaches(int cacheInfoSize); ``` 调用该方法前,你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。如果你需要设置可缓存的音乐资源数量,可通过 [initialize](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_initialize_imusiccontentcenter) 的 `configuration` 来设置。 当你不再需要使用已缓存的音乐资源时,你需要及时释放内存以防止内存泄漏。 ### 参数 [#参数-2] 指定要获取的缓存音乐资源列表的长度。 ### 返回值 [#返回值-3] - 方法调用成功时,返回 [MusicCacheInfo](/zh-CN/api-reference/rtc/flutter/class-musiccacheinfo) 对象的列表。 - 方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getCount [#getcount] 获取本次请求的音乐榜单数量。 ```dart Future getCount(); ``` ### 返回值 [#返回值-4] 本次请求的音乐榜单数量。 ### 所属接口类 [#所属接口类-4] - [MusicChartCollection](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_musicchartcollection) ## getCount [#getcount-1] 获取本次请求的音乐数量。 ```dart int getCount(); ``` ### 返回值 [#返回值-5] 本次请求的音乐数量。 ### 所属接口类 [#所属接口类-5] - [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection) ## getInternalSongCode [#getinternalsongcode] 创建音乐资源的副歌片段编号。 ```dart Future getInternalSongCode( {required int songCode, required String jsonOption}); ``` ### 适用场景 [#适用场景] 当你需要播放某一音乐资源的副歌片段前,你需要调用此方法,通过 `jsonOption` 参数和该音乐资源的 `songCode` 来为该音乐资源的副歌片段创建一个编号,作为该资源的唯一标识。当你获取到该片段的编号后,在你调用相应方法打开、预加载、移除该资源时,将该内部歌曲编号传入 `songCode` 参数。 ### 参数 [#参数-3] 音乐资源编号,用于标识音乐资源。你可以通过调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_searchmusic) 方法来获取音乐资源,并通过由此触发的 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调获取音乐资源的编号(`songCode`)。 :::note 注: 声网会根据你在 `sceneType` 传入的应用场景进行收费。不同的应用场景对应不同的费率,你可以参考 [计费说明](/zh-CN/solutions/online-ktv/online-ktv-sdk/reference/billing) 查看详细的计费。如果需要切换到不同场景,需要重新调用此方法并传入 `sceneType` 的值。 ::: 扩展 JSON 字段,默认为 `null`。目前支持传入下列值: - sceneType:场景类型。1:直播场景,在线 K 歌房和背景音乐播放;2:直播场景,背景音乐播放;3:(默认)声动语聊场景,在线 K 歌房;4:声动语聊场景,背景音乐播放;5:VR 场景,在线 K 歌房和背景音乐播放。示例:`{"sceneType":1}`。 - highPart:副歌片段的索引,从 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调中获取,索引从 0 开始。示例:`{"format": {"highpart": 0}}`。 ### 返回值 [#返回值-6] - 方法调用成功,返回创建的音乐资源内部编号。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-6] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getLyric [#getlyric] 获取音乐资源的歌词下载地址。 ```dart Future getLyric({required int songCode, int lyricType = 0}); ``` 成功调用该方法后,SDK 会触发 [onLyricResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onlyricresult) 回调报告歌词的下载地址。 ### 参数 [#参数-4] 音乐资源的编号,用于标识音乐资源。 歌词类型: - 0:xml 格式。 - 1:lrc 格式。 ### 返回值 [#返回值-7] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-7] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getMusic [#getmusic] 获取当前页面列表中音乐资源的详细信息。 ```dart Music getMusic(int index); ``` ### 参数 [#参数-5] [Music](/zh-CN/api-reference/rtc/flutter/class-music) 数组的索引。 ### 返回值 [#返回值-8] 一个 [Music](/zh-CN/api-reference/rtc/flutter/class-music) 实例。 ### 所属接口类 [#所属接口类-8] - [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection) ## getMusicCharts [#getmusiccharts] 获取全部音乐榜单。 ```dart Future getMusicCharts(); ``` 当你调用该方法后,SDK 会触发 [onMusicChartsResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) 回调报告音乐榜单的详细信息。 ### 返回值 [#返回值-9] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-9] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getMusicCollectionByMusicChartId [#getmusiccollectionbymusicchartid] 通过音乐榜单的 ID 获取指定榜单的音乐资源列表。 ```dart Future getMusicCollectionByMusicChartId( {required int musicChartId, required int page, required int pageSize, String? jsonOption}); ``` 成功调用该方法后,SDK 会触发 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调报告榜单中音乐资源列表的详细信息。 ### 参数 [#参数-6] 音乐榜单的 ID,可以通过 [onMusicChartsResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) 回调获取。你也可以通过 RESTful API 来[获取曲库所有歌曲列表](/zh-CN/api-reference/online-ktv/android/ktv-scenario/api/music-content-center#获取曲库所有歌曲列表)或[获取增量歌曲列表](/zh-CN/api-reference/online-ktv/android/ktv-scenario/api/music-content-center#获取增量歌曲列表)。 当前页面编号,默认从 1 开始。 当前音乐资源列表的总页面数量,最大值为 50。 扩展 JSON 字段,默认为 `null`。你可以通过该字段来筛选出你需要的音乐资源,目前支持筛选可打分的音乐资源及音乐资源的副歌片段: - `pitchType`:音乐资源是否支持评分。 - `1`:可评分的音乐资源。 - `2`:不可评分的音乐资源。 - `needHighPart`:是否需要合唱片段资源。 - `YES`:需要合唱片段资源。 - `NO`:不需要合唱片段资源。 ### 返回值 [#返回值-10] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-10] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getMusicContentCenter [#getmusiccontentcenter] 获取 [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter)。 ```dart MusicContentCenter getMusicContentCenter() ``` ### 返回值 [#返回值-11] 一个 [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) 对象。 ### 所属接口类 [#所属接口类-11] - [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) ## getPage [#getpage] 获取音乐资源列表当前页的页码。 ```dart int getPage(); ``` ### 返回值 [#返回值-12] 当前页的页码。 ### 所属接口类 [#所属接口类-12] - [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection) ## getPageSize [#getpagesize] 获取 SDK 实际返回的音乐资源数量。 ```dart int getPageSize(); ``` ### 返回值 [#返回值-13] SDK 实际返回的音乐资源数量。 ### 所属接口类 [#所属接口类-13] - [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection) ## getSongSimpleInfo [#getsongsimpleinfo] 获取某一音乐资源的详细信息。 ```dart Future getSongSimpleInfo(int songCode); ``` 在调用该方法前,你需要先获取到对应的音乐资源的编号。你可以通过调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_searchmusic) 方法来获取音乐资源,并通过由此触发的 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调获取音乐资源的编号(`songCode`)。 当你调用该方法后,SDK 会触发 [onSongSimpleInfoResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onsongsimpleinforesult) 回调报告音乐资源的详细信息。 ### 参数 [#参数-7] 音乐资源的编号,用于标识音乐资源。 ### 返回值 [#返回值-14] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-14] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## getTotal [#gettotal] 获取列表内音乐资源的总数量。 ```dart int getTotal(); ``` ### 返回值 [#返回值-15] 列表内音乐资源的总数量。 ### 所属接口类 [#所属接口类-15] - [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection) ## initialize [#initialize] 初始化 [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter)。 ```dart Future initialize(MusicContentCenterConfiguration configuration); ``` 在调用 [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) 类下的其他方法前,你需要先调用该方法初始化 [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter)。 ### 参数 [#参数-8] [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) 的设置,详见 [MusicContentCenterConfiguration](/zh-CN/api-reference/rtc/flutter/class-musiccontentcenterconfiguration)。 ### 返回值 [#返回值-16] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-16] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## isPreloaded [#ispreloaded] 检测音乐资源是否已被预加载。 ```dart Future isPreloaded(int songCode); ``` 该方法为同步调用。如需预加载新的音乐资源,可调用 [preload](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_preload2)。 ### 参数 [#参数-9] 音乐资源的编号,用于标识一个音乐资源。 ### 返回值 [#返回值-17] - `true`:该音乐资源已被预加载。 - `false`:该音乐资源未被预加载。 ### 所属接口类 [#所属接口类-17] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## openWithSongCode [#openwithsongcode] 通过音乐资源编号打开音乐资源。 ```dart Future openWithSongCode({required int songCode, int startPos = 0}); ``` 在调用此方法之前,请确保需要播放的音乐资源已加载完成。你可以调用 [isPreloaded](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_ispreloaded) 方法来检测音乐资源是否已被预加载,或通过 [onPreLoadEvent](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调得知。 调用该方法后会触发 [onPlayerSourceStateChanged](/zh-CN/api-reference/rtc/flutter/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayersourcestatechanged) 回调。在收到报告播放状态为 `playerStateOpenCompleted` 后,你可以调用 [play](/zh-CN/api-reference/rtc/flutter/play/mediaplayer/mediaplayer-control#api_imediaplayer_play) 方法播放媒体文件。 :::note 注: 如果你想要打开的音乐资源受数字版权保护,则需要调用此方法打开。对于不受数字版权保护的音乐资源,你可以选择通过调用此方法或 [MediaPlayer](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imediaplayer) 类下的 [open](/zh-CN/api-reference/rtc/flutter/play/mediaplayer/mediaplayer-open#api_imediaplayer_open) 方法来打开。 ::: ### 参数 [#参数-10] 音乐资源的编号,用于标识音乐资源。 设置起始播放位置(毫秒),默认值为 0。 ### 返回值 [#返回值-18] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-18] - [MusicPlayer](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusicplayer) ## preload [#preload] 预加载音乐资源。 ```dart Future preload(int songCode); ``` 你可以调用该方法预先加载需要播放的音乐资源。成功调用该方法后,SDK 会触发 [onPreLoadEvent](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调报告预加载音乐资源的事件。 在调用该方法来预加载音乐资源之前,你需要调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 或 [searchMusic](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_searchmusic) 方法来获取你需要播放的音乐资源,并通过由此触发的 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调获取音乐资源的编号(`songCode`)。 :::note 注: 如需销毁 [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) 对象,请在收到 [onPreLoadEvent](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) 回调后,再调用 [release](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法。 ::: ### 参数 [#参数-11] 音乐资源的编号,用于标识音乐资源。 ### 返回值 [#返回值-19] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-19] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## registerEventHandler [#registereventhandler] 注册音乐内容中心回调事件。 ```dart void registerEventHandler(MusicContentCenterEventHandler eventHandler); ``` ### 参数 [#参数-12] 待注册的回调事件,详见 [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler)。 ### 返回值 [#返回值-20] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-20] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## release [#release] 释放音乐内容中心所占用的所有资源。 ```dart Future release(); ``` 该方法需要在 [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) 的 [release](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) 方法前调用。 ### 所属接口类 [#所属接口类-21] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## removeCache [#removecache] 删除已缓存的音乐资源。 ```dart Future removeCache(int songCode); ``` 你可以调用该方法删除某一已缓存的音乐资源,如需删除多个音乐资源,你可以多次调用该方法。 ### 参数 [#参数-13] 待删除的音乐资源的编号。 ### 返回值 [#返回值-21] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-22] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## renewToken [#renewtoken] 更新 Token。 ```dart Future renewToken(String token); ``` 当你用于鉴权的 Token 快要过期或已过期时,你可以调用该方法来传入新生成的 Token。 ### 参数 [#参数-14] 新的 Token。 ### 返回值 [#返回值-22] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-23] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## searchMusic [#searchmusic] 搜索音乐资源。 ```dart Future searchMusic( {required String keyWord, required int page, required int pageSize, String? jsonOption}); ``` 成功调用该方法后,SDK 会触发 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调报告检索到的音乐资源列表。 ### 参数 [#参数-15] 搜索关键词,支持歌曲名、歌手搜索。 想要获取的音乐资源列表的目标页编号。 每页所展示的音乐资源的最大数量,最大值为 50。 扩展 JSON 字段,默认为 `null`。你可以通过该字段来筛选出你需要的音乐资源,目前支持筛选可打分的音乐资源及音乐资源的副歌片段: - `pitchType`:音乐资源是否支持评分。 - `1`:可评分的音乐资源。 - `2`:不可评分的音乐资源。 - `needHighPart`:是否需要合唱片段资源。 - `YES`:需要合唱片段资源。 - `NO`:不需要合唱片段资源。 ### 返回值 [#返回值-23] 一个 `requestId`,为本次请求的唯一标识。 ### 所属接口类 [#所属接口类-24] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## setPlayMode [#setplaymode] 设置音乐资源的播放模式。 ```dart Future setPlayMode(MusicPlayMode mode); ``` 你可以调用该方法来设置启用原唱、伴奏或导唱。如不调用该方法进行设置,则默认播放伴奏;如果音乐资源没有伴奏,则播放原唱。 :::note 注: 你可以通过 [onMusicCollectionResult](/zh-CN/api-reference/rtc/flutter/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) 回调获取音乐资源的详细信息,并可通过其中的 `result` 参数得知需播放的版权音乐所支持的播放类型。 ::: ### 适用场景 [#适用场景-1] 在线 K 歌、秀场等娱乐场景下,如果你需要播放声网内容中心提供的版权音乐,你可以调用该方法来设置播放模式。 ### 调用时机 [#调用时机-1] 该方法需要在 [createMusicPlayer](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_createmusicplayer) 之后调用。 ### 参数 [#参数-16] 播放模式,详见 [MusicPlayMode](/zh-CN/api-reference/rtc/flutter/enum-musicplaymode)。 ### 返回值 [#返回值-24] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-25] - [MusicPlayer](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusicplayer) ## unregisterEventHandler [#unregistereventhandler] 取消注册音乐内容中心事件回调。 ```dart void unregisterEventHandler(); ``` ### 返回值 [#返回值-25] 方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-26] - [MusicContentCenter](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcenter) ## onLyricResult [#onlyricresult] 歌词下载地址回调。 ```dart final void Function(String requestId, int songCode, String lyricUrl, MusicContentCenterStateReason reason)? onLyricResult; ``` 当你调用 [getLyric](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getlyric) 获取指定歌曲的歌词下载地址后,SDK 会触发该回调。 ### 参数 [#参数-17] 请求 ID。本次请求的唯一标识。 音乐资源的编号,用于标识音乐资源。 歌词的下载地址。 音乐内容中心的请求状态码,详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/flutter/enum-musiccontentcenterstatereason)。 ### 所属接口类 [#所属接口类-27] - [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler) ## onMusicChartsResult [#onmusicchartsresult] 获取音乐榜单回调。 ```dart final void Function(String requestId, List result, MusicContentCenterStateReason reason)? onMusicChartsResult; ``` 当你调用 [getMusicCharts](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getmusiccharts) 方法获取全部音乐榜单之后,SDK 会触发该回调。 ### 参数 [#参数-18] 请求 ID。本次请求的唯一标识。 音乐内容中心的请求状态码,详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/flutter/enum-musiccontentcenterstatereason)。 当前可播放的音乐榜单列表。详见 [MusicChartInfo](/zh-CN/api-reference/rtc/flutter/class-musicchartinfo)。 ### 所属接口类 [#所属接口类-28] - [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler) ## onMusicCollectionResult [#onmusiccollectionresult] 获取音乐资源列表回调。 ```dart final void Function(String requestId, MusicCollection result, MusicContentCenterStateReason reason)? onMusicCollectionResult; ``` 当你调用 [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) 方法来获取指定榜单的音乐资源列表或调用 [searchMusic](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_searchmusic) 来搜索音乐资源时,SDK 会触发此回调报告榜单中音乐资源列表的详细信息。 ### 参数 [#参数-19] 请求 ID。本次请求的唯一标识。 音乐内容中心的请求状态码,详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/flutter/enum-musiccontentcenterstatereason)。 音乐资源列表的详细信息。详见 [MusicCollection](/zh-CN/api-reference/rtc/flutter/class-musiccollection)。 ### 所属接口类 [#所属接口类-29] - [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler) ## onPreLoadEvent [#onpreloadevent] 报告预加载音乐资源的事件。 ```dart final void Function( String requestId, int songCode, int percent, String lyricUrl, PreloadState state, MusicContentCenterStateReason reason)? onPreLoadEvent; ``` 当你调用 [preload](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_preload2) 方法预加载音乐资源后,SDK 会触发该回调。 ### 参数 [#参数-20] 请求 ID。本次请求的唯一标识。 音乐资源的编号,用于标识一个音乐资源。 音乐资源当前的加载进度,取值范围为 [0,100]。 歌词下载地址。 当前音乐资源的加载状态。详见 [PreloadState](/zh-CN/api-reference/rtc/flutter/enum-preloadstate)。 音乐内容中心的请求状态码,详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/flutter/enum-musiccontentcenterstatereason)。 ### 所属接口类 [#所属接口类-30] - [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler) ## onSongSimpleInfoResult [#onsongsimpleinforesult] 音乐资源的详细信息回调。 ```dart final void Function(String requestId, int songCode, String simpleInfo, MusicContentCenterStateReason reason)? onSongSimpleInfoResult; ``` 当你调用 [getSongSimpleInfo](/zh-CN/api-reference/rtc/flutter/play/drm#api_imusiccontentcenter_getsongsimpleinfo) 获取某一音乐资源的详细信息后,SDK 会触发该回调。 ### 参数 [#参数-21] 请求 ID。本次请求的唯一标识。 音乐资源的编号,用于标识音乐资源。 音乐资源的相关信息,包含下列内容: - 副歌片段的开始和结束的时间(ms) - 副歌片段的歌词下载地址 - 副歌片段时长(ms) - 歌曲名称 - 歌手名 音乐内容中心的请求状态码,详见 [MusicContentCenterStateReason](/zh-CN/api-reference/rtc/flutter/enum-musiccontentcenterstatereason)。 ### 所属接口类 [#所属接口类-31] - [MusicContentCenterEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_imusiccontentcentereventhandler)