package shakuhachi
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=8bd4675792ec93d705e68d4e43dc04aa1124fcaf644ae3a1a3fda68464276f95
sha512=712efcbe13e6e9d3336f72c2c25d4b41225cdd245f21adeeadc8aa4ad31ca9c905077e0873a3d1165d7c09357c009c859c4a7cd9c2d0c9bffc27144525594e72
doc/shakuhachi.libs/Skhclibs/Collection/Album/index.html
Module Collection.AlbumSource
Operations on albums
val kquery :
accept_empty:bool ->
t ->
SkhcDb.Database.t ->
SkhcQuery.Node.t SkhcQuery.Query.t option ->
(((SkhcDb.Album.t
* SkhcDb.Album.Stats.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t)
list,
Sqlite3.Rc.t * string)
result ->
'a) ->
'akquery ~accept_empty collection database query k tries to filter albums within database that matches query. The result is then given to k.
If query is None, no album is matched unless accept_empty, in this case, all albums are matched.
val query :
accept_empty:bool ->
t ->
SkhcDb.Database.t ->
SkhcQuery.Node.t SkhcQuery.Query.t option ->
((SkhcDb.Album.t
* SkhcDb.Album.Stats.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t)
list,
Sqlite3.Rc.t * string)
resultquery ~accept_empty collection database query is Skhclibs.Collection.Album.kquery with k being the identity function.
val musics_from_album_id :
t ->
SkhcDb.Database.t ->
int64 ->
((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_from_id collection database album_id returns all musics having the album id album_id.
val sort :
(bool * (_, _, _, _, _) SkhcQuery.Field.t) list ->
(SkhcDb.Album.t
* SkhcDb.Album.Stats.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t)
list ->
(SkhcDb.Album.t
* SkhcDb.Album.Stats.t
* (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t)
listsort keys musics is SkhcQuery.Query.sort_with_keys with SkhcQuery.Query.compare_album_key.
val set_rating :
t ->
SkhcDb.Database.t ->
SkhcDb.Album.t ->
int option ->
(SkhcDb.Album.t, Sqlite3.Rc.t * string) resultset_rating collection database album rating sets album rating to rating. if SkhcDb.Album.rating album = rating, returns album as is. Otherwise, call SkhcDb.Album.update.
val set_flag :
t ->
SkhcDb.Database.t ->
SkhcDb.Album.t ->
(SkhcDb.Album.t, Sqlite3.Rc.t * string) resultset_flag collection database album sets flag to true. if album has already flag set to true, this functions returns album as is. Otherwise, it calls SkhcDb.Album.update.
val unset_flag :
t ->
SkhcDb.Database.t ->
SkhcDb.Album.t ->
(SkhcDb.Album.t, Sqlite3.Rc.t * string) resultunset_flag collection database album sets flag to false. if album has already flag set to false, this functions returns album as is. Otherwise, it calls SkhcDb.Album.update.
cover collection album returns the cover bytes associated with album in collection. Returns None is album doesn't have an artwork. This function doesn't try to find a cover inside album' songs.
raise Sys_error if one of the underlying system calls fails.