Handles the "playAudioWhenScreenIsLocked" similar to the iOS behaviour.

[romedius]

If the Flag is not set the media will be played (standard behaviour up to now.

If the Flag is set to false, active playing sounds are paused on the Activitys onPause event and resumed after onResume is fired.
The functionality is implemented similarly to the pausedForPhone functionality.

[ghenry22]

Apparently playAudioWhenScreenIsLocked is deprecated on iOS (from the tickets I was reading today) anyway so this PR could probably be closed if that is correct.

[cordova-qa]

Cordova CI Build has completed successfully.

Commit - Link
Dashboard - Link

Builder Name	Console Output	Test Report	Device Logs
Windows 8.1 Store	Link	Link	Link
Windows 10 Store	Link	Link	Link
Windows 8.1 Phone	Link	Link	Link
iOS	Link	Link	Link
Android Mac	Link	Link	Link

[romedius]

Hi!
the option is listed as an iOs Quirk, but it seems to be supported.
I would be willing to integrate it into the new plugin version, if i get a heads up that more people would benefit from this contribution.
@stevengill

[katzlbt]

@ghenry22 Current sources and README do not indicate any deprecation of playAudioWhenScreenIsLocked in iOS. Which tickets did you read?

https://github.com/apache/cordova-plugin-media/blob/master/README.md
https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/index.html

[stevengill]

Hey @romedius!

Thanks for sending this in!

I have a few questions I was hoping you could answer to speed up the review.

So right now, media will keep playing in the background by default? And your PR will allow users to pause the media when the app goes to the background. Does that sound correct?

This is how it works in iOS now? @ghenry22 said it was deprecated in iOS. Is this documented somewhere?

Do you have an issue number for this yet? issues.cordova.io

[romedius]

@stevengill This is exactly the behavior. The media should pause as soon as onPause() is triggered and resumed on onResume()
Currently this feature is documented as "Quirk" on the iOS platform. https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media/#ios-quirks playAudioWhenScreenIsLocked
I will create a new pull request by tomorrow.

[romedius]

@stevengill in the newer plugin version, 2.4.0 there is a pauseAllLostFocus() and resumeAllGainedFocus() functionality. Unfortunately that does not works with the playAudioWhenScreenIsLocked parameter. I have to look into that to avoid duplications.
Can you point me to the documentation that explains those functions?

[romedius]

@stevengill I've created a new pull request. See:
#121

[romedius]

Replaced by #121