From 1e49c6d5b39023b432d8cce13508170a219fcd1e Mon Sep 17 00:00:00 2001 From: Seungbae Shin Date: Thu, 18 Feb 2016 19:41:39 +0900 Subject: [PATCH] Revise doxygen / document description [Version] 0.3.26 [Profile] Common [Issue Type] Document Change-Id: I773ed789e4c928cd137b423397093a5806dd5e77 --- doc/audio_io_doc.h | 4 ++-- include/audio_io.h | 4 ++-- packaging/capi-media-audio-io.spec | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/audio_io_doc.h b/doc/audio_io_doc.h index 627981e..2d9f045 100644 --- a/doc/audio_io_doc.h +++ b/doc/audio_io_doc.h @@ -47,8 +47,8 @@ * The input and output devices both have an available set of queries, to find the suggested buffer size, sampling rate, channel type, * and sample type. For output, there is an additional query, to get the sound type (these types are defined in the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API). * - * Reading and writing is done by allocating a buffer and passing the buffer to the input device - * via audio_in_start_recording(), audio_in_read(), or writing to the buffer and passing it to the output device via audio_out_write(). + * Reading from input device is done by audio_in_read() with allocated buffer after audio_in_prepare(). + * Similarly, writing to output device is done by audio_out_write() with allocated buffer after audio_out_prepare(). * */ diff --git a/include/audio_io.h b/include/audio_io.h index 57b2e67..1446460 100644 --- a/include/audio_io.h +++ b/include/audio_io.h @@ -1043,7 +1043,7 @@ int audio_out_ignore_session(audio_out_h output); * * @details @a callback will be called when you can write a PCM data. * It might cause dead lock if change the state of audio handle in callback. - * (ex: audio_in_destroy, audio_in_prepare, audio_in_unprepare) + * (ex: audio_out_destroy, audio_out_prepare, audio_out_unprepare) * Recommend to use as a VOIP only. * Recommend not to hold callback too long.(it affects latency) * @@ -1061,7 +1061,7 @@ int audio_out_ignore_session(audio_out_h output); * @retval #AUDIO_IO_ERROR_DEVICE_NOT_OPENED Device not opened * @retval #AUDIO_IO_ERROR_SOUND_POLICY Sound policy error * - * @see audio_in_set_stream_cb() + * @see audio_out_unset_stream_cb() */ int audio_out_set_stream_cb(audio_out_h output, audio_out_stream_cb callback, void* user_data); diff --git a/packaging/capi-media-audio-io.spec b/packaging/capi-media-audio-io.spec index 52b5830..e1a86c2 100644 --- a/packaging/capi-media-audio-io.spec +++ b/packaging/capi-media-audio-io.spec @@ -1,6 +1,6 @@ Name: capi-media-audio-io Summary: An Audio Input & Audio Output library in Tizen Native API -Version: 0.3.25 +Version: 0.3.26 Release: 0 Group: Multimedia/API License: Apache-2.0 -- 2.7.4