metadata 0.3.0 (latest) · OCaml Package

ID3v2 metadata.

val parse : 
  ?recode:
    (?source:[ `ISO_8859_1 | `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      ?target:[ `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      string ->
      string) ->
  Metadata__.MetadataBase.Reader.t ->
  (string * string) list

Parse the ID3v2 header.

val parse_file : 
  ?recode:
    (?source:[ `ISO_8859_1 | `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      ?target:[ `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      string ->
      string) ->
  ?custom_parser:(Metadata__.MetadataBase.parser_handler -> unit) ->
  string ->
  (string * string) list

Parse the ID3v2 header from a file.

val dump : Metadata__.MetadataBase.Reader.t -> string

Dump the ID3v2 header.

val dump_file : string -> string

Dump the ID3v2 header from a file.

type apic = {

mime : string;
picture_type : int;
description : string;
data : string;

}

type pic = {

pic_format : string;
pic_type : int;
pic_description : string;
pic_data : string;

}

val parse_apic : 
  ?recode:
    (?source:[ `ISO_8859_1 | `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      ?target:[ `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      string ->
      string) ->
  string ->
  apic

Parse an APIC tag (containing album art).

val parse_pic : 
  ?recode:
    (?source:[ `ISO_8859_1 | `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      ?target:[ `UTF_8 | `UTF_16 | `UTF_16LE | `UTF_16BE ] ->
      string ->
      string) ->
  string ->
  pic

Parse a PIC tag (containing album art).

type frame_id = [

| `AENC
| `APIC
| `COMM
| `COMR
| `ENCR
| `EQUA
| `ETCO
| `GEOB
| `GRID
| `IPLS
| `LINK
| `MCDI
| `MLLT
| `OWNE
| `PCNT
| `POPM
| `POSS
| `PRIV
| `RBUF
| `RVAD
| `RVRB
| `SYLT
| `SYTC
| `TALB
| `TBPM
| `TCOM
| `TCON
| `TCOP
| `TDAT
| `TDLY
| `TENC
| `TEXT
| `TFLT
| `TIME
| `TIT1
| `TIT2
| `TIT3
| `TKEY
| `TLAN
| `TLEN
| `TMED
| `TOAL
| `TOFN
| `TOLY
| `TOPE
| `TORY
| `TOWN
| `TPE1
| `TPE2
| `TPE3
| `TPE4
| `TPOS
| `TPUB
| `TRCK
| `TRDA
| `TRSN
| `TRSO
| `TSIZ
| `TSRC
| `TSSE
| `TXXX
| `TYER
| `UFID
| `USER
| `USLT
| `WCOM
| `WCOP
| `WOAF
| `WOAR
| `WOAS
| `WORS
| `WPAY
| `WPUB
| `WXXX

]

Frame identifier.

val string_of_frame_id : frame_id -> string

String representation of a frame identifier.

val frame_id_of_string : string -> frame_id option

Parse a string into a frame id.

val binary_frame : frame_id -> bool

Does a frame contain binary data?

type text_encoding = [

| `ISO_8859_1
| `UTF_16
| `UTF_16BE
| `UTF_16LE
| `UTF_8

]

Charset for encoding text.

type frame_data = [

| `Text of text_encoding * string
| `Binary of string

]

Data contained in a frame.

type frame_flag = [

| `File_alter_preservation of bool
| `Tag_alter_perservation of bool

]

val default_flags : frame_id -> frame_flag list

Default flags for a frame.

type frame = {

id : frame_id;
data : frame_data;
flags : frame_flag list;

}

A ID3 frame.

val make : version:int -> frame list -> string

Create an ID3v2 header. Consistency between frame_id and frame_data is not enforced and left to the user to check.

package metadata