X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFCntVideoMetadata.h;h=f475a595b669d6ddabc79c5a979150a0cc04a907;hb=HEAD;hp=c1d2075677923c9f9b21fd4d290725962d122404;hpb=014d94abed8174f4c94e7d36ff0d3382ed28e33c;p=platform%2Fframework%2Fnative%2Fcontent.git diff --git a/inc/FCntVideoMetadata.h b/inc/FCntVideoMetadata.h index c1d2075..f475a59 100644 --- a/inc/FCntVideoMetadata.h +++ b/inc/FCntVideoMetadata.h @@ -14,7 +14,7 @@ // limitations under the License. // /** - * @file FCntVideoMetadata.h + * @file FCntVideoMetadata.h * @brief This is the header file for the %VideoMetadata class. * * This header file contains the declarations of the %VideoMetadata class. @@ -36,35 +36,37 @@ namespace Tizen { namespace Content class _VideoMetadataImpl; /** - * @class VideoMetadata - * @brief This class provides methods to access the video metadata. + * @class VideoMetadata + * @brief This class provides methods to access the video metadata. * - * @since 2.0 + * @since 2.0 * - * The %VideoMetadata class provides methods to access the video metadata that contains video content-specific attributes. + * The %VideoMetadata class provides methods to access the video metadata that contains video content-specific + * attributes. * * The following example demonstrates how to use the %VideoMetadata class. * * @code + * #include + * #include + * #include + * + * using namespace Tizen::Content; + * * result * MyClass::TestVideoMetadata(void) * { * Tizen::Base::String contentPath = Tizen::System::Environment::GetMediaPath() + L"Videos/video.mp4"; * VideoMetadata* pVideoMeta = ContentManagerUtil::GetVideoMetaN(contentPath); - * TryReturn(pVideoMeta != null, GetLastResult(), "ContentManagerUtil::GetVideoMetaN failed."); + * result r = GetLastResult(); * - * // Width * pVideoMeta->GetWidth(); - * - * // Height * pVideoMeta->GetHeight(); - * - * // Duration * pVideoMeta->GetDuration(); * * delete pVideoMeta; * - * return E_SUCCESS; + * return r; * } * @endcode */ @@ -84,7 +86,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %VideoMetadata + * @param[in] rhs An instance of %VideoMetadata to copy */ VideoMetadata(const VideoMetadata& rhs); @@ -132,18 +134,18 @@ public: int GetFramerate(void) const; /** - * @if OSPDEPREC + * @if OSPDEPREC * Gets the bit rate. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated because a new method has been added. @n - * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate(). + * Instead of using this method, use GetAudioBitrate() or GetVideoBitrate(). * @since 2.0 - * @endif * * @return The bit rate in bits per second (bps) - * @remarks There are two kinds of bit rates in a video file: audio and video. @n - * The return value is the bit rate for the audio. + * @remarks + * - There are two kinds of bit rates in a video file: audio and video. + * - The return value is the bit rate for the audio. * @endif */ int GetBitrate(void) const; @@ -176,64 +178,66 @@ public: Tizen::Base::String GetGenre(void) const; /** - * Gets a comment of a video file. + * Gets the comment of the video file. * * @since 2.1 * - * @return A comment of a video file + * @return The comment of the video file */ Tizen::Base::String GetComment(void) const; /** - * Gets the description of a video file. + * Gets the description of the video file. * * @since 2.1 * - * @return The description of a video file + * @return The description of the video file */ Tizen::Base::String GetDescription(void) const; /** - * Gets the album art of a video. + * Gets the album art of the video. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the album art - * @exception E_SUCCESS The method is successful. + * @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. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @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 %VideoMetadata objects by overriding the Tizen::Base::Object::Equals() method. + * Compares the equality of the values between two %VideoMetadata objects by overriding the + * Tizen::Base::Object::Equals() method. * - * @since 2.0 + * @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 @n - * 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; /** * Gets the hash value of the current instance by overriding the Tizen::Base::Object::GetHashCode() method. * - * @since 2.0 + * @since 2.0 * - * @return The hash value of the current instance + * @return The hash value of the current instance */ virtual int GetHashCode(void) const; /** * Copying of objects using this copy assignment operator is allowed. * - * @since 2.0 + * @since 2.0 * - * @return A reference to this instance - * @param[in] rhs An instance of %VideoMetadata + * @return A reference to this instance + * @param[in] rhs An instance of %VideoMetadata to copy */ VideoMetadata& operator =(const VideoMetadata& rhs);