/**
* @file radio.h
* @brief This file contains the radio API.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
/**
/**
* @brief Radio type handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct radio_s *radio_h;
/**
* @brief Enumeration of radio state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
RADIO_STATE_READY, /**< Ready to play or scan */
/**
* @brief Enumeration of error codes for the radio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
RADIO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
RADIO_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */
RADIO_ERROR_INVALID_STATE = TIZEN_ERROR_RADIO | 0x01 , /**< Invalid state */
RADIO_ERROR_SOUND_POLICY = TIZEN_ERROR_RADIO | 0x02 , /**< Sound policy error */
- RADIO_ERROR_NO_ANTENNA = TIZEN_ERROR_RADIO | 0x03 , /**< No Antenna error (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
+ RADIO_ERROR_NO_ANTENNA = TIZEN_ERROR_RADIO | 0x03 , /**< No Antenna error (Since 2.4) */
RADIO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
RADIO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
} radio_error_e;
/**
* @brief Enumeration of radio interrupted type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
RADIO_INTERRUPTED_BY_RESOURCE_CONFLICT = 4, /**< Interrupted by a resource conflict */
/**
* @brief Called when the scan information is updated.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] frequency The tuned radio frequency [87500 ~ 108000] (kHz)
* @param[in] user_data The user data passed from the callback registration function
* @pre It will be invoked by radio_scan_start().
/**
* @brief Called when the radio scan is stopped.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @pre It will be invoked when the scan is stopped by radio_scan_stop().
* @see radio_scan_stop()
/**
* @brief Called when the radio scan is completed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @pre It will be invoked when the scan is completed by registering this callback using radio_set_scan_completed_cb().
* @see radio_scan_start()
/**
* @brief Called when the radio seek is completed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] frequency The current frequency [87500 ~ 108000] (kHz)
* @param[in] user_data The user data passed from the callback registration function
* @pre It will be invoked when the radio seek is completed by registering this callback using radio_seek_up() or radio_seek_down().
/**
* @brief Called when the radio is interrupted.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] code The interrupted error code
* @param[in] user_data The user data passed from the callback registration function
* @see radio_set_interrupted_cb()
/**
* @brief Creates a radio handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a radio using radio_destroy().
* @param[out] radio A new handle to radio
* @return @c 0 on success,
/**
* @brief Destroys the radio handle and releases all its resources.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks To completely shutdown the radio operation, call this function with a valid radio handle.
*
* @param[in] radio The handle to radio to be destroyed
/**
* @brief Gets the radio's current state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[out] state The current state of the radio
* @return @c 0 on success,
/**
* @brief Starts playing the radio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Stops playing the radio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Seeks up the effective frequency of the radio, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Seeks down the effective frequency of the radio, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Sets the radio frequency.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] frequency The frequency to set [87500 ~ 108000] (kHz)
* @return @c 0 on success,
/**
* @brief Gets the current frequency of the radio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[out] frequency The current frequency [87500 ~ 108000] (kHz)
* @return @c 0 on success,
/**
* @brief Gets the current signal strength of the radio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[out] strength The current signal strength [-128 ~ 128] (dBm)
* @return @c 0 on success,
/**
* @brief Starts scanning radio signals, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Stops scanning radio signals, asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Sets the radio's mute status.
* @details If the mute status is @c true, no sounds will be played. If @c false, sounds will be played. Until this function is called, by default the radio is not muted.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] muted The new mute status: (@c true = mute, @c false = not muted)
* @return @c 0 on success,
/**
* @brief Gets the radio's mute status.
* @details If the mute status is @c true, no sounds are played. If @c false, sounds are played.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[out] muted The current mute status: (@c true = mute, @c false = not muted)
* @return @c 0 on success,
/**
* @brief Sets a callback function to be invoked when the scan finishes.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Unsets the scan completed callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets a callback function to be invoked when the radio is interrupted.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
/**
* @brief Unsets the interrupted callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the min, max frequency of the region.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] radio The handle to radio
* @param[out] min_freq The min frequency [87500 ~ 108000] (kHz)
* @param[out] max_freq The max frequency [87500 ~ 108000] (kHz)
/**
* @brief Gets channel spacing.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @param[in] radio The handle to radio
* @param[out] channel_spacing The channel spacing value
* @return @c 0 on success,