``` The following 25 packages will be updated: Package Name Current Version Updated Version Update Reason flame 1.32.0 1.33.0 manual versioning flame_test 2.0.3 2.1.0 manual versioning flame_audio 2.11.10 2.11.11 updated with patch changes flame_behaviors 1.2.0 1.3.0 updated with minor changes flame_console 0.1.2+12 0.1.2+13 updated with patch changes flame_fire_atlas 1.8.11 1.8.12 updated with patch changes flame_network_assets 0.3.3+16 0.3.3+17 updated with patch changes flame_spine 0.2.2+16 0.2.2+17 updated with patch changes flame_sprite_fusion 0.2.0+3 0.2.1 updated with minor changes flame_steering_behaviors 0.2.0 0.2.1 updated with minor changes flame_tiled 3.0.7 3.0.8 updated with patch changes flame_behavior_tree 0.1.3+16 0.1.3+17 dependency was updated flame_oxygen 0.2.3+16 0.2.3+17 dependency was updated flame_isolate 0.6.2+16 0.6.2+17 dependency was updated flame_texturepacker 5.0.1 5.0.2 dependency was updated flame_bloc 1.12.17 1.12.18 dependency was updated flame_kenney_xml 0.1.1+16 0.1.1+17 dependency was updated flame_lottie 0.4.2+16 0.4.2+17 dependency was updated flame_markdown 0.2.4+9 0.2.4+10 dependency was updated flame_rive 1.10.19 1.10.20 dependency was updated flame_forge2d 0.19.2 0.19.2+1 dependency was updated flame_noise 0.3.2+16 0.3.2+17 dependency was updated flame_riverpod 5.4.19 5.4.20 dependency was updated flame_svg 1.11.16 1.11.17 dependency was updated flame_3d 0.1.1+2 0.1.1+3 dependency was updated ```
Adds audio support for Flame using the audioplayers package.
flame_audio
This package makes it easy to add audio capabilities to your games, integrating Audioplayers features seamless into your Flame game code.
Add this as a dependency to your Flame game if you want to play background music, ambient sounds, sound effects, etc. For the full documentation, visit flame_audio.
How to use
Add sound files to assets/audio. Remember to run pub get after updating pubspec.yaml with:
assets:
- assets/audio
General sounds
Use these built-in methods to play sounds in your Flame game:
import 'package:flame_audio/flame_audio.dart';
// For shorter reused audio clips, like sound effects
FlameAudio.play('explosion.mp3');
// For looping an audio file
FlameAudio.loop('music.mp3');
// For playing a longer audio file
FlameAudio.playLongAudio('music.mp3');
// For looping a longer audio file
FlameAudio.loopLongAudio('music.mp3');
Background music
Start by initializing FlameAudio bgm.
FlameAudio.bgm.initialize();
Remember to call dispose to remove the observer.
FlameAudio.bgm.dispose();
To play a looping background music
import 'package:flame_audio/flame_audio.dart';
// play with optional volume param
FlameAudio.bgm.play('music/world-map.mp3', volume: .25);
To stop background music
FlameAudio.bgm.stop();
To pause and resume background music
FlameAudio.bgm.pause();
FlameAudio.bgm.resume();
Caching
You can pre-load your sounds into the audioCache. This prevents a delay for the first time an audio file is called. The files are cached automatically after the first time.
// cache single track
await FlameAudio.audioCache.load('explosion.mp3');
// cache multiple tracks
await FlameAudio.audioCache.loadAll(['explosion.mp3', 'music.mp3']);
To clear the cache
// clear specific track
FlameAudio.audioCache.clear('explosion.mp3');
// clear whole cache
FlameAudio.audioCache.clearCache();
Audio pool
Use AudioPools if you have extremely quick firing, repetitive or simultaneous sounds. To create an AudioPool:
AudioPool audioPool = await FlameAudio.createPool('explosion.mp3', maxPlayers: 2);
audioPool.start();