Overview

This document is intended to give you a conceptual overview of Cricket Audio.

Detailed API documentation is in the C++ header files themselves, in the inc/ck directory.  Doxygen-generated documentation for those headers can be found here.

For the iOS Objective-C interface, every method or property corresponds directly to a function in the C++ interface; so for documentation on a particular Objective-C method or property, refer to the corresponding function in the C++ documentation.  For example, for documentation on the -(void) play method on the class CkoSound, look at the documentation for CkSound::play().

For the Android Java interface, there is javadoc-generated documentation here.