package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.2.0.tar.gz
sha256=966fc8667c2aa9830e64950d2de74bd564a65d60e1f50cfd3dc1e99ef106dc47
sha512=6423ce04d784ba521a7f49fabdafbe036e2dd80cd08ca999fdc6767262d7f12aa4e5002d65efd4c568b343eaabf4d680191c88334d629e1ca0156084531e9e0b

doc/shakuhachi.libs/Skhclibs/Collection/index.html

Module Skhclibs.CollectionSource

Operations on a shakuhachi collection.

Sourcetype t

type of a collection

open' config opens the collection with configuration provided by config.

Sourceval realpath : t -> string -> string

realpath collection path returns

  • path if path is absolute (eg. starts with / on unix).
  • music_directory + path if path is relative.
Sourceval database : t -> SkhcDb.Database.t

database collection returns a database handler associated with collection.

Sourceval with_database : t -> (SkhcDb.Database.t -> 'a) -> 'a

with_database collection f runs f with a database handler associated with collection. SkhcDb.Database.close is guaranteed to be called whether f completes normaly or raises an exception. with_database discards any results or exceptions of SkhcDb.Database.close.

config collection returns the configuration used when calling open'.

Sourceval dir_artist : t -> SkhcMetadata.Metadata.t -> string

dir_artist collection metadata returns the directory name of where should be collected the artist's albums according to metadata. The path returned is relative to configuration's music_directory.

Sourceval dir_artist_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_artist_absolute collection metadata is dir_artist but returns the absolute path instead of the relative one.

Sourceval dir_album : t -> SkhcMetadata.Metadata.t -> string

dir_album collection metadata returns the directory name of where should be collected the album's songs according to metadata. The path returned is relative to configuration's music_directory. Since shakuhachi stores songs in a artist/album directory structure, this function calls dir_artist underneath.

Sourceval dir_album_absolute : t -> SkhcMetadata.Metadata.t -> string

dir_album_absolute collection metadata is dir_album but returns the absolute path instead of the relative one.

Sourcemodule Album : sig ... end

Operations on albums

Sourcemodule Artist : sig ... end

Operations on artists

Sourcemodule Music : sig ... end

Operations on musics

Sourcemodule Playlist : sig ... end

Operations on playlists