API Reference¶

This API provides a way to develop audio applications using Elements like Codecs, Streams or Filters.

Elements of the Audio Development Framework¶

The application is developed by combining the Elements into a Pipeline. A diagram below presents organization of two elements, MP3 decoder and I2S stream, in the Audio Pipeline, that has been used in get-started/play_mp3 example.

Sample Organization of Elements in Audio Pipeline¶

The audio data is typically acquired using an input Stream, processed with Codecs and Filters, and finally output with another Stream. There is an Event Interface to facilitate communication of the application events. Interfacing with specific hardware is done using Peripherals.

See a table of contents below with links to description of all the above components.