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})
- The looping background music class.
Properties
- audioPlayer ↔ AudioPlayer
-
The AudioPlayer instance that is used to play the audio.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isPlaying ↔ bool
-
Whether Bgm is playing or not.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
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
-
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.
-
initialize(
) → void - Registers a WidgetsBinding observer.
-
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}) → 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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited