Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

Abstract cancelDownload

  • cancelDownload(resourceID: string): void
  • 取消下载音乐资源。

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

    Parameters

    • resourceID: string

      歌曲或伴奏对应的资源 ID。

    Returns void

Abstract clearCache

  • clearCache(): void
  • 清除缓存。

    支持版本:2.13.0 及以上。 详情描述:在使用本模块时,可能产生一些缓存文件,可以通过本接口进行清除。 业务场景:用于清除 App 的缓存。 调用时机:在创建版权音乐 [createCopyrightedMusic] 之后。

    Returns void

Abstract download

  • 下载音乐资源。

    支持版本:2.13.0 及以上。 详情描述:下载音乐资源,下载成功后才能进行播放。 业务场景:获取音乐资源授权后,利用本接口下载对应的资源。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 成功之后。 注意事项:下载版权音乐资源受网络影响。

    Parameters

    • resourceID: string

      歌曲或伴奏对应的资源 ID。

    Returns Promise<ZegoCopyrightedMusicDownloadResult>

    下载载歌曲或伴奏结果。

Abstract emit

  • emit(eventName: string, ...args: any[]): any
  • emit callback

    Parameters

    • eventName: string
    • Rest ...args: any[]

    Returns any

Abstract getAverageScore

  • getAverageScore(resourceID: string): number
  • 获取平均评分。

    支持版本:2.15.0 及以上。 详情描述:获取平均评分。 业务场景:可以用于在视图上显示平均评分。 调用时机:在播放版权伴奏或高潮片段,并开始打分后可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    平均评分。

Abstract getCacheSize

  • getCacheSize(): number
  • 获取缓存大小。

    支持版本:2.13.0 及以上。 详情描述:在使用本模块时,可能产生一些缓存文件,可以通过本接口获取缓存文件的大小。 业务场景:用于展示 App 的缓存大小。 调用时机:在创建版权音乐 [createCopyrightedMusic] 之后。

    Returns number

    缓存文件大小,单位 byte。

Abstract getCurrentPitch

  • getCurrentPitch(resourceID: string): number
  • 获取实时音高数据。

    支持版本:2.15.0 及以上。 详情描述:获取实时音高数据。 业务场景:可以用于在视图上显示实时音高线。 调用时机:在播放版权伴奏或高潮片段,并开始打分后可调用。

    Parameters

    • resourceID: string

      歌曲或伴奏对应的资源 ID。

    Returns number

    实时音高数据。

Abstract getDuration

  • getDuration(resourceID: string): number
  • 获取歌曲或伴奏文件的播放时长。

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

    Parameters

    • resourceID: string

      歌曲或伴奏对应的资源 ID。

    Returns number

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

Abstract getFullScore

  • getFullScore(resourceID: string): number
  • 获取满分。

    支持版本:3.0.2 及以上。 详情描述:获取满分。 业务场景:可以用于在视图上显示满分。 调用时机:在播放版权伴奏或高潮片段,并开始打分后可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    满分。

Abstract getKrcLyricByToken

  • 获取逐字歌词。

    支持版本:2.13.0 及以上。 详情描述:获取逐字歌词,支持逐字解析歌词。 业务场景:用于逐字显示歌词。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 成功之后。

    Parameters

    • krcToken: string

      通过调用 [requestResource] 点伴奏或点高潮片段、或调用 [getSharedResource] 接口获取分享资源时获取的 krcToken。详情请参考 https://doc-zh.zego.im/article/15079#2_2

    Returns Promise<ZegoCopyrightedMusicGetKrcLyricByTokenResult>

    获取逐字格式歌词的结果。

Abstract getLrcLyric

  • 获取 lrc 格式歌词。

    支持版本:3.12.0 及以上。 详情描述:获取 lrc 格式歌词,支持逐行解析歌词。 业务场景:用于逐行显示歌词。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 成功之后。

    Parameters

    Returns Promise<ZegoCopyrightedMusicGetLrcLyricResult>

    获取 lrc 格式歌词完成回调。

Abstract getPreviousScore

  • getPreviousScore(resourceID: string): number
  • 获取上一句的评分。

    支持版本:2.15.0 及以上。 详情描述:返回值是获取上一句的评分。 业务场景:可以用于在视图上显示每一句的评分。 调用时机:在播放版权伴奏或高潮片段,并开始打分后可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    上一句的评分。

Abstract getSharedResource

  • 获取分享歌曲资源。

    支持版本:3.12.0 及以上。 详情描述:可以获取到歌曲的基本信息(时长、歌名、歌手等),以及最重要的可以用于本地播放的资源 id,还有相关的一些鉴权信息。 业务场景:获取版权歌曲,用于本地播放。 相关接口:房间内某个用户调用 [requestResource] 接口获取某音乐资源成功后,房间内其他用户可以调用此接口免费获取一次该音乐资源。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 之后。 注意事项:每个资源有唯一的资源 ID。调用本接口获取到的资源,具有时效性,有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

    Parameters

    Returns Promise<ZegoCopyrightedMusicGetSharedResourceResult>

    获取分享音乐资源结果。

Abstract getStandardPitch

  • 获取标准音高数据。

    支持版本:2.15.0 及以上。 详情描述:获取标准音高数据。 业务场景:可以用于在视图上显示标准音高线。 注意事项:只有伴奏或高潮片段资源才有音高线。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns Promise<ZegoCopyrightedMusicGetStandardPitchResult>

    获取标准音高数据结果。

Abstract getTotalScore

  • getTotalScore(resourceID: string): number
  • 获取总评分。

    支持版本:2.15.0 及以上。 详情描述:获取总评分。 业务场景:可以用于在视图上显示总评分。 调用时机:在播放版权伴奏或高潮片段,并开始打分后可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    总评分。

Abstract initCopyrightedMusic

  • 初始化版权音乐模块。

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

    Parameters

    Returns Promise<ZegoCopyrightedMusicInitResult>

    版权音乐模块初始化的结果。

Abstract off

  • off<CopyrightedMusicEventType>(event: CopyrightedMusicEventType, callback: undefined | ZegoCopyrightedMusicListener[CopyrightedMusicEventType]): any
  • unregister callback

    Type parameters

    Parameters

    • event: CopyrightedMusicEventType
    • callback: undefined | ZegoCopyrightedMusicListener[CopyrightedMusicEventType]

    Returns any

Abstract on

  • on<CopyrightedMusicEventType>(event: CopyrightedMusicEventType, callback: ZegoCopyrightedMusicListener[CopyrightedMusicEventType]): any
  • register callback

    Type parameters

    Parameters

    • event: CopyrightedMusicEventType
    • callback: ZegoCopyrightedMusicListener[CopyrightedMusicEventType]

    Returns any

Abstract pauseScore

  • pauseScore(resourceID: string): number
  • 暂停评分。

    支持版本:2.15.0 及以上。 详情描述:暂停正在进行的评分,将停止 [OnCurrentPitchValueUpdate] 回调。 业务场景:正在评分时可调用此接口暂停评分功能。 调用时机:正在评分时可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    错误码。参考 [ZegoErrorCode] 的值。

Abstract queryCache

  • 查询资源是否有缓存。

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

    Parameters

    Returns boolean

    资源缓存是否存在。

Abstract requestResource

  • 获取音乐资源。

    支持版本:3.12.0 及以上。 详情描述:可以获取到歌曲的基本信息(时长、歌名、歌手等),以及最重要的可以用于本地播放的资源 id,还有相关的一些鉴权信息。 业务场景:获取版权歌曲,用于本地播放与分享。 相关接口:房间内某个用户调用此接口获取某音乐资源成功后,房间内其他用户可以调用 [getSharedResource] 接口免费获取一次该音乐资源。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 之后。 注意事项:

    1. 每个资源有唯一的资源 ID。
    2. 每调用一次此接口,都会触发一次计费,详情请咨询 ZEGO 商务人员。
    3. 调用本接口获取到的资源,具有时效性,有效时长为 “SDK 初始化生命周期结束” 与 “24 小时资源有效期” 两者之间的最小值。

    Parameters

    Returns Promise<ZegoCopyrightedMusicRequestResourceResult>

    获取音乐资源结果。

Abstract resetScore

  • resetScore(resourceID: string): number
  • 重置评分。

    支持版本:2.15.0 及以上。 详情描述:重置已经进行过的评分,将停止 [OnCurrentPitchValueUpdate] 回调,获取平均分或总分将为 0。 业务场景:常用于重唱同一首歌的场景。 调用时机:已经进行过评分后可以调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    错误码。参考 [ZegoErrorCode] 的值。

Abstract resumeScore

  • resumeScore(resourceID: string): number
  • 恢复评分。

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

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    错误码。参考 [ZegoErrorCode] 的值。

Abstract sendExtendedRequest

  • 发送扩展功能请求。

    支持版本:2.13.0 及以上。 详情描述:发送扩展功能请求,访问版权歌曲库获取相关歌单、榜单歌曲信息。 业务场景:用于获取歌曲列表。 调用时机:在初始化版权音乐 [initCopyrightedMusic] 成功之后。

    Parameters

    Returns Promise<ZegoCopyrightedMusicSendExtendedRequestResult>

    发送扩展功能请求结果回调

Abstract setScoringLevel

  • setScoringLevel(level: number): void
  • 设置打分难度级别。

    支持版本:2.22.0 及以上。 详情描述:用户可以通过该接口设置打分难度级别。 调用时机:调用 [initCopyrightedMusic] 初始化版权音乐成功后,调用 [startScore] 开始打分前。 默认值:未调用该函数时,打分难度级别默认是 4。 注意事项:该方法不支持动态设置,调用该方法成功后,下一次调用 [startScore] 生效。

    Parameters

    • level: number

      打分难度级别。level 取值范围 0 ~ 4。打分难度由 0 到 4 逐级递减。

    Returns void

Abstract startScore

  • startScore(resourceID: string, pitchValueInterval: number): number
  • 开始评分。

    支持版本:2.15.0 及以上。 详情描述:开始评分后,将会根据设置的回调时间间隔,收到评分结果 [OnCurrentPitchValueUpdate] 回调。 业务场景:可以用于在视图上显示唱歌评分。 调用时机:在获取到逐字歌词,并播放版权音乐的伴奏资源之后可调用。 注意事项:目前仅支持在推流开始 [startPublishingStream] 后,才能开始打分。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    • pitchValueInterval: number

      实时音高线回调的时间间隔, 单位毫秒,默认 50 毫秒。

    Returns number

    错误码。参考 [ZegoErrorCode] 的值。

Abstract stopScore

  • stopScore(resourceID: string): number
  • 结束评分。

    支持版本:2.15.0 及以上。 详情描述:结束当前评分,将停止 [OnCurrentPitchValueUpdate] 回调,但依然可以正常获取平均分或总分。 业务场景:正在评分时可调用此接口结束评分。 调用时机:正在评分时可调用。

    Parameters

    • resourceID: string

      伴奏或高潮片段对应的资源 ID。

    Returns number

    错误码。参考 [ZegoErrorCode] 的值。

Generated using TypeDoc