Class ZegoAudioPlayer


  • public class ZegoAudioPlayer
    extends java.lang.Object
    音效播放器
    • Constructor Summary

      Constructors 
      Constructor Description
      ZegoAudioPlayer()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroyAudioPlayer()
      销毁音效播放器
      long getCurrentDuration​(int soundID)
      获取音效的当前进度
      long getDuration​(int soundID)
      获取音效的总时长
      void pauseAll()
      暂停全部音效
      void pauseEffect​(int soundID)
      暂停播放音效
      void playEffect​(android.net.Uri uri, int soundID, int loopCount, boolean publish)
      播放音效
      void playEffect​(java.lang.String path, int soundID, int loopCount, boolean publish)
      播放音效
      void preloadEffect​(android.net.Uri uri, int soundID)
      预加载音效
      void preloadEffect​(java.lang.String path, int soundID)
      预加载音效
      void resumeAll()
      恢复全部音效
      void resumeEffect​(int soundID)
      恢复播放音效
      int seekTo​(int soundID, long timestamp)
      设置进度
      void setCallback​(IZegoAudioPlayerCallback callback)
      设置音效播放器的回调
      void setPlaySpeed​(int soundID, float speed)
      设置指定音效的播放速度
      void setPlayVolume​(int soundID, int volume)
      设置单个音效的本地播放音量
      void setPlayVolumeAll​(int volume)
      设置所有音效的本地播放音量
      void setPublishVolume​(int soundID, int volume)
      设置单个音效的推流音量
      void setPublishVolumeAll​(int volume)
      设置所有音效的推流音量
      void setVolume​(int soundID, int volume)
      设置单个音效的本地播放音量, 如果该音效 ID 设置了推流模式, 也会设置推流音量
      void setVolumeAll​(int volume)
      设置所有音效的本地播放音量, 如果音效 ID 设置了推流模式, 也会设置推流音量
      void stopAll()
      停止全部音效
      void stopEffect​(int soundID)
      停止播放音效
      void unloadEffect​(int soundID)
      删除预加载音效
      void updatePosition​(int soundID, float[] position)
      更新音效播放器(音频源)位置
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ZegoAudioPlayer

        public ZegoAudioPlayer()
    • Method Detail

      • destroyAudioPlayer

        public void destroyAudioPlayer()
        销毁音效播放器
      • setCallback

        public void setCallback​(IZegoAudioPlayerCallback callback)
        设置音效播放器的回调
        Parameters:
        callback - 参考 { com.zego.zegoavkit2.audioplayer.IZegoAudioPlayerCallback }
      • playEffect

        public void playEffect​(java.lang.String path,
                               int soundID,
                               int loopCount,
                               boolean publish)
        播放音效

        注意: 如果是播放预加载的音效,指定音效 ID, 音效资源文件填空

        Parameters:
        path - 音效资源文件的本地路径
        soundID - 音效 ID
        loopCount - 循环次数
        publish - 是否放入推流中
      • playEffect

        public void playEffect​(android.net.Uri uri,
                               int soundID,
                               int loopCount,
                               boolean publish)
        播放音效

        注意: 如果是播放预加载的音效,指定音效 ID, 音效资源文件填空

        Parameters:
        uri - 音效资源文件 uri
        soundID - 音效 ID
        loopCount - 循环次数
        publish - 是否放入推流中
      • stopEffect

        public void stopEffect​(int soundID)
        停止播放音效
        Parameters:
        soundID - 音效 ID
      • pauseEffect

        public void pauseEffect​(int soundID)
        暂停播放音效
        Parameters:
        soundID - 音效 ID
      • resumeEffect

        public void resumeEffect​(int soundID)
        恢复播放音效
        Parameters:
        soundID - 音效 ID
      • setVolume

        public void setVolume​(int soundID,
                              int volume)
        设置单个音效的本地播放音量, 如果该音效 ID 设置了推流模式, 也会设置推流音量
        Parameters:
        soundID - 音效 ID
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在调用 playEffect 后调用此接口

      • setPublishVolume

        public void setPublishVolume​(int soundID,
                                     int volume)
        设置单个音效的推流音量
        Parameters:
        soundID - 音效 ID
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在调用 playEffect 后调用此接口

      • setPlayVolume

        public void setPlayVolume​(int soundID,
                                  int volume)
        设置单个音效的本地播放音量
        Parameters:
        soundID - 音效 ID
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在调用 playEffect 后调用此接口

      • setVolumeAll

        public void setVolumeAll​(int volume)
        设置所有音效的本地播放音量, 如果音效 ID 设置了推流模式, 也会设置推流音量
        Parameters:
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在 ZegoAudioPlayer 创建后调用此接口

      • setPublishVolumeAll

        public void setPublishVolumeAll​(int volume)
        设置所有音效的推流音量
        Parameters:
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在 ZegoAudioPlayer 创建后调用此接口

      • setPlayVolumeAll

        public void setPlayVolumeAll​(int volume)
        设置所有音效的本地播放音量
        Parameters:
        volume - 音量,取值范围[0, 200],默认 100

        注意: 请在 ZegoAudioPlayer 创建后调用此接口

      • setPlaySpeed

        public void setPlaySpeed​(int soundID,
                                 float speed)
        设置指定音效的播放速度
        Parameters:
        soundID - 音效 ID
        speed - 倍速,取值范围[0.5, 2.0],默认 1.0
      • pauseAll

        public void pauseAll()
        暂停全部音效
      • resumeAll

        public void resumeAll()
        恢复全部音效
      • stopAll

        public void stopAll()
        停止全部音效
      • preloadEffect

        public void preloadEffect​(java.lang.String path,
                                  int soundID)
        预加载音效
        Parameters:
        path - 音效资源文件的本地路径
        soundID - 音效 ID
      • preloadEffect

        public void preloadEffect​(android.net.Uri uri,
                                  int soundID)
        预加载音效
        Parameters:
        uri - 音效资源文件 uri
        soundID - 音效 ID
      • unloadEffect

        public void unloadEffect​(int soundID)
        删除预加载音效
        Parameters:
        soundID - 音效 ID
      • seekTo

        public int seekTo​(int soundID,
                          long timestamp)
        设置进度
        Parameters:
        soundID - 音效 ID
        timestamp - 进度
        Returns:
        返回 0 表示成功, 返回 -1 表示失败
      • getDuration

        public long getDuration​(int soundID)
        获取音效的总时长
        Parameters:
        soundID - 音效 ID
        Returns:
        返回音效的总时长, 返回 0 表示失败
      • getCurrentDuration

        public long getCurrentDuration​(int soundID)
        获取音效的当前进度
        Parameters:
        soundID - 音效 ID
        Returns:
        返回音效的当前进度, 返回 -1 表示失败
      • updatePosition

        public void updatePosition​(int soundID,
                                   float[] position)
        更新音效播放器(音频源)位置
        Parameters:
        soundID - 音效 ID
        position - 用户的三维空间坐标

        注意:
        1. 此接口需要与 RangeAudio/RangeScene 模块配合使用,RangeAudio/RangeScene 模块开启 3D 音效后,此接口才能调用成功。
        2. 此接口需要在收到 OnPlayEffect 回调后调用。