Bgm class

The looping background music class.

This class helps with looping background music management that reacts to application lifecycle state changes. On construction, the instance is added as an observer to the WidgetsBinding instance. A dispose function is provided in case this functionality needs to be unloaded but the app needs to keep running.





audioPlayer AudioPlayer
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
isPlaying bool
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


clear(String file) → void
Clears the file in the cache. [...]
clearAll() → void
Clears all the audios in the cache. Alias of FlameAudio.clearAll();.
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features. [...]
didChangeAppLifecycleState(AppLifecycleState state) → void
Handler for AppLifecycleState changes. [...]
didChangeLocales(List<Locale> locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings. [...]
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated. [...]
didChangePlatformBrightness() → void
Called when the platform brightness changes. [...]
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes. [...]
didHaveMemoryPressure() → void
Called when the system is running low on memory. [...]
didPopRoute() Future<bool>
Called when the system tells the app to pop the current route. For example, on Android, this is called when the user presses the back button. [...]
didPushRoute(String route) Future<bool>
Called when the host tells the application to push a new route onto the navigator. [...]
didPushRouteInformation(RouteInformation routeInformation) Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router. [...]
dispose() → void
Dispose the WidgetsBinding observer.
initialize() → void
Registers a WidgetsBinding observer. [...]
load(String file) Future<File>
Prefetch an audio and store it in the cache. [...]
loadAll(List<String> files) Future<List<File>>
Prefetch a list of audios and store them in the cache. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
pause() → void
Pauses the background music without unloading or resetting the audio player.
play(String filename, {double volume}) → void
Plays and loops a background music file specified by filename. [...]
resume() → void
Resumes the currently played (but resumed) background music.
stop() → void
Stops the currently playing background music track (if any).
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]