* @endif
*
* @return An error code
- * @param[in] pContentPath The content path
- * @exception E_SUCCESS The method is successful.
+ * @param[in] pContentPath The content path @n
+ * The path should be started with directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
+ * @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_IO An I/O error has occurred.
- * @exception E_SYSTEM An internal error has occurred.
- * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+ * @exception E_IO An I/O error has occurred.
+ * @exception E_SYSTEM An internal error has occurred.
*/
result Construct(const Tizen::Base::String* pContentPath);
*
* @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 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;
*
* @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 number of channels of an audio file @n
+ * The values are @c 1 in a monophonic stream and @c 2c in a stereophonic stream.
*/
int GetChannelCount(void) const;
*
* @since 2.0
*
- * @return A pointer to the thumbnail image
+ * @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;
*
* @since 2.0
*
- * @return A pointer to the album art
+ * @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;
*
* @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.
+ * @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 An error code
- * @param contentType The content type
+ * @param contentType The content type @n
+ * This method is used to access only one type of content. The allowed types are
+ * @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO. @n
+ * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT<ContentType>&)
+ * instead of this method.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot connect to the database.
- * @remarks This method is used to access only one type of content. @n
- * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT<ContentType>&). @n
- * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO.
*/
result Construct(ContentType contentType);
* @since 2.0
*
* @return An error code
- * @param contentTypeList The list of content types
+ * @param contentTypeList The list of content types @n
+ * This method is used to access more than one type of content, but total count should not be greater than @c 4.
+ * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO,
+ * and @c CONTENT_TYPE_VIDEO. Any combination with @c CONTENT_TYPE_ALL is a invalid argument. @n
+ * If you want to access only one type of content, use Construct(ContentType) instead of this method.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM The method cannot connect to the database.
- * @remarks This method is used to access more than one type of content. @n
- * If you want to access only one type of content, use Construct(ContentType). @n
- * Total count of @c contentTypeList should not be greater than @c 4. @n
- * Any combination with @c CONTENT_TYPE_ALL is a invalid argument. @n
- * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO.
*/
result Construct(const Tizen::Base::Collection::IListT<ContentType>& contentTypeList);
* @exception E_SERVICE_BUSY The database is busy.
* @remarks
* - If the @c E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(),
- * the file can be created as a content only using the OtherContentInfo class.
+ * the file can be created as a content only using the OtherContentInfo class.
* - The specific error code can be accessed using the GetLastResult() method.
*/
ContentId CreateContent(const ContentInfo& contentInfo);
*
* @return The content ID
* @param[in] byteBuffer The @c byteBuffer of the content to create
- * @param[in] destinationPath The destination file path formed by the @c byteBuffer
+ * @param[in] destinationPath The destination file path formed by the @c byteBuffer @n
+ * The path should be started with the directory path returned by either
+ * Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath().
* @param[in] pContentInfo A pointer to the ContentInfo instance @n
* If the content path exists in %ContentInfo, it gets ignored.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
- * @remarks
- * - The destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath().
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
ContentId CreateContent(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Base::String& destinationPath, const ContentInfo* pContentInfo = null);
* @privilege %http://tizen.org/privilege/content.write
*
* @return The content ID
- * @param[in] sourcePath The source file path
- * @param[in] destinationPath The destination file path
+ * @param[in] sourcePath The source file path @n
+ * The path should be started with the directory path returned by either Tizen::App::App::GetAppRootPath()
+ * or Tizen::System::Environment::GetExternalStoragePath().
+ * @param[in] destinationPath The destination file path @n
+ * The path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath()
+ * or Tizen::System::Environment::GetExternalStoragePath().
* @param[in] deleteSource Set to @c true in order to delete the source file, @n
* else @c false
* @param[in] pContentInfo A pointer to the ContentInfo instance @n
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SERVICE_BUSY The database is busy.
- * @remarks
- * - The source path should start with the directory path returned by either Tizen::App::App::GetAppRootPath() or Tizen::System::Environment::GetExternalStoragePath().
- * - The destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath().
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
ContentId CreateContent(const Tizen::Base::String& sourcePath, const Tizen::Base::String& destinationPath, bool deleteSource, const ContentInfo* pContentInfo = null);
* For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
- * @return The content type
+ * @return The content type @n
+ * The value can be different for each device
* @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid, or
* the length of the specified path is @c 0 or exceeds system limitations.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported.
- * @remarks
- * - The content type can be different for each device.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::ContentType CheckContentType(const Tizen::Base::String& filePath);
* @since 2.0
*
* @return An error code
- * @param[in] type The content type
+ * @param[in] type The content type @n
+ * Only @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE,
+ * @c CONTENT_TYPE_AUDIO, or @c CONTENT_TYPE_VIDEO is supported.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
*
- * @remarks To search a specific type, use the content type as @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, or @c CONTENT_TYPE_VIDEO.
- *
* The following example demonstrates how to use the %Construct() method.
*
* @code
*
- * // Call Construct() of ContentSearch
+ * // Calls Construct() of ContentSearch
* ContentSearch search;
* result r = search.Construct(CONTENT_TYPE_IMAGE);
* if (IsFailed(r))
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified @c column is either invalid or empty. @n
* - The content is searched with @c type set as ::CONTENT_TYPE_UNKNOWN. @n
- * - The length of the specified @c whereExpr parameter exceeds 512 characters.
+ * - The length of the specified @c whereExpr parameter exceeds @c 512 characters.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - The return value must be deleted.
* - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n
- * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
+ * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %SearchN() method.
*
* @code
*
- * // Call Construct() of ContentSearch
+ * // Calls Construct() of ContentSearch
* ContentSearch search;
* result r = search.Construct(CONTENT_TYPE_AUDIO);
* if (IsFailed(r))
* {
- * // Do something for an error
+ * // Does something for an error
* }
*
- * // Call SearchN() of ContentSearch as the first page
+ * // Calls SearchN() of ContentSearch as the first page
* int pageNo = 1;
* int countPerPage = 5;
* int totalPage = 0;
* // Do something for an error
* }
*
- * // Do something
+ * // Does something
*
- * // Delete resource
+ * // Deletes resource
* pContentInfoList->RemoveAll(true);
* delete pContentInfoList;
*
*
* @since 2.0
*
- * @return The download request
+ * @return The download request @n
+ * The download request information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
* @param[in] reqId The request ID returned by Start()
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The download request information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DownloadRequest* GetDownloadRequestN(RequestId reqId) const;
*
* @since 2.0
*
- * @return The download state
+ * @return The download state @n
+ * The download state information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
* @param[in] reqId The request ID returned by Start()
- * @remarks The download state information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
*/
DownloadState GetState(RequestId reqId) const;
*
* @return An error code
* @param[in] reqId The request ID returned by Start()
- * @param[out] mimeType The MIME type
+ * @param[out] mimeType The MIME type @n
+ * The MIME type information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has
+ * been called.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG There is no download request for the specified @c reqId.
* @exception E_INVALID_OPERATION The current download state prohibits the execution of this operation. @n
* The download operation has not yet started.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
- * @remarks The MIME type information is available for at least the next 24 hours after IDownloadListener::OnDownloadCompleted() has been called.
*/
result GetMimeType(RequestId reqId, Tizen::Base::String& mimeType) const;
* @endif
*
* @return An error code
- * @param[in] pContentPath The content path
+ * @param[in] pContentPath The content path @n
+ * The path should be started with directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_IO An I/O error has occurred.
* @exception E_SYSTEM An internal error has occurred.
- * @remarks
- * - The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
- * - If the content has coordinates as metadata, they are automatically set.
+ * @remarks If the content has coordinates as metadata, they are automatically set.
*/
result Construct(const Tizen::Base::String* pContentPath);
*
* @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.
+ * @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;
* @endif
*
* @return An error code
- * @param[in] pContentPath The content path
+ * @param[in] pContentPath The content path @n
+ * The path should be started with directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_IO An I/O error has occurred.
* @exception E_SYSTEM An internal error has occurred.
- * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+ * @remarks
+ *
*/
result Construct(const Tizen::Base::String* pContentPath);
* @endif
*
* @return An error code
- * @param[in] pContentPath The content path
+ * @param[in] pContentPath The content path @n
+ * The path should be started with directory path returned by
+ * either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * If the path is @c null,
+ * use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
+ * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
+ * instead of this method.
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_IO An I/O error has occurred.
* @exception E_SYSTEM An internal error has occurred.
- * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*).
+ * @remarks
*/
result Construct(const Tizen::Base::String* pContentPath);
*
* @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.
+ * @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;
projects / platform / framework / native / content.git / commitdiff