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

ZegoAudioEffectPlayer

ZegoAudioEffectPlayer

Declared in ZegoAudioEffectPlayer.java

方法

setEventHandler

setEventHandler
public void setEventHandler(IZegoAudioEffectPlayerEventHandler handler)
设置音效播放器回调。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
handlerIZegoAudioEffectPlayerEventHandler音效播放器回调。

详情

设置音效播放器回调。

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 相关接口：[createAudioEffectPlayer]。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

start

start
public void start(int audioEffectID, String path, ZegoAudioEffectPlayConfig config)
开始播放音效。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。SDK 内部使用 audioEffectID 进行音效的播放控制，SDK 不强制用户以固定形式的值传入该参数，最好保证每个音效可以有唯一的 ID，推荐的方式有静态自增 ID 和传入音效文件路径的 hash 两种方式。
pathString音效资源的路径。<br>取值范围：目前仅支持播放本地文件，不支持 "assets://"、"ipod-library://" 和网络资源等。如果之前使用 [loadResource] 预先加载了音效，可传入 null 或 ""。
configZegoAudioEffectPlayConfig音效播放配置。<br>默认值：传空则仅播放一次，且不会混音入推流中。

详情

开始播放音效，默认仅播放一次，且不会将音效混入推流中，如需修改请配置 [config] 参数。

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

stop

stop
public void stop(int audioEffectID)
停止播放音效。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

停止播放指定的音效 [audioEffectID]。

  • 调用时机：指定的 [audioEffectID] 已经 [start] 。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

pause

pause
public void pause(int audioEffectID)
暂停播放音效。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

暂停播放指定的音效 [audioEffectID]。

  • 调用时机：指定的 [audioEffectID] 已经 [start]。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

resume

resume
public void resume(int audioEffectID)
恢复播放音效。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

恢复播放指定的音效 [audioEffectID]。

  • 调用时机：指定的 [audioEffectID] 处于 [pause] 状态。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

stopAll

stopAll
public void stopAll()
停止播放所有音效。
Declared in ZegoAudioEffectPlayer.java

停止播放所有音效。

  • 调用时机：正在播放音效。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

pauseAll

pauseAll
public void pauseAll()
暂停播放所有音效。
Declared in ZegoAudioEffectPlayer.java

暂停播放所有音效。

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

resumeAll

resumeAll
public void resumeAll()
恢复播放所有音效。
Declared in ZegoAudioEffectPlayer.java

恢复播放所有音效。

  • 调用时机：在 [pauseAll] 之后可调用。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

seekTo

seekTo
public void seekTo(int audioEffectID, long millisecond, IZegoAudioEffectPlayerSeekToCallback callback)
设置播放进度。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
millisecondlong指定的播放进度的时间点。
callbackIZegoAudioEffectPlayerSeekToCallback指定播放进度结果。

详情

设置指定音效的播放进度，单位为毫秒。

  • 调用时机：指定的 [audioEffectID] 已经 [start]，且还没有播完。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

setVolume

setVolume
public void setVolume(int audioEffectID, int volume)
设置单个音效的播放音量，会同时设置本地播放音量和推流音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

设置指定音效的播放音量，会同时设置本地播放音量和推流音量。

  • 调用时机：指定的 [audioEffectID] 已经 [start]。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

setPlayVolume

setPlayVolume
public void setPlayVolume(int audioEffectID, int volume)
设置单个音效的本地播放音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

设置指定音效的本地播放音量。

  • 调用时机：指定的 [audioEffectID] 已经 [start]。
  • 支持版本：3.11.0 及以上。
  • 使用限制：无。

setPublishVolume

setPublishVolume
public void setPublishVolume(int audioEffectID, int volume)
设置单个音效的推流音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

设置指定音效的推流音量。

  • 调用时机：指定的 [audioEffectID] 已经 [start]。
  • 支持版本：3.11.0 及以上。
  • 使用限制：无。

setVolumeAll

setVolumeAll
public void setVolumeAll(int volume)
设置所有音效的播放音量，会同时设置本地播放音量和推流音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

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

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

setPlayVolumeAll

setPlayVolumeAll
public void setPlayVolumeAll(int volume)
设置所有音效的本地播放音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

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

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 支持版本：3.11.0 及以上。
  • 使用限制：无。

setPublishVolumeAll

setPublishVolumeAll
public void setPublishVolumeAll(int volume)
设置所有音效的推流音量。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
volumeint音量值。<br>取值范围：范围为 0 ~ 200。 <br>默认值：默认为 100。

详情

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

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 支持版本：3.11.0 及以上。
  • 使用限制：无。

setPlaySpeed

setPlaySpeed
public void setPlaySpeed(int audioEffectID, float speed)
设置指定音效的播放速度，会同时设置本地播放速度和推流速度（不支持单独设置）。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
speedfloat播放的倍速。<br>取值范围：范围为 0.5 ~ 2.0。 <br>默认值：默认为 1.0。

详情

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

  • 调用时机：指定的 [audioEffectID] 已经 [start]。
  • 支持版本：2.18.0 及以上。
  • 使用限制：无。

getTotalDuration

getTotalDuration
public long getTotalDuration(int audioEffectID)
获取指定音效资源的总长度。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

获取指定音效资源的总长度，单位为毫秒。

  • 调用时机：必须在加载资源完成后才能调用，否则返回值为 0。
  • 相关接口：[start]，[loadResource]。
  • 支持版本：1.16.0 及以上。
  • 使用限制：在 [createAudioEffectPlayer] 之后可调用。

返回值

单位为毫秒。

getCurrentProgress

getCurrentProgress
public long getCurrentProgress(int audioEffectID)
获取当前播放进度。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

获取指定音效的当前播放进度。单位为毫秒。

  • 调用时机：必须在加载资源完成后才能调用，否则返回值为 0。
  • 相关接口：[start]，[loadResource]。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

loadResource

loadResource
public void loadResource(int audioEffectID, String path, IZegoAudioEffectPlayerLoadResourceCallback callback)
加载音效资源。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
pathString音效资源路径，不能传入 nil 或 ""。<br>取值范围：目前仅支持播放本地文件，不支持 "assets://"、"ipod-library://" 和网络资源等。
callbackIZegoAudioEffectPlayerLoadResourceCallback加载音效资源结果回调。

详情

在频繁播放相同音效场景中，SDK 为了优化重复读文件并解码的性能，提供了预加载音效文件到内存中的功能。预加载支持最多同时加载 15 个音效文件，并且音效文件时长不能超过 30s，否则加载会报错 Android 开发者可通过 Uri 方式进行传参，即：String path = uri.toString();

unloadResource

unloadResource
public void unloadResource(int audioEffectID)
卸载音效资源。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。

详情

卸载指定音效的音效资源。

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

updatePosition

updatePosition
public void updatePosition(int audioEffectID, float[] position)
更新音效播放器(音频源)位置。
Declared in ZegoAudioEffectPlayer.java

参数

名称类型描述
audioEffectIDint音效资源的 ID。
positionfloat[]自身在世界坐标系中的坐标，参数是长度为 3 的 float 数组。

详情

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

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

getIndex

getIndex
public int getIndex()
获取音效播放器索引。
Declared in ZegoAudioEffectPlayer.java

获取音效播放器索引。

  • 调用时机：在 [createAudioEffectPlayer] 之后可调用。
  • 支持版本：1.16.0 及以上。
  • 使用限制：无。

音效播放器索引。

上一篇

zegoaudioeffectplayconfig

下一篇

zegoaudioframeparam

当前页

返回到顶部