Android用(ちょっと)本格的なミュージックプレーヤの開発 part7

9th Dec 2016

２年以上前に公開した Android用(ちょっと)本格的なミュージックプレーヤの開発シリーズですが、メール、コメントなどで今でも質問を頂き、音を出す部分に関しても需要がありそうなので時間がかかりそうですがここにひっそりと更新していきます。

ミュージックプレーヤで音を出すには1

Androidで音を鳴らしたい場合基本的には　Android MediaPlayerクラスを使用します。かなり多機能なので再生に関してはこのクラスを全面的に使用すればいいのですが、

画像出典・参考

このMediaPlayer、一種の有限ステートマシンになっています。この状態を正しく管理してやることが必要です。通常ゲームなどで mp3 をBGMとしてかけるだけなら基本の"型"どおりのコードを貼り付けておけばよいのですが (ちょっと)本格的なプレーヤではもう少しデリケートに扱う必要があります。

ミュージックプレーヤで音を出すには2

もう１つ重要なのが、MediaPlayerを管理する場所です。ゲームなどで音を鳴らすなら　Activity 配下のクラスで適当に音を鳴らせばいいのですが、(ちょっと)本格的なプレーヤではそうはいきません。

ミュージックプレーヤでは、通常 part1〜6で作成したようなライブラリから再生する曲を選択したあとは、基本的に画面(アクティビティ)は閉じて、他のアプリの裏で再生したり、ウィジェットや通知領域からの操作も受け付ける必要があります。

よって、MediaPlayerの管理はActivityではなく、 Service で行う必要があります。サービスで MediaPlayer を管理しておいてアクティビティやウィジェットからそのサービスに接続、リモートでコマンドやリクエストを送信して、サービス側でこれを受け取って各種操作を行ったり、現在再生中のトラックの情報やアルバムアートをアクティビティ側に送信し返したり　という処理が必要になります。 ~~このあたりは part6までとは比べ物にならないほど~~ ~~面倒な仕組みを多用するので記事にするのをサボっていたわけです~~

最小限のサービス

というわけで今回は最小限のサービスを作って、Mainアクティビティからテストコマンドが送れるようにしてみます。

なお、ソースのベースは　partX で作成した近代化改修版 TestPlayer2 で HOMEのわざとらしいテンプレートだけ削除したものを使用しています。

最小限のサービス

public class TestPlayerService extends Service {

    enum ACTION
    {
        TEST0 { @Override public String getCmd(){return "link.canter.hiroumauma.testplayer2.ACTION_TEST0"; }},
        TEST1 { @Override public String getCmd(){return "link.canter.hiroumauma.testplayer2.ACTION_TEST1"; }},;
        public String getCmd(){return name(); }
    }

    private final IBinder mBinder = (IBinder)new TestPlayerServiceLocalBinder();

    public class TestPlayerServiceLocalBinder extends Binder
    {
        TestPlayerService getService()
        {
            return TestPlayerService.this;
        }
    }

    @Override public void onCreate(){
        super.onCreate();
    }

    @Override public void onDestroy(){
        super.onDestroy();
    }

    @Override
    public IBinder onBind(Intent intent)
    {
        Toast.makeText(this, "TestPlayerService#onBind"+":"+ intent, Toast.LENGTH_SHORT).show();
        return mBinder;
    }

    @Override
    public void onRebind(Intent intent)
    {
        Toast.makeText(this, "TestPlayerService#onRebind"+":"+ intent, Toast.LENGTH_SHORT).show();
    }

    @Override
    public boolean onUnbind(Intent intent)
    {
        Toast.makeText(this, "TestPlayerService#onUnbind"+":"+ intent, Toast.LENGTH_SHORT).show();

        return true;
    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId)
    {

        String action = intent.getAction();

        if(action.equals(ACTION.TEST0.getCmd()))
        {
            Toast.makeText(this, "TestPlayerService#TEST0"+":"+ intent.getStringExtra("TEST_MSG"), Toast.LENGTH_SHORT).show();
        }else if(action.equals(ACTION.TEST1.getCmd())){
            Toast.makeText(this, "TestPlayerService#TEST1"+":"+ Integer.toString(intent.getIntExtra("TEST_ID",0)), Toast.LENGTH_SHORT).show();
        }

        return START_STICKY;
    }
}

これが今回作成した最低限のサービスです。

    enum ACTION
    {
        TEST0 { @Override public String getCmd(){return "link.canter.hiroumauma.testplayer2.ACTION_TEST0"; }},
        TEST1 { @Override public String getCmd(){return "link.canter.hiroumauma.testplayer2.ACTION_TEST1"; }},;
        public String getCmd(){return name(); }
    }

この部分はサービスが受け取れるコマンドのリストです。今回はまだ中身がないので　TEST0, TEST1 という名前を enum で並べたあと enumをちょっと拡張してコマンドのフルネームも出せるようにしてあります。 (あとで効果を発揮します。)

    private final IBinder mBinder = (IBinder)new TestPlayerServiceLocalBinder();

    public class TestPlayerServiceLocalBinder extends Binder
    {
        TestPlayerService getService()
        {
            return TestPlayerService.this;
        }
    }

このあたりは後のための布石です。ローカルバインダーを用いてアクティビティからサービスに直アクセスする技があるのでそれの用意をしています。

その後 OnCreate, onDestroy onBind, onRebind, onUnbind などは今は何も書いていません。基本的には名前の通りのメソッド達です。

最後 OnStartCommandがアクティビティやウィジェットから、 Intentを用いて要求が行われた際に働く部分です。

String action = intent.getAction();

で渡されたコマンドを受け取り

 if(action.equals(ACTION.TEST0.getCmd()))

こんな感じで用意しておいたコマンドを見つけることができます。ここで、再生や一時停止、次曲送り、巻き戻し　などのコマンドに対する動きを作ればいいわけです。

最後に返している値でServiceの挙動が変わります。 STICKY は明示的に起動されて、明示的に止められるまで背後で動作するモードです。

アクティビティ側の準備

ハリボテサービスができたのでアクティビティ側も準備します

まず

    public static TestPlayerService TestPlayerBoundService;
    public static boolean           IsTestPlayerServiceBound;

２つメンバを追加して

次に

    private ServiceConnection TestPlayerServiceConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className, IBinder service) {
            Toast.makeText(Main.this, "Activity:onServiceConnected",Toast.LENGTH_SHORT).show();
            TestPlayerBoundService = ((TestPlayerService.TestPlayerServiceLocalBinder)service).getService();
        }

        public void onServiceDisconnected(ComponentName className) {
            TestPlayerBoundService = null;
            Toast.makeText(Main.this, "Activity:onServiceDisconnected",Toast.LENGTH_SHORT).show();
        }
    };

例のローカルバインダを使用して TestPlayerBoundServiceを捕まえる TestPlayerServiceConnection というのを作っておきます。

そうしたら

    public void doBindService(){
        bindService(new Intent(Main.this, TestPlayerService.class), TestPlayerServiceConnection, Context.BIND_AUTO_CREATE);
        IsTestPlayerServiceBound = true;
    }

    public void doUnbindService(){
        if(IsTestPlayerServiceBound){
            unbindService(TestPlayerServiceConnection);
            IsTestPlayerServiceBound = false;
        }
    }

サービスとアクティビティを Bing / Unbind するメソッドを追加さらに

    public void CallService(ACTION action)
    {
        Intent intent = new Intent(this, TestPlayerService.class);
        intent.setAction(action.getCmd());
        switch(action)
        {
            case TEST0:
                intent.putExtra("TEST_MSG", "The quick brown fox jumps over the lazy dog");
                break;
            case TEST1:
                intent.putExtra("TEST_ID", 0523);
                break;
            default:
                break;
        }

        startService(intent);
    }

サービスにコマンドを与えるメソッドも作ってみました。このメソッドの引数　ACTION は先ほど　Service側に用意した TestPlayerService.ACTION です。 ACTIONは　enum で作ってあるので　switch でズラズラかいて大丈夫です。 setAction はコマンドのフルネームが必要ですが　.getCmd() とすればOKです。 enumのちょい拡張でこのあたりはスッキリします。

最後に onCreate() 内に　 doBindService(); を追記して一通りの準備は完了です。

AndroidManifest

サービスを起動する場合 AndroidManifest.xmlに編集が必要です。

application の中に

<service android:name=".TestPlayerService"/>

などと追記します。(nameは読み替えて下さい)

以上で最低限のServiceの完成です。

テスト

早速作成したサービスにアクセスしてみます。今回は、TEST0 コマンドでちょっとした文字列をサービスに渡してみます。

partXで作成した　サイドナビのツールボタンと設定ボタンを借りて

            case R.id.nav_tools:
                CallService(ACTION.TEST0);
                break;
            case R.id.nav_settings:
                doUnbindService();
                stopService(new Intent(this, TestPlayerService.class));
                break;

この２コマンドだけは最低限用意します。 TEST0 コマンドを送信するテストとサービスをアンバインドして停止させるテストです。

せっかくなので実機で ◯アプリ起動直後に Serviceが起動