需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

版权音乐

  • HarmonyOS

更新时间不可用

createMusicPlayer

创建音乐播放器。

TypeScript
public abstract createMusicPlayer():IAgoraMusicPlayer

详情

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

返回值

  • 方法调用成功：返回 IAgoraMusicPlayer 对象。
  • 方法调用失败：返回空指针。

所属接口类

destroyMusicPlayer

销毁音乐播放器对象。

当你不再需要使用音乐播放器时，你可以调用该方法来销毁音乐播放器对象。销毁之后如果需要重新使用音乐播放器，需要调用 createMusicPlayer 重新创建一个音乐播放器对象。

调用时机

该方法在加入频道前后均可调用，但请确保在 RtcEngine 的 destroy 方法前调用。

调用限制

无。

参数

返回值

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

所属接口类

destroy

销毁 IAgoraMusicContentCenter 实例。

TypeScript
public static destroy():void
{
  RtcNapi.destroyMusicContentCenter()
}

详情

该方法需要在 RtcEngine 的 destroy 方法前调用。

所属接口类

getCaches

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

TypeScript
public abstract getCaches():MusicCacheInfo[]

详情

调用该方法前，你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。如果你需要设置可缓存的音乐资源数量，可通过 initialize 的 configuration 来设置。

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

返回值

  • 方法调用成功时，返回包含 MusicCacheInfo 对象的数组。
  • 方法调用失败时，返回 NULL。

所属接口类

getInternalSongCode

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

TypeScript
public abstract getInternalSongCode(songCode:bigint,jsonOption:string):bigint

自从

v4.2.2

适用场景

当你需要播放某一音乐资源的副歌片段前，你需要调用此方法，通过 jsonOption 参数和该音乐资源的 songCode 来为该音乐资源的副歌片段创建一个编号，作为该资源的唯一标识。当你获取到该片段的编号后，在你调用相应方法打开、预加载、移除该资源时，将该内部歌曲编号传入 songCode 参数。

参数

参数名描述
songCode

音乐资源编号，用于标识音乐资源。你可以通过调用 getMusicCollectionByMusicChartId 或 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\}\}
表格内容超出当前宽度，可横向滚动查看更多列。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

所属接口类

getLyric

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

TypeScript
public abstract getLyric(songCode:bigint,lyricType:number):string

详情

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

参数

参数名描述
songCode

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

lyricType

歌词类型：

  • 0：xml 格式。
  • 1：lrc 格式。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

所属接口类

getMusicCharts

获取全部音乐榜单。

TypeScript
public abstract getMusicCharts():string

详情

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

返回值

所属接口类

getMusicCollectionByMusicChartId

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

TypeScript
public abstract getMusicCollectionByMusicChartId(musicChartId:number,page:number,pageSize:number,jsonOption?:string):string

详情

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

参数

参数名描述
musicChartId

音乐榜单的 ID，可以通过 onMusicChartsResult 回调获取。你也可以通过 RESTful API 来获取曲库所有歌曲列表或获取增量歌曲列表。

page

当前页面编号，默认从 1 开始。

pageSize

当前音乐资源列表的总页面数量，最大值为 50。

jsonOption

扩展 JSON 字段，默认为 NULL。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：

Key 值Value 值示例
pitchType

是否支持打分：

  • 1：支持打分的音乐资源。
  • 2：不支持打分的音乐资源。
\{"pitchType":1\}
needHighPart

是否需要副歌片段资源：

  • true：需要副歌片段资源。
  • false：不需要副歌片段资源。
\{"needHighPart":true\}
表格内容超出当前宽度，可横向滚动查看更多列。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

一个 requestId，为本次请求的唯一标识。

所属接口类

getSongSimpleInfo

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

TypeScript
public abstract getSongSimpleInfo(songCode:bigint):string

详情

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

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

参数

参数名描述
songCode

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

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

所属接口类

initialize

初始化 IAgoraMusicContentCenter。

TypeScript
public abstract initialize(configuration:MusicContentCenterConfiguration):number

详情

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

参数

参数名描述
configuration

IAgoraMusicContentCenter 的设置，详见 MusicContentCenterConfiguration。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

所属接口类

isPreloaded

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

TypeScript
public abstract isPreloaded(songCode:bigint):number

详情

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

参数

参数名描述
songCode

音乐资源的编号，用于标识一个音乐资源。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功，该音乐资源已被预加载。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

preload

预加载音乐资源。

TypeScript
public abstract preload(songCode:bigint):string

详情

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

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

注意： 如需销毁 RtcEngine 对象，请在收到 onPreLoadEvent 回调后，再调用 destroy 方法。

参数

参数名描述
songCode

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

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

所属接口类

registerEventHandler

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

TypeScript
public abstract registerEventHandler(eventHandler:IMusicContentCenterEventHandler):number

详情

参数

待注册的回调事件，详见 IMusicContentCenterEventHandler。

返回值

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

所属接口类

release

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

TypeScript
public abstract release(): void;

详情

该方法需要在 RtcEngine 的 destroy 方法前调用。

所属接口类

removeCache

删除已缓存的音乐资源。

TypeScript
public abstract removeCache(songCode:bigint):number

详情

你可以调用该方法删除某一已缓存的音乐资源，如需删除多个音乐资源，你可以多次调用该方法。

注： 该方法不会删除正在播放中的已缓存音乐资源。

参数

参数名描述
songCode

待删除的音乐资源的编号。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功，音乐资源已删除。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

renewToken

更新 Token。

TypeScript
public abstract renewToken(token:string):number

详情

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

参数

参数名描述
token

新的 Token。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

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

所属接口类

searchMusic

搜索音乐资源。

TypeScript
public abstract searchMusic(keyword:string,page:number,pageSize:number,jsonOption?:string):string

详情

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

参数

参数名描述
keyword

搜索关键词，支持歌曲名、歌手搜索。

page

想要获取的音乐资源列表的目标页编号。

pageSize

每页所展示的音乐资源的最大数量，最大值为 50。

jsonOption

扩展 JSON 字段，默认为 NULL。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：

Key 值Value 值示例
pitchType

是否支持打分：

  • 1：支持打分的音乐资源。
  • 2：不支持打分的音乐资源。
\{"pitchType":1\}
needHighPart

是否需要副歌片段资源：

  • true：需要副歌片段资源。
  • false：不需要副歌片段资源。
\{"needHighPart":true\}
表格内容超出当前宽度，可横向滚动查看更多列。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

一个 requestId，为本次请求的唯一标识。

所属接口类

setPlayMode

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

TypeScript
abstract setPlayMode(mode:Constants.MusicPlayMode):number

你可以调用该方法来设置启用原唱、伴奏或导唱。如不调用该方法进行设置，则默认播放伴奏；如果音乐资源没有伴奏，则播放原唱。

注意： 你可以通过 onMusicCollectionResult 回调获取音乐资源的详细信息，并可通过其中的 参数得知需播放的版权音乐所支持的播放类型。

适用场景

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

调用时机

该方法需要在 createMusicPlayer 之后调用。

调用限制

无。

参数

参数名描述
mode

播放模式，详见 MusicPlayMode。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。

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

    • -2: 参数设置错误，请重新设置参数。

所属接口类

unregisterEventHandler

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

TypeScript
public abstract unregisterEventHandler():number

详情

返回值

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

所属接口类

onLyricResult

歌词下载地址回调。

TypeScript
onLyricResult?:(requestId:string,songCode:bigint,lyricUrl:string,reason:Constants.MusicContentCenterStateReason) => void

详情

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

参数

参数名描述
requestId

请求 ID。本次请求的唯一标识。

lyricUrl

歌词的下载地址。

reason

音乐内容中心的请求状态码，详见 MusicContentCenterStateReason。

表格内容超出当前宽度，可横向滚动查看更多列。

onMusicChartsResult

获取音乐榜单回调。

TypeScript
onMusicChartsResult?:(requestId:string,list:MusicChartInfo[],reason:Constants.MusicContentCenterStateReason) => void

详情

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

参数

参数名描述
requestId

请求 ID。本次请求的唯一标识。

reason

音乐内容中心的请求状态码，详见 MusicContentCenterStateReason。

list

当前可播放的音乐榜单列表。详见 MusicChartInfo。

表格内容超出当前宽度，可横向滚动查看更多列。

onMusicCollectionResult

获取音乐资源列表回调。

TypeScript
onMusicCollectionResult?:(requestId:string,page:number,pageSize:number,total:number,list:Music[],reason:Constants.MusicContentCenterStateReason) => void

详情

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

参数

参数名描述
requestId

请求 ID。本次请求的唯一标识。

reason

音乐内容中心的请求状态码，详见 MusicContentCenterStateReason。

page

当前页面编号，默认从 1 开始。

pageSize

每页所展示的音乐资源的最大数量，最大值为 50。

total

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

list

音乐资源列表的详细信息。详见 Music。

表格内容超出当前宽度，可横向滚动查看更多列。

onPreLoadEvent

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

TypeScript
onPreLoadEvent?:(requestId:string,songCode:bigint,percent:number,lyricUrl:string,state:number,reason:Constants.MusicContentCenterStateReason) => void

详情

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

参数

参数名描述
songCode

音乐资源的编号，用于标识一个音乐资源。

percent

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

lyricUrl

歌词下载地址。

state

当前音乐资源的加载状态：

  • 0：音乐资源加载完成。
  • 1：音乐资源加载失败。
  • 2：音乐资源正在加载中。
reason

音乐内容中心的请求状态码，详见 MusicContentCenterStateReason。

表格内容超出当前宽度，可横向滚动查看更多列。

onSongSimpleInfoResult

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

TypeScript
onSongSimpleInfoResult?:(requestId:string,songCode:bigint,simpleInfo:string,reason:Constants.MusicContentCenterStateReason) => void

详情

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

参数

参数名描述
requestId

请求 ID。本次请求的唯一标识。

songCode

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

simpleInfo

音乐资源的相关信息，包含下列内容：

  • 副歌片段的开始和结束的时间（ms）
  • 副歌片段的歌词下载地址
  • 副歌片段时长（ms）
  • 歌曲名称
  • 歌手名
reason

音乐内容中心的请求状态码，详见 MusicContentCenterStateReason。

表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利