/**
* @brief Called when the scan information is updated.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] frequency The tuned radio frequency [87500 ~ 108000] (kHz)
+ * @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().
* @see radio_scan_start()
/**
* @brief Called when the radio seek is completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] frequency The current frequency [87500 ~ 108000] (kHz)
+ * @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().
* @see radio_seek_up()
/**
* @brief Called when the radio is interrupted.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] error_code The interrupted error code
- * @param[in] user_data The user data passed from the callback registration function
+ * @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()
* @see radio_unset_interrupted_cb()
*/
* @brief Creates a radio handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a radio using radio_destroy().
- * @param[out] radio A new handle to radio
+ * @param[out] radio A new handle to radio
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* @retval #RADIO_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #RADIO_ERROR_OUT_OF_MEMORY Out of memory
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @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
+ * @param[in] radio The handle to radio to be destroyed
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Gets the radio's current state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
- * @param[out] state The current state of the radio
+ * @param[in] radio The handle to radio
+ * @param[out] state The current state of the radio
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Starts playing the radio.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
+ * @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Stops playing the radio.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
+ * @param[in] radio The handle to radio
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Seeks up the effective frequency of the radio, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Seeks down the effective frequency of the radio, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Sets the radio frequency.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
- * @param[in] frequency The frequency to set [87500 ~ 108000] (kHz)
+ * @param[in] radio The handle to radio
+ * @param[in] frequency The frequency to set [87500 ~ 108000] (kHz)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Gets the current frequency of the radio.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
- * @param[out] frequency The current frequency [87500 ~ 108000] (kHz)
+ * @param[in] radio The handle to radio
+ * @param[out] frequency The current frequency [87500 ~ 108000] (kHz)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Gets the current signal strength of the radio.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] radio The handle to radio
- * @param[out] strength The current signal strength [-128 ~ 128] (dBm)
+ * @param[in] radio The handle to radio
+ * @param[out] strength The current signal strength [-128 ~ 128] (dBm)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
int radio_get_signal_strength(radio_h radio, int *strength);
/**
- * @brief Starts scanning radio signals, asynchronously
+ * @brief Starts scanning radio signals, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Stops scanning radio signals, asynchronously.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @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
- * @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.
- * @param[in] radio The handle to radio
- * @param[in] muted The new mute status: (@c true = mute, @c false = not muted)
+ * @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,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Gets the radio's mute status.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @details If the mute status is @c true, no sounds are played. If @c false, sounds are played.
- * @param[in] radio The handle to radio
- * @param[out] muted The current mute status: (@c true = mute, @c false = not muted)
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @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,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
int radio_is_muted(radio_h radio, bool *muted);
/**
- * @brief Registers a callback function to be invoked when the scan finishes.
+ * @brief Sets a callback function to be invoked when the scan finishes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
int radio_set_scan_completed_cb(radio_h radio, radio_scan_completed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the scan completed callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] radio The handle to radio
* @return @c 0 on success,
int radio_unset_scan_completed_cb(radio_h radio);
/**
- * @brief Registers a callback function to be invoked when the radio is interrupted.
+ * @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
- * @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
+ * @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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
int radio_set_interrupted_cb(radio_h radio, radio_interrupted_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the interrupted callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] radio The handle to radio
* @return @c 0 on success,
/**
* @brief Gets the min, max frequency of the region.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @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)
+ * @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)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
/**
* @brief Gets channel spacing.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param[in] radio The handle to radio
+ * @param[in] radio The handle to radio
* @param[out] channel_spacing The channel spacing value
* @return @c 0 on success,
* otherwise a negative error value
* To change system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API.
* Finally, it does not support to set other value into each channel currently.
* @since_tizen 3.0
- * @param[in] radio The handle to radio
- * @param[in] volume The volume to set [0.0 ~ 1.0](1.0 = 100%)
+ * @param[in] radio The handle to radio
+ * @param[in] volume The volume to set [0.0 ~ 1.0](1.0 = 100%)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful
* This function gets the radio volume, not the system volume.
* To get the system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API.
* @since_tizen 3.0
- * @param[in] radio The handle to radio
- * @param[out] volume The current volume [0.0 ~ 1.0](1.0 = 100%)
+ * @param[in] radio The handle to radio
+ * @param[out] volume The current volume [0.0 ~ 1.0](1.0 = 100%)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #RADIO_ERROR_NONE Successful