X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include_product%2Fmedia_audio.h;h=9ab50095a6f2f0117d09475275203806b2eb50b8;hb=e569880dca6dc41da3162a039054e583cff86509;hp=6a5c87fb969e2fa81a2cdcc6c03a523af5f37c57;hpb=21192627642f93d3326da37d0ddbbdb213ddc4e8;p=platform%2Fcore%2Fapi%2Fmedia-content.git

diff --git a/include_product/media_audio.h b/include_product/media_audio.h
index 6a5c87f..9ab5009 100755
--- a/include_product/media_audio.h
+++ b/include_product/media_audio.h
@@ -15,8 +15,8 @@
 */
 
 
-#ifndef __TIZEN_AUDIO_META_H__
-#define __TIZEN_AUDIO_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_AUDIO_H__
+#define __TIZEN_CONTENT_MEDIA_AUDIO_H__
 
 #include <media_content_type.h>
 
@@ -27,7 +27,7 @@ extern "C" {
 /**
  * @file media_audio.h
  * @brief This file contains the audio metadata API and related functions to proceed with audio metadata. \n
- *        Description of the audio content involves: album, artist, album_artist, author, genre and description tags. \n
+ *        Description of the audio content involves: album, artist, album_artist, genre and description tags. \n
  *        Parameters of the recording are also supported such as format, bitrate, duration, size etc.
  */
 
@@ -42,10 +42,10 @@ extern "C" {
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release the destination handle using audio_meta_destroy().
+ * @remarks The @a dst should be released using audio_meta_destroy().
  *
  * @param[out] dst The destination handle to the audio metadata
- * @param[in]  src The source handle to the audio metadata
+ * @param[in] src The source handle to the audio metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -61,12 +61,12 @@ int audio_meta_clone(audio_meta_h *dst, audio_meta_h src);
 /**
  * @brief Destroys the audio metadata.
  * @details This function frees all resources related to the audio metadata handle. This handle
- *          no longer can be used to perform any operation. A new handle has to
+ *          no longer can be used to perform any operations. A new handle has to
  *          be created before the next use.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -84,10 +84,10 @@ int audio_meta_destroy(audio_meta_h audio);
  * @brief Gets the ID of the media of the given audio metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
  *
- * @param[in]  audio    The audio metadata handle
- * @param[out] media_id The ID of the audio
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] media_id The media ID
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -101,13 +101,13 @@ int audio_meta_get_media_id(audio_meta_h audio, char **media_id);
 /**
  * @brief Gets the album of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no album info, the method returns empty string.
+ *          Since 3.0, if the media content has no album info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
  *
- * @param[in]  audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] album The album of the audio metadata
  *
  * @return @c 0 on success,
@@ -122,13 +122,13 @@ int audio_meta_get_album(audio_meta_h audio, char **album);
 /**
  * @brief Gets the artist of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no artist info, the method returns empty string.
+ *          Since 3.0, if the media content has no artist info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
  *
- * @param[in]  audio  The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] artist The artist of the audio metadata
  *
  * @return @c 0 on success,
@@ -143,13 +143,13 @@ int audio_meta_get_artist(audio_meta_h audio, char **artist);
 /**
  * @brief Gets the album artist of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no album artist info, the method returns empty string.
+ *          Since 3.0, if the media content has no album artist info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
  *
- * @param[in]  audio        The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] album_artist The album artist of the audio metadata
  *
  * @return @c 0 on success,
@@ -164,13 +164,13 @@ int audio_meta_get_album_artist(audio_meta_h audio, char **album_artist);
 /**
  * @brief Gets the genre of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no genre info, the method returns empty string.
+ *          Since 3.0, if the media content has no genre info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
  *
- * @param[in]  audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] genre The genre of the audio metadata
  *
  * @return @c 0 on success,
@@ -185,13 +185,13 @@ int audio_meta_get_genre(audio_meta_h audio, char **genre);
 /**
  * @brief Gets the composer of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no composer info, the method returns empty string.
+ *          Since 3.0, if the media content has no composer info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
  *
- * @param[in]  audio    The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] composer The composer of the audio metadata
  *
  * @return @c 0 on success,
@@ -206,14 +206,14 @@ int audio_meta_get_composer(audio_meta_h audio, char **composer);
 /**
  * @brief Gets the year of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no year info, the method returns empty string.
+ *          Since 3.0, if the media content has no year info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
  *
- * @param[in]  audio The audio metadata handle
- * @param[out] year  The year of the audio metadata
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] year The year of the audio metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -226,11 +226,14 @@ int audio_meta_get_year(audio_meta_h audio, char **year);
 
 /**
  * @brief Gets the recorded date of the given audio metadata.
+ * @details The format of the recorded date may vary depending on the file format. \n
+ *          For more details on the recorded date format, refer to the file format specification.
+ *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
  *
- * @param[in]  audio         The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] recorded_date The recorded date of the audio metadata
  *
  * @return @c 0 on success,
@@ -248,9 +251,9 @@ int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
  *
- * @param[in]  audio     The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] copyright The copyright of the audio metadata
  *
  * @return @c 0 on success,
@@ -265,13 +268,13 @@ int audio_meta_get_copyright(audio_meta_h audio, char **copyright);
 /**
  * @brief Gets the track number of the given audio metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no track info, the method returns empty string.
+ *          Since 3.0, if the media content has no track info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
  *
- * @param[in]  audio     The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] track_num The audio track number of the audio metadata
  *
  * @return @c 0 on success,
@@ -287,7 +290,7 @@ int audio_meta_get_track_num(audio_meta_h audio, char **track_num);
  * @brief Gets the bitrate of the given audio metadata in bitrate per second.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  audio    The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] bit_rate The audio bitrate in bit per second [bps]
  *
  * @return @c 0 on success,
@@ -302,8 +305,8 @@ int audio_meta_get_bit_rate(audio_meta_h audio, int *bit_rate);
  * @brief Gets bit per sample of the given audio metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param [in]  audio        The handle to the audio metadata
- * @param [out] bitpersample The audio bit per sample
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] bitpersample The audio bit per sample
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -317,7 +320,7 @@ int audio_meta_get_bitpersample(audio_meta_h audio, int *bitpersample);
  * @brief Gets the sample rate of the given audio metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  audio       The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] sample_rate The audio sample rate[hz]
  *
  * @return @c 0 on success,
@@ -332,7 +335,7 @@ int audio_meta_get_sample_rate(audio_meta_h audio, int *sample_rate);
  * @brief Gets the channel of the given audio metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  audio   The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] channel The channel of the audio
  *
  * @return @c 0 on success,
@@ -347,7 +350,7 @@ int audio_meta_get_channel(audio_meta_h audio, int *channel);
  * @brief Gets the track duration of the given audio metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  audio    The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
  * @param[out] duration The audio file duration
  *
  * @return @c 0 on success,
@@ -359,39 +362,6 @@ int audio_meta_get_channel(audio_meta_h audio, int *channel);
 int audio_meta_get_duration(audio_meta_h audio, int *duration);
 
 /**
- * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore.
- * @brief Updates an audio metadata with modified attributes in the media database.
- * @details The function updates the given audio meta in the media database. The function should be called after any change in audio attributes, to be updated to the media
- *          database.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
- *
- * @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
- *
- * @param[in] audio The audio metadata handle
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
- * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @pre This function requires opened connection to content service by media_content_connect().
- *
- * @see media_content_connect()
- */
-int audio_meta_update_to_db(audio_meta_h audio) TIZEN_DEPRECATED_API;
-
-/**
  *@}
  */
 
@@ -399,4 +369,4 @@ int audio_meta_update_to_db(audio_meta_h audio) TIZEN_DEPRECATED_API;
 }
 #endif /* __cplusplus */
 
-#endif /*__TIZEN_AUDIO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_AUDIO_H__*/