Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoAudioEffectPlayer

Hierarchy

Index

Methods

Methods

Abstract emit

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

  • emit callback

    Parameters

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

    Returns any

Abstract getCurrentProgress

  • getCurrentProgress(audioEffectID: number): number

  • 获取当前播放进度。

    支持版本：1.16.0 及以上。 详情描述：获取指定音效的当前播放进度。单位为毫秒。 调用时机：必须在加载资源完成后才能调用，否则返回值为 0。 使用限制：无。 相关接口：[start]，[loadResource]。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns number

Abstract getIndex

  • getIndex(): number

  • 获取音效播放器索引。

    支持版本：1.16.0 及以上。 详情描述：获取音效播放器索引。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Returns number

    音效播放器索引。

Abstract getTotalDuration

  • getTotalDuration(audioEffectID: number): number

  • 获取指定音效资源的总长度。

    支持版本：1.16.0 及以上。 详情描述：获取指定音效资源的总长度，单位为毫秒。 调用时机：必须在加载资源完成后才能调用，否则返回值为 0。 使用限制：在 [createAudioEffectPlayer] 之后可调用。 相关接口：[start]，[loadResource]。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns number

    单位为毫秒。

Abstract loadResource

  • 加载音效资源。

    支持版本：1.16.0 及以上。 详情描述：加载音效资源。 业务场景：在频繁播放相同音效场景中，SDK 为了优化重复读文件并解码的性能，提供了预加载音效文件到内存中的功能。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：预加载支持最多同时加载 15 个音效文件，并且音效文件时长不能超过 30s，否则加载会报错。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • path: string

      音效资源路径，不能传入 null 或 ""。
      取值范围：目前仅支持播放本地文件，不支持 "assets://"、"ipod-library://" 和网络资源等。

    Returns Promise<ZegoAudioEffectPlayerLoadResourceResult>

    音效播放器加载资源完成的结果通知

Abstract off

  • off<AudioEffectPlayerEventType>(event: AudioEffectPlayerEventType, callback: undefined | ZegoAudioEffectPlayerListener[AudioEffectPlayerEventType]): any

  • unregister callback

    Type parameters

    Parameters

    • event: AudioEffectPlayerEventType
    • callback: undefined | ZegoAudioEffectPlayerListener[AudioEffectPlayerEventType]

    Returns any

Abstract on

  • on<AudioEffectPlayerEventType>(event: AudioEffectPlayerEventType, callback: ZegoAudioEffectPlayerListener[AudioEffectPlayerEventType]): any

  • register callback

    Type parameters

    Parameters

    • event: AudioEffectPlayerEventType
    • callback: ZegoAudioEffectPlayerListener[AudioEffectPlayerEventType]

    Returns any

Abstract pause

  • pause(audioEffectID: number): void

  • 暂停播放音效。

    支持版本：1.16.0 及以上。 详情描述：暂停播放指定的音效 [audioEffectID]。 调用时机：指定的 [audioEffectID] 已经 [start]。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns void

Abstract pauseAll

  • pauseAll(): void

  • 暂停播放所有音效。

    支持版本：1.16.0 及以上。 详情描述：暂停播放所有音效。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Returns void

Abstract resume

  • resume(audioEffectID: number): void

  • 恢复播放音效。

    支持版本：1.16.0 及以上。 详情描述：恢复播放指定的音效 [audioEffectID]。 调用时机：指定的 [audioEffectID] 处于 [pause] 状态。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns void

Abstract resumeAll

  • resumeAll(): void

  • 恢复播放所有音效。

    支持版本：1.16.0 及以上。 详情描述：恢复播放所有音效。 调用时机：在 [pauseAll] 之后可调用。 使用限制：无。

    Returns void

Abstract seekTo

  • 设置播放进度。

    支持版本：1.16.0 及以上。 详情描述：设置指定音效的播放进度，单位为毫秒。 调用时机：指定的 [audioEffectID] 已经 [start]，且还没有播完。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • millisecond: number

      指定的播放进度的时间点。

    Returns Promise<ZegoAudioEffectPlayerSeekToResult>

    音效播放器设置指定播放进度的结果通知

Abstract setPlaySpeed

  • setPlaySpeed(audioEffectID: number, speed: number): void

  • 设置指定音效的播放速度，会同时设置本地播放速度和推流速度（不支持单独设置）。

    支持版本：2.18.0 及以上。 详情描述：设置指定音效的播放速度，会同时设置本地播放速度和推流速度（不支持单独设置）。 调用时机：指定的 [audioEffectID] 已经 [start]。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • speed: number

      播放的倍速。
      取值范围：范围为 0.5 ~ 2.0。
      默认值：默认为 1.0。

    Returns void

Abstract setPlayVolume

  • setPlayVolume(audioEffectID: number, volume: number): void

  • 设置单个音效的本地播放音量。

    支持版本：3.11.0 及以上。 详情描述：设置指定音效的本地播放音量。 调用时机：指定的 [audioEffectID] 已经 [start]。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract setPlayVolumeAll

  • setPlayVolumeAll(volume: number): void

  • 设置所有音效的本地播放音量。

    支持版本：3.11.0 及以上。 详情描述：设置所有音效的本地播放音量。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Parameters

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract setPublishVolume

  • setPublishVolume(audioEffectID: number, volume: number): void

  • 设置单个音效的推流音量。

    支持版本：3.11.0 及以上。 详情描述：设置指定音效的推流音量。 调用时机：指定的 [audioEffectID] 已经 [start]。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract setPublishVolumeAll

  • setPublishVolumeAll(volume: number): void

  • 设置所有音效的推流音量。

    支持版本：3.11.0 及以上。 详情描述：设置所有音效的推流音量。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Parameters

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract setVolume

  • setVolume(audioEffectID: number, volume: number): void

  • 设置单个音效的播放音量，会同时设置本地播放音量和推流音量。

    支持版本：1.16.0 及以上。 详情描述：设置指定音效的播放音量，会同时设置本地播放音量和推流音量。 调用时机：指定的 [audioEffectID] 已经 [start]。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract setVolumeAll

  • setVolumeAll(volume: number): void

  • 设置所有音效的播放音量，会同时设置本地播放音量和推流音量。

    支持版本：1.16.0 及以上。 详情描述：设置所有音效的播放音量，会同时设置本地播放音量和推流音量。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Parameters

    • volume: number

      音量值。
      取值范围：范围为 0 ~ 200。
      默认值：默认为 100。

    Returns void

Abstract start

  • 开始播放音效。

    支持版本：1.16.0 及以上。 详情描述：开始播放音效，默认仅播放一次，且不会将音效混入推流中，如需修改请配置 [config] 参数。 业务场景：当需要播放简短的声音效果，比如鼓掌，欢呼声等时，可以使用该接口实现，进一步通过 [config] 参数配置播放次数，将音效混入推流中。 调用时机：在 [createAudioEffectPlayer] 之后可调用。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。SDK 内部使用 audioEffectID 进行音效的播放控制，SDK 不强制用户以固定形式的值传入该参数，最好保证每个音效可以有唯一的 ID，推荐的方式有静态自增 ID 和传入音效文件路径的 hash 两种方式。

    • Optional path: string

      音效资源的路径。
      取值范围：目前仅支持播放本地文件，不支持 "assets://"、"ipod-library://" 和网络资源等。如果之前使用 [loadResource] 预先加载了音效，可传入 null 或 ""。

    • Optional config: ZegoAudioEffectPlayConfig

      音效播放配置。
      默认值：传空则仅播放一次，且不会混音入推流中。

    Returns void

Abstract stop

  • stop(audioEffectID: number): void

  • 停止播放音效。

    支持版本：1.16.0 及以上。 详情描述：停止播放指定的音效 [audioEffectID]。 调用时机：指定的 [audioEffectID] 已经 [start] 。 使用限制：无。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns void

Abstract stopAll

  • stopAll(): void

  • 停止播放所有音效。

    支持版本：1.16.0 及以上。 详情描述：停止播放所有音效。 调用时机：正在播放音效。 使用限制：无。

    Returns void

Abstract unloadResource

  • unloadResource(audioEffectID: number): void

  • 卸载音效资源。

    支持版本：1.16.0 及以上。 详情描述：卸载指定音效的音效资源。 调用时机：在音效使用完毕之后，可以通过此函数释放相关资源；否则 SDK 将在 AudioEffectPlayer 实例销毁时释放加载的资源。 使用限制：无。 相关接口：[loadResource]。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    Returns void

Abstract updatePosition

  • updatePosition(audioEffectID: number, position: number[]): void

  • 更新音效播放器(音频源)位置。

    支持版本：3.6.0 及以上。 详情描述：更新音效播放器(音频源)位置。。 业务场景：音效播放器也需要有 3D 空间音效。 调用时机：监听[onAudioEffectPlayStateUpdate]回调，请在播放状态为ZegoAudioEffectPlayState.Playing之后ZegoAudioEffectPlayState.NoPlay/PlayEnded之前调用该接口。 使用限制：此接口需要与 RangeAudio/RangeScene 模块配合使用，RangeAudio/RangeScene 模块开启 3D 音效后，此接口才能调用成功。

    Parameters

    • audioEffectID: number

      音效资源的 ID。

    • position: number[]

      自身在世界坐标系中的坐标，参数是长度为 3 的 float 数组。

    Returns void

Generated using TypeDoc