*/
-#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>
*
* @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,
+ * @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_PERMISSION_DENIED Permission denied
*
* @see audio_meta_destroy()
*/
/**
* @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,
+ * @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
*
* @pre Get a copy of audio metadata handle handle by calling audio_meta_clone().
*
* @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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_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().
+ * @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,
+ * @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_PERMISSION_DENIED Permission denied
*/
int audio_meta_get_recorded_date(audio_meta_h audio, char **recorded_date);
/**
* @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
*
- * @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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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".
+ * @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_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,
+ * @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_PERMISSION_DENIED Permission denied
*/
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,
+ * @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_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,
+ * @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_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,
+ * @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_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,
+ * @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_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,
+ * @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_duration(audio_meta_h audio, int *duration);
/**
- * @deprecated Deprecated since 2.4. [Use media_info_get_played_count() instead]
- * @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);
-
-/**
- * @deprecated Deprecated since 2.4. [Use media_info_get_played_time() instead]
- * @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);
-
-/**
- * @deprecated Deprecated since 2.4.
- * @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);
-
-/**
- * @deprecated Deprecated since 2.4. [Use media_info_increase_played_count() instead]
- * @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
- *
- * @post audio_meta_update_to_db().
- */
-int audio_meta_set_played_count(audio_meta_h audio, int played_count);
-
-/**
- * @deprecated Deprecated since 2.4. [Use media_info_set_played_time() instead]
- * @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
- *
- * @post audio_meta_update_to_db().
- */
-int audio_meta_set_played_time(audio_meta_h audio, time_t played_time);
-
-/**
- * @deprecated Deprecated since 2.4.
- * @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
- *
- * @post audio_meta_update_to_db().
- */
-int audio_meta_set_played_position(audio_meta_h audio, int played_position);
-
-/**
+ * @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. For example, for setting the played time using audio_meta_get_played_time(), after that the audio_meta_update_to_db() function should be called to update media database.
+ * database.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
*
* @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
+ * @param[in] audio The handle to the audio metadata
*
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
*
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
- * @see audio_meta_set_played_time()
- * @see audio_meta_set_played_count()
- * @see audio_meta_set_played_position()
*/
-int audio_meta_update_to_db(audio_meta_h audio);
+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__*/
projects / platform / core / api / media-content.git / blobdiff