OGG Decoder

Decode an audio data stream provided in OGG format.

API Reference

Header File

components/esp-adf-libs/esp_codec/include/codec/ogg_decoder.h

Functions

audio_element_handle_t ogg_decoder_init(ogg_decoder_cfg_t *config)

Create an Audio Element handle to decode incoming OGG data.

Parameters: config – The configuration
Returns: The audio element handle

Structures

struct ogg_decoder_cfg_t

OGG Decoder configuration.

Public Members

int out_rb_size: Size of output ringbuffer

int task_stack: Task stack size

int task_core: CPU core number (0 or 1) where decoder task in running

int task_prio: Task priority (based on freeRTOS priority)

bool stack_in_ext: Try to allocate stack in external memory

Macros

OGG_DECODER_TASK_STACK_SIZE

OGG_DECODER_TASK_CORE

OGG_DECODER_TASK_PRIO

OGG_DECODER_RINGBUFFER_SIZE

DEFAULT_OGG_DECODER_CONFIG()

Provide feedback about this document