[ACR-1838] Deprecate all bookmark and playlist funtions
[platform/core/api/media-content.git] / include_product / media_audio.h
index 2dcd046..c18ad3d 100755 (executable)
@@ -40,7 +40,7 @@ extern "C" {
  * @brief Clones the audio metadata.
  * @details This function copies the audio metadata handle from a source to destination.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a dst should be released using audio_meta_destroy().
  *
@@ -64,7 +64,7 @@ int audio_meta_clone(audio_meta_h *dst, audio_meta_h src);
  *          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
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  *
@@ -82,7 +82,7 @@ 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
+ * @since_tizen 2.3
  *
  * @remarks The @a media_id should be released using free().
  *
@@ -101,9 +101,9 @@ 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
+ * @since_tizen 2.3
  *
  * @remarks The @a album should be released using free().
  *
@@ -122,9 +122,9 @@ 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
+ * @since_tizen 2.3
  *
  * @remarks The @a artist should be released using free().
  *
@@ -143,9 +143,9 @@ 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
+ * @since_tizen 2.3
  *
  * @remarks The @a album_artist should be released using free().
  *
@@ -164,9 +164,9 @@ 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
+ * @since_tizen 2.3
  *
  * @remarks The @a genre should be released using free().
  *
@@ -183,11 +183,12 @@ int audio_meta_get_album_artist(audio_meta_h audio, char **album_artist);
 int audio_meta_get_genre(audio_meta_h audio, char **genre);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @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
+ * @since_tizen 2.3
  *
  * @remarks The @a composer should be released using free().
  *
@@ -201,14 +202,14 @@ int audio_meta_get_genre(audio_meta_h audio, char **genre);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  */
-int audio_meta_get_composer(audio_meta_h audio, char **composer);
+int audio_meta_get_composer(audio_meta_h audio, char **composer) TIZEN_DEPRECATED_API;
 
 /**
  * @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
+ * @since_tizen 2.3
  *
  * @remarks The @a year should be released using free().
  *
@@ -225,11 +226,12 @@ int audio_meta_get_composer(audio_meta_h audio, char **composer);
 int audio_meta_get_year(audio_meta_h audio, char **year);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the recorded date of the given audio metadata.
- * @details The recorded date is got from audio file's metadata. Some formats like mp4 use UTC and the rest can be different. \n
- *              So, please refer to the format specification if needed.
+ * @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
+ * @since_tizen 2.3
  *
  * @remarks The @a recorded_date should be released using free().
  *
@@ -243,13 +245,14 @@ int audio_meta_get_year(audio_meta_h audio, char **year);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  */
-int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
+int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the copyright notice of the given audio metadata.
  * @details If the media content has no copyright info, the method returns empty string.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a copyright should be released using free().
  *
@@ -263,14 +266,14 @@ int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  */
-int audio_meta_get_copyright(audio_meta_h audio, char **copyright);
+int audio_meta_get_copyright(audio_meta_h audio, char **copyright) TIZEN_DEPRECATED_API;
 
 /**
  * @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
+ * @since_tizen 2.3
  *
  * @remarks The @a track_num should be released using free().
  *
@@ -287,8 +290,9 @@ int audio_meta_get_copyright(audio_meta_h audio, char **copyright);
 int audio_meta_get_track_num(audio_meta_h audio, char **track_num);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  * @param[out] bit_rate The audio bitrate in bit per second [bps]
@@ -299,11 +303,12 @@ int audio_meta_get_track_num(audio_meta_h audio, char **track_num);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int audio_meta_get_bit_rate(audio_meta_h audio, int *bit_rate);
+int audio_meta_get_bit_rate(audio_meta_h audio, int *bit_rate) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets bit per sample of the given audio metadata.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  * @param[out] bitpersample The audio bit per sample
@@ -314,11 +319,12 @@ int audio_meta_get_bit_rate(audio_meta_h audio, int *bit_rate);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int audio_meta_get_bitpersample(audio_meta_h audio, int *bitpersample);
+int audio_meta_get_bitpersample(audio_meta_h audio, int *bitpersample) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the sample rate of the given audio metadata.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  * @param[out] sample_rate The audio sample rate[hz]
@@ -329,11 +335,12 @@ int audio_meta_get_bitpersample(audio_meta_h audio, int *bitpersample);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int audio_meta_get_sample_rate(audio_meta_h audio, int *sample_rate);
+int audio_meta_get_sample_rate(audio_meta_h audio, int *sample_rate) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the channel of the given audio metadata.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  * @param[out] channel The channel of the audio
@@ -344,11 +351,12 @@ int audio_meta_get_sample_rate(audio_meta_h audio, int *sample_rate);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int audio_meta_get_channel(audio_meta_h audio, int *channel);
+int audio_meta_get_channel(audio_meta_h audio, int *channel) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the track duration of the given audio metadata.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] audio The handle to the audio metadata
  * @param[out] duration The audio file duration
@@ -359,7 +367,7 @@ int audio_meta_get_channel(audio_meta_h audio, int *channel);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int audio_meta_get_duration(audio_meta_h audio, int *duration);
+int audio_meta_get_duration(audio_meta_h audio, int *duration) TIZEN_DEPRECATED_API;
 
 /**
  *@}