package cue_sheet_maker

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type cue_sheet = {
  1. catalog : string option;
  2. cd_text_file : string option;
  3. cd_texts : [ `Arranger of string | `Composer of string | `Disc_Id of string | `Genre of string | `Message of string | `Performer of string | `Size_Info of string | `Songwriter of string | `Title of string | `Toc_Info of string | `Toc_Info2 of string ] list;
  4. rems : (string, string) Stdlib.Hashtbl.t;
  5. file : string * cue_file_format;
  6. tracks : CueTrack.cue_track list;
}
val create_empty_sheet : file:(string * cue_file_format) -> cue_sheet

Create an cue sheet representation with just the file name and its format

val string_of_cue_sheet : ?sum:bool -> cue_sheet -> string

String representation of a cue sheet

if ~sum all the indexes of tracks will be set by adding the offset time of previous tracks. Use ~sum if you set for each track its length

val add_catalog : string -> cue_sheet -> cue_sheet

Add a catalog to the sheet. If the catalog already exist, the old value is replaced

val add_cd_text_file : string -> cue_sheet -> cue_sheet

Add a cd text file to the sheet. If the cd text file already exist, the old value is replaced

val add_arranger : string -> cue_sheet -> cue_sheet

Add an arraanger to the sheet. If the arranger already exist, the old value is replaced

val add_composer : string -> cue_sheet -> cue_sheet

Add a composer to the sheet. If the composer already exist, the old value is replaced

val add_disc_id : string -> cue_sheet -> cue_sheet

Add a disc id to the sheet. If the disc id already exist, the old value is replaced

val add_genre : string -> cue_sheet -> cue_sheet

Add a genre to the sheet. If the genre already exist, the old value is replaced

val add_message : string -> cue_sheet -> cue_sheet

Add a message to the sheet. If the message already exist, the old value is replaced

val add_performer : string -> cue_sheet -> cue_sheet

Add a performer to the sheet. If the performer already exist, the old value is replaced

val add_songwriter : string -> cue_sheet -> cue_sheet

Add a songwritter to the sheet. If the songwritter already exist, the old value is replaced

val add_title : string -> cue_sheet -> cue_sheet

Add a title to the sheet. If the title already exist, the old value is replaced

val add_toc_info : string -> cue_sheet -> cue_sheet

Add a toc info to the sheet. If the toc info already exist, the old value is replaced

val add_toc_info2 : string -> cue_sheet -> cue_sheet

Add a toc info 2 to the sheet. If the toc info 2 already exist, the old value is replaced

val add_size_info : string -> cue_sheet -> cue_sheet

Add a size info to the sheet. If the size info talog already exist, the old value is replaced

val add_rem : (string * string) -> cue_sheet -> cue_sheet

Add a rem to the sheet. If the rem key already exist, the old value is replaced. All key are set uppercase

val add_track : CueTrack.cue_track -> cue_sheet -> cue_sheet

Add a track to the sheet. If the index of the track already exist, the old value is replaced

val export : ?sum:bool -> string -> cue_sheet -> (unit, exn) Stdlib.result

Write the string representation of a cue sheet to the file output

if ~sum all the indexes of tracks will be set by adding the offset time of previous tracks. Use ~sum if you set for each track its length

See string_of_cue_sheet

  • returns

    unit if sucess or exn if an error occured with the file handling