MediaPlayer详解和使用

Android多媒体相关的API，网上基本都能找到很多相关的文章，使用起来也很简单，一直在犹豫要不要写这方面的内容，后来决定还是写一写，一方面算是一个归纳总结，另一方面，也方便以后查阅。这一篇就写一下MediaPlayer。

状态图详解

下图是一个MediaPlayer的生命周期和状态。其中，椭圆代表MediaPlayer可能驻留的状态，弧线表示MediaPlayer的播放控制操作。这里有两种类型的弧线，单箭头弧线代表同步方法调用，双箭头弧线代表异步方法调用。

1、新创建的MediaPlayer对象、或者调用了reset()方法的MediaPlayer对象，都处于Idle状态，这两种方法得到的对象，有一个微小但十分重要的差别。

处于Idle状态时，调用 getCurrentPosition(), getDuration(), getVideoHeight(), getVideoWidth(), setAudioStreamType(), setLooping(), setVolume(), pause(), start(), stop(), seekTo(), prepare(), prepareAsync()方法都会报错。新创建的MediaPlayer对象，调用以上方法，无法接收到注册的OnErrorListener.onError()回调；调用reset()方法的MediaPlayer对象可以接收到回调。

MediaPlayer不再被使用时，应立即调用release()方法来释放资源，资源可能包括硬件加速组件的单态固件，若没有调用release()方法可能会导致之后的MediaPlayer对象实例无法使用这种单态硬件资源，导致异常。

一旦MediaPlayer对象进入了End状态，将不能再被使用，也没有办法再迁移到其他状态。

2、由于种种原因，一些操作可能会失败，如不支持的格式/分辨率太高/流超时等，还有编程错误（比如在无效状态下调用某个操作），此时会回调OnErrorListener.onError()方法（需客户端提前注册listener）。一旦发生错误，MediaPlayer对象会进入Error状态，此时可以调用reset()方法把这个对象恢复到Idle状态。

在不合法的状态下调用一些方法，如prepare()、prepareAsync()和setDataSource()等会抛出ILlegalStateException异常。

3、Idle状态下，调用 setDataSource()方法会迁移到Initialized状态，非Idle状态下调用此方法会报 ILlegalStateException异常。注意，setDataSource()方法可能会抛出IOException异常。

4、调用prepare()、prepareAsync()方法可以迁移到Prepared状态，该状态下才可以进行基本播放操作。

异步的prepareAsync()方法需要通过OnPrepareListener.onPrepared()监听准备是否完成，Preparing是一个中间状态，如果在此状态下调用任何影响播放功能的方法，最终的运行结果都是未知的。

在不合适的状态下调用prepare()和prepareAsync()方法会抛出ILlegalStateException异常。

5、调用start()方法成功返回后，会迁移到Started状态，isPlaying()方法返回是否处于Started状态。迁移到Started状态时，可以通过OnBufferingUpdateListener.onBufferingUpdate()回调得知。

Started状态下调用start()方法没有影响。

6、调用pause()方法并返回时，会迁移到Paused状态。注意，Started与Paused状态的转换在内部的播放引擎中是异步的，所以isPlaying()可能会延时更新，如果是播放网络流媒体，这个延时可能会有几秒。

Paused状态下调用pause()方法没有影响。

7、除了Idle、Initialized状态，其它状态下都可以调用stop()迁移到Stopped状态，Stopped状态下调用stop()方法没有影响。

8、seekTo()方法可以调整播放位置，seekTo()方法是异步的，尤其是播放网络流媒体时延时很明显。实际定位完成后，通过OnSeekComplete.onSeekComplete()通知。

“活动状态”(Prepared、Started、Paused、PlaybackCompleted状态)下都可以调用seekTo()方法。

9、迁移到PlaybackCompleted状态后，如果通过setLooping()方法开启了循环模式，会重新进入到Started状态，并且不会回调OnCompletion.onCompletion()方法、如果没有开启循环，就会回调这个方法。

PlaybackCompleted状态下调用start()方法会迁移到Started状态。

各方法的调用状态

除了下面几个方法调用时需要特别注意状态的判断，其余常用方法，基本所有状态都是OK的，或者即便状态不对也不会报错。如果对某个方法调用有疑问，查阅API文档，下面只列出一些常用的、需要注意状态的方法。

下面这几个方法需要注意下：

1、setDataSource()
有效状态：Idle
调用结果：调用成功，会迁移到Initialized状态
无效状态：报IllegalStateException异常

2、prepare()、prepareAsync()
有效状态：Initialized/Stopped
调用结果：调用成功，会迁移到Prepared/Preparing状态
无效状态：报IllegalStateException异常

3、pause()
有效状态：Started/Paused
调用结果：调用成功，会迁移到Paused状态
无效状态：player进入Error状态

4、start()
有效状态：Prepared/Started/Paused/PlaybackCompleted
调用结果：调用成功，会迁移到Started状态
无效状态：player进入Error状态

5、stop()
有效状态：Prepared/Started/Stopped/Paused/PlaybackCompleted
调用结果：调用成功，会迁移到Stopped状态
无效状态：player进入Error状态

6、seekTo()
有效状态：Prepared/Started/Paused/PlaybackCompleted
调用结果：调用成功，不会改变player的状态
无效状态：player进入Error状态

使用demo

使用之前先整理一下大概要用到播放操作的方法，每个方法的有效状态是怎样。

大概要用到setDataSource()、prepare()、start()、pause()、seekTo()这5个方法，stop()方法一般不用，不播放的时候最好调release()释放资源。其中setDataSource()和prepare()基本就是初始化的时候连续调用，不太需要注意状态，所以剩下需要注意的也就start()、pause()和seekTo()这3个方法。

排除stop()方法和Stopped状态后，从“不可操作”到“可操作”的分界点就在Prepared状态，所以我们可以使用一个变量hasPrepared来标记是否可操作，start()和seekTo()方法在“可操作”状态下都是可以正常调用的。

剩下的就是pause()方法，只能在Started和Paused状态下调用，可以使用一个变量canPause来标记是否可以调用pause()方法。实际上，Prepared和PlaybackCompleted状态在程序中也基本是个瞬时状态，基本不会停留。一旦Prepared，程序就会调用start()方法进行播放；一旦PlaybackCompleted，就会进行下一个曲目的初始化、准备、播放。

那么下面就看一下使用方法吧：

public class MyPlayer implements MediaPlayer.OnPreparedListener, MediaPlayer.OnErrorListener, MediaPlayer.OnCompletionListener {
    private MediaPlayer mPlayer;
    private boolean hasPrepared;

    private void initIfNecessary() {
        if (null == mPlayer) {
            mPlayer = new MediaPlayer();
            mPlayer.setOnErrorListener(this);
            mPlayer.setOnCompletionListener(this);
            mPlayer.setOnPreparedListener(this);
        }
    }

    public void play(Context context, Uri dataSource) {
        hasPrepared = false; // 开始播放前讲Flag置为不可操作
        initIfNecessary(); // 如果是第一次播放/player已经释放了，就会重新创建、初始化
        try {
            mPlayer.reset();
            mPlayer.setDataSource(context, dataSource); // 设置曲目资源
            mPlayer.prepareAsync(); // 异步的准备方法
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public void start() {
        // release()会释放player、将player置空，所以这里需要判断一下
        if (null != mPlayer && hasPrepared) {
            mPlayer.start();
        }
    }

    public void pause() {
        if (null != mPlayer && hasPrepared) {
            mPlayer.pause();
        }
    }

    public void seekTo(int position) {
        if (null != mPlayer && hasPrepared) {
            mPlayer.seekTo(position);
        }
    }

    // 对于播放视频来说，通过设置SurfaceHolder来设置显示Surface。这个方法不需要判断状态、也不会改变player状态
    public void setDisplay(SurfaceHolder holder) {
        if (null != mPlayer) {
            mPlayer.setDisplay(holder);
        }
    }
    public void release() {
        hasPrepared = false;
        mPlayer.stop();
        mPlayer.release();
        mPlayer = null;
    }

    @Override
    public void onPrepared(MediaPlayer mp) {
        hasPrepared = true; // 准备完成后回调到这里
        start();
    }

    @Override
    public void onCompletion(MediaPlayer mp) {
        hasPrepared = false;
        // 通知调用处，调用play()方法进行下一个曲目的播放
    }

    @Override
    public boolean onError(MediaPlayer mp, int what, int extra) {
        hasPrepared = false;
        return false;
    }
}