OnAudioRoom class
Interface and Main method for use on_audio_room.
on_audio_room is a Flutter Package used to create a "room" to storage audio sections.
RoomTypes:
- Favorites.
- Last Played.
- MostPlayed.
- Playlists.
- Playlist songs.
See more:
Homepage: GitHub
Documentation: API
Any problem? Issues
Any suggestion? Pull request
Constructors
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
-
addAllTo(
RoomType roomType, List entities, {int? playlistKey}) → Future< List< int> > - Used to add a list of song(entity) to a specific room.
-
addTo(
RoomType roomType, dynamic entity, {int? playlistKey, bool ignoreDuplicate = true}) → Future< int?> -
Used to add a specific song(entity) into a specific
Room
. -
checkIn(
RoomType roomType, int entityKey, {int? playlistKey}) → Future< bool> - Used to check if a song(entity) was added to a specific room.
-
clearAll(
) → Future< bool> - Used to reset ALL the database.
-
clearPlaylists(
) → Future< bool> - Used to delete ALL the playlists.
-
clearRoom(
RoomType roomType, {int? playlistKey}) → Future< bool> - Used to delete ALL the entities from a specific room.
-
closeRoom(
) → void - Used to close room's
-
createPlaylist(
String playlistName, {bool ignoreDuplicate = false}) → Future< int?> - Used to create a internal playlist.
-
deleteAllFrom(
RoomType roomType, List< int> keys, {int? playlistKey}) → Future<bool> - Used to delete all defined entities from a specific room.
-
deleteFrom(
RoomType roomType, int entityKey, {int? playlistKey}) → Future< bool> - Used to delete a specific song(entity) from a specific room.
-
deletePlaylist(
int key) → Future< bool> - Used to delete a internal playlist.
-
deleteRoomFile(
RoomType roomType) → Future< bool> - Used to delete the file which contains the box and closes the box.
-
getRoomInfo(
RoomType roomType) → RoomEntity -
Used to get some information about a specific
Room
. -
initRoom(
[RoomType? roomType, String? subDir]) → Future< bool> - Used to init/open room's
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
queryAllFromPlaylist(
int playlistKey, {int limit = 50, bool reverse = false, RoomSortType? sortType}) → Future< List< SongEntity> > -
Used to query all songs(entities) from
playlist
room. -
queryFavorites(
{int limit = 50, bool reverse = false, RoomSortType? sortType}) → Future< List< FavoritesEntity> > -
Used to query all songs(entities) from
favorites
room. -
queryFromFavorites(
int entityKey) → Future< FavoritesEntity?> -
Used to query a specific song(entity) from
favorites
room. -
queryFromLastPlayed(
int entityKey) → Future< LastPlayedEntity?> -
Used to query a specific song(entity) from
last_played
room. -
queryFromMostPlayed(
int entityKey) → Future< MostPlayedEntity?> -
Used to query a specific song(entity) from
most_played
room. -
queryFromPlaylist(
int playlistKey, int id) → Future< SongEntity?> -
Used to query a specific song(entity) from
playlist
room. -
queryLastPlayed(
{int limit = 50, bool reverse = false, RoomSortType? sortType}) → Future< List< LastPlayedEntity> > -
Used to query all songs(entities) from
last_played
room. -
queryMostPlayed(
{int limit = 50, bool reverse = false, RoomSortType? sortType}) → Future< List< MostPlayedEntity> > -
Used to query all songs(entities) from
most_played
room. -
queryPlaylist(
int key) → Future< PlaylistEntity?> -
Used to query a specific playlist(entity) from
playlists
room. -
queryPlaylists(
{int limit = 50, bool reverse = false}) → Future< List< PlaylistEntity> > -
Used to query all playlist(entities) from
playlists
room. -
renamePlaylist(
int key, String newName) → Future< bool> - Used to rename a internal playlist.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateCount(
int key, {bool automatic = true, int? newCount}) → Future< bool> - Used to update the count of listened songs.
-
updateRoom(
RoomType roomType, dynamic entity) → Future< bool> -
Used to update a specific
Room
.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited