2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
17 * @file FCntAudioMetadata.h
18 * @brief This is the header file for the %AudioMetadata class.
20 * This header file contains the declarations of the %AudioMetadata class.
23 #ifndef _FCNT_AUDIO_METADATA_H_
24 #define _FCNT_AUDIO_METADATA_H_
26 #include <FBaseObject.h>
28 namespace Tizen { namespace Graphics
33 namespace Tizen { namespace Content
36 class _AudioMetadataImpl;
39 * @class AudioMetadata
40 * @brief This class provides methods to access the audio metadata.
44 * The %AudioMetadata class provides methods to access the audio metadata that contains audio content-specific attributes.
46 * The following example demonstrates how to use the %AudioMetadata class.
50 * MyClass::TestAudioMetadata(void)
52 * result r = E_SUCCESS;
54 * Tizen::Base::String contentPath = Tizen::System::Environment::GetMediaPath() + L"Sounds/hot.mp3";
55 * AudioMetadata* pAudioMeta = ContentManagerUtil::GetAudioMetaN(contentPath);
56 * TryReturn(pAudioMeta != null, GetLastResult(), "ContentManagerUtil::GetAudioMetaN failed.");
59 * pAudioMeta->GetTitle();
62 * pAudioMeta->GetFrequency();
65 * pAudioMeta->GetArtist();
68 * pAudioMeta->GetAlbumName();
71 * pAudioMeta->GetDuration();
74 * pAudioMeta->GetYear();
77 * Tizen::Media::Image image;
78 * r = image.Construct();
85 * Tizen::Graphics::Bitmap* pBitmap = pAudioMeta->GetThumbnailN();
86 * if (pBitmap == null)
89 * return GetLastResult();
92 * Tizen::Base::String thumbnailPath = Tizen::System::Environment::GetMediaPath() + L"Images/audio.bmp";
93 * r = image.EncodeToFile(*pBitmap, Tizen::Media::IMG_FORMAT_BMP, thumbnailPath, false);
108 class _OSP_EXPORT_ AudioMetadata
109 : virtual public Tizen::Base::Object
113 * This is the default constructor for this class.
120 * Copying of objects using this copy constructor is allowed.
124 * @param[in] rhs An instance of %AudioMetadata
126 AudioMetadata(const AudioMetadata& rhs);
129 * This destructor overrides Tizen::Base::Object::~Object().
133 virtual ~AudioMetadata(void);
136 * Gets the title of the audio file.
140 * @return The title of the audio file
142 Tizen::Base::String GetTitle(void) const;
145 * Gets the bit rate of the audio file.
149 * @return The audio bit rate in bits per second (bps)
151 int GetBitrate(void) const;
154 * Gets the frequency of the audio file.
158 * @return The frequency in hertz (Hz)
160 int GetFrequency(void) const;
163 * Gets the artist information of the audio file.
167 * @return The artist information of the audio file
169 Tizen::Base::String GetArtist(void) const;
172 * Gets the album name of the audio file.
176 * @return The album name of the audio file
178 Tizen::Base::String GetAlbumName(void) const;
181 * Gets the comment of the audio file.
185 * @return The comment of the audio file
187 Tizen::Base::String GetComment(void) const;
190 * Gets the description of an audio file.
194 * @return The description of an audio file
196 Tizen::Base::String GetDescription(void) const;
199 * Gets the track number of an audio file.
203 * @return The track number of an audio file
205 int GetTrack(void) const;
208 * Gets the genre information of an audio file.
212 * @return The genre information of an audio file
214 Tizen::Base::String GetGenre(void) const;
217 * Gets the composer information of an audio file.
221 * @return The composer information of an audio file
223 Tizen::Base::String GetComposer(void) const;
226 * Gets the copyright information of an audio file.
230 * @return The copyright information of an audio file
232 Tizen::Base::String GetCopyright(void) const;
235 * Gets the duration of an audio file.
239 * @return The duration in milliseconds
241 long GetDuration(void) const;
244 * Gets the year information of an audio file.
248 * @return The year information of an audio file
250 int GetYear(void) const;
253 * Gets the track information of an audio file.
257 * @return The track number/position in set
258 * @remarks This method returns track information that is embedded in the content metadata. @n
259 * The format returned can be like "4/9" or "4" (in case the position is not available).
261 Tizen::Base::String GetTrackInfo(void) const;
264 * Gets the recording date of an audio file.
268 * @return The recording date of an audio file
270 Tizen::Base::String GetRecordingDate(void) const;
273 * Gets the number of channels of an audio file.
277 * @return The number of channels of an audio file
278 * @remarks A monophonic stream has one channel and a stereophonic stream has two channels. @n
279 * Valid values are either @c 1 or @c 2.
281 int GetChannelCount(void) const;
284 * Gets the thumbnail of an audio file.
288 * @return A pointer to the thumbnail image
289 * @exception E_SUCCESS The method is successful.
290 * @exception E_DATA_NOT_FOUND The thumbnail image does not exist.
291 * @exception E_OUT_OF_MEMORY The memory is insufficient.
293 * - This method returns the thumbnail image that is resized to 80x60 pixels.
294 * - The specific error code can be accessed using the GetLastResult() method.
296 Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
299 * Gets the album art of an audio file.
303 * @return A pointer to the album art
304 * @exception E_SUCCESS The method is successful.
305 * @exception E_DATA_NOT_FOUND The album art does not exist.
306 * @exception E_OUT_OF_MEMORY The memory is insufficient.
308 * - GetThumbnailN() returns the thumbnail image that is resized to 80x60 pixels.
309 * - GetAlbumArtN() returns the original album art that is embedded in the content metadata.
310 * - The specific error code can be accessed using the GetLastResult() method.
312 Tizen::Graphics::Bitmap* GetAlbumArtN(void) const;
315 * Compares the equality of values between two %AudioMetadata objects by overriding the Tizen::Base::Object::Equals() method.
319 * @return @c true if all the fields in the objects are equal, @n
321 * @param[in] rhs The Tizen::Base::Object with which the comparison is done
322 * @remarks An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
324 virtual bool Equals(const Tizen::Base::Object& rhs) const;
327 * Gets the hash value of the current instance by overriding the Tizen::Base::Object::GetHashCode() method.
331 * @return The hash value of the current instance
333 virtual int GetHashCode(void) const;
336 * Copying of objects using this copy assignment operator is allowed.
340 * @return A reference to this instance
341 * @param[in] rhs An instance of %AudioMetadata
343 AudioMetadata& operator =(const AudioMetadata& rhs);
346 friend class _AudioMetadataImpl;
347 _AudioMetadataImpl* __pImpl;
349 }; // class AudioMetadata
353 #endif // _FCNT_AUDIO_METADATA_H_