fix!: Default audio output to system preferences

[Gustl22]

Description

Supersedes #1501

• Introduce AudioContextConfigRoute to allow forcing audio to speaker or earpiece (this can be extended to e.g. bluetooth devices) for both iOS and Android
• ios: change default AVAudioSessionCategory from .playAndRecord to .playback to not play from earpiece as in record mode (see iOS volume very low (sound is coming from earpiece) #1194)
• ios: remove default AVAudioSessionOptions.defaultToSpeaker to allow playing from system default device instead of speaker only (see Sound does not play through headphones on Android and iOS devices #1486)
• android: change default AudioContextAndroid.isSpeakerphoneOn from true to false to allow playing from system default device instead of speaker only (see Sound does not play through headphones on Android and iOS devices #1486)
• ios: remove default AVAudioSessionOptions.mixWithOthers to interrupt audio of other apps, like in Android
• android: change default AudioContextAndroid.stayAwake from true to false to not stay awake, like in iOS

WARNING: I could not test on a real device for iOS, all this is based on experiences of our community linked below!

Checklist

• The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs:, chore: etc).
• I have read the Contributor Guide and followed the process outlined for submitting PRs.
• I have updated/added tests for ALL new/updated/fixed functionality.
• I have updated/added relevant documentation and added dartdoc comments with ///, where necessary.
• I have updated/added relevant examples in example.

Breaking Change

• Yes, this is a breaking change.
• No, this is not a breaking change.

Migration instructions

Before	After
AudioContextAndroid()	AudioContextAndroid(isSpeakerphoneOn: true, stayAwake: true)
AudioContextIOS()	AudioContextIOS(category: AVAudioSessionCategory.playAndRecord, options: [AVAudioSessionOptions.mixWithOthers, AVAudioSessionOptions.defaultToSpeaker])
AudioContextConfig()	AudioContextConfig(route: AudioContextConfigRoute.speaker, stayAwake: true})

Related Issues

Closes #1491
Closes #1486
#1194

[Gustl22]

@wujek-srujek @MichaelNZ85 @xxddff @LeoSandbox can you test this branch, if it solves your needs and if it still plays the sound through the speakers (and not the earpiece) by default?

You can test this branch by copying this to pubspec.yaml:

dependency_overrides:
  audioplayers:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_platform_interface:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_platform_interface'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_web:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_web'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_linux:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_linux'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_android:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_android'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_darwin:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_darwin'
      ref: 'gustl22/1486-ios-headphones'
  audioplayers_windows:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_windows'
      ref: 'gustl22/1486-ios-headphones'

[spydon]

Lgtm! I wonder how some of these defaults came into play to start with 😅

[Gustl22]

@luanpotter do you have concerns about the changes?

[spydon]

@luanpotter do you have concerns about the changes?

I'll physically poke him, we're both at FlutterCon 😄

[Gustl22]

Nice to hear, enjoy your stay 🥳

[spydon]

Nice to hear, enjoy your stay 🥳

Luan thinks it looks good, he gives his physical approval! 😄