* @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. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - This method returns the thumbnail image that is resized to 80x60 pixels.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
* @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. @n
- * GetAlbumArtN() returns the original album art that is embedded in the content metadata. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - GetThumbnailN() returns the thumbnail image that is resized to 80x60 pixels. @n
+ * GetAlbumArtN() returns the original album art that is embedded in the content metadata.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetAlbumArtN(void) const;
* @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 If the E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(),
- * the file can be created as a content only using the OtherContentInfo class. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(),
+ * 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);
* @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(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
*/
ContentId CreateContent(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Base::String& destinationPath, const ContentInfo* pContentInfo = null);
* @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(). @n
- * The destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The source path should start with the directory path returned by either Tizen::App::App::GetAppRootPath() or Tizen::System::Environment::GetExternalStoragePath(). @n
+ * 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.
*/
ContentId CreateContent(const Tizen::Base::String& sourcePath, const Tizen::Base::String& destinationPath, bool deleteSource, const ContentInfo* pContentInfo = null);
* @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the image data is valid but meta information does not exist, the width and height are set from actual image data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the image data is valid but meta information does not exist, the width and height are set from actual image data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::String& filePath);
* @param[in] byteBuffer The buffer that contains image data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the image data in the buffer is valid but meta information does not exist, the width and height are set from actual image data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the image data in the buffer is valid but meta information does not exist, the width and height are set from actual image data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the audio data is valid but meta information does not exist, the duration is set from actual audio data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the audio data is valid but meta information does not exist, the duration is set from actual audio data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::String& filePath);
* @param[in] byteBuffer The buffer that contains audio data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the audio data in the buffer is valid but meta information does not exist, the duration is set from actual audio data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the audio data in the buffer is valid but meta information does not exist, the duration is set from actual audio data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* @param[in] filePath The file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the video data is valid but meta information does not exist, the duration is set from actual video data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the video data is valid but meta information does not exist, the duration is set from actual video data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::String& filePath);
* @param[in] byteBuffer The buffer that contains video data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks If the video data in the buffer is valid but meta information does not exist, the duration is set from actual video data.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the video data in the buffer is valid but meta information does not exist, the duration is set from actual video data.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
* For more information, see @ref CompContentManagerUtilPage "here".
* @endif
*
- * @return The content type
+ * @return The content type
* @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. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @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.
*/
static Tizen::Content::ContentType CheckContentType(const Tizen::Base::String& filePath);
* - The length of the specified @c whereExpr parameter exceeds 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.
- * @remarks The return value must be deleted. @n
- * ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO.
- * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
+ * @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.
+ * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %SearchN() method.
*
* the content is searched with @c type set as CONTENT_TYPE_UNKNOWN.
* @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.
- * @remarks The return value must be deleted. @n
- * The result of GetValueListN() returns a distinct value. @n
- * ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO.
- * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted. @n
+ * The result of GetValueListN() returns a distinct value.
+ * - ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO.
+ * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %GetValueListN() method.
*
* @exception E_INVALID_ARG The specified @c column is either invalid or empty, or the content is searched with @c type set as CONTENT_TYPE_UNKNOWN.
* @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.
- * @remarks The return value must be deleted. @n
- * The result of GetValueListN() returns a distinct value. @n
- * ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO.
- * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted. @n
+ * The result of GetValueListN() returns a distinct value.
+ * - ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO.
+ * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs.
*
* The following example demonstrates how to use the %GetValueListN() method.
*
* @exception E_IN_PROGRESS A previous request is in progress.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
- * The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
+ * @remarks
+ * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
+ * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
* @see IContentTransferListener::OnContentDownloadCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
* @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission.
* @exception E_IN_PROGRESS A previous request is in progress.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
- * The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
+ * @remarks
+ * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100.
+ * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int).
* @see IContentTransferListener::OnContentDownloadToBufferCompleted()
* @see IContentTransferListener::OnContentTransferInProgress()
*/
* @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*)
- * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). @n
- * If the content has coordinates as metadata, they are automatically set.
+ * @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*)
+ * 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.
*/
result Construct(const Tizen::Base::String* pContentPath);
* @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.
- * @remarks The content path must start with @c '/Media' or @c '/Storagecard/Media'. @n
- * The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is Bitmap (bmp).
+ * @remarks
+ * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
+ * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
+ * The permitted format for a thumbnail image is Bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
* @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.
- * @remarks The content path must start with @c '/Media' or @c '/Storagecard/Media'. @n
- * The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is bitmap (bmp).
+ * @remarks
+ * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
+ * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
+ * The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
* @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.
- * @remarks The content path must start with @c '/Media' or @c '/Storagecard/Media'. @n
- * The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
- * The permitted format for a thumbnail image is bitmap (bmp).
+ * @remarks
+ * - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
+ * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
+ * The permitted format for a thumbnail image is bitmap (bmp).
* @endif
*/
virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
projects / platform / framework / native / content.git / commitdiff