extra/id3/id3-docs.factor

   1 ! Copyright (C) 2008 Tim Wawrzynczak
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax sequences kernel ;
   4 IN: id3
   5
   6 HELP: id3-parse-mp3-file
   7 { $values
   8     { "path" "a path string" }
   9     { "object/f" "either a tuple consisting of the data from an MP3 file, or an f indicating this file has no (supported) ID3 information." } }
  10 { $description "Return a tuple containing the ID3 information parsed out of the MP3 file" } ;
  11
  12 ARTICLE: "id3" "ID3 tags"
  13 { $emphasis "ID3" } " tags are textual data that is used to describe the information (title, artist, etc.) in an .MP3 file"
  14 "Parsing an MP3 file: "
  15 { $subsection id3-parse-mp3-file } ;
  16
  17 ABOUT: "id3"