diff options
author | Paul Adenot <[email protected]> | 2016-07-01 15:00:06 +0200 |
---|---|---|
committer | Paul Adenot <[email protected]> | 2016-07-01 15:00:06 +0200 |
commit | dcc90f40c89cd304a85ed687b59b77d0542dbd2c (patch) | |
tree | 0a6764021f1c0ca4d6908f755ad1271224f17a23 /include | |
parent | 4b4e6e3db126ee62af7514fff65a7f6bd7346aeb (diff) | |
download | cubeb-dcc90f40c89cd304a85ed687b59b77d0542dbd2c.tar.gz cubeb-dcc90f40c89cd304a85ed687b59b77d0542dbd2c.zip |
Address comments.
Diffstat (limited to 'include')
-rw-r--r-- | include/cubeb/cubeb.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/cubeb/cubeb.h b/include/cubeb/cubeb.h index 06ed5fa..9bc06fb 100644 --- a/include/cubeb/cubeb.h +++ b/include/cubeb/cubeb.h @@ -328,7 +328,7 @@ typedef void (* cubeb_state_callback)(cubeb_stream * stream, /** * User supplied callback called when the underlying device changed. - * @param user THe pointer passed to cubeb_stream_init. */ + * @param user The pointer passed to cubeb_stream_init. */ typedef void (* cubeb_device_changed_callback)(void * user_ptr); /** @@ -409,7 +409,7 @@ void cubeb_destroy(cubeb * context); @param data_callback Will be called to preroll data before playback is started by cubeb_stream_start. @param state_callback A pointer to a state callback. - @param user_ptr A pointer that will be passed to the callback. This pointer + @param user_ptr A pointer that will be passed to the callbacks. This pointer must outlive the life time of the stream. @retval CUBEB_OK @retval CUBEB_ERROR @@ -427,7 +427,8 @@ int cubeb_stream_init(cubeb * context, cubeb_state_callback state_callback, void * user_ptr); -/** Destroy a stream. +/** Destroy a stream. `cubeb_stream_stop` MUST be called before destroying a + stream. @param stream The stream to destroy. */ void cubeb_stream_destroy(cubeb_stream * stream); |