版权音乐

CreateMusicPlayer

创建音乐播放器。

C#

public abstract IMusicPlayer CreateMusicPlayer();

详情

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

返回值

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

所属接口类

• IMusicContentCenter

DestroyMusicPlayer

销毁音乐播放器对象。

C#

public abstract int DestroyMusicPlayer(IMusicPlayer music_player);

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

调用时机

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

调用限制

无。

参数

music_player

IMusicPlayer 对象。

返回值

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

所属接口类

• IMusicContentCenter

GetCaches

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

C#

public abstract int GetCaches(ref MusicCacheInfo[] cacheInfo, ref Int32 cacheInfoSize);

详情

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

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

参数

cacheInfo

输出参数，指向用于存储已缓存音乐资源的内存缓冲区的指针。

cacheInfoSize

输入和输出参数。

• 输入值：cacheInfo 数组的长度，即你所分配的 MusicCacheInfo 结构体的数量。
• 输出值：方法执行完毕后输出的 MusicCacheInfo 结构体的数量。

返回值

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

所属接口类

• IMusicContentCenter

GetInternalSongCode

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

C#

public abstract int GetInternalSongCode(Int64 songCode, string jsonOption, ref Int64 internalSongCode);

适用场景

当你需要播放某一音乐资源的副歌片段前，你需要调用此方法，通过 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}}

internalSongCode

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

返回值

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

所属接口类

• IMusicContentCenter

GetLyric

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

C#

public abstract int GetLyric(ref string requestId, Int64 songCode, int LyricType = 0);

详情

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

参数

songCode

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

lyricType

歌词类型：

• 0：xml 格式。
• 1：lrc 格式。

requestId

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

返回值

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

所属接口类

• IMusicContentCenter

GetMusicCharts

获取全部音乐榜单。

C#

public abstract int GetMusicCharts(ref string requestId);

详情

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

参数

requestId

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

返回值

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

所属接口类

• IMusicContentCenter

GetMusicCollectionByMusicChartId

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

C#

public abstract int GetMusicCollectionByMusicChartId(ref string requestId, int musicChartType, int page, int pageSize, string jsonOption = "");

详情

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

参数

requestId

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

musicChartType

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

page

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

pageSize

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

jsonOption

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

Key 值	Value 值	示例
pitchType	是否支持打分： 1：支持打分的音乐资源。 2：不支持打分的音乐资源。	{"pitchType":1}
needHighPart	是否需要副歌片段资源： true：需要副歌片段资源。 false：不需要副歌片段资源。	{"needHighPart":true}

返回值

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

所属接口类

• IMusicContentCenter

GetMusicContentCenter

获取 IMusicContentCenter。

C#

public abstract IMusicContentCenter GetMusicContentCenter();

返回值

一个 IMusicContentCenter 对象。

所属接口类

• IRtcEngine

GetSongSimpleInfo

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

C#

public abstract int GetSongSimpleInfo(ref string requestId, Int64 songCode);

详情

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

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

参数

songCode

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

requestId

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

返回值

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

所属接口类

• IMusicContentCenter

Initialize

初始化 IMusicContentCenter。

C#

public abstract int Initialize(MusicContentCenterConfiguration configuration);

详情

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

参数

configuration

IMusicContentCenter 的设置，详见 MusicContentCenterConfiguration。

返回值

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

所属接口类

• IMusicContentCenter

IsPreloaded

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

C#

public abstract int IsPreloaded(Int64 songCode);

详情

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

参数

songCode

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

返回值

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

所属接口类

• IMusicContentCenter

Preload [1/2]

预加载音乐资源。

C#

public abstract int Preload(Int64 songCode, string jsonOption = "");

详情

废弃

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

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

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

注意

如需销毁 IRtcEngine 对象，请在收到 OnPreLoadEvent 回调后，再调用 Dispose 方法。

参数

songCode

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

jsonOption

扩展 JSON 字段。

声网会根据你在场景字段（sceneType）传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 计费说明 查看详细的计费。

• 1：直播场景：K 歌及背景音乐播放。
• 2：直播场景：背景音乐播放。
• 3：（默认）语聊场景：K 歌。
• 4：语聊场景：背景音乐播放。
• 5：VR 场景：K 歌及背景音乐播放。

如果需要切换到不同场景，需要重新调用此方法并在该字段中传入 sceneType 的值。

示例：{"sceneType":1}

返回值

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

所属接口类

• IMusicContentCenter

Preload [2/2]

预加载音乐资源。

C#

public abstract int Preload(ref string requestId, Int64 songCode);

详情

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

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

注意

如需销毁 IRtcEngine 对象，请在收到 OnPreLoadEvent 回调后，再调用 Dispose 方法。

参数

songCode

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

requestId

输出参数，请求 ID。本次请求的唯一标识。

返回值

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

所属接口类

• IMusicContentCenter

RegisterEventHandler

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

C#

public abstract int RegisterEventHandler(IMusicContentCenterEventHandler eventHandler);

详情

参数

eventHandler

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

返回值

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

所属接口类

• IMusicContentCenter

RemoveCache

删除已缓存的音乐资源。

C#

public abstract int RemoveCache(Int64 songCode);

详情

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

信息

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

参数

songCode

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

返回值

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

所属接口类

• IMusicContentCenter

RenewToken

更新 Token。

C#

public override int RenewToken(string token)
          {
              if (_rtcEngineInstance == null || _musicContentCenterImpl == null)
              {
                  return ErrorCode;
              }
              return _musicContentCenterImpl.RenewToken(token);
          }

详情

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

参数

token

新的 Token。

返回值

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

所属接口类

• IMusicContentCenter

SearchMusic

搜索音乐资源。

C#

public abstract int SearchMusic(ref string requestId, string keyWord, int page, int pageSize, string jsonOption = "");

详情

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

参数

keyword

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

page

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

pageSize

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

jsonOption

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

Key 值	Value 值	示例
pitchType	是否支持打分： 1：支持打分的音乐资源。 2：不支持打分的音乐资源。	{"pitchType":1}
needHighPart	是否需要副歌片段资源： true：需要副歌片段资源。 false：不需要副歌片段资源。	{"needHighPart":true}

requestId

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

返回值

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

所属接口类

• IMusicContentCenter

SetPlayMode

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

C#

public abstract int SetPlayMode(MusicPlayMode mode);

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

注意

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

适用场景

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

调用时机

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

调用限制

无。

参数

mode

播放模式，详见 MusicPlayMode。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -2: 参数设置错误，请重新设置参数。

所属接口类

• IMusicPlayer

UnregisterEventHandler

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

C#

public abstract int UnregisterEventHandler();

返回值

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

所属接口类

• IMusicContentCenter

OnLyricResult

歌词下载地址回调。

C#

public abstract void OnLyricResult(string requestId, long songCode, string lyricUrl, MusicContentCenterStateReason reason);

详情

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

参数

requestId

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

songCode

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

lyricUrl

歌词的下载地址。

reason

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

所属接口类

• IMusicContentCenterEventHandler

OnMusicChartsResult

获取音乐榜单回调。

C#

public abstract void OnMusicChartsResult(string requestId, MusicChartInfo[] result, MusicContentCenterStateReason reason);

详情

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

参数

requestId

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

reason

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

result

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

所属接口类

• IMusicContentCenterEventHandler

OnMusicCollectionResult

获取音乐资源列表回调。

C#

public abstract void OnMusicCollectionResult(string requestId, MusicCollection result, MusicContentCenterStateReason reason);

详情

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

参数

requestId

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

reason

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

result

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

所属接口类

• IMusicContentCenterEventHandler

OnPreLoadEvent

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

C#

public abstract void OnPreLoadEvent(string requestId, long songCode, int percent, string lyricUrl, PreloadState state, MusicContentCenterStateReason reason);

详情

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

参数

requestId

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

songCode

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

percent

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

lyricUrl

歌词下载地址。

state

当前音乐资源的加载状态。详见 PreloadState。

reason

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

所属接口类

• IMusicContentCenterEventHandler

OnSongSimpleInfoResult

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

C#

public abstract void OnSongSimpleInfoResult(string requestId, long songCode, string simpleInfo, MusicContentCenterStateReason reason);

详情

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

参数

requestId

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

songCode

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

simpleInfo

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

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

reason

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

所属接口类

• IMusicContentCenterEventHandler

Open

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

C#

public abstract int Open(Int64 songCode, Int64 startPos);

详情

信息

如果你想要打开的音乐资源受数字版权保护，则需要调用此方法打开。对于不受数字版权保护的音乐资源，你可以选择通过调用此方法或 IMediaPlayer 类下的 Open 方法来打开。

在调用此方法之前，请确保需要播放的音乐资源已加载完成。你可以调用 IsPreloaded 方法来检测音乐资源是否已被预加载，或通过 OnPreLoadEvent 回调得知。

调用该方法后会触发 OnPlayerSourceStateChanged 回调。在收到报告播放状态为 PLAYER_STATE_OPEN_COMPLETED 后，你可以调用 Play 方法播放媒体文件。

参数

songCode

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

startPos

设置起始播放位置（毫秒），默认值为 0。

返回值

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

所属接口类

• IMusicPlayer