opusfile Documentation

Introduction

This is the documentation for the libopusfile C API.

The libopusfile package provides a convenient high-level API for decoding and basic manipulation of all Ogg Opus audio streams. libopusfile is implemented as a layer on top of Xiph.Org's reference libogg and libopus libraries.

libopusfile provides serveral sets of built-in routines for file/stream access, and may also use custom stream I/O routines provided by the embedded environment. There are built-in I/O routines provided for ANSI-compliant stdio (FILE *), memory buffers, and URLs (including <file:> URLs, plus optionally <http:> and <https:> URLs).

Organization

The main API is divided into several sections:

• Opening and Closing
• Stream Information
• Decoding
• Seeking

Several additional sections are not tied to the main API.

• Abstract Stream Reading Interface
• Header Information
• Error Codes