extra/audio/vorbis/vorbis-docs.factor

   1 ! Copyright (C) 2010 Joe Groff.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: audio.engine destructors help.markup help.syntax
   4 io.files kernel math strings ;
   5 IN: audio.vorbis
   6
   7 HELP: <vorbis-stream>
   8 { $values
   9     { "stream" "a binary input stream" } { "buffer-size" integer }
  10     { "vorbis-stream" vorbis-stream }
  11 }
  12 { $description "Constructs " { $link vorbis-stream } " over the contents of " { $snippet "stream" } ". When used as an audio generator, the Vorbis stream will supply data to the audio engine in " { $snippet "buffer-size" } " byte blocks. If the Vorbis stream is created successfully, it will take ownership of " { $snippet "stream" } ", disposing it when " { $link dispose } " is called on the " { $snippet "vorbis-stream" } "." } ;
  13
  14 HELP: no-vorbis-in-ogg
  15 { $description { $link <vorbis-stream> } " throws this error when the Ogg stream it reads contains no Vorbis channel." } ;
  16
  17 HELP: ogg-error
  18 { $values
  19     { "code" integer }
  20 }
  21 { $description { $link <vorbis-stream> } " throws this error when the Ogg library raises an error while trying to parse the stream." } ;
  22
  23 HELP: read-vorbis-stream
  24 { $values
  25     { "filename" string } { "buffer-size" integer }
  26     { "vorbis-stream" vorbis-stream }
  27 }
  28 { $description "Opens a binary " { $link <file-reader> } " for the file named " { $snippet "filename" } ", and construct a " { $link vorbis-stream } " over the file contents using " { $link <vorbis-stream> } "." } ;
  29
  30 { read-vorbis-stream <vorbis-stream> } related-words
  31
  32 HELP: vorbis-error
  33 { $values
  34     { "code" integer }
  35 }
  36 { $description { $link <vorbis-stream> } " throws this error when the Vorbis library raises an error while trying to parse the stream." } ;
  37
  38 HELP: vorbis-stream
  39 { $class-description "Objects of this class maintain the stream and decoder state for the Ogg Vorbis decoder. " { $snippet "vorbis-stream" } " implements the " { $link "audio.engine-generators" } ", so it can be used as the generator for a " { $link streaming-audio-clip } ". Use " { $link <vorbis-stream> } " or " { $link read-vorbis-stream } " to construct a Vorbis stream." } ;
  40
  41 ARTICLE: "audio.vorbis" "Ogg Vorbis audio streaming"
  42 "The " { $vocab-link "audio.vorbis" } " vocabulary provides Ogg Vorbis decoding and streaming for " { $vocab-link "audio.engine" } "."
  43 { $subsections
  44     vorbis-stream
  45     read-vorbis-stream
  46     <vorbis-stream>
  47 } ;
  48
  49 ABOUT: "audio.vorbis"