playerReady.on is not triggered

[zhouhao27]

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

I'm using alphaTab.kotline in an Android app. It's working fine in version 1.3.0. But when I changed to version 1.6.1. The playerReady.on is not triggered.

Expected Behavior

The playerReady.on should be called.

Steps To Reproduce

Code:

I followed the tutorial for Android:

val settings = MutableLiveData<Settings>().apply {
        value = Settings().apply {
            this.player.enableCursor = true
            this.player.enablePlayer = true
            this.player.enableUserInteraction = true
            this.display.barCountPerPartial = 4.0
            this.display.resources.barNumberFont
        }
    }

......

        mAlphaTabView.api.playerReady.on {
            Log.i("AlphaTab", "Player is ready")
            playPause.visibility = View.VISIBLE
        }

Link to jsFiddle, CodePen, Project

No response

Version and Environment

Sorry, I could not find how to call `alphaTab.Environment.printEnvironmentInfo()`

[versions]
agp = "8.12.0"
kotlin = "2.0.21"
coreKtx = "1.17.0"
junit = "4.13.2"
junitVersion = "1.3.0"
espressoCore = "3.7.0"
appcompat = "1.7.1"
material = "1.10.0"
activity = "1.10.1"
constraintlayout = "2.1.4"
alphatab = "1.6.1"

[libraries]
androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
junit = { group = "junit", name = "junit", version.ref = "junit" }
androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "appcompat" }
material = { group = "com.google.android.material", name = "material", version.ref = "material" }
androidx-activity = { group = "androidx.activity", name = "activity", version.ref = "activity" }
androidx-constraintlayout = { group = "androidx.constraintlayout", name = "constraintlayout", version.ref = "constraintlayout" }
alphatab = { group = "net.alphatab", name = "alphaTab", version.ref = "alphatab" }

Platform

Android (Native)

Anything else?

No response

[Danielku15]

Have you considered that the player might already be ready at the time you register to the event? alphaTab will not fire the event upon registration if the player is already ready.

if (mAlphaTabView.api.isReadyForPlayback) {
  mAlphaTabView.api.playerReady.on {
    Log.i("AlphaTab", "Player is ready (event)")
    playPause.visibility = View.VISIBLE
  }  
} else {
  Log.i("AlphaTab", "Player is ready (direct)")
  playPause.visibility = View.VISIBLE
}

As things are happening asynchronous (especially also considering the UI layer) it could be a race condition you have to handle.

Edit: and you need to be sure to load a file into alphaTab. If possible please provide a full reproducible example (not only snippets) so I can run things on my side in the way you do it.

[zhouhao27]

I think probably the issue is in player. Even I set the button to VISIBLE, I still can not play the audio. The same code working fine in alphaTab 1.3.0. Anyway here is my project file.

AlphaTabDemo.zip

[Danielku15]

I opened the project and my initial assumption was correct as I see "Player is ready (direct)" in the logcat. The player is already ready at the time you register to the event.

The actual problem cause is the use of the deprecated isPlayerEnabled vs the new playerMode that needs to be used. The backwards compatibility logic added, does not account properly for fully changed settings objects.

As a temporary workaround: you can change the MainViewModel to set this.player.playerMode = PlayerMode.EnabledSynthesizer instead of playerEnabled

---

Dev Notes:

1. Ensure we propagate @deprecated annotations to Kotlin/C# so that they are marked as obsolete on the consumer side.
2. Handle the enablePlayer backwards compatibility also in the updateSettings
3. Extend some built-in events with an "initial fire" condition so that they fire the handler directly if the respective condition is fulfilled (like player ready in this case).

[zhouhao27]

Will have a try and let you know. Thanks.