README touchup

This commit is contained in:
Andrew Kelley 2015-09-03 10:54:50 -07:00
parent b55a225b9c
commit 066553b07e
2 changed files with 8 additions and 2 deletions

View file

@ -8,8 +8,6 @@ This library is an abstraction; however in the delicate balance between
performance and power, and API convenience, the scale is tipped closer to
the former. Features that only exist in some sound backends are exposed.
**This project is a work-in-progress.**
## Features and Limitations
* Supported backends:
@ -263,6 +261,8 @@ For each backend, do the following:
parameters to test a USB microphone in raw mode.
0. Run `./backend_disconnect_recover` and read the testing instructions that
it prints.
0. Run `./latency` and make sure the printed beeps line up with the beeps that
you hear.
### Building the Documentation

View file

@ -1012,6 +1012,9 @@ SOUNDIO_EXPORT int soundio_outstream_pause(struct SoundIoOutStream *outstream, b
/// to become audible.
///
/// This function must be called only from within SoundIoOutStream::write_callback.
///
/// Possible errors:
/// * #SoundIoErrorStreaming
SOUNDIO_EXPORT int soundio_outstream_get_latency(struct SoundIoOutStream *outstream,
double *out_latency);
@ -1114,6 +1117,9 @@ SOUNDIO_EXPORT int soundio_instream_pause(struct SoundIoInStream *instream, bool
/// represented in the buffer. This includes both software and hardware latency.
///
/// This function must be called only from within SoundIoInStream::read_callback.
///
/// Possible errors:
/// * #SoundIoErrorStreaming
SOUNDIO_EXPORT int soundio_instream_get_latency(struct SoundIoInStream *instream,
double *out_latency);