diff options
| author | Paul Adenot <[email protected]> | 2023-11-10 15:27:05 +0100 |
|---|---|---|
| committer | Paul Adenot <[email protected]> | 2023-11-10 15:32:00 +0100 |
| commit | 28eed05dd57c7645e89b7ab364490223d21ed6cd (patch) | |
| tree | 3987f2646a969aa46af7e77e6a03c0627022c033 /include | |
| parent | 625213fd9f34baa2bee05004219592ed8a6675ce (diff) | |
| download | cubeb-28eed05dd57c7645e89b7ab364490223d21ed6cd.tar.gz cubeb-28eed05dd57c7645e89b7ab364490223d21ed6cd.zip | |
Non functional change: Fix missing documentation in cubeb.h
Diffstat (limited to 'include')
| -rw-r--r-- | include/cubeb/cubeb.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/cubeb/cubeb.h b/include/cubeb/cubeb.h index f653f5b..b606695 100644 --- a/include/cubeb/cubeb.h +++ b/include/cubeb/cubeb.h @@ -163,6 +163,7 @@ typedef enum { implications. */ } cubeb_log_level; +/// A single channel position, to be used in a bitmask. typedef enum { CHANNEL_UNKNOWN = 0, CHANNEL_FRONT_LEFT = 1 << 0, @@ -185,6 +186,9 @@ typedef enum { CHANNEL_TOP_BACK_RIGHT = 1 << 17 } cubeb_channel; +/// A bitmask representing the channel layout of a cubeb stream. This is +/// bit-compatible with WAVEFORMATEXENSIBLE and in the same order as the SMPTE +/// ordering. typedef uint32_t cubeb_channel_layout; // Some common layout definitions. enum { @@ -433,7 +437,7 @@ typedef void (*cubeb_state_callback)(cubeb_stream * stream, void * user_ptr, /** * User supplied callback called when the underlying device changed. - * @param user The pointer passed to cubeb_stream_init. */ + * @param user_ptr The pointer passed to cubeb_stream_init. */ typedef void (*cubeb_device_changed_callback)(void * user_ptr); /** |