fix!: remove unused defaultToSpeaker in AudioContextIOS and replace with AVAudioSessionOptions.defaultToSpeaker

[Gustl22]

Description

• The parameter defaultToSpeaker was not used in AudioContextIOS. Instead option: [AVAudioSessionOptions.defaultToSpeaker] should be used
• AudioContext now has default configurations for iOS and android. Nevertheless it is recommended to set the config via AudioContextConfig.build().

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

Old:

  AudioPlayer.global.setGlobalAudioContext(
    AudioContext(
      iOS: AudioContextIOS(
        defaultToSpeaker: true,
        category: AVAudioSessionCategory.playback,
        options: [AVAudioSessionOptions.mixWithOthers],
      ),
      android: AudioContextAndroid(
        isSpeakerphoneOn: true,
        stayAwake: true,
        contentType: AndroidContentType.music,
        usageType: AndroidUsageType.media,
        audioFocus: AndroidAudioFocus.gain,
      ),
    ),
  );

New:

  AudioPlayer.global.setGlobalAudioContext(
    AudioContext(
      iOS: AudioContextIOS(
        category: AVAudioSessionCategory.playback,
        options: [
          AVAudioSessionOptions.mixWithOthers,
          AVAudioSessionOptions.defaultToSpeaker,
        ],
      ),
    ),
  );

Instead of setting defaultToSpeaker in AudioContextIOS, use the option: [AVAudioSessionOptions.defaultToSpeaker].

Related Issues

Closes #1194
Related to #1363

[Gustl22]

@lukepighetti you can test this by adding following lines to your pubspec.yaml in your project:

dependency_overrides:
  audioplayers:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'
  audioplayers_platform_interface:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_platform_interface'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'
  audioplayers_darwin:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_darwin'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'

[spydon]

@lukepighetti you can test this by adding following lines to your pubspec.yaml in your project:

dependency_overrides:
  audioplayers:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'
  audioplayers_platform_interface:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_platform_interface'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'
  audioplayers_darwin:
    git:
      url: https://github.com/bluefireteam/audioplayers.git
      path: 'packages/audioplayers_darwin'
      ref: '1499a51037e900b7a41ef3514803db8472ed767f'

Or @OlegNovosad

[spydon]

Let's hope this solves it once and for all, it probably will! 🙏

[luanpotter]

Nice! Thanks for fixing this correctly @Gustl22