ryujinx/libsoundio
1
0
Fork 0
mirror of https://github.com/Ryujinx/libsoundio.git synced 2024-12-23 03:45:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: cleanup

Browse source
This commit is contained in:
Andrew Kelley 2015-09-18 21:20:53 -07:00
parent 65e1d8bdd1
commit a9e455aec8
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
soundio/soundio.h
View file

@ -423,10 +423,10 @@ struct SoundIoDevice {
/// whatever format is most convenient /// whatever format is most convenient
/// for you which is supported by the device, because when you are the only /// for you which is supported by the device, because when you are the only
/// application left, the mixer might decide to switch /// application left, the mixer might decide to switch
/// current_format to yours. You can learn the supported formats via formats and /// current_format to yours. You can learn the supported formats via
/// SoundIoDevice::format_count. If this information is missing due to a /// formats and SoundIoDevice::format_count. If this information is missing
/// probe error, formats will be `NULL`. If current_format /// due to a probe error, formats will be `NULL`. If current_format is
/// is unavailable, it will be set to #SoundIoFormatInvalid. /// unavailable, it will be set to #SoundIoFormatInvalid.
/// Devices are guaranteed to have at least 1 format available. /// Devices are guaranteed to have at least 1 format available.
enum SoundIoFormat current_format; enum SoundIoFormat current_format;
@ -490,14 +490,16 @@ struct SoundIoOutStream {
/// Populated automatically when you call ::soundio_outstream_create. /// Populated automatically when you call ::soundio_outstream_create.
struct SoundIoDevice *device; struct SoundIoDevice *device;
/// Defaults to #SoundIoFormatFloat32NE, followed by the first one supported. /// Defaults to #SoundIoFormatFloat32NE, followed by the first one
/// supported.
enum SoundIoFormat format; enum SoundIoFormat format;
/// Sample rate is the number of frames per second. /// Sample rate is the number of frames per second.
/// Defaults to 48000 (and then clamped into range). /// Defaults to 48000 (and then clamped into range).
int sample_rate; int sample_rate;
/// Defaults to Stereo, if available, followed by the first layout supported. /// Defaults to Stereo, if available, followed by the first layout
/// supported.
struct SoundIoChannelLayout layout; struct SoundIoChannelLayout layout;
/// Ignoring hardware latency, this is the number of seconds it takes for /// Ignoring hardware latency, this is the number of seconds it takes for
@ -547,9 +549,9 @@ struct SoundIoOutStream {
/// pthread_join, pthread_cond_wait, etc. /// pthread_join, pthread_cond_wait, etc.
void (*write_callback)(struct SoundIoOutStream *, void (*write_callback)(struct SoundIoOutStream *,
int frame_count_min, int frame_count_max); int frame_count_min, int frame_count_max);
/// This optional callback happens when the sound device runs out of buffered /// This optional callback happens when the sound device runs out of
/// audio data to play. After this occurs, the outstream waits until the /// buffered audio data to play. After this occurs, the outstream waits
/// buffer is full to resume playback. /// until the buffer is full to resume playback.
/// This is called from the SoundIoOutStream::write_callback thread context. /// This is called from the SoundIoOutStream::write_callback thread context.
void (*underflow_callback)(struct SoundIoOutStream *); void (*underflow_callback)(struct SoundIoOutStream *);
/// Optional callback. `err` is always SoundIoErrorStreaming. /// Optional callback. `err` is always SoundIoErrorStreaming.
@ -580,7 +582,8 @@ struct SoundIoOutStream {
int bytes_per_sample; int bytes_per_sample;
/// If setting the channel layout fails for some reason, this field is set /// If setting the channel layout fails for some reason, this field is set
/// to an error code. Possible error codes are: #SoundIoErrorIncompatibleDevice /// to an error code. Possible error codes are:
/// * #SoundIoErrorIncompatibleDevice
int layout_error; int layout_error;
}; };
@ -589,14 +592,16 @@ struct SoundIoInStream {
/// Populated automatically when you call ::soundio_outstream_create. /// Populated automatically when you call ::soundio_outstream_create.
struct SoundIoDevice *device; struct SoundIoDevice *device;
/// Defaults to SoundIoFormatFloat32NE, followed by the first one supported. /// Defaults to #SoundIoFormatFloat32NE, followed by the first one
/// supported.
enum SoundIoFormat format; enum SoundIoFormat format;
/// Sample rate is the number of frames per second. /// Sample rate is the number of frames per second.
/// Defaults to max(sample_rate_min, min(sample_rate_max, 48000)) /// Defaults to max(sample_rate_min, min(sample_rate_max, 48000))
int sample_rate; int sample_rate;
/// Defaults to Stereo, if available, followed by the first layout supported. /// Defaults to Stereo, if available, followed by the first layout
/// supported.
struct SoundIoChannelLayout layout; struct SoundIoChannelLayout layout;
/// Ignoring hardware latency, this is the number of seconds it takes for a /// Ignoring hardware latency, this is the number of seconds it takes for a