MediaFilter class

A filter that will be used with:

  • queryAudios(querySongs);
  • queryAlbums;
  • queryArtists;
  • queryPlaylists;
  • queryGenres.
  • queryArtwork.

Constructors

MediaFilter.forAlbums({AlbumSortType? albumSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, MediaDirType? dirType})
A 'default' filter that can be used for albums.
MediaFilter.forArtists({ArtistSortType? artistSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, MediaDirType? dirType})
A 'default' filter that can be used for artists.
MediaFilter.forArtwork({ArtworkFormatType? artworkFormat = ArtworkFormatType.JPEG, int? artworkSize = 100, int? artworkQuality = 50, bool? cacheArtwork = true, bool? cacheTemporarily = true, bool? overrideCache = false})
A 'default' filter that can be used for artwork.
MediaFilter.forAudios({AudioSortType? audioSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, Map<AudioType, bool> type = const {}, MediaDirType? dirType})
A 'default' filter that can be used for audios.
MediaFilter.forGenres({GenreSortType? genreSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, MediaDirType? dirType})
A 'default' filter that can be used for genres.
MediaFilter.forPlaylists({PlaylistSortType? playlistSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, MediaDirType? dirType})
A 'default' filter that can be used for playlists.
MediaFilter.forSongs({AudioSortType? audioSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, Map<AudioType, bool> type = const {AudioType.IS_MUSIC : true}, MediaDirType? dirType})
A 'default' filter that can be used for audios(songs).
MediaFilter.init({AudioSortType? audioSortType, AlbumSortType? albumSortType, ArtistSortType? artistSortType, PlaylistSortType? playlistSortType, GenreSortType? genreSortType, int? limit, OrderType orderType = OrderType.ASC_OR_SMALLER, UriType uriType = UriType.EXTERNAL, bool ignoreCase = true, Map<int, List<String>> toQuery = const {}, Map<int, List<String>> toRemove = const {}, Map<AudioType, bool> type = const {}, MediaDirType? dirType, ArtworkFormatType? artworkFormat, int? artworkSize, int? artworkQuality, bool? cacheArtwork, bool? cacheTemporarily, bool? overrideCache})
A 'default' filter that can be used to all filters.

Properties

albumSortType ↔ AlbumSortType?
The album sort type.
getter/setter pair
artistSortType ↔ ArtistSortType?
The artist sort type.
getter/setter pair
artworkFormat ↔ ArtworkFormatType?
The artwork format.
getter/setter pair
artworkQuality ↔ int?
The artwork quality.
getter/setter pair
artworkSize ↔ int?
The artwork size.
getter/setter pair
audioSortType ↔ AudioSortType?
The audio sort type.
getter/setter pair
cacheArtwork ↔ bool?
Define if the artwork will be cached(saved) inside the app directory.
getter/setter pair
cacheTemporarily ↔ bool?
Define if the artwork will be deleted will be deleted automatically
getter/setter pair
dirType ↔ MediaDirType?
Define where the plugin will query the medias:
getter/setter pair
genreSortType ↔ GenreSortType?
The genre sort type.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
ignoreCase ↔ bool
Define if we should ignore the 'Case-sensitive'.
getter/setter pair
limit ↔ int?
Define if we should limit the 'query'.
getter/setter pair
orderType ↔ OrderType
The list order type.
getter/setter pair
overrideCache ↔ bool?
Define if the artwork will be overriden if already exists.
getter/setter pair
playlistSortType ↔ PlaylistSortType?
The playlist sort type.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toQuery ↔ Map<int, List<String>>
The 'objects'(titles, albums, artists, etc...) to be 'queried'.
getter/setter pair
toRemove ↔ Map<int, List<String>>
The 'objects'(titles, albums, artists, etc...) to be removed from 'query'.
getter/setter pair
type ↔ Map<AudioType, bool>
The 'type' of the audios.
getter/setter pair
uriType ↔ UriType
The 'query' url type.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited