namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage media info and query related items in the database.
+ /// Provides commands to manage the media information and query related items in the database.
/// </summary>
public class MediaInfoCommand : MediaCommand
{
/// <summary>
/// Initializes a new instance of the <see cref="FolderCommand"/> class with the specified <see cref="MediaDatabase"/>.
/// </summary>
- /// <param name="database">A <see cref="MediaDatabase"/> that the commands run on.</param>
+ /// <param name="database">The <see cref="MediaDatabase"/> that the commands run on.</param>
/// <exception cref="ArgumentNullException"><paramref name="database"/> is null.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="database"/> has already been disposed of.</exception>
public MediaInfoCommand(MediaDatabase database) : base(database)
/// <summary>
/// Retrieves the number of the bookmarks added to the media.
/// </summary>
- /// <param name="mediaId">The media id to count bookmarks added to the media.</param>
- /// <returns>The number of bookmarks.</returns>
+ /// <param name="mediaId">The media ID to count the bookmarks added to the media.</param>
+ /// <returns>The number of the bookmarks.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Retrieves the number of the bookmarks added to the media with <see cref="CountArguments"/>.
+ /// Retrieves the number of the bookmarks added to the media with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="mediaId">The media id to count bookmarks added to the media.</param>
+ /// <param name="mediaId">The media ID to count the bookmarks added to the media.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
- /// <returns>The number of bookmarks.</returns>
+ /// <returns>The number of the bookmarks.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <summary>
/// Retrieves the bookmarks added to the media.
/// </summary>
- /// <param name="mediaId">The media id to select bookmarks added to the media.</param>
+ /// <param name="mediaId">The media ID to select the bookmarks added to the media.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
}
/// <summary>
- /// Retrieves the bookmarks added to the media with <see cref="SelectArguments"/>.
+ /// Retrieves the bookmarks added to the media with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="mediaId">The media id to select bookmarks added to the media.</param>
+ /// <param name="mediaId">The media ID to select the bookmarks added to the media.</param>
/// <param name="filter">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <summary>
- /// Retrieves the number of the face info added to or detected from the media.
+ /// Retrieves the number of the face information added to or detected from the media.
/// </summary>
- /// <param name="mediaId">The media id to count face info added to the media.</param>
- /// <returns>The number of face info.</returns>
+ /// <param name="mediaId">The media ID to count face information added to the media.</param>
+ /// <returns>The number of the face information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Retrieves the number of the face info added to or detected from the media with filter.
+ /// Retrieves the number of the face information added to or detected from the media with filter.
/// </summary>
- /// <param name="mediaId">The media id to count face info added to the media.</param>
+ /// <param name="mediaId">The media ID to count the face information added to the media.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
- /// <returns>The number of face info.</returns>
+ /// <returns>The number of the face information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Retrieves the face info added to or detected from the media.
+ /// Retrieves the face information added to or detected from the media.
/// </summary>
- /// <param name="mediaId">The media id to select face info added to the media.</param>
+ /// <param name="mediaId">The media ID to select face information added to the media.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
}
/// <summary>
- /// Retrieves the face info added to or detected from the media with <see cref="SelectArguments"/>.
+ /// Retrieves the face information added to or detected from the media with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="mediaId">The media id to select face info added to the media.</param>
+ /// <param name="mediaId">The media ID to select the face information added to the media.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// Retrieves the number of tags that the media has.
/// </summary>
/// <returns>The number of tags.</returns>
- /// <param name="mediaId">The media id to count tags added to the media.</param>
+ /// <param name="mediaId">The media ID to count tags added to the media.</param>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Retrieves the number of tags that the media has with <see cref="CountArguments"/>.
+ /// Retrieves the number of tags that the media has with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="mediaId">The media id to count tags added to the media.</param>
+ /// <param name="mediaId">The media ID to count tags added to the media.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of tags.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <summary>
/// Retrieves the tags that the media has.
/// </summary>
- /// <param name="mediaId">The media id to select tags added to the media.</param>
+ /// <param name="mediaId">The media ID to select tags added to the media.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
}
/// <summary>
- /// Retrieves the tags that the media has with <see cref="SelectArguments"/>.
+ /// Retrieves the tags that the media has with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="mediaId">The media id to select tags added to the media.</param>
+ /// <param name="mediaId">The media ID to select tags added to the media.</param>
/// <param name="filter">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <summary>
- /// Retrieves the number of the media info.
+ /// Retrieves the number of the media information.
/// </summary>
- /// <returns>The number of media info.</returns>
+ /// <returns>The number of the media information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Retrieves the number of the media info with <see cref="SelectArguments"/>.
+ /// Retrieves the number of the media information with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
- /// <returns>The number of media info.</returns>
+ /// <returns>The number of media information.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <summary>
/// Retrieves the media.
/// </summary>
- /// <param name="mediaId">The media id to retrieve.</param>
+ /// <param name="mediaId">The media ID to retrieve.</param>
/// <returns>The <see cref="MediaInfo"/> instance if the matched record was found in the database, otherwise null.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
}
/// <summary>
- /// Retrieves the number of values grouped by the specified column with <see cref="SelectArguments"/>.
+ /// Retrieves the number of values grouped by the specified column with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="columnKey">The column key.</param>
/// <returns>The number of groups.</returns>
}
/// <summary>
- /// Retrieves the number of values grouped by the specified column with <see cref="SelectArguments"/>.
+ /// Retrieves the number of values grouped by the specified column with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="columnKey">The column key.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
}
/// <summary>
- /// Retrieves the group values of the specified column. with <see cref="SelectArguments"/>.
+ /// Retrieves the group values of the specified column with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="columnKey">The column key.</param>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
}
/// <summary>
- /// Retrieves the media with <see cref="SelectArguments"/>.
+ /// Retrieves the media with the <see cref="SelectArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
}
/// <summary>
- /// Deletes a media from the database.
+ /// Deletes the media from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to delete.</param>
+ /// <param name="mediaId">The media ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</returns>
- /// <remarks><see cref="MediaDatabase.ScanFile(string)"/> or <see cref="MediaDatabase.ScanFolderAsync(string)"/> can be used instead.</remarks>
+ /// <remarks>The <see cref="MediaDatabase.ScanFile(string)"/> or the <see cref="MediaDatabase.ScanFolderAsync(string)"/> can be used instead.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
}
/// <summary>
- /// Adds media to the database.
+ /// Adds the media to the database.
/// </summary>
/// <param name="path">The file path to add.</param>
/// <returns>The <see cref="MediaInfo"/> instance that contains the record information in the database.</returns>
/// <remarks>
- /// If the media already exists in the database, it returns existing information.\n
+ /// If the media already exists in the database, it returns the existing information.\n
/// \n
- /// <see cref="MediaDatabase.ScanFile(string)"/> or <see cref="MediaDatabase.ScanFolderAsync(string)"/> can be used instead.\n
+ /// The <see cref="MediaDatabase.ScanFile(string)"/> or the <see cref="MediaDatabase.ScanFolderAsync(string)"/> can be used instead.\n
/// \n
/// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
/// If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage.
/// <exception cref="ArgumentException">
/// <paramref name="paths"/> contains null.\n
/// -or-\n
- /// <paramref name="paths"/> contains invalid path.\n
+ /// <paramref name="paths"/> contains the invalid path.\n
/// -or-\n
/// The number of <paramref name="paths"/> is 300 or more items.
/// </exception>
/// <exception cref="ArgumentException">
/// <paramref name="paths"/> contains null.\n
/// -or-\n
- /// <paramref name="paths"/> contains invalid path.\n
+ /// <paramref name="paths"/> contains the invalid path.\n
/// -or-\n
/// The number of <paramref name="paths"/> is 300 or more items.
/// </exception>
}
/// <summary>
- /// Updates a media with the specified values.
+ /// Updates the media with the specified values.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to update.</param>
+ /// <param name="mediaId">The media ID to update.</param>
/// <param name="values">The values for update.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>Only values set in <see cref="MediaInfoUpdateValues"/> are updated.</remarks>
+ /// <remarks>Only values set in the <see cref="MediaInfoUpdateValues"/> are updated.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// <exception cref="MediaDatabaseException">An error occurred while executing the command.</exception>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="mediaId">The media id to move.</param>
+ /// <param name="mediaId">The media ID to move.</param>
/// <param name="newPath">The path that the media has been moved to.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <remarks>
- /// Usually, it is used after the media file is moved to another path.\n
+ /// Usually, it is used after the media file is moved to the another path.\n
/// \n
/// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
/// If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage.
#region CreateThumbnailAsync
/// <summary>
- /// Creates a thumbnail image for the given media.
- /// If a thumbnail already exists for the given media, the existing path will be returned.
+ /// Creates the thumbnail image for the given media.
+ /// If the thumbnail already exists for the given media, the existing path will be returned.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to create thumbnail.</param>
+ /// <param name="mediaId">The media ID to create the thumbnail.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the thumbnail path.</returns>
/// <exception cref="InvalidOperationException">
/// The <see cref="MediaDatabase"/> is disconnected.\n
/// </exception>
/// <exception cref="FileNotFoundException">The file of the media does not exists; moved or deleted.</exception>
/// <exception cref="UnsupportedContentException">
- /// Thumbnail is not available for the given media.\n
+ /// The thumbnail is not available for the given media.\n
/// -or-\n
- /// The media is in external usb storage(<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
+ /// The media is in the external USB storage (<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
/// </exception>
public Task<string> CreateThumbnailAsync(string mediaId)
{
}
/// <summary>
- /// Creates a thumbnail image for the given media.
- /// If a thumbnail already exists for the given media, the existing path will be returned.
+ /// Creates the thumbnail image for the given media.
+ /// If the thumbnail already exists for the given media, the existing path will be returned.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to create thumbnail.</param>
+ /// <param name="mediaId">The media ID to create the thumbnail.</param>
/// <param name="cancellationToken">The token to cancel the operation.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the thumbnail path.</returns>
/// <exception cref="InvalidOperationException">
/// </exception>
/// <exception cref="FileNotFoundException">The file of the media does not exists; moved or deleted.</exception>
/// <exception cref="UnsupportedContentException">
- /// Thumbnail is not available for the given media.\n
+ /// The thumbnail is not available for the given media.\n
/// -or-\n
- /// The media is in external usb storage(<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
+ /// The media is in the external USB storage (<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
/// </exception>
public Task<string> CreateThumbnailAsync(string mediaId, CancellationToken cancellationToken)
{
#region DetectFaceAsync
/// <summary>
/// Detects faces from the given media.
- /// If a thumbnail already exists for the given media, the existing path will be returned.
+ /// If the thumbnail already exists for the given media, the existing path will be returned.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <feature>http://tizen.org/feature/vision.face_recognition</feature>
- /// <param name="mediaId">The media id to create thumbnail.</param>
+ /// <param name="mediaId">The media ID to create the thumbnail.</param>
/// <returns>A task that represents the asynchronous add operation. The task result contains the number of faces detected.</returns>
/// <exception cref="InvalidOperationException">
/// The <see cref="MediaDatabase"/> is disconnected.\n
/// <paramref name="mediaId"/> is a zero-length string, contains only white space.
/// </exception>
/// <exception cref="FileNotFoundException">The file of the media does not exists; moved or deleted.</exception>
- /// <exception cref="UnsupportedContentException">Feace detection is not available for the given media.</exception>
+ /// <exception cref="UnsupportedContentException">Face detection is not available for the given media.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">The caller has no required privilege.</exception>
public Task<int> DetectFaceAsync(string mediaId)
}
/// <summary>
- /// Creates a thumbnail image for the given media.
- /// If a thumbnail already exists for the given media, the existing path will be returned.
+ /// Creates the thumbnail image for the given media.
+ /// If the thumbnail already exists for the given media, the existing path will be returned.
/// </summary>
/// <remarks>
- /// Media in external storage is not supported, with the exception of MMC.
+ /// Media in the external storage is not supported, with the exception of MMC.
/// </remarks>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <feature>http://tizen.org/feature/vision.face_recognition</feature>
- /// <param name="mediaId">The media id to create thumbnail.</param>
+ /// <param name="mediaId">The media ID to create the thumbnail.</param>
/// <param name="cancellationToken">The token to cancel the operation.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the number of faces detected.</returns>
/// <exception cref="InvalidOperationException">
/// <exception cref="UnsupportedContentException">
/// Face detection is not available for the given media.\n
/// -or-\n
- /// The media is in external usb storage(<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
+ /// The media is in the external USB storage (<see cref="MediaInfo.StorageType"/> is <see cref="StorageType.ExternalUsb"/>).
/// </exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
public Task<int> DetectFaceAsync(string mediaId, CancellationToken cancellationToken)