package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.3.1.tar.gz
sha256=91dc3168bc12fdd6032c16f9990018fd54f91cea50d9f6eb798e4d5eecd9c6a6
sha512=a93c4bf39d80d2c595d361b393f0f1fd2fd078e5bd714988e835a0b5ac8c8c48d3b4cbe2e11d33c9168d9f2f44818b6a60e38b32773bd4967c24794abbf323dd

doc/shakuhachi.config/SkhcConfig/Format/index.html

Module SkhcConfig.FormatSource

Operations on the .format section.

Sourcetype t

type of the format section.

Sourceval section : string

section name

Sourceval default : t

default is the section used if the format section is missing from the configuration file.

Sourceval init : filename:string -> artist_artwork:string -> album_cover:string -> music_list:string -> album_list:string -> artist_list:string -> music_remove:string -> t

init ~filename ~artist_artwork ~album_cover ~music_list ~album_list ~artist_list ~music_remove create a format section with filename, artist_artwork, album_cover, music_list, album_list, artist_list and music_remove.

  • since 0.2.0, [artist_artwork] and [album_cover] new parameters.
Sourceval of_section : Section.t -> t

of_section section parse section to create a format section. If an expected key is missing from section, the key is associated with its default value.

Sourceval to_section : t -> Section.t

to_section format serializes format into a section.

Sourceval filename : t -> string

filename format returns the formatting used for naming a music file.

Sourceval artist_artwork : t -> string

artist_cover format returns the formatting used for naming an artist's artwork.

  • since 0.2.0
Sourceval album_cover : t -> string

album_cover format returns the formatting used for naming an album's cover.

  • since 0.2.0
Sourceval music_list : t -> string

music_list format returns the formatting used when listing musics.

Sourceval artist_list : t -> string

artist format returns the formatting used when listing artists.

Sourceval album_list : t -> string

album_list format returns the formatting used when listing albums.

Sourceval music_remove : t -> string

music_remove format returns the formatting used when removing musics.