MusicPlayer

所有已知实现类:

AbstractMusicPlayer, MediaMusicPlayer
```
public interface MusicPlayer
```
该接口定义了音乐播放器的基本功能，开发者可以通过实现该接口来创建一个自定义的音乐播放器。
关于如何实现自定义的音乐播放器，请参考 MusicPlayer 各方法的文档。文档对如何实现各方法的要求与限制进行了详细介绍。

另请参阅:

MediaMusicPlayer

嵌套类概要

嵌套类
限定符和类型	接口和说明
`static interface`	`MusicPlayer.OnBufferingUpdateListener` 用于监听音乐播放器的缓存进度。
`static interface`	`MusicPlayer.OnCompletionListener` 用于监听音乐播放器是否播放完毕。
`static interface`	`MusicPlayer.OnErrorListener` 用于监听器音乐播放的错误状态。
`static interface`	`MusicPlayer.OnPreparedListener` 用于监听音乐播放器是否准备完毕。
`static interface`	`MusicPlayer.OnRepeatListener` 用于监听播放的循环播放事件。
`static interface`	`MusicPlayer.OnSeekCompleteListener` 用于监听音乐播放器的播放进度是否调整完毕。
`static interface`	`MusicPlayer.OnStalledListener` 用于监听播放器的 stalled 状态。

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`dismissQuiet()` 从临时降低的音量中恢复原来的音量。
`int`	`getAudioSessionId()` 获取音频会话 ID。
`int`	`getDuration()` 获取当前音频文件的持续时间（单位：毫秒）。
`int`	`getProgress()` 获取当前的播放进度（单位：毫秒）。
`boolean`	`isInvalid()` 当前音乐播放器是否已失效（对于新创建的对象，该方法默认返回 false）。
`boolean`	`isLooping()` 判断是否循环播放（默认为 false）。
`boolean`	`isPlaying()` 判断播放器是否正在播放。
`boolean`	`isStalled()` 判断当前播放器是否处于 stalled 状态。
`void`	`pause()` 暂停播放。
`void`	`prepare()` 准备音乐播放器。
`void`	`quiet()` 临时降低音量。
`void`	`release()` 释放音乐播放器。
`void`	`seekTo(int pos)` 调整播放器的播放进度。
`void`	`setLooping(boolean looping)` 设置是否循环播放。
`void`	`setOnBufferingUpdateListener(MusicPlayer.OnBufferingUpdateListener listener)` 设置一个 `MusicPlayer.OnBufferingUpdateListener` 监听器。
`void`	`setOnCompletionListener(MusicPlayer.OnCompletionListener listener)` 设置一个 `MusicPlayer.OnCompletionListener` 监听器。
`void`	`setOnErrorListener(MusicPlayer.OnErrorListener listener)` 设置一个 `MusicPlayer.OnErrorListener` 监听器。
`void`	`setOnPreparedListener(MusicPlayer.OnPreparedListener listener)` 设置一个 `MusicPlayer.OnPreparedListener` 监听器。
`void`	`setOnRepeatListener(MusicPlayer.OnRepeatListener listener)` 设置一个 `MusicPlayer.OnRepeatListener` 监听器。
`void`	`setOnSeekCompleteListener(MusicPlayer.OnSeekCompleteListener listener)` 设置一个 `MusicPlayer.OnSeekCompleteListener` 监听器。
`void`	`setOnStalledListener(MusicPlayer.OnStalledListener listener)` 设置一个 `MusicPlayer.OnStalledListener` 监听器。
`void`	`setSpeed(float speed)` 设置音乐播放器的播放速度。
`void`	`setVolume(float leftVolume, float rightVolume)` 设置音量为当前音量的百分比，范围为 [0.0 ~ 1.0] 的闭区间。
`void`	`start()` 开始播放。
`void`	`stop()` 停止播放。

- 方法详细资料
  - prepare
```
void prepare()
      throws java.lang.Exception
```
    准备音乐播放器。
    该方法会在主线程上执行，如果准备操作是个耗时操作，你应该在异步线程中执行它。
    在实现该方法时，建议先检查 isInvalid() 状态，如果返回 true，说明当前 MusicPlayer 已失效，此时因立即从该方法中返回，不应该再调用任何方法。
    
    抛出:
    
    java.lang.Exception
  - setLooping
```
void setLooping(boolean looping)
```
    设置是否循环播放。
    如果播放器处于循环播放状态，则应返回 true，否则返回 false。对于新创建的 MusicPlayer 对象来说，该方法默认返回 false。
    
    参数:
    
    looping - 是否循环播放（默认返回 false）。
  - isLooping
```
boolean isLooping()
```
    判断是否循环播放（默认为 false）。
    
    返回:
    
    是否循环播放（默认为 false）。
  - isStalled
```
boolean isStalled()
```
    判断当前播放器是否处于 stalled 状态。
    stalled 状态用于表示当前缓冲区是否有足够的数据继续播放，如果缓冲区没有足够的数据支撑继续播放，则该方法会返回 true，如果缓冲区有足够的数据可以继续播放，则返回 false。
    
    返回:
    
    当前播放器是否处于 stalled 状态
  - isPlaying
```
boolean isPlaying()
```
    判断播放器是否正在播放。
    该方法的返回值只受 start()、pause()、stop()、发生错误或者 release() 的影响。调用 start() 方法后，该方法应该返回 true，并且只在调用 pause()、 stop()、播放器发生错误或者调用了 release() 方法时才返回 false。调用了 start() 方法后，即使缓冲区没有足够的数据支持继续播放，只要没有没有调用 pause()、stop()、发生错误或者调用 release() 方法，该方法就应该返回 true，即使当前缓冲区没有足够的数据，播放器正在缓冲。
    
    返回:
    
    播放器是否正在播放音乐
  - getDuration
```
int getDuration()
```
    获取当前音频文件的持续时间（单位：毫秒）。
    
    返回:
    
    当前音频文件的持续时间（单位：毫秒），如果持续时间未知，则返回 -1。
  - getProgress
```
int getProgress()
```
    获取当前的播放进度（单位：毫秒）。
    
    返回:
    
    返回当前的播放进度（单位：毫秒）
  - start
```
void start()
```
    开始播放。
  - pause
```
void pause()
```
    暂停播放。
  - stop
```
void stop()
```
    停止播放。
  - seekTo
```
void seekTo(int pos)
```
    调整播放器的播放进度。
    
    参数:
    
    pos - 要调整到的播放位置（单位：毫秒）
  - setVolume
```
void setVolume(float leftVolume,
               float rightVolume)
```
    设置音量为当前音量的百分比，范围为 [0.0 ~ 1.0] 的闭区间。
    如果你的播放器实现不打算支持单独分别设置左右声道的音量，则全部使用 leftVolume 参数的值即可。
    
    参数:
    
    leftVolume - 左声道的音量百分比（范围为 [0.0 ~ 1.0] 的闭区间）
    
    rightVolume - 右声道的音量百分比（范围为 [0.0 ~ 1.0] 的闭区间）
  - setSpeed
```
void setSpeed(float speed)
```
    设置音乐播放器的播放速度。
    
    参数:
    
    speed - 播放速度，最小值为 0.1。
  - quiet
```
void quiet()
```
    临时降低音量。
    音量应该降低到不足以影响到其他应用的音频清晰度，通常为当前音量的 0.2。
    
    另请参阅:
    
    dismissQuiet()
  - dismissQuiet
```
void dismissQuiet()
```
    从临时降低的音量中恢复原来的音量。
    
    另请参阅:
    
    quiet()
  - release
```
void release()
```
    释放音乐播放器。
    注意！一旦调用该方法，就不能再调用 MusicPlayer 对象的任何方法，否则会发生不可预见的错误。
    调用该方法后应该立即释放你的音乐播放器（释放占用的内存，断开网络连接）。此时 isInvalid() 方法应该返回 true，isPlaying() 方法与 isStalled() 方法应该返回 false。
  - isInvalid
```
boolean isInvalid()
```
    当前音乐播放器是否已失效（对于新创建的对象，该方法默认返回 false）。
    当播放器发生错误，或者调用 release() 方法后，该方法应该返回 true。如果该方法返回 true，则不应再调用除 release() 方法以外的任何其他方法。
    
    返回:
    
    返回 true 表示当前音乐播放器已失效，此时不应再调用除 release() 方法以外的任何其他方法
  - getAudioSessionId
```
int getAudioSessionId()
```
    获取音频会话 ID。如果失败，则返回 0。
    
    返回:
    
    音频会话 ID。如果失败，则返回 0。
  - setOnPreparedListener
```
void setOnPreparedListener(@Nullable
                           MusicPlayer.OnPreparedListener listener)
```
    设置一个 MusicPlayer.OnPreparedListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnCompletionListener
```
void setOnCompletionListener(@Nullable
                             MusicPlayer.OnCompletionListener listener)
```
    设置一个 MusicPlayer.OnCompletionListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnRepeatListener
```
void setOnRepeatListener(@Nullable
                         MusicPlayer.OnRepeatListener listener)
```
    设置一个 MusicPlayer.OnRepeatListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnSeekCompleteListener
```
void setOnSeekCompleteListener(@Nullable
                               MusicPlayer.OnSeekCompleteListener listener)
```
    设置一个 MusicPlayer.OnSeekCompleteListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnStalledListener
```
void setOnStalledListener(@Nullable
                          MusicPlayer.OnStalledListener listener)
```
    设置一个 MusicPlayer.OnStalledListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnBufferingUpdateListener
```
void setOnBufferingUpdateListener(@Nullable
                                  MusicPlayer.OnBufferingUpdateListener listener)
```
    设置一个 MusicPlayer.OnBufferingUpdateListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。
  - setOnErrorListener
```
void setOnErrorListener(@Nullable
                        MusicPlayer.OnErrorListener listener)
```
    设置一个 MusicPlayer.OnErrorListener 监听器。
    
    参数:
    
    listener - 监听器对象，可为 null。为 null 时将清除上次设置的监听器。

接口 MusicPlayer

嵌套类概要

方法概要

方法详细资料

prepare

setLooping

isLooping

isStalled

isPlaying

getDuration

getProgress

start

pause

stop

seekTo

setVolume

setSpeed

quiet

dismissQuiet

release

isInvalid

getAudioSessionId

setOnPreparedListener

setOnCompletionListener

setOnRepeatListener

setOnSeekCompleteListener

setOnStalledListener

setOnBufferingUpdateListener

setOnErrorListener