docs: Add note on simultaneous/rapid AVPlayer instantiation limits for iOS

[gnarhard]

Description

Checklist

• The title of my PR starts with a Conventional Commit prefix (fix:, feat:, refactor:,
  docs:, chore:, test:, ci: 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.

Related Issues

Addresses: #1744

[Gustl22]

Thank you for the contribution. We may also can try to apply a specific error message in that case. Can you post a code example and the max parallel players you could use until the error message appeared?

[gnarhard]

Thank you for the contribution. We may also can try to apply a specific error message in that case. Can you post a code example and the max parallel players you could use until the error message appeared?

I'm noticing a very similar limitation on Android. A helpful error message would be much appreciated. My code will cover creating pools, but this limitation affects the generic player creation as well. It starts getting risky past 10 new players. This is a device-specific issue because of differing hardware. I would highly encourage anyone to not exceed creating 10 players within a 2 second time period. On android, more than this will cause extreme latency, and on iOS it will give the dreaded 'unknown error' and stop trying to load the player.

final paths = <String>[]; // max of 10
for (final path in paths) {
  await AudioPool.create(
    source: AssetSource(path),
    // Creating more than 1 player can increase your risk of seeing the dreaded 'unknown error' when loading in a loop.
    minPlayers: 1,
    maxPlayers: maxPlayers,
  );
}