package vorbis

You can search for identifiers within the package.

in-package search v0.2.0

vorbis
- Vorbis
  - Decoder
  - Encoder
  - File
    
    Decoder
  - Skeleton
vorbis.decoder
- Vorbis_decoder

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Internal decoder state

val init : Ogg.Stream.packet -> Ogg.Stream.packet -> Ogg.Stream.packet -> t

Initialize decoder. Needs the first 3 packets of the ogg logical * stream. Use check_packet to check against the first one.

val info : t -> info

Get vorbis infos from the decoder

val comments : t -> string * (string * string) list

Get vorbis comments from the decoder

val check_packet : Ogg.Stream.packet -> bool

Check wether a ogg packet contains vorbis data. * Usefull for parsing ogg containers with multiple streams.

val decode_pcm : 
  t ->
  Ogg.Stream.stream ->
  float array array ->
  int ->
  int ->
  int

decode_pcm dec stream buffer pos offset decodes pcm float data * from stream. The floats are written in buffer, starting at * position pos. The function returns the number of samples actually written.

val restart : t -> unit

Restart the decoder