logo
控制台登录/注册
文档
客户端 API
服务端 API
实时音视频
Android: Java
功能总览
常用类
ZegoExpressEnginelink
IZegoEventHandlerlink
ZegoRealTimeSequentialDataManagerlink
ZegoMediaPlayerlink
ZegoAudioEffectPlayerlink
ZegoRangeAudiolink
全部分类
Class
Interface
Enum
当前页

ZegoCopyrightedMusic

ZegoCopyrightedMusic

Declared in ZegoCopyrightedMusic.java

方法

setEventHandler

setEventHandler
public void setEventHandler(IZegoCopyrightedMusicEventHandler handler)
设置版权音乐回调。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
handlerIZegoCopyrightedMusicEventHandler用于接收版权音乐回调的对象。

详情

设置版权音乐模块回调的接口，可接收歌曲播放状态相关回调通知。

  • 调用时机：在创建版权音乐 [createCopyrightedMusic] 之后。
  • 支持版本：2.13.0 及以上。

initCopyrightedMusic

initCopyrightedMusic
public void initCopyrightedMusic(ZegoCopyrightedMusicConfig config, IZegoCopyrightedMusicInitCallback callback)
初始化版权音乐模块。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicConfig版权音乐配置。
callbackIZegoCopyrightedMusicInitCallback初始化结果

详情

初始化版权音乐，以便后续使用版权音乐的功能。

  • 调用时机：在创建版权音乐 [createCopyrightedMusic] 和登录房间 [loginRoom] 之后。
  • 支持版本：2.13.0 及以上。
  • 注意事项：1. 必须传入真实用户信息，否则无法获取歌曲资源进行播放。2. 初始化版权音乐时设置的用户 ID 和用户名需要和登录房间时设置的用户 ID 和用户名一致。

getCacheSize

getCacheSize
public long getCacheSize()
获取缓存大小。
Declared in ZegoCopyrightedMusic.java

在使用本模块时，可能产生一些缓存文件，可以通过本接口获取缓存文件的大小。

  • 业务场景：用于展示 App 的缓存大小。
  • 调用时机：在创建版权音乐 [createCopyrightedMusic] 之后。
  • 支持版本：2.13.0 及以上。

缓存文件大小，单位 byte。

clearCache

clearCache
public void clearCache()
清除缓存。
Declared in ZegoCopyrightedMusic.java

在使用本模块时，可能产生一些缓存文件，可以通过本接口进行清除。

  • 业务场景：用于清除 App 的缓存。
  • 调用时机：在创建版权音乐 [createCopyrightedMusic] 之后。
  • 支持版本：2.13.0 及以上。

sendExtendedRequest

sendExtendedRequest
public void sendExtendedRequest(String command, String params, IZegoCopyrightedMusicSendExtendedRequestCallback callback)
发送扩展功能请求。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
commandString请求命令，具体支持的命令请参考 https://doc-zh.zego.im/article/15077
paramsString请求参数，每个请求命令具备对应的请求参数，请参考 https://doc-zh.zego.im/article/15077
callbackIZegoCopyrightedMusicSendExtendedRequestCallback发送扩展功能请求结果

详情

发送扩展功能请求，访问版权歌曲库获取相关歌单、榜单歌曲信息。

  • 业务场景：用于获取歌曲列表。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。

getLrcLyric

getLrcLyric
public void getLrcLyric(String songID, ZegoCopyrightedMusicVendorID vendorID, IZegoCopyrightedMusicGetLrcLyricCallback callback)
获取 lrc 格式歌词。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
songIDString歌曲或伴奏的 ID，一首歌的歌曲和伴奏共用同一个 ID。
vendorIDZegoCopyrightedMusicVendorID版权方。
callbackIZegoCopyrightedMusicGetLrcLyricCallback获取 lrc 格式歌词结果

详情

获取 lrc 格式歌词，支持逐行解析歌词。

  • 业务场景：用于逐行显示歌词。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：3.2.1 及以上。

getLrcLyric

getLrcLyric
public void getLrcLyric(ZegoCopyrightedMusicGetLyricConfig config, IZegoCopyrightedMusicGetLrcLyricCallback callback)
获取 lrc 格式歌词。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicGetLyricConfig获取歌词的配置。
callbackIZegoCopyrightedMusicGetLrcLyricCallback获取 lrc 格式歌词结果

详情

获取 lrc 格式歌词，支持逐行解析歌词。

  • 业务场景：用于逐行显示歌词。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：3.12.0 及以上。

getKrcLyricByToken

getKrcLyricByToken
public void getKrcLyricByToken(String krcToken, IZegoCopyrightedMusicGetKrcLyricByTokenCallback callback)
获取逐字歌词。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
krcTokenString通过调用 [requestResource] 点伴奏或点高潮片段、或调用 [getSharedResource] 接口获取分享资源时获取的 krcToken。详情请参考 https://doc-zh.zego.im/article/15079#2_2
callbackIZegoCopyrightedMusicGetKrcLyricByTokenCallback获取逐字格式歌词结果。

详情

获取逐字歌词，支持逐字解析歌词。

  • 业务场景：用于逐字显示歌词。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。

requestResource

requestResource
public void requestResource(ZegoCopyrightedMusicRequestConfig config, ZegoCopyrightedMusicResourceType type, IZegoCopyrightedMusicRequestResourceCallback callback)
获取音乐资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicRequestConfig获取音乐资源的配置。
typeZegoCopyrightedMusicResourceType版权音乐资源类型。
callbackIZegoCopyrightedMusicRequestResourceCallback获取音乐资源结果回调。

详情

可以获取到歌曲的基本信息（时长、歌名、歌手等），以及最重要的可以用于本地播放的资源 id，还有相关的一些鉴权信息。

  • 业务场景：获取版权歌曲，用于本地播放与分享。
  • 相关接口：房间内某个用户调用此接口获取某音乐资源成功后，房间内其他用户可以调用 [getSharedResource] 接口免费获取一次该音乐资源。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 之后。
  • 支持版本：3.0.2 及以上。
  • 注意事项： 1. 每个资源有唯一的资源 ID。 2. 每调用一次此接口，都会触发一次计费，详情请咨询 ZEGO 商务人员。 3. 调用本接口获取到的资源，具有时效性，有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

requestResource

requestResource
public void requestResource(ZegoCopyrightedMusicRequestConfigV2 config, IZegoCopyrightedMusicRequestResourceCallback callback)
获取音乐资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicRequestConfigV2获取音乐资源的配置。
callbackIZegoCopyrightedMusicRequestResourceCallback获取音乐资源结果回调。

详情

可以获取到歌曲的基本信息（时长、歌名、歌手等），以及最重要的可以用于本地播放的资源 id，还有相关的一些鉴权信息。

  • 业务场景：获取版权歌曲，用于本地播放与分享。
  • 相关接口：房间内某个用户调用此接口获取某音乐资源成功后，房间内其他用户可以调用 [getSharedResource] 接口免费获取一次该音乐资源。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 之后。
  • 支持版本：3.12.0 及以上。
  • 注意事项： 1. 每个资源有唯一的资源 ID。 2. 每调用一次此接口，都会触发一次计费，详情请咨询 ZEGO 商务人员。 3. 调用本接口获取到的资源，具有时效性，有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

getSharedResource

getSharedResource
public void getSharedResource(ZegoCopyrightedMusicGetSharedConfig config, ZegoCopyrightedMusicResourceType type, IZegoCopyrightedMusicGetSharedResourceCallback callback)
获取分享歌曲资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicGetSharedConfig获取分享歌曲资源的配置。
typeZegoCopyrightedMusicResourceType版权音乐资源类型。
callbackIZegoCopyrightedMusicGetSharedResourceCallback获取分享音乐资源结果回调。

详情

可以获取到歌曲的基本信息（时长、歌名、歌手等），以及最重要的可以用于本地播放的资源 id，还有相关的一些鉴权信息。

  • 业务场景：获取版权歌曲，用于本地播放。
  • 相关接口：房间内某个用户调用 [requestResource] 接口获取某音乐资源成功后，房间内其他用户可以调用此接口免费获取一次该音乐资源。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 之后。
  • 支持版本：3.0.2 及以上。
  • 注意事项：每个资源有唯一的资源 ID。调用本接口获取到的资源，具有时效性，有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

getSharedResource

getSharedResource
public void getSharedResource(ZegoCopyrightedMusicGetSharedConfigV2 config, IZegoCopyrightedMusicGetSharedResourceCallback callback)
获取分享歌曲资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicGetSharedConfigV2获取分享歌曲资源的配置。
callbackIZegoCopyrightedMusicGetSharedResourceCallback获取分享音乐资源结果回调。

详情

可以获取到歌曲的基本信息（时长、歌名、歌手等），以及最重要的可以用于本地播放的资源 id，还有相关的一些鉴权信息。

  • 业务场景：获取版权歌曲，用于本地播放。
  • 相关接口：房间内某个用户调用 [requestResource] 接口获取某音乐资源成功后，房间内其他用户可以调用此接口免费获取一次该音乐资源。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 之后。
  • 支持版本：3.12.0 及以上。
  • 注意事项：每个资源有唯一的资源 ID。调用本接口获取到的资源，具有时效性，有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

download

download
public void download(String resourceID, IZegoCopyrightedMusicDownloadCallback callback)
下载音乐资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString歌曲或伴奏对应的资源 ID。
callbackIZegoCopyrightedMusicDownloadCallback下载载歌曲或伴奏结果。

详情

下载音乐资源，下载成功后才能进行播放。

  • 业务场景：获取音乐资源授权后，利用本接口下载对应的资源。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
  • 注意事项：下载版权音乐资源受网络影响。

cancelDownload

cancelDownload
public void cancelDownload(String resourceID)
取消下载音乐资源。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString歌曲或伴奏对应的资源 ID。

详情

取消下载音乐资源。

  • 业务场景：当开始下载音乐资源后，利用本接口取消对应的下载任务。
  • 调用时机：在开始下载 [download] 之后。
  • 支持版本：3.11.0 及以上。
  • 注意事项：当传入有效的 resourceID 时, 只会取消未完成的下载任务, 当传入空字符串时, 取消所有未完成的下载任务。

queryCache

queryCache
public boolean queryCache(ZegoCopyrightedMusicQueryCacheConfig config)
查询资源是否有缓存。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicQueryCacheConfig查询资源缓存的配置。

详情

查询资源是否有缓存

  • 业务场景：可以用于在查询歌曲资源是否有缓存。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：3.9.0 及以上。

queryCache

queryCache
public boolean queryCache(ZegoCopyrightedMusicQueryCacheConfigV2 config)
查询资源是否有缓存。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicQueryCacheConfigV2查询资源缓存的配置。

详情

查询资源是否有缓存

  • 业务场景：可以用于在查询歌曲资源是否有缓存。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：3.12.0 及以上。

getDuration

getDuration
public long getDuration(String resourceID)
获取歌曲或伴奏文件的播放时长。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString歌曲或伴奏对应的资源 ID。

详情

获取歌曲或伴奏文件的播放时长。

  • 业务场景：可以用于在视图上显示歌曲或伴奏的播放时长信息。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。

setScoringLevel

setScoringLevel
public void setScoringLevel(int level)
设置打分难度级别。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
levelint打分难度级别。level 取值范围 0 ~ 4。打分难度由 0 到 4 逐级递减。

详情

用户可以通过该接口设置打分难度级别。

  • 调用时机：调用 [initCopyrightedMusic] 初始化版权音乐成功后，调用 [startScore] 开始打分前。
  • 默认值：未调用该函数时，打分难度级别默认是 4。
  • 支持版本：2.22.0 及以上。
  • 注意事项：该方法不支持动态设置，调用该方法成功后，下一次调用 [startScore] 生效。

startScore

startScore
public int startScore(String resourceID, int pitchValueInterval)
开始评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。
pitchValueIntervalint实时音高线回调的时间间隔, 单位毫秒，默认 50 毫秒。

详情

开始评分后，将会根据设置的回调时间间隔，收到评分结果 [OnCurrentPitchValueUpdate] 回调。

  • 业务场景：可以用于在视图上显示唱歌评分。
  • 调用时机：在获取到逐字歌词，并播放版权音乐的伴奏资源之后可调用。
  • 支持版本：2.15.0 及以上。
  • 注意事项：目前仅支持在推流开始 [startPublishingStream] 后，才能开始打分。

pauseScore

pauseScore
public int pauseScore(String resourceID)
暂停评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

暂停正在进行的评分，将停止 [OnCurrentPitchValueUpdate] 回调。

  • 业务场景：正在评分时可调用此接口暂停评分功能。
  • 调用时机：正在评分时可调用。
  • 支持版本：2.15.0 及以上。

resumeScore

resumeScore
public int resumeScore(String resourceID)
恢复评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

恢复当前暂停的评分。

  • 业务场景：当前有暂停的评分时可调用此接口恢复评分功能。
  • 调用时机：当前有暂停的评分时可调用。
  • 支持版本：2.15.0 及以上。

stopScore

stopScore
public int stopScore(String resourceID)
结束评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

结束当前评分，将停止 [OnCurrentPitchValueUpdate] 回调，但依然可以正常获取平均分或总分。

  • 业务场景：正在评分时可调用此接口结束评分。
  • 调用时机：正在评分时可调用。
  • 支持版本：2.15.0 及以上。

resetScore

resetScore
public int resetScore(String resourceID)
重置评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

重置已经进行过的评分，将停止 [OnCurrentPitchValueUpdate] 回调，获取平均分或总分将为 0。

  • 业务场景：常用于重唱同一首歌的场景。
  • 调用时机：已经进行过评分后可以调用。
  • 支持版本：2.15.0 及以上。

getPreviousScore

getPreviousScore
public int getPreviousScore(String resourceID)
获取上一句的评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

返回值是获取上一句的评分。

  • 业务场景：可以用于在视图上显示每一句的评分。
  • 调用时机：在播放版权伴奏或高潮片段，并开始打分后可调用。
  • 支持版本：2.15.0 及以上。

getAverageScore

getAverageScore
public int getAverageScore(String resourceID)
获取平均评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

获取平均评分。

  • 业务场景：可以用于在视图上显示平均评分。
  • 调用时机：在播放版权伴奏或高潮片段，并开始打分后可调用。
  • 支持版本：2.15.0 及以上。

getTotalScore

getTotalScore
public int getTotalScore(String resourceID)
获取总评分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

获取总评分。

  • 业务场景：可以用于在视图上显示总评分。
  • 调用时机：在播放版权伴奏或高潮片段，并开始打分后可调用。
  • 支持版本：2.15.0 及以上。

getFullScore

getFullScore
public int getFullScore(String resourceID)
获取满分。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。

详情

获取满分。

  • 业务场景：可以用于在视图上显示满分。
  • 调用时机：在播放版权伴奏或高潮片段，并开始打分后可调用。
  • 支持版本：3.0.2 及以上。

getStandardPitch

getStandardPitch
public void getStandardPitch(String resourceID, IZegoCopyrightedMusicGetStandardPitchCallback callback)
获取标准音高数据。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString伴奏或高潮片段对应的资源 ID。
callbackIZegoCopyrightedMusicGetStandardPitchCallback获取标准音高数据结果。

详情

获取标准音高数据。

  • 业务场景：可以用于在视图上显示标准音高线。
  • 支持版本：2.15.0 及以上。
  • 注意事项：只有伴奏或高潮片段资源才有音高线。

getCurrentPitch

getCurrentPitch
public int getCurrentPitch(String resourceID)
获取实时音高数据。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
resourceIDString歌曲或伴奏对应的资源 ID。

详情

获取实时音高数据。

  • 业务场景：可以用于在视图上显示实时音高线。
  • 调用时机：在播放版权伴奏或高潮片段，并开始打分后可调用。
  • 支持版本：2.15.0 及以上。

requestSong

requestSong
deprecated
public void requestSong(ZegoCopyrightedMusicRequestConfig config, IZegoCopyrightedMusicRequestSongCallback callback)
【已废弃】点歌。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicRequestConfig请求配置。
callbackIZegoCopyrightedMusicRequestSongCallback点歌结果

详情

点歌不仅可以获取到歌曲的基本信息（时长、歌名、歌手等），还可以用于本地播放的资源 ID 或用于分享给他人播放的 share_token，还有相关的一些鉴权信息。支持按次点歌方式。

  • 业务场景：获取版权歌曲，用于本地播放与分享。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
  • 注意事项：该接口会触发计费。一首歌曲可能存在普通、高清、无损三种音质，每种音质都有不同的资源文件，每个资源文件有唯一的资源 ID。
已废弃
此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。

requestAccompaniment

requestAccompaniment
deprecated
public void requestAccompaniment(ZegoCopyrightedMusicRequestConfig config, IZegoCopyrightedMusicRequestAccompanimentCallback callback)
【已废弃】点伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicRequestConfig请求配置。
callbackIZegoCopyrightedMusicRequestAccompanimentCallback点伴奏结果。

详情

可以获取 songID 对应歌曲的伴奏资源，包括 resource_id、krc_token、share_token 等。支持按次点伴奏方式。

  • 业务场景：获取版权歌曲伴奏，用于本地播放与分享。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
  • 注意事项：该接口会触发计费。
已废弃
此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。

requestAccompanimentClip

requestAccompanimentClip
deprecated
public void requestAccompanimentClip(ZegoCopyrightedMusicRequestConfig config, IZegoCopyrightedMusicRequestAccompanimentClipCallback callback)
【已废弃】点伴奏高潮片段。此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
configZegoCopyrightedMusicRequestConfig请求配置。
callbackIZegoCopyrightedMusicRequestAccompanimentClipCallback点伴奏高潮片段结果。

详情

可以获取 songID 对应歌曲的高潮片段资源，包括 resource_id、krc_token、share_token 等。支持按次点伴奏高潮片段方式。

  • 业务场景：获取版权歌曲伴奏高潮片段，用于本地播放与分享。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
  • 注意事项：该接口会触发计费。
已废弃
此函数在 3.0.2 版本及以上已废弃，请使用 [requestResource] 函数代替。

getMusicByToken

getMusicByToken
deprecated
public void getMusicByToken(String shareToken, IZegoCopyrightedMusicGetMusicByTokenCallback callback)
【已废弃】获取歌曲或伴奏。此函数在 3.0.2 版本及以上已废弃，请使用 [getSharedResource] 函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
shareTokenString访问一首歌曲或伴奏的对应授权 token。
callbackIZegoCopyrightedMusicGetMusicByTokenCallback获取歌曲或伴奏结果。

详情

通过他人分享的歌曲或伴奏 token，获取对应的一首歌曲或伴奏。

  • 业务场景：在线 KTV 场景中，合唱者收到主唱分享的歌曲或伴奏 token 后，通过本接口获取对应的一首歌曲或伴奏，然后在本端进行播放。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
已废弃
此函数在 3.0.2 版本及以上已废弃，请使用 [getSharedResource] 函数代替。

getLrcLyric

getLrcLyric
deprecated
public void getLrcLyric(String songID, IZegoCopyrightedMusicGetLrcLyricCallback callback)
【已废弃】获取 lrc 格式歌词。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
songIDString歌曲或伴奏的 ID，一首歌的歌曲和伴奏共用同一个 ID。
callbackIZegoCopyrightedMusicGetLrcLyricCallback获取 lrc 格式歌词结果

详情

获取 lrc 格式歌词，支持逐行解析歌词。

  • 业务场景：用于逐行显示歌词。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
已废弃
此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。

queryCache

queryCache
deprecated
public boolean queryCache(String songID, ZegoCopyrightedMusicType type)
【已废弃】查询资源是否有缓存。此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
songIDString歌曲或伴奏的 ID，一首歌的歌曲和伴奏共用同一个 ID。
typeZegoCopyrightedMusicType歌曲资源类型。

详情

查询资源是否有缓存。

  • 业务场景：可以用于在查询歌曲资源是否有缓存。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：2.13.0 及以上。
已废弃
此函数在 3.2.1 版本及以上已废弃，请使用带 [vendorID] 参数的同名函数代替。

queryCache

queryCache
deprecated
public boolean queryCache(String songID, ZegoCopyrightedMusicType type, ZegoCopyrightedMusicVendorID vendorID)
【已废弃】查询资源是否有缓存。此函数在 3.9.0 版本及以上已废弃，请使用带 [config] 参数的同名函数代替。
Declared in ZegoCopyrightedMusic.java

参数

名称类型描述
songIDString歌曲或伴奏的 ID，一首歌的歌曲和伴奏共用同一个 ID。
typeZegoCopyrightedMusicType歌曲资源类型。
vendorIDZegoCopyrightedMusicVendorID版权方。

详情

查询资源是否有缓存

  • 业务场景：可以用于在查询歌曲资源是否有缓存。
  • 调用时机：在初始化版权音乐 [initCopyrightedMusic] 成功之后。
  • 支持版本：3.2.1 及以上。
已废弃
此函数在 3.9.0 版本及以上已废弃，请使用带 [config] 参数的同名函数代替。

上一篇

zegocolorenhancementparams

下一篇

zegocopyrightedmusicconfig

当前页

返回到顶部