README.md
1# An implementation of the audio driver protocol
2
3This library is a C++ implementation of the Zircon Audio Stream and Ring Buffer
4driver protocols suitable for use in simple audio drivers where the codec and
5DAI functionality are contained in the same driver.
6
7It handles most of the boilerplate of publishing and shutting down devices,
8handling client connections, and serialization/de-serialization/validation of
9protocol messages as well as enforcing some of the protocol state requirements.
10
11Generally speaking, users of the library should only need to subclass the
12SimpleAudioStream, provide details about their capabilities during Init, then
13respond to messages in their overloaded methods. Hopefully, this allows authors
14of simple audio drivers more time to focus on banging on registers, and less
15time on manually validating messages and protocol state.
16