package shakuhachi
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=966fc8667c2aa9830e64950d2de74bd564a65d60e1f50cfd3dc1e99ef106dc47
sha512=6423ce04d784ba521a7f49fabdafbe036e2dd80cd08ca999fdc6767262d7f12aa4e5002d65efd4c568b343eaabf4d680191c88334d629e1ca0156084531e9e0b
doc/shakuhachi.libs/Skhclibs/Collection/Playlist/index.html
Module Collection.PlaylistSource
Operations on playlists
val create :
t ->
SkhcDb.Database.t ->
smart:bool ->
flag:bool ->
rating:int option ->
string ->
SkhcQuery.Query.t ->
(SkhcDb.Playlist.t
* (SkhcDb.MusicFile.t
* SkhcDb.Album.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
* SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
list,
Sqlite3.Rc.t * string)
resultcreate collection database ~smart ~flag ~rating name query creates a new playlist with songs matched by query. The newly created playlist is inserted inside database and the playlist is returned.
val playlists :
t ->
SkhcDb.Database.t ->
((SkhcDb.Playlist.t * SkhcDb.Playlist.Stats.t) list, Sqlite3.Rc.t * string)
resultplaylists collection database returs all playlists managed by collection.
val find_from_name :
t ->
SkhcDb.Database.t ->
string ->
(SkhcDb.Playlist.t option, Sqlite3.Rc.t * string) resultfind_from_name collection database name finds the first playlist having the name name. Returns None if no such playlist is found.
val musics :
t ->
SkhcDb.Database.t ->
SkhcDb.Playlist.t ->
((SkhcDb.MusicFile.t
* SkhcDb.Album.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
* SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
list,
Sqlite3.Rc.t * string)
resultmusics collection database playlist fetches all the musics within playlist.
val add :
t ->
SkhcDb.Database.t ->
SkhcDb.Playlist.t ->
SkhcQuery.Query.t ->
(SkhcDb.Playlist.t
* (SkhcDb.MusicFile.t
* SkhcDb.Album.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
* SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
list,
Error.t)
resultadd collection db playlist query adds musics matched by query in playlist. Returns the updated playlist along with its songs.
val delete :
t ->
SkhcDb.Database.t ->
SkhcDb.Playlist.t ->
SkhcQuery.Query.t ->
(SkhcDb.Playlist.t
* (SkhcDb.MusicFile.t
* SkhcDb.Album.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
* SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
list,
Error.t)
resultdelete collection db playlist query removes musics matched by query from playlist. Returns the updated playlist along with its songs.
val replace :
t ->
SkhcDb.Database.t ->
SkhcDb.Playlist.t ->
SkhcQuery.Query.t ->
(SkhcDb.Playlist.t
* (SkhcDb.MusicFile.t
* SkhcDb.Album.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
* SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
list,
Error.t)
resultreplace collection db playlist query replaces playlist's query by query. For non-smart playlist, This functions also recomputes playlist's songs. Returns the updated playlist along with its songs.
val remove :
t ->
SkhcDb.Database.t ->
SkhcDb.Playlist.t ->
(unit, Sqlite3.Rc.t * string) resultremove collection db playlist removes playlist from db.
val remove_from_name :
t ->
SkhcDb.Database.t ->
string ->
(unit, [> `NoMatchingPlaylist | `SqliteError of Sqlite3.Rc.t * string ])
resultremove_from_name is remove but tries to find the playlist from its name.