From a853198d0e0af3515a8f7195561420d276905117 Mon Sep 17 00:00:00 2001 From: Seungbae Shin Date: Tue, 5 Dec 2023 17:16:05 +0900 Subject: [PATCH] Update @since_tizen doxygen tag due to profile merge [Version] 0.5.66 [Issue Type] Doxygen Change-Id: I24cfc27df402b5903fdde94cf332447276142f9c --- include/audio_io.h | 68 +++++++++++++++++++------------------- packaging/capi-media-audio-io.spec | 2 +- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/include/audio_io.h b/include/audio_io.h index a78c239..d971b3c 100644 --- a/include/audio_io.h +++ b/include/audio_io.h @@ -37,7 +37,7 @@ extern "C" { /** * @brief The audio input handle. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef struct audio_io_s *audio_in_h; @@ -52,7 +52,7 @@ typedef struct audio_io_s *audio_in_h; /** * @brief The audio output handle. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef struct audio_io_s *audio_out_h; @@ -67,7 +67,7 @@ typedef struct audio_io_s *audio_out_h; /** * @brief Enumeration for audio sample type with bit depth. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { AUDIO_SAMPLE_TYPE_U8 = 0x70, /**< Unsigned 8-bit audio samples */ @@ -79,7 +79,7 @@ typedef enum { /** * @brief Enumeration for audio channel. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { AUDIO_CHANNEL_MONO = 0x80, /**< 1 channel, mono */ @@ -112,7 +112,7 @@ typedef enum { /** * @brief Enumeration for audio input and output error. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { AUDIO_IO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -142,7 +142,7 @@ typedef enum { /** * @brief Called when audio input data is available in asynchronous (event) mode. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks Use audio_in_peek() to get 'audio in' data inside callback, use audio_in_drop() after use of peeked data. * @@ -175,7 +175,7 @@ typedef void (*audio_in_state_changed_cb)(audio_in_h handle, audio_io_state_e pr * * @details This function is used for audio input initialization. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @privlevel public * @privilege %http://tizen.org/privilege/recorder * @@ -212,7 +212,7 @@ int audio_in_create(int sample_rate, audio_channel_e channel, audio_sample_type_ /** * @brief Releases the audio input handle and all its resources associated with an audio stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input to destroy * @return @c 0 on success, @@ -256,7 +256,7 @@ int audio_in_set_sound_stream_info(audio_in_h input, sound_stream_info_h stream_ /** * @brief Prepares the audio input for reading audio data by starting buffering of audio data from the device. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @return @c 0 on success, @@ -275,7 +275,7 @@ int audio_in_prepare(audio_in_h input); /** * @brief Unprepares the audio input. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @return @c 0 on success, @@ -331,7 +331,7 @@ int audio_in_resume(audio_in_h input); /** * @brief Flushes and discards buffered audio data from the input stream. * - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @since_tizen 2.4 * * @param[in] input The handle to the audio input * @return @c 0 on success, @@ -348,7 +348,7 @@ int audio_in_flush(audio_in_h input); /** * @brief Reads audio data from the audio input buffer. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @param[out] buffer The PCM buffer address @@ -368,7 +368,7 @@ int audio_in_read(audio_in_h input, void *buffer, unsigned int length); /** * @brief Gets the size to be allocated for the audio input buffer. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @param[out] size The buffer size (in bytes, the maximum size is 1 MB) @@ -384,7 +384,7 @@ int audio_in_get_buffer_size(audio_in_h input, int *size); /** * @brief Gets the sample rate of the audio input data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @param[out] sample_rate The audio sample rate \n @@ -401,7 +401,7 @@ int audio_in_get_sample_rate(audio_in_h input, int *sample_rate); /** * @brief Gets the channel type of the audio input data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @param[out] channel The audio channel type \n @@ -418,7 +418,7 @@ int audio_in_get_channel(audio_in_h input, audio_channel_e *channel); /** * @brief Gets the sample audio format of the audio input data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @param[out] type The type of audio sample \n @@ -442,7 +442,7 @@ int audio_in_get_sample_type(audio_in_h input, audio_sample_type_e *type); * Recommend to use as a VOIP only. * Recommend not to hold callback too long.(it affects latency) * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks @a input must be created using audio_in_create(). * @@ -465,7 +465,7 @@ int audio_in_set_stream_cb(audio_in_h input, audio_in_stream_cb callback, void* /** * @brief Unregisters the callback function. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] input The handle to the audio input * @return @c 0 on success, @@ -484,7 +484,7 @@ int audio_in_unset_stream_cb(audio_in_h input); * * @details This function works correctly only with read callback. Otherwise it won't operate as intended. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks Works only in asynchronous (event) mode. * This function provides the pointer to the 'audio in' buffer. The pointed memory is owned by the platform, therefore the @a buffer should not be released by the application. @@ -511,7 +511,7 @@ int audio_in_peek(audio_in_h input, const void **buffer, unsigned int *length); * * @details This function works correctly only with read callback. Otherwise it won't operate as intended. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks Works only in asynchronous (event) mode. This will remove 'audio in' data from the actual stream buffer. Use this if peeked data is not needed anymore. * @@ -618,7 +618,7 @@ int audio_in_set_volume(audio_in_h input, double volume); /** * @brief Called when 'audio out' data can be written in asynchronous (event) mode. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks Use audio_out_write() to write pcm data inside this callback. * @param[in] handle The handle to the audio output @@ -682,7 +682,7 @@ int audio_out_create_new(int sample_rate, audio_channel_e channel, audio_sample_ /** * @brief Releases the audio output handle, along with all its resources. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output to destroy * @return @c 0 on success, @@ -726,7 +726,7 @@ int audio_out_set_sound_stream_info(audio_out_h output, sound_stream_info_h stre /** * @brief Prepares the audio output for playback, this must be called before audio_out_write(). * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @return @c 0 on success, @@ -743,7 +743,7 @@ int audio_out_prepare(audio_out_h output); /** * @brief Unprepares the audio output. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @return @c 0 on success, @@ -798,7 +798,7 @@ int audio_out_resume(audio_out_h output); * * @details This function waits until drains stream buffer completely. (e.g end of playback) * - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @since_tizen 2.4 * * @param[in] output The handle to the audio output * @return @c 0 on success, @@ -815,7 +815,7 @@ int audio_out_drain(audio_out_h output); /** * @brief Flushes and discards buffered audio data from the output stream. * - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @since_tizen 2.4 * * @param[in] output The handle to the audio output * @return @c 0 on success, @@ -832,7 +832,7 @@ int audio_out_flush(audio_out_h output); /** * @brief Starts writing the audio data to the device. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[in,out] buffer The PCM buffer address @@ -851,7 +851,7 @@ int audio_out_write(audio_out_h output, void *buffer, unsigned int length); /** * @brief Gets the size to be allocated for the audio output buffer. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[out] size The suggested buffer size (in bytes, the maximum size is 1 MB) @@ -867,7 +867,7 @@ int audio_out_get_buffer_size(audio_out_h output, int *size); /** * @brief Gets the sample rate of the audio output data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[out] sample_rate The audio sample rate \n @@ -883,7 +883,7 @@ int audio_out_get_sample_rate(audio_out_h output, int *sample_rate); /** * @brief Gets the channel type of the audio output data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[out] channel The audio channel type (mono or stereo) @@ -897,7 +897,7 @@ int audio_out_get_channel(audio_out_h output, audio_channel_e *channel); /** * @brief Gets the sample audio format of the audio output data stream. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[out] type The type of audio sample \n @@ -914,7 +914,7 @@ int audio_out_get_sample_type(audio_out_h output, audio_sample_type_e *type); /** * @brief Gets the sound type supported by the audio output device. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @param[out] type The sound type @@ -934,7 +934,7 @@ int audio_out_get_sound_type(audio_out_h output, sound_type_e *type); * Recommend to use as a VOIP only. * Recommend not to hold callback too long.(it affects latency) * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @remarks @a output must be created using audio_out_create_new(). * @@ -955,7 +955,7 @@ int audio_out_set_stream_cb(audio_out_h output, audio_out_stream_cb callback, vo /** * @brief Unregisters the callback function. * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * * @param[in] output The handle to the audio output * @return 0 on success, otherwise a negative error value diff --git a/packaging/capi-media-audio-io.spec b/packaging/capi-media-audio-io.spec index ff806c1..d75c66b 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.5.65 +Version: 0.5.66 Release: 0 Group: Multimedia/API License: Apache-2.0 -- 2.7.4