projects / platform / core / api / media-content.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add details for the get_Recorded_date APIs
[platform/core/api/media-content.git] / include / media_audio.h
diff --git a/include/media_audio.h b/include/media_audio.h
index 6e25593..d39762a 100755 (executable)
--- a/include/media_audio.h
+++ b/include/media_audio.h
@@ -53,7 +53,6 @@ extern "C" {
  * @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_PERMISSION_DENIED Permission denied
  *
  * @see audio_meta_destroy()
  */
@@ -74,7 +73,6 @@ int audio_meta_clone(audio_meta_h *dst, audio_meta_h src);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre Get a copy of audio metadata handle handle by calling audio_meta_clone().
  *
@@ -97,7 +95,6 @@ int audio_meta_destroy(audio_meta_h audio);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_media_id(audio_meta_h audio, char **media_id);
 
@@ -119,7 +116,6 @@ int audio_meta_get_media_id(audio_meta_h audio, char **media_id);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_album(audio_meta_h audio, char **album);
 
@@ -141,7 +137,6 @@ int audio_meta_get_album(audio_meta_h audio, char **album);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_artist(audio_meta_h audio, char **artist);
 
@@ -163,7 +158,6 @@ int audio_meta_get_artist(audio_meta_h audio, char **artist);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_album_artist(audio_meta_h audio, char **album_artist);
 
@@ -185,7 +179,6 @@ int audio_meta_get_album_artist(audio_meta_h audio, char **album_artist);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_genre(audio_meta_h audio, char **genre);
 
@@ -207,7 +200,6 @@ int audio_meta_get_genre(audio_meta_h audio, char **genre);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_composer(audio_meta_h audio, char **composer);
 
@@ -229,12 +221,14 @@ int audio_meta_get_composer(audio_meta_h audio, char **composer);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_year(audio_meta_h audio, char **year);
 
 /**
  * @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.
+ *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a recorded_date using free().
@@ -248,7 +242,6 @@ int audio_meta_get_year(audio_meta_h audio, char **year);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
 
@@ -269,7 +262,6 @@ int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_copyright(audio_meta_h audio, char **copyright);
 
@@ -291,7 +283,6 @@ int audio_meta_get_copyright(audio_meta_h audio, char **copyright);
  * @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_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_track_num(audio_meta_h audio, char **track_num);
 
@@ -307,7 +298,6 @@ 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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_bit_rate(audio_meta_h audio, int *bit_rate);
 
@@ -323,7 +313,6 @@ 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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_bitpersample(audio_meta_h audio, int *bitpersample);
 
@@ -339,7 +328,6 @@ 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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_sample_rate(audio_meta_h audio, int *sample_rate);
 
@@ -355,7 +343,6 @@ 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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_channel(audio_meta_h audio, int *channel);
 
@@ -371,126 +358,10 @@ 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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int audio_meta_get_duration(audio_meta_h audio, int *duration);
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played count value between applications. It is recommended that the value is managed by the application.
- * @brief Gets the number of times the given audio has been played.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in]  audio        The audio metadata handle
- * @param[out] played_count The counter of the audio played
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_get_played_count(audio_meta_h audio, int *played_count) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played time value between applications. It is recommended that the value is managed by the application.
- * @brief Gets the last played time parameter of the audio.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in]  audio       The audio metadata handle
- * @param[out] played_time The last played time of the audio
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_get_played_time(audio_meta_h audio, time_t *played_time) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played position value between applications. It is recommended that the value is managed by the application.
- * @brief Gets the played position parameter of the audio.
- * @details This function returns the elapsed playback position parameter of the audio as a period
- *          starting from the beginning of the track.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in]  audio           The audio metadata handle
- * @param[out] played_position The elapsed time of the audio
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_get_played_position(audio_meta_h audio, int *played_position) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played count value between applications. It is recommended that the value is managed by the application.
- * @brief Sets the played count of the audio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] audio        The audio metadata handle
- * @param[in] played_count The played count of the audio
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_set_played_count(audio_meta_h audio, int played_count) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played time value between applications. It is recommended that the value is managed by the application.
- * @brief Sets the last played time of the audio.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] audio       The audio metadata handle
- * @param[in] played_time The last played time of the audio
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_set_played_time(audio_meta_h audio, time_t played_time) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
- *        This function does not guarantee independence of the played position value between applications. It is recommended that the value is managed by the application.
- * @brief Sets the played position of the audio.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @remarks  It is NOT recommended to use this attribute for your application-specific purpose because this attribute can be overwritten by other applications (even 0).
- *
- * @param[in] audio           The audio metadata handle
- * @param[in] played_position The played position of the audio
- *
- * @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_PERMISSION_DENIED Permission denied
- */
-int audio_meta_set_played_position(audio_meta_h audio, int played_position) TIZEN_DEPRECATED_API;
-
-/**
  * @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
Domain: Multimedia / Media Content;