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.
- Inheritance
Constructors
- Bgm({AudioCache? audioCache})
Properties
- audioCache ↔ AudioCache
-
getter/setter pair
- audioPlayer ↔ AudioPlayer?
-
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isPlaying ↔ bool
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clear(
Uri file) → void - Clears the file in the cache.
-
clearAll(
) → void - Clears all the audios in the cache.
-
didChangeAccessibilityFeatures(
) → void -
Called when the system changes the set of currently active accessibility
features.
inherited
-
didChangeAppLifecycleState(
AppLifecycleState state) → void -
Handler for AppLifecycleState changes.
override
-
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.
inherited
-
didChangeMetrics(
) → void -
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness(
) → void -
Called when the platform brightness changes.
inherited
-
didChangeTextScaleFactor(
) → void -
Called when the platform's text scale factor changes.
inherited
-
didChangeViewFocus(
ViewFocusEvent event) → void -
Called whenever the PlatformDispatcher receives a notification that the
focus state on a view has changed.
inherited
-
didHaveMemoryPressure(
) → void -
Called when the system is running low on memory.
inherited
-
didPopRoute(
) → Future< bool> -
Called when the system tells the app to pop the current route, such as
after a system back button press or back gesture.
inherited
-
didPushRoute(
String route) → Future< bool> -
Called when the host tells the application to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(
RouteInformation routeInformation) → Future< bool> -
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didRequestAppExit(
) → Future< AppExitResponse> -
Called when a request is received from the system to exit the application.
inherited
-
dispose(
) → void - Dispose the WidgetsBinding observer.
-
handleCancelBackGesture(
) → void -
Called when a predictive back gesture is canceled, indicating that no
navigation should occur.
inherited
-
handleCommitBackGesture(
) → void -
Called when a predictive back gesture is finished successfully, indicating
that the current route should be popped.
inherited
-
handleStartBackGesture(
PredictiveBackEvent backEvent) → bool -
Called at the start of a predictive back gesture.
inherited
-
handleUpdateBackGestureProgress(
PredictiveBackEvent backEvent) → void -
Called when a predictive back gesture moves.
inherited
-
initialize(
) → void - Registers a WidgetsBinding observer.
-
load(
String file) → Future< Uri> - Pre-fetch an audio and store it in the cache.
-
loadAll(
List< String> files) → Future<List< Uri> > - Pre-fetch an audio and store it in the cache.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → Future< void> - Pauses the background music without unloading or resetting the audio player.
-
play(
String filename, {double volume = 1.0}) → Future< void> -
Plays and loops a background music file specified by
filename. -
resume(
) → Future< void> - Resumes the currently played (but resumed) background music.
-
stop(
) → Future< void> - Stops the currently playing background music track (if any).
-
toString(
) → String -
A string representation of this object.
inherited
-
volume(
dynamic volume) → Future< void>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited