Music (p.shakuhachi.0.3.3.doc.shakuhachi.libs.Skhclibs.Collection.Music)

Source

val kquery : 
  accept_empty:bool ->
  t ->
  SkhcDb.Database.t ->
  SkhcQuery.Node.t SkhcQuery.Query.t option ->
  (((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)
     result ->
    'a) ->
  'a

kquery ~accept_empty collection database query k tries to filter musics within database that matches query. The result is then given to k.

If query is None, no music is matched unless accept_empty, in this case, all musics are matched.

since 0.3.3

Source

val query : 
  accept_empty:bool ->
  t ->
  SkhcDb.Database.t ->
  SkhcQuery.Node.t SkhcQuery.Query.t option ->
  ((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)
    result

query ~accept_empty collection database query is Skhclibs.Collection.Music.kquery with k being the identity function.

since 0.3.3

Source

val add : 
  t ->
  SkhcDb.Database.t ->
  ?music_old:SkhcDb.MusicFile.t ->
  compilation:bool ->
  string ->
  SkhcMetadata.Metadata.t ->
  (SkhcDb.MusicFile.t, Sqlite3.Rc.t * string) result

add collection database ?music_old ~compilation path metadata adds the song located at path with metadata to db. add reads metadata to create or find artists and albums. compilation indicates whether the song is part of a compilation album.

if music_old, add updates music_old.

see SkhcDb.MusicFile.insert for more explainations on music_old.

raise Unix.Unix_error if Unix.stat fails with path.

Source

val remove : 
  t ->
  SkhcDb.Database.t ->
  SkhcDb.MusicFile.t ->
  (unit, Sqlite3.Rc.t * string) result

remove collection database musicfile removes musicfile from the database. The file in the filesystem is untouched.

Sourceval path : t -> SkhcDb.MusicFile.t -> string

path collection music returns the full path of music.

Source

val scrobble : 
  ?played_at:float ->
  t ->
  SkhcDb.Database.t ->
  SkhcDb.MusicFile.t ->
  (SkhcDb.MusicFile.t, Sqlite3.Rc.t * string) result

scrobble ?played_at collection database music_file increases play_count by one, set played_at to played_at if given or defaults to Unix.time () and call SkhcDb.MusicFile.update

before 0.3.3,
no optional argument $played_at

Source

val set_rating : 
  t ->
  SkhcDb.Database.t ->
  SkhcDb.MusicFile.t ->
  int option ->
  (SkhcDb.MusicFile.t, Sqlite3.Rc.t * string) result

set_rating collection database music rating sets music rating to rating. if SkhcDb.MusicFile.rating music = rating, returns music as is. Otherwise, call SkhcDb.MusicFile.update.

Source

val set_flag : 
  t ->
  SkhcDb.Database.t ->
  SkhcDb.MusicFile.t ->
  (SkhcDb.MusicFile.t, Sqlite3.Rc.t * string) result

set_flag collection database music_file sets flag to true. if music_file has already flag set to true, this functions returns music_file as is. Otherwise, it calls SkhcDb.MusicFile.update.

Source

val unset_flag : 
  t ->
  SkhcDb.Database.t ->
  SkhcDb.MusicFile.t ->
  (SkhcDb.MusicFile.t, Sqlite3.Rc.t * string) result

unset_flag collection database music_file sets flag to false. if music_file has already flag set to false, this functions returns music_file as is. Otherwise, it calls SkhcDb.MusicFile.update.

Sourceval audio : t -> SkhcDb.MusicFile.t -> string

audio collection music_file returns the content of the file pointed by music_file.

raise Sys_error if one of the underlying system calls fails.

Source

val find_with_metadata : 
  compilation:bool ->
  t ->
  SkhcDb.Database.t ->
  SkhcMetadata.Metadata.t ->
  (_, _, _, _, _) SkhcQuery.Field.t SkhcQuery.Query.t ->
  (SkhcDb.MusicFile.t
   * SkhcDb.Album.t
   * (string * SkhcDb.Roles.t) Map.Make(Int64).t
   * SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
    option

find_with_metadata ~compilation collection database metadata query tries to find a music within database which has metadata matching metadata with query.

since 0.3.0

Source

val sort : 
  (bool * ('a, 'b, 'c, 'd, 'e) SkhcQuery.Field.t) list ->
  (SkhcDb.MusicFile.t
   * SkhcDb.Album.t
   * (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
   * SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
    list ->
  (SkhcDb.MusicFile.t
   * SkhcDb.Album.t
   * (string * SkhcDb.Roles.t) SkhcDb.Ids.Map.t
   * SkhcMetadata.Metadata.Values.t SkhcMetadata.Metadata.Properties.t)
    list

sort keys musics is SkhcQuery.Query.sort_with_keys with SkhcQuery.Query.compare_music_key.

since 0.3.1