ryujinx/libsoundio
1
0
Fork 0
mirror of https://github.com/Ryujinx/libsoundio.git synced 2025-01-03 15:25:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

README touchup

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

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

6
soundio/soundio.h
View file

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