package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install 

dune-project
 Dependency

codeberg.org Readme Changelog Edit opam file Versions (5)

Authors

  1. E
    EruEri <nayinayu@mailo.com>

Maintainers

  1. E
    EruEri <nayinayu@mailo.com>

Sources

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

doc/shakuhachi.plugin/SkhcPlugin/Plugin/module-type-S/index.html

Module type Plugin.SSource

Signature of a shakuhachi plugin.

val name : string

Plugin's name. This name should match the one inside the configuration file.

val on_loaded : (Skhclibs.Collection.t -> SkhcConfig.Plugin.Config.t -> bool) option

on_loaded collection plg_conf is called when the module is successfully loaded.

val on_scan_file : (Skhclibs.Collection.t -> string -> string) option

on_scan_file collection path is called when a file at path will be treated for importing. on_scan_file returns the path to the file that have to being imported. Useful if your want to transcode audiofile before importing.

val on_scan_metadata : (Skhclibs.Collection.t -> string -> SkhcMetadata.Metadata.t -> SkhcMetadata.Metadata.t) option

on_metadata collection path metadata is called right after the medadata being extracted from the audio file at path when importing.

val on_file_moved : (Skhclibs.Collection.t -> string -> string -> unit) option

on_file_moved collection src dst is called when a file within a collection is moved from src to dst

val on_music_modified : (Skhclibs.Collection.t -> SkhcDb.MusicFile.t -> SkhcDb.MusicFile.t -> unit) option

on_music_modified collection old new' is called when old is modified. At least a field, other than id and updated_at is different between old and new'.

val on_artist_modified : (Skhclibs.Collection.t -> SkhcDb.Artist.t -> SkhcDb.Artist.t -> unit) option

on_artist_modified collection old new' is called when old is modified. At least a field, other than id and updated_at is different between old and new'.

val on_album_modified : (Skhclibs.Collection.t -> SkhcDb.Album.t -> SkhcDb.Album.t -> unit) option

on_album_modified collection old new' is called when old is modified. At least a field, other than id and updated_at is different between old and new'.

val on_playlist_modified : (Skhclibs.Collection.t -> SkhcDb.Playlist.t -> SkhcDb.Playlist.t -> unit) option

on_playlist_modified collection old new' is called when old is modified. At least a field, other than id and updated_at is different between old and new'.

on_playlist_tracks_updated collection playlist musics is called when the musics inside of playlist has been updated.