/**
* @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;
/**
* @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;
/**
* @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 */
/**
* @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 */
/**
* @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 */
/**
* @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.
*
*
* @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
*
/**
* @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,
/**
* @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,
/**
* @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,
/**
* @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,
/**
* @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
/**
* @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)
/**
* @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
/**
* @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
/**
* @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
* 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().
*
/**
* @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,
*
* @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.
*
* @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.
*
/**
* @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
/**
* @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,
/**
* @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,
/**
* @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,
*
* @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,
/**
* @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,
/**
* @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
/**
* @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)
/**
* @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
/**
* @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)
/**
* @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
/**
* @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
* 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().
*
/**
* @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