soundPoolのサウンド停止がスリープ(onPause)状態を通るとできなくなる

Question

kotlinにて、android studioでアプリの開発を行っております。

カウントダウンタイマーを実装しており、タイマーが0になったとき、soundPoolにて音を再生しています。

〇アプリが開いた状態
タイマーが0になり、音が再生されたとき、停止ボタンを押すことで、音を止めることができます。

〇スリープ状態
カウントダウン中に端末がスリープ状態になり、タイマーが0になり、音が再生されたとき、
端末のスリープを解除し、停止ボタンを押しても音が停止しません。

おそらくsoundpoolの設定を onResume, onPause　で最適化できていないからなのかと思っておりますが、
この辺が解決できずに大変困っております。

解決方法がお分かりになる方がおりましたらご教授いただけないでしょうか?
宜しくお願い致します。

コードはその他機能も実装して冗長なため一部切り出して貼りました。

package com.example.xxxxxxxxx

import android.media.AudioAttributes
import android.media.SoundPool
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.os.Handler
import android.util.Log
import com.example.handler.databinding.ActivityMainBinding


class MainActivity : AppCompatActivity() {
    private lateinit var binding: ActivityMainBinding
    private var pomoTimerStarted = false //最初は停止
    private var soundRunning = false //音が鳴っているかどうか

    val handler = Handler()  //一度だけ代入
    var pomodoroTimeTime = 300 //5min


    //音鳴らす//////////////////////////////////////////////////////////////////////////////
    private lateinit var soundPool: SoundPool
    private var soundResId = 0
    private var soundOne = 0
    var streamId = 0

    //count Down
    val runnableDown = object : Runnable {
        override fun run() {
            pomodoroTimeTime--

            // ?.letを用いて、nullではない場合のみ更新
            timeToText(pomodoroTimeTime)?.let{
                binding.showTextTime.text = it
            }
            handler.postDelayed(this, 1000)


            if(pomodoroTimeTime == 0) {
                soundPlay()
            }
            else if(pomodoroTimeTime < 0){
                pomodoroTimeTime = 0
            }
            else{
            }
        }
    }

    //アラーム再生
    val runnableSound = object : Runnable{
        override fun run(){
            streamId = soundPool.play(soundOne, 1.0f, 1.0f, 0, 0, 1.0f)
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)

    binding.playStop.setOnClickListener{
        if(pomoTimerStarted && !soundRunning) {     //downが動作⇒停止
            breakStopTimer()
        }

        else if(!pomoTimerStarted && !soundRunning) { //downが停止⇒動作
            breakStartTimer()
        }

        else { //音が鳴っている
            stopAlarm()
        }
    }

    
    public fun breakStartTimer(){
        binding.playStop.setImageResource(R.drawable.stop)
        handler.post(runnableDown)

        pomoTimerStarted = true
        soundRunning = false
    }

    public fun breakStopTimer(){
        binding.playStop.setImageResource(R.drawable.play)
        handler.removeCallbacks(runnableDown)

        pomoTimerStarted = false
        soundRunning = false
    }

    public fun soundPlay(){
        Log.d("debug", "soundPlay")

        pomoTimerStarted = false
        soundRunning = true

        handler.removeCallbacks(runnableDown) //カウントダウンタイマー停止
        handler.post(runnableSound) //音を鳴らす
    }

    public fun stopAlarm(){
        soundPool.stop(streamId) //アラーム停止もやる
        handler.removeCallbacks(runnableSound)

        pomodoroTimeTime = 300

        pomoTimerStarted = false
        soundRunning = false

        binding.playStop.setImageResource(R.drawable.play)
    }

    public fun soundStarted(){
        soundPool.play(soundOne, 1.0f, 1.0f, 0, 0, 1.0f)
    }


    override fun onResume() {
        super.onResume()
        Log.d("debug", "onResume")

        //soundPool設定
        val audioAttributes = AudioAttributes.Builder()
                .setUsage(AudioAttributes.USAGE_GAME)
                .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
                .build()

        soundPool = SoundPool.Builder()
                .setAudioAttributes(audioAttributes)
                .setMaxStreams(2)
                .build()

        soundOne = soundPool.load(this, R.raw.bellsound, 1)

        // load が終わったか確認する場合
        soundPool.setOnLoadCompleteListener{ soundPool, sampleId, status ->
            Log.d("debug", "sampleId=$sampleId")
            Log.d("debug", "status=$status")
        }


        //サウンドをメモリにロード
        soundPool = SoundPool.Builder().run {
            val audioAttributes = AudioAttributes.Builder().run {
                setUsage(AudioAttributes.USAGE_ALARM)
                build()
            }
            setMaxStreams(1)
            setAudioAttributes(audioAttributes)
            build()
        }
        soundResId = soundPool.load(this, R.raw.lazer, 1)
    }

    override fun onPause() { //アクティビティ非表示   (バックグラウンドでの動作）
        super.onPause()
        Log.d("debug", "onPause")

        if(pomodoroTimeTime < 0){
                soundPlay()
        }
    }

}

Comments

[jimbe]

「停止ボタン」を押されたらどのメソッドが呼ばれるのでしょうか。

[jimbe]

onResume の中に SoundPool の Build が 2 回あります。 1 回目は( 2 回目に上書きされて)無意味と思いますが、何か意味があるのでしょうか。
onCreate の中の一連の if 文も、アプリ起動時には不要に思いますが…。(アプリを起動したらいきなりカウントダウンが始まるのでしょうか。)

[kakashi55]

ご返答いただきありがとうございます。
SoundPoolのBuildが2回あるのは誤記です。
(コメントで気が付きました。。)
onCreate内のif文は、ボタン処理の1行を消してしまっていたため訂正しました。

[jimbe]

一行だけ追加されると {} の対応も変になりますけれども。
切り出されるのは結構ですが、検証・再現するにしましてもご提示頂いたコードを修正しなければならないのでは、肝心の問題点が分からなくなってしまいます。
ご質問されている状況が再現できるよう、コードとレイアウトのセットで動作する状態でのご提示をお願い致します。

Answer 1

kotlin は不慣れなもので、"らしくない"コードになっているかと思いますが、ご容赦ください。
以下のコード・レイアウトの他、リソースとして raw フォルダに alarm.mp3 を置いてテストしました。

ご質問の原因は、onResume で SoundPool を作り直してしまっているためかと思います。
裏に回った後再び表に表示された場合に onResume が実行され、鳴らしていたものと違う SoundPool が作られて soundPool 変数に上書きされてしまうため、 soundPool.stop(streamId) としても新しい soundPool には streamId が無くて停止できないのではないでしょうか。

以下のコードでは、SoundManager なるクラスを作って音関係を入れてしまい、アクティビティの onCreate で一度だけ SoundPool を作る様にしています。
ついでに、 RunnableDown も innner class 化しました。

MainActivity.kt

package com.teratail.q359037

import android.content.Context
import android.media.AudioAttributes
import android.media.SoundPool
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.os.Handler
import android.os.Looper
import android.view.View
import com.teratail.q359037.databinding.ActivityMainBinding

class SoundManager(context : Context) {
    private var soundPool: SoundPool
    private var soundOne = 0
    private var streamId = 0

    init {
        //soundPool設定
        val audioAttributes = AudioAttributes.Builder()
            .setUsage(AudioAttributes.USAGE_GAME)
            .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
            .build()

        soundPool = SoundPool.Builder()
            .setAudioAttributes(audioAttributes)
            .setMaxStreams(1)
            .build()

        soundOne = soundPool.load(context, R.raw.alarm, 1)
    }

    fun playOne() {
        cancelOne()
        streamId = soundPool.play(soundOne, 1.0f, 1.0f, 0, -1, 1.0f)
    }

    fun cancelOne() {
        if(streamId != 0) {
            soundPool.stop(streamId)
            streamId = 0;
        }
    }
}

class MainActivity : AppCompatActivity() {
    private lateinit var binding: ActivityMainBinding
    private val handler = Handler(Looper.getMainLooper())  //一度だけ代入
    private lateinit var soundManager : SoundManager
    private var runnableDown : RunnableDown? = null

    inner class RunnableDown(private var time : Int = 300) : Runnable {
        override fun run() {
            showTime(time)
            if(time == 0) {
                soundManager.playOne()
            } else {
                time --
                handler.postDelayed(this, 1000)
            }
        }
        fun start() : RunnableDown {
            handler.post(this)
            return this;
        }
        fun cancel() { //handler と同じイベントループ(スレッド)上で呼ぶこと
            handler.removeCallbacks(this)
            soundManager.cancelOne()
        }
    }

    fun showTime(time : Int) {
        binding.showTextTime.text = "%d:%02d".format(time/60, time%60)
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)
        soundManager = SoundManager(this)
        showTime(0)
    }

    public fun playTimer(v : View) {
        runnableDown = RunnableDown(10).start()
    }

    public fun stopTimer(v : View){
        runnableDown?.cancel();
        runnableDown = null
    }
}

レイアウト: activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

  <TextView
      android:id="@+id/showTextTime"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="0:00"
      android:textSize="40dp"
      app:layout_constraintBottom_toTopOf="@id/play"
      app:layout_constraintLeft_toLeftOf="parent"
      app:layout_constraintRight_toRightOf="parent"
      app:layout_constraintTop_toTopOf="parent" />

  <Button
      android:id="@+id/play"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="start"
      android:onClick="playTimer"
      app:layout_constraintBottom_toTopOf="@id/stop"
      app:layout_constraintLeft_toLeftOf="parent"
      app:layout_constraintRight_toRightOf="parent"
      app:layout_constraintTop_toBottomOf="@id/showTextTime" />

  <Button
      android:id="@+id/stop"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="stop"
      android:onClick="stopTimer"
      app:layout_constraintBottom_toBottomOf="parent"
      app:layout_constraintLeft_toLeftOf="parent"
      app:layout_constraintRight_toRightOf="parent"
      app:layout_constraintTop_toBottomOf="@id/play" />

</androidx.constraintlayout.widget.ConstraintLayout>

Comments

[kakashi55]

御丁寧な回答ありがとうございます。
原因がonResume で SoundPool を作り直したがために、soundPool 変数が上書きされてしまっていたのですね。
言われてみれば確かにその通りでした。
またご丁寧に動作するサンプルコードについても教えていただきありがとうございます。
無事本件解決し、理解を深めることができました。