OnAudioQueryPlatform class abstract
The interface that implementations of on_audio_query must implement.
Platform implementations should extend this class rather than implement it as on_audio_query
does not consider newly added methods to be breaking changes. Extending this class
(using extends) ensures that the subclass will get the default implementation, while
platform implementations that implements this interface will be broken by newly added
OnAudioQueryPlatform methods.
- Inheritance
-
- Object
- PlatformInterface
- OnAudioQueryPlatform
- Implementers
Constructors
- OnAudioQueryPlatform()
- Constructs a OnAudioQueryPlatform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addToPlaylist(
int playlistId, int audioId) → Future< bool> - Used to add a specific song/audio to a specific Playlist
-
createPlaylist(
String name, {String? author, String? desc}) → Future< bool> - Used to create a Playlist
-
moveItemTo(
int playlistId, int from, int to) → Future< bool> - Used to change song/audio position from a specific Playlist
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
permissionsRequest(
{bool retryRequest = false}) → Future< bool> - Used to request Android permissions.
-
permissionsStatus(
) → Future< bool> - Used to check Android permissions status
-
queryAlbums(
{AlbumSortType? sortType, OrderType? orderType, UriType? uriType, bool? ignoreCase}) → Future< List< AlbumModel> > - Used to return Albums Info based in AlbumModel.
-
queryAllPath(
) → Future< List< String> > - Used to return Songs path.
-
queryArtists(
{ArtistSortType? sortType, OrderType? orderType, UriType? uriType, bool? ignoreCase}) → Future< List< ArtistModel> > - Used to return Artists Info based in ArtistModel.
-
queryArtwork(
int id, ArtworkType type, {ArtworkFormat? format, int? size, int? quality}) → Future< Uint8List?> - Used to return Songs Artwork.
-
queryAudiosFrom(
AudiosFromType type, Object where, {SongSortType? sortType, OrderType? orderType, bool? ignoreCase}) → Future< List< SongModel> > - Used to return Songs/Audios Info from a specific queryType based in SongModel.
-
queryDeviceInfo(
) → Future< DeviceModel> - Used to return Device Info
-
queryFromFolder(
String path, {SongSortType? sortType, OrderType? orderType, UriType? uriType}) → Future< List< SongModel> > -
Used to return Songs Info from a specific
Folderbased in SongModel. -
queryGenres(
{GenreSortType? sortType, OrderType? orderType, UriType? uriType, bool? ignoreCase}) → Future< List< GenreModel> > - Used to return Genres Info based in GenreModel.
-
queryPlaylists(
{PlaylistSortType? sortType, OrderType? orderType, UriType? uriType, bool? ignoreCase}) → Future< List< PlaylistModel> > - Used to return Playlists Info based in PlaylistModel.
-
querySongs(
{SongSortType? sortType, OrderType? orderType, UriType? uriType, bool? ignoreCase, String? path}) → Future< List< SongModel> > - Used to return Songs Info based in SongModel.
-
queryWithFilters(
String argsVal, WithFiltersType withType, dynamic args) → Future< List> - Used to return Songs Info based in Something. Works like a "Search".
-
removeFromPlaylist(
int playlistId, int audioId) → Future< bool> - Used to remove a specific song/audio from a specific Playlist
-
removePlaylist(
int playlistId) → Future< bool> - Used to remove/delete a Playlist
-
renamePlaylist(
int playlistId, String newName) → Future< bool> - Used to rename a specific Playlist
-
scanMedia(
String path) → Future< bool> -
Used to scan the given
path -
setLogConfig(
LogConfig? logConfig) → Future< void> - Used to set the logging behavior.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ OnAudioQueryPlatform
-
The default instance of OnAudioQueryPlatform to use.
getter/setter pair