mirror of
https://github.com/Ryujinx/libsoundio.git
synced 2025-01-03 19:45:44 +00:00
small docs update
This commit is contained in:
parent
4c5742eb29
commit
7bab3f0189
|
@ -258,7 +258,6 @@ view `coverage/index.html` in a browser.
|
|||
out what the frame index it thinks the user pressed it at and make sure
|
||||
that is correct.
|
||||
0. Create a test for input stream overflow handling.
|
||||
0. Expose JACK options in `jack_client_open`
|
||||
0. Allow calling functions from outside the callbacks as long as they first
|
||||
call lock and then unlock when done.
|
||||
0. Should pause/resume be callable from outside the callbacks?
|
||||
|
@ -268,13 +267,9 @@ view `coverage/index.html` in a browser.
|
|||
0. use a documentation generator and host the docs somewhere
|
||||
0. -fvisibility=hidden and then explicitly export stuff, or
|
||||
explicitly make the unexported stuff private
|
||||
0. look at microphone example and determine if fewer memcpys can be done
|
||||
with the audio data
|
||||
- test that sending the frame count to begin read works with PulseAudio
|
||||
0. add len arguments to APIs that have char *
|
||||
0. Test in an app that needs to synchronize video to test the
|
||||
latency/synchronization API.
|
||||
0. Support PulseAudio proplist properties for main context and streams
|
||||
0. Expose JACK options in `jack_client_open`
|
||||
0. custom allocator support
|
||||
0. mlock memory which is accessed in the real time path
|
||||
0. make rtprio warning a callback and have existing behavior be the default callback
|
||||
|
|
|
@ -493,6 +493,7 @@ void soundio_destroy(struct SoundIo *soundio);
|
|||
// to. It tries `soundio_connect_backend` on all available backends in order.
|
||||
int soundio_connect(struct SoundIo *soundio);
|
||||
// Instead of calling `soundio_connect` you may call this function to try a
|
||||
// specific backend.
|
||||
int soundio_connect_backend(struct SoundIo *soundio, enum SoundIoBackend backend);
|
||||
void soundio_disconnect(struct SoundIo *soundio);
|
||||
|
||||
|
@ -654,7 +655,7 @@ int soundio_outstream_start(struct SoundIoOutStream *outstream);
|
|||
// greater than 0 frames.
|
||||
// It is your responsibility to call this function no more and no fewer than the
|
||||
// correct number of times as determined by `requested_frame_count` from
|
||||
// `write_callback`. See sine.c for an example.
|
||||
// `write_callback`. See sio_sine.c for an example.
|
||||
// You must call this function only from the `write_callback` thread context.
|
||||
// After calling this function, write data to `areas` and then call `soundio_outstream_end_write`.
|
||||
int soundio_outstream_begin_write(struct SoundIoOutStream *outstream,
|
||||
|
@ -705,7 +706,7 @@ int soundio_instream_start(struct SoundIoInStream *instream);
|
|||
// Returned will be the number of frames you can actually read.
|
||||
// It is your responsibility to call this function no more and no fewer than the
|
||||
// correct number of times as determined by `available_frame_count` from
|
||||
// `read_callback`. See microphone.c for an example.
|
||||
// `read_callback`. See sio_microphone.c for an example.
|
||||
// You must call this function only from the `read_callback` thread context.
|
||||
// After calling this function, read data from `areas` and then use
|
||||
// `soundio_instream_end_read` to actually remove the data from the buffer
|
||||
|
|
Loading…
Reference in a new issue