//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
// limitations under the License.
//
/**
- * @file FCntAudioMetadata.h
+ * @file FCntAudioMetadata.h
* @brief This is the header file for the %AudioMetadata class.
*
* This header file contains the declarations of the %AudioMetadata class.
* The following example demonstrates how to use the %AudioMetadata class.
*
* @code
+ * #include <FBase.h>
+ * #include <FContent.h>
+ * #include <FMedia.h>
+ * #include <FSystem.h>
+ *
+ * using namespace Tizen::Content;
+ *
* result
* MyClass::TestAudioMetadata(void)
* {
- * result r = E_SUCCESS;
- *
* Tizen::Base::String contentPath = Tizen::System::Environment::GetMediaPath() + L"Sounds/hot.mp3";
* AudioMetadata* pAudioMeta = ContentManagerUtil::GetAudioMetaN(contentPath);
- * TryReturn(pAudioMeta != null, GetLastResult(), "ContentManagerUtil::GetAudioMetaN failed.");
+ * result r = GetLastResult();
*
- * // Title
* pAudioMeta->GetTitle();
- *
- * // Frequency
* pAudioMeta->GetFrequency();
- *
- * // Artist
* pAudioMeta->GetArtist();
- *
- * // Album name
* pAudioMeta->GetAlbumName();
- *
- * // Duration
* pAudioMeta->GetDuration();
- *
- * // Year
* pAudioMeta->GetYear();
*
- * // Thumbnail
* Tizen::Media::Image image;
* r = image.Construct();
- * if (IsFailed(r))
- * {
- * delete pAudioMeta;
- * return r;
- * }
*
* Tizen::Graphics::Bitmap* pBitmap = pAudioMeta->GetThumbnailN();
- * if (pBitmap == null)
- * {
- * delete pAudioMeta;
- * return GetLastResult();
- * }
+ * r = GetLastResult();
*
* Tizen::Base::String thumbnailPath = Tizen::System::Environment::GetMediaPath() + L"Images/audio.bmp";
* r = image.EncodeToFile(*pBitmap, Tizen::Media::IMG_FORMAT_BMP, thumbnailPath, false);
- * if (IsFailed(r))
- * {
- * delete pAudioMeta;
- * delete pBitmap;
- * return r;
- * }
*
* delete pAudioMeta;
* delete pBitmap;
*
* @since 2.0
*
- * @param[in] rhs An instance of %AudioMetadata
+ * @param[in] rhs An instance of %AudioMetadata to copy
*/
AudioMetadata(const AudioMetadata& rhs);
Tizen::Base::String GetComment(void) const;
/**
- * Gets the description of an audio file.
+ * Gets the description of the audio file.
*
* @since 2.1
*
- * @return The description of an audio file
+ * @return The description of the audio file
*/
Tizen::Base::String GetDescription(void) const;
/**
- * Gets the track number of an audio file.
+ * Gets the track number of the audio file.
*
* @since 2.0
*
- * @return The track number of an audio file
+ * @return The track number of the audio file
*/
int GetTrack(void) const;
/**
- * Gets the genre information of an audio file.
+ * Gets the genre information of the audio file.
*
* @since 2.0
*
- * @return The genre information of an audio file
+ * @return The genre information of the audio file
*/
Tizen::Base::String GetGenre(void) const;
/**
- * Gets the composer information of an audio file.
+ * Gets the composer information of the audio file.
*
* @since 2.0
*
- * @return The composer information of an audio file
+ * @return The composer information of the audio file
*/
Tizen::Base::String GetComposer(void) const;
/**
- * Gets the copyright information of an audio file.
+ * Gets the copyright information of the audio file.
*
* @since 2.0
*
- * @return The copyright information of an audio file
+ * @return The copyright information of the audio file
*/
Tizen::Base::String GetCopyright(void) const;
/**
- * Gets the duration of an audio file.
+ * Gets the duration of the audio file.
*
* @since 2.0
*
long GetDuration(void) const;
/**
- * Gets the year information of an audio file.
+ * Gets the year information of the audio file.
*
* @since 2.0
*
- * @return The year information of an audio file
+ * @return The year information of the audio file
*/
int GetYear(void) const;
/**
- * Gets the track information of an audio file.
+ * Gets the track information of the audio file.
*
* @since 2.0
*
- * @return The track number/position in set
- * @remarks This method returns track information that is embedded in the content metadata. @n
- * The format returned can be like "4/9" or "4" (in case the position is not available).
+ * @return The track number/position embedded in the content metadata @n
+ * The value can be like "4/9" or "4" in case the position is not available.
*/
Tizen::Base::String GetTrackInfo(void) const;
/**
- * Gets the recording date of an audio file.
+ * Gets the recording date of the audio file.
*
* @since 2.0
*
- * @return The recording date of an audio file
+ * @return The recording date of the audio file
*/
Tizen::Base::String GetRecordingDate(void) const;
/**
- * Gets the number of channels of an audio file.
+ * Gets the number of channels of the audio file.
*
* @since 2.0
*
- * @return The number of channels of an audio file
- * @remarks A monophonic stream has one channel and a stereophonic stream has two channels. @n
- * Valid values are either @c 1 or @c 2.
+ * @return The channel count of the audio file @n
+ * The values are @c 1 in a monophonic stream and @c 2 in a stereophonic stream.
*/
int GetChannelCount(void) const;
/**
- * Gets the thumbnail of an audio file.
+ * Gets the thumbnail of the audio file.
*
* @since 2.0
*
- * @return A pointer to the thumbnail image
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
+ * @return A pointer to the thumbnail image that is resized to 80x60 pixels
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks
- * - This method returns the thumbnail image that is resized to 80x60 pixels.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
/**
- * Gets the album art of an audio file.
+ * Gets the album art of the audio file.
*
* @since 2.0
*
- * @return A pointer to the album art
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND The album art does not exist.
+ * @return A pointer to the album art that is embedded in the content metadata
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The album art does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks
- * - GetThumbnailN() returns the thumbnail image that is resized to 80x60 pixels.
- * - GetAlbumArtN() returns the original album art that is embedded in the content metadata.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetAlbumArtN(void) const;
/**
- * Compares the equality of values between two %AudioMetadata objects by overriding the Tizen::Base::Object::Equals() method.
+ * Compares the equality of the values between two %AudioMetadata objects by overriding the Tizen::Base::Object::Equals() method.
*
* @since 2.0
*
- * @return @c true if all the fields in the objects are equal, @n
- * else @c false
- * @param[in] rhs The Tizen::Base::Object with which the comparison is done
- * @remarks An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
+ * @return @c true if all the fields in the objects are equal, @n
+ * else @c false
+ * @param[in] rhs The Tizen::Base::Object with which the comparison is done @n
+ * An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
* @since 2.0
*
* @return A reference to this instance
- * @param[in] rhs An instance of %AudioMetadata
+ * @param[in] rhs An instance of %AudioMetadata to copy
*/
AudioMetadata& operator =(const AudioMetadata& rhs);
projects / platform / framework / native / content.git / blobdiff