namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents a logical collection grouping of related media info.
+ /// Represents a logical collection grouping of related media information.
/// </summary>
/// <seealso cref="AlbumCommand"/>
public class Album
internal static Album FromHandle(IntPtr handle) => new Album(handle);
/// <summary>
- /// Get the id of the album.
+ /// Gets the ID of the album.
/// </summary>
- /// <value>The unique id of the album.</value>
+ /// <value>The unique ID of the album.</value>
public int Id { get; }
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="AlbumCommand"/> 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 AlbumCommand(MediaDatabase database) : base(database)
}
/// <summary>
- /// Retrieves an album with an album id.
+ /// Retrieves an album with the album ID.
/// </summary>
- /// <param name="albumId">The id of the album to query with.</param>
+ /// <param name="albumId">The ID of the album to query with.</param>
/// <returns>The <see cref="Album"/> if <paramref name="albumId"/> exists, 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 media info that belongs to the album.
+ /// Retrieves the number of media information that belongs to the album.
/// </summary>
- /// <param name="albumId">The id of the album to query with.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="albumId">The ID of the album to query with.</param>
+ /// <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="ArgumentOutOfRangeException"><paramref name="albumId"/> is equal to or less than zero.</exception>
}
/// <summary>
- /// Retrieves the number of media info that belongs to the album with <see cref="CountArguments"/>..
+ /// Retrieves the number of media information that belongs to the album with <see cref="CountArguments"/>.
/// </summary>
- /// <param name="albumId">The id of the album to count media.</param>
+ /// <param name="albumId">The ID of the album to count media.</param>
/// <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="ArgumentOutOfRangeException"><paramref name="albumId"/> is equal to or less than zero.</exception>
}
/// <summary>
- /// Retrieves the media info of an album.
+ /// Retrieves the media information of the album.
/// </summary>
- /// <param name="albumId">The id of the album to select media.</param>
+ /// <param name="albumId">The ID of the album to select 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 media info of an album with <see cref="SelectArguments"/>.
+ /// Retrieves the media information of the album with <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="albumId">The id of the album to query with.</param>
+ /// <param name="albumId">The ID of the album to query with.</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>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents an audio media information.
+ /// Represents the audio media information.
/// </summary>
public class AudioInfo : MediaInfo
{
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents a media bookmark that allows you to mark interesting moment
- /// in media(video and audio) to enable fast searching.
+ /// Represents the media bookmark that allows you to mark an interesting moment
+ /// in media (video and audio) to enable fast searching.
/// </summary>
public class Bookmark
{
}
/// <summary>
- /// Gets the id of the bookmark.
+ /// Gets the ID of the bookmark.
/// </summary>
- /// <value>The id of the bookmark.</value>
+ /// <value>The ID of the bookmark.</value>
public int Id { get; }
/// <summary>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage bookmarks in database.
+ /// Provides commands to manage bookmarks in the database.
/// </summary>
/// <seealso cref="Bookmark"/>
public class BookmarkCommand : MediaCommand
/// <summary>
/// Initializes a new instance of the <see cref="BookmarkCommand"/> 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 BookmarkCommand(MediaDatabase database) : base(database)
}
/// <summary>
- /// Inserts new bookmark into the database with the specified media and offset.
+ /// Inserts a new bookmark into the database with the specified media and offset.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to be associated with.</param>
+ /// <param name="mediaId">The media ID to be associated with.</param>
/// <param name="offset">The time offset in milliseconds.</param>
/// <returns>The <see cref="Bookmark"/> instance that contains the record information inserted.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
}
/// <summary>
- /// Inserts new bookmark into the database with the specified media id, offset and name.
+ /// Inserts a new bookmark into the database with the specified media ID, offset, and name.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="mediaId">The media id to be associated with.</param>
+ /// <param name="mediaId">The media ID to be associated with.</param>
/// <param name="offset">The time offset in milliseconds.</param>
/// <param name="name">The name of the bookmark. This value can be null.</param>
/// <returns>The <see cref="Bookmark"/> instance that contains the record information inserted.</returns>
}
/// <summary>
- /// Inserts new bookmark into the database with the specified media id, offset, name and thumbnail path.
+ /// Inserts a new bookmark into the database with the specified media ID, offset, name, and thumbnail path.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <remarks>
- /// Thumbnail may be useful only when the media is video.
+ /// The thumbnail may be useful only when the media is video.
/// </remarks>
- /// <param name="mediaId">The media id to be associated with.</param>
+ /// <param name="mediaId">The media ID to be associated with.</param>
/// <param name="offset">The time offset in milliseconds.</param>
/// <param name="name">The name of the bookmark. This value can be null.</param>
/// <param name="thumbnailPath">The thumbnail path of the bookmark. This value can be null.</param>
/// Deletes a bookmark from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="bookmarkId">The bookmark id to delete.</param>
+ /// <param name="bookmarkId">The bookmark ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
public static class MediaInfoColumns
{
/// <summary>
- /// Gets the column name for the id of media.
+ /// Gets the column name for the ID of media.
/// </summary>
- /// <value>The column name for the id of media.</value>
+ /// <value>The column name for the ID of media.</value>
/// <remarks>The value type is string.</remarks>
/// <seealso cref="MediaInfo.Id"/>
public static string Id => "MEDIA_ID";
public static string Path => "MEDIA_PATH";
/// <summary>
- /// Gets the column name for display name of media.
+ /// Gets the column name for the display name of media.
/// </summary>
/// <value>The column name for the display name of media.</value>
/// <remarks>The value type is string.</remarks>
/// <value>The column name for the type of media.</value>
/// <remarks>
/// The value type is integer.
- /// The value should be an integer that is one of <see cref="MediaContent.MediaType"/> values.
+ /// The value should be an integer that is one of the <see cref="MediaContent.MediaType"/> values.
/// </remarks>
/// <seealso cref="MediaInfo.MediaType"/>
public static string MediaType => "MEDIA_TYPE";
/// <value>The column name for the orientation of media.</value>
/// <remarks>
/// The value type is integer.
- /// The value should be an integer that is one of <see cref="MediaContent.Orientation"/> values.
+ /// The value should be an integer that is one of the <see cref="MediaContent.Orientation"/> values.
/// </remarks>
/// <seealso cref="MediaContent.Orientation"/>
/// <seealso cref="ImageInfo.Orientation"/>
public static string Orientation => "MEDIA_ORIENTATION";
/// <summary>
- /// Gets the column name for the burst id of media.
+ /// Gets the column name for the burst ID of media.
/// </summary>
- /// <value>The column name for the burst id of media.</value>
+ /// <value>The column name for the burst ID of media.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
/// </summary>
/// <value>The column name for the favorite status of media.</value>
/// <remarks>
- /// The value type is integer(1 : true, 0 : false).
+ /// The value type is integer (1 : true, 0 : false).
/// </remarks>
/// <seealso cref="MediaInfo.IsFavorite"/>
public static string Favorite => "MEDIA_FAVOURITE";
/// </summary>
/// <value>The column name for the drm of media.</value>
/// <remarks>
- /// The value type is integer(1 : true, 0 : false).
+ /// The value type is integer (1 : true, 0 : false).
/// </remarks>
/// <seealso cref="MediaInfo.IsDrm"/>
public static string IsDrm => "MEDIA_IS_DRM";
/// <value>The column name for the storage type of media.</value>
/// <remarks>
/// The value type is integer.
- /// The value should be an integer that is one of <see cref="MediaContent.StorageType"/> values.
+ /// The value should be an integer that is one of the <see cref="MediaContent.StorageType"/> values.
/// </remarks>
/// <seealso cref="MediaInfo.StorageType"/>
public static string StorageType => "MEDIA_STORAGE_TYPE";
public static string FNumber => "MEDIA_FNUMBER";
/// <summary>
- /// Gets the column name for the iso of media.
+ /// Gets the column name for the ISO of media.
/// </summary>
- /// <value>The column name for the iso of media.</value>
+ /// <value>The column name for the ISO of media.</value>
/// <remarks>
/// The value type is integer.
/// </remarks>
public static class FolderColumns
{
/// <summary>
- /// Gets the column name for the id of folder.
+ /// Gets the column name for the ID of folder.
/// </summary>
- /// <value>The column name for the id of folder.</value>
+ /// <value>The column name for the ID of folder.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
/// <value>The column name for the storage type of folder.</value>
/// <remarks>
/// The value type is integer.
- /// The value should be an integer that is one of <see cref="MediaContent.StorageType"/> values.
+ /// The value should be an integer that is one of the <see cref="MediaContent.StorageType"/> values.
/// </remarks>
/// <seealso cref="Folder.StorageType"/>
public static string StorageType => "FOLDER_STORAGE_TYPE";
public static string Name => "PLAYLIST_NAME";
/// <summary>
- /// Gets the column name for the id of playlist.
+ /// Gets the column name for the ID of playlist.
/// </summary>
- /// <value>The column name for the id of playlist.</value>
+ /// <value>The column name for the ID of playlist.</value>
/// <remarks>
/// The value type is integer.
/// </remarks>
}
/// <summary>
- /// Provides the tag column names that can be used for <see cref="SelectArguments"/>.
+ /// Provides the tag column names that can be used for the <see cref="SelectArguments"/>.
/// </summary>
/// <seealso cref="SelectArguments"/>
/// <seealso cref="CountArguments"/>
public static string Count => "TAG_MEDIA_COUNT";
/// <summary>
- /// Gets the column name for the id of tag.
+ /// Gets the column name for the ID of tag.
/// </summary>
- /// <value>The column name for the id of tag.</value>
+ /// <value>The column name for the ID of tag.</value>
/// <remarks>
/// The value type is integer.
/// </remarks>
public static class BookmarkColumns
{
/// <summary>
- /// Gets the column name for offset of bookmark.
+ /// Gets the column name for the offset of the bookmark.
/// </summary>
- /// <value>The column name for the offset of bookmark.</value>
+ /// <value>The column name for the offset of the bookmark.</value>
/// <remarks>
/// The value type is integer.
/// </remarks>
public static string Offset => "BOOKMARK_MARKED_TIME";
/// <summary>
- /// Gets the column name for the id of bookmark.
+ /// Gets the column name for the ID of the bookmark.
/// </summary>
- /// <value>The column name for the id of bookmark.</value>
+ /// <value>The column name for the ID of the bookmark.</value>
/// <remarks>
/// The value type is integer.
/// </remarks>
public static string Id => "BOOKMARK_ID";
/// <summary>
- /// Gets the column name for the name of bookmark.
+ /// Gets the column name for the name of the bookmark.
/// </summary>
- /// <value>The column name for the name of bookmark.</value>
+ /// <value>The column name for the name of the bookmark.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
public static class FaceInfoColumns
{
/// <summary>
- /// Gets the column name for the tag of face info.
+ /// Gets the column name for the tag of face information.
/// </summary>
- /// <value>The column name for the tag of face info.</value>
+ /// <value>The column name for the tag of face information.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
public static string Tag => "MEDIA_FACE_TAG";
/// <summary>
- /// Gets the column name for the id of face info.
+ /// Gets the column name for the ID of face information.
/// </summary>
- /// <value>The column name for the id of face info.</value>
+ /// <value>The column name for the ID of face information.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
public static class StorageColumns
{
/// <summary>
- /// Gets the column name for the id of storage.
+ /// Gets the column name for the ID of storage.
/// </summary>
- /// <value>The column name for the id of storage.</value>
+ /// <value>The column name for the ID of storage.</value>
/// <remarks>
/// The value type is string.
/// </remarks>
/// <value>The column name for the type of storage.</value>
/// <remarks>
/// The value type is integer.
- /// The value should be an integer that is one of <see cref="MediaContent.StorageType"/> values.
+ /// The value should be an integer that is one of the <see cref="MediaContent.StorageType"/> values.
/// </remarks>
/// <seealso cref="Storage.Type"/>
public static string Type => "MEDIA_STORAGE_TYPE";
}
/// <summary>
- /// Specifies storage types.
+ /// Specifies the storage types.
/// </summary>
public enum StorageType
{
Internal = 0,
/// <summary>
- /// The device's external storage like sd card.
+ /// The device's external storage like SD card.
/// </summary>
External = 1,
/// <summary>
- /// The external usb storage.
+ /// The external USB storage.
/// </summary>
ExternalUsb = 2
}
}
/// <summary>
- /// Specifies types of <see cref="MediaInfo"/>.
+ /// Specifies types of the <see cref="MediaInfo"/>.
/// </summary>
public enum MediaType
{
}
/// <summary>
- /// Gets the process id which triggers the event.
+ /// Gets the process ID which triggers the event.
/// </summary>
- /// <value>The process id which triggers the event.</value>
+ /// <value>The process ID which triggers the event.</value>
public int ProcessId
{
get;
}
/// <summary>
- /// Gets the id of the media updated.
+ /// Gets the ID of the media updated.
/// </summary>
- /// <value>The id of the media updated.</value>
+ /// <value>The ID of the media updated.</value>
public string Id
{
get;
}
/// <summary>
- /// The mime type of the media updated.
+ /// The MIME type of the media updated.
/// </summary>
- /// <value>The mime type of the media updated.</value>
+ /// <value>The MIME type of the media updated.</value>
public string MimeType
{
get;
}
/// <summary>
- /// Gets the id of the folder updated.
+ /// Gets the ID of the folder updated.
/// </summary>
- /// <value>The id of the folder updated.</value>
+ /// <value>The ID of the folder updated.</value>
public string Id
{
get;
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents the face information for media.
+ /// Represents the face information for the media.
/// </summary>
public class FaceInfo
{
public Rectangle Rect { get; }
/// <summary>
- /// Gets the id of face info.
+ /// Gets the ID of face information.
/// </summary>
public string Id { get; }
/// <summary>
- /// Gets the media id that the face info is added.
+ /// Gets the media ID that the face information is added.
/// </summary>
- /// <value>The media id that the face info is added.</value>
+ /// <value>The media ID that the face information is added.</value>
public string MediaInfoId { get; }
/// <summary>
/// Gets the tag name.
/// </summary>
- /// <value>The tag name of face info.</value>
+ /// <value>The tag name of face information.</value>
public string Tag { get; }
/// <summary>
- /// Gets the orientation of face info.
+ /// Gets the orientation of face information.
/// </summary>
- /// <value>The orientation of face info.</value>
+ /// <value>The orientation of face information.</value>
public Orientation Orientation { get; }
internal static FaceInfo FromHandle(IntPtr handle)
}
/// <summary>
- /// Returns a string representation of the face info.
+ /// Returns a string representation of the face information.
/// </summary>
/// <returns>A string representation of the current face info.</returns>
public override string ToString() =>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage face infos in the database.
+ /// Provides commands to manage face information in the database.
/// </summary>
/// <seealso cref="Album"/>
public class FaceInfoCommand : MediaCommand
/// <summary>
/// Initializes a new instance of the <see cref="FaceInfoCommand"/> 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 FaceInfoCommand(MediaDatabase database) : base(database)
}
/// <summary>
- /// Deletes a face info from the database.
+ /// Deletes the face information from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="faceInfoId">The face info id to delete.</param>
+ /// <param name="faceInfoId">The face information ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</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.
+ /// Retrieves the face information.
/// </summary>
/// <returns>The <see cref="MediaDataReader{TRecord}"/> containing the results.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
}
/// <summary>
- /// Retrieves the face info with <see cref="SelectArguments"/>.
+ /// Retrieves the face information with the <see cref="SelectArguments"/>.
/// </summary>
/// <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>
/// Updates a tag with the specified tag.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="faceInfoId">The face info id to update.</param>
+ /// <param name="faceInfoId">The face information ID to update.</param>
/// <param name="tag">The tag value for update.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>Only values set in <see cref="PlaylistUpdateValues"/> are updated.</remarks>
+ /// <remarks>Only values set in the <see cref="PlaylistUpdateValues"/> 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>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents the folder information for media.
+ /// Represents the folder information for the media.
/// </summary>
/// <remarks>
- /// A <see cref="Folder"/> is used to organize media content files i.e. image, audio, video files,
+ /// The <see cref="Folder"/> is used to organize media content files, i.e., image, audio, and video files,
/// in the physical storage of the device.
/// </remarks>
public class Folder
internal static Folder FromHandle(IntPtr handle) => new Folder(handle);
/// <summary>
- /// Gets the id of folder.
+ /// Gets the ID of the folder.
/// </summary>
- /// <value>The unique id of folder.</value>
+ /// <value>The unique ID of the folder.</value>
public string Id { get; }
/// <summary>
- /// Gets the path of folder.
+ /// Gets the path of the folder.
/// </summary>
- /// <value>The path of folder.</value>
+ /// <value>The path of the folder.</value>
public string Path { get; }
/// <summary>
- /// Gets the name of folder.
+ /// Gets the name of the folder.
/// </summary>
- /// <value>The name of folder.</value>
+ /// <value>The name of the folder.</value>
public string Name { get; }
/// <summary>
public StorageType StorageType { get; }
/// <summary>
- /// Gets the storage id of the storage that the folder exists.
+ /// Gets the storage ID of the storage that the folder exists.
/// </summary>
- /// <value>The storage id of the storage that the folder exists.</value>
+ /// <value>The storage ID of the storage that the folder exists.</value>
public string StorageId { get; }
/// <summary>
/// <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 FolderCommand(MediaDatabase database) : base(database)
}
/// <summary>
- /// Retrieves the number of folders with <see cref="CountArguments"/>.
+ /// Retrieves the number of folders with the <see cref="CountArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of folders.</returns>
}
/// <summary>
- /// Retrieves the folders with <see cref="SelectArguments"/>.
+ /// Retrieves the folders 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>
/// Retrieves the folder.
/// </summary>
- /// <param name="folderId">The folder id to query with.</param>
+ /// <param name="folderId">The folder ID to query with.</param>
/// <returns>The <see cref="Folder"/> 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 media info under the folder.
+ /// Retrieves the number of media information under the folder.
/// </summary>
- /// <param name="folderId">The id of the folder to count media in the folder.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="folderId">The ID of the folder to count media in the folder.</param>
+ /// <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 number of media info under the folder with <see cref="CountArguments"/>.
+ /// Retrieves the number of media information under the folder with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="folderId">The id of the folder to count media in the folder.</param>
+ /// <param name="folderId">The ID of the folder to count media in the folder.</param>
/// <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 info under the folder.
+ /// Retrieves the media information under the folder.
/// </summary>
- /// <param name="folderId">The id of the folder to select media in the folder.</param>
+ /// <param name="folderId">The ID of the folder to select media in the folder.</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 media info under the folder with <see cref="SelectArguments"/>.
+ /// Retrieves the media information under the folder with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="folderId">The id of the folder to select media in the folder.</param>
+ /// <param name="folderId">The ID of the folder to select media in the folder.</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>
public string DateTaken { get; }
/// <summary>
- /// Gets the burst shot id.
+ /// Gets the burst shot ID.
/// </summary>
- /// <value>The burst shot id if it is a burst shot, otherwise an empty string.</value>
+ /// <value>The burst shot ID if it is a burst shot, otherwise an empty string.</value>
/// <seealso cref="IsBurstShot"/>
public string BurstId { get; }
/// <summary>
- /// Gets the exposure time from exif.
+ /// Gets the exposure time from EXIF.
/// </summary>
- /// <value>The exposure time from exif.</value>
+ /// <value>The exposure time from EXIF.</value>
public string ExposureTime { get; }
/// <summary>
- /// Gets the FNumber from exif.
+ /// Gets the FNumber from EXIF.
/// </summary>
/// <value>The FNumber from exif.</value>
public double FNumber { get; }
/// <summary>
- /// Gets the iso from exif.
+ /// Gets the ISO from EXIF.
/// </summary>
- /// <value>The iso from exif.</value>
+ /// <value>The iso from EXIF.</value>
public int Iso { get; }
/// <summary>
- /// Gets the model from exif.
+ /// Gets the model from EXIF.
/// </summary>
- /// <value>The model from exif.</value>
+ /// <value>The model from EXIF.</value>
public string Model { get; }
/// <summary>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// <see cref="MediaCommand"/> is a base class for command classes.
+ /// The <see cref="MediaCommand"/> is a base class for command classes.
/// </summary>
public abstract class MediaCommand
{
/// <summary>
/// Initializes a new instance of the <see cref="MediaCommand"/> 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>
protected MediaCommand(MediaDatabase database)
private static readonly object _folderUpdatedLock = new object();
/// <summary>
- /// Occurs when there is a change for folder in the database.
+ /// Occurs when there is a change for the folder in the database.
/// </summary>
public static event EventHandler<FolderUpdatedEventArgs> FolderUpdated
{
}
/// <summary>
- /// Requests to scan a folder, recursively.
+ /// Requests to scan a folder recursively.
/// </summary>
/// <remarks>
/// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
/// <param name="folderPath">The path to scan.</param>
- /// <param name="recursive">The value indicating if the folder is to recursively scanned.</param>
+ /// <param name="recursive">The value indicating if the folder is to be recursively scanned.</param>
/// <remarks>Folders that contains a file named ".scan_ignore" will not be scanned.</remarks>
/// <returns>A task that represents the asynchronous scan operation.</returns>
/// <exception cref="InvalidOperationException">The database is not connected.</exception>
}
/// <summary>
- /// Requests to scan a folder, recursively.
+ /// Requests to scan a folder recursively.
/// </summary>
/// <remarks>
/// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
}
/// <summary>
- /// Requests to scan a folder, recursively.
+ /// Requests to scan a folder recursively.
/// </summary>
/// <remarks>
/// If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
/// <param name="folderPath">The path to scan.</param>
- /// <param name="recursive">The value indicating if the folder is to recursively scanned.</param>
+ /// <param name="recursive">The value indicating if the folder is to be recursively scanned.</param>
/// <param name="cancellationToken">The token to stop scanning.</param>
/// <remarks>Folders that contains a file named ".scan_ignore" will not be scanned.</remarks>
/// <returns>A task that represents the asynchronous scan operation.</returns>
}
/// <summary>
- /// Releases all resources.
+ /// Releases all the resources.
/// </summary>
public void Dispose()
{
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Specifies database errors.
+ /// Specifies the database errors.
/// </summary>
public enum MediaDatabaseError
{
}
/// <summary>
- /// The exception that is thrown when an database operation failed.
+ /// The exception that is thrown when a database operation failed.
/// </summary>
public class MediaDatabaseException : Exception
{
}
/// <summary>
- /// Gets the id of media.
+ /// Gets the ID of media.
/// </summary>
- /// <value>The unique id of media.</value>
+ /// <value>The unique ID of media.</value>
public string Id { get; }
/// <summary>
/// Gets the timeline of media.
/// </summary>
/// <value>
- /// The creation date if the file has the creation information (like recorded date or Image creation date),
+ /// The creation date if the file has the creation information (like recorded date or image creation date),
/// otherwise the modified date.
/// </value>
public DateTimeOffset Timeline { get; }
public string AgeRating { get; }
/// <summary>
- /// Gets the storage id of the storage that the media is stored on.
+ /// Gets the storage ID of the storage that the media is stored on.
/// </summary>
- /// <value>The storage id of the storage that the media is stored on.</value>
+ /// <value>The storage ID of the storage that the media is stored on.</value>
public string StorageId { get; }
/// <summary>
public StorageType StorageType { get; }
/// <summary>
- /// Returns a string representation of the media info.
+ /// Returns a string representation of the media information.
/// </summary>
- /// <returns>A string representation of the current media info.</returns>
+ /// <returns>A string representation of the current media information.</returns>
public override string ToString() => $"Id={Id}, Path={Path}, MediaType={MediaType}";
internal static MediaInfo FromHandle(Interop.MediaInfoHandle handle)
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Specifies group keys for <see cref="MediaInfo"/>.
+ /// Specifies the group keys for <see cref="MediaInfo"/>.
/// </summary>
public enum MediaInfoColumnKey
{
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)
public class MediaInfoUpdateValues
{
/// <summary>
- /// Gets or sets the weather information for update.
+ /// Gets or sets the weather information for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for weather; the field will not be updated if null.</value>
public string Weather { get; set; }
/// <summary>
- /// Gets or sets the favorite status for update.
+ /// Gets or sets the favorite status for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A value indicating whether the media is favorite; the field will not be updated if null.</value>
public bool? IsFavorite { get; set; }
/// <summary>
- /// Gets or sets the provider information for update.
+ /// Gets or sets the provider information for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for provider; the field will not be updated if null.</value>
public string Provider { get; set; }
/// <summary>
- /// Gets or sets the category information for update.
+ /// Gets or sets the category information for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for category; the field will not be updated if null.</value>
/// <summary>
- /// Gets or sets the location tag for update.
+ /// Gets or sets the location tag for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for location tag; the field will not be updated if null.</value>
public string LocationTag { get; set; }
/// <summary>
- /// Gets or sets the age rating information for update.
+ /// Gets or sets the age rating information for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for age rating; the field will not be updated if null.</value>
/// <summary>
/// The Tizen.Content.MediaContent namespace provides types used in the entire content service.
-/// The information about media items(i.e. image, audio and video) are managed in the content database
+/// The information about media items (i.e. image, audio, and video) are managed in the content database
/// and operations that involve database require an active connection with the media content service.
-/// During media scanning, Media content service extracts media information automatically. Media information
-/// includes basic file info like path, size, modified time etc and some metadata like ID3 tag, EXIF,
-/// thumbnail, etc. (thumbnail extracted only in Internal and SD card storage.
+/// During media scanning, the media content service extracts the media information automatically. The media information
+/// includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF,
+/// thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage.
/// </summary>
-/// <remarks>Media content service does not manage hidden files.</remarks>
+/// <remarks>The media content service does not manage hidden files.</remarks>
namespace Tizen.Content.MediaContent { }
\ No newline at end of file
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents a playlist that is a group of media(usually songs).
+ /// Represents the playlist that is a group of media (usually songs).
/// </summary>
public class Playlist
{
/// <summary>
/// Gets the ID of the playlist.
/// </summary>
- /// <value>The unique id of the playlist.</value>
+ /// <value>The unique ID of the playlist.</value>
public int Id { get; }
/// <summary>
/// <remarks>
/// The values only set in the object will be affected to the update command.
/// </remarks>
- /// <seealso cref="PlaylistCommand.Update(int, PlaylistUpdateValues)"/>
+ /// <seealso cref="PlaylistCommand.Update (int, PlaylistUpdateValues)"/>
public class PlaylistUpdateValues
{
/// <summary>
- /// Gets or sets the name of playlist for update.
+ /// Gets or sets the name of the playlist for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
/// <value>A string for name; the field will not be updated if null.</value>
public string Name { get; set; }
/// <summary>
- /// Gets or sets the thumbnail path of playlist for update.
+ /// Gets or sets the thumbnail path of the playlist for an update.
/// </summary>
/// <remarks>If the value is null, the update operation will have no effect on the field.</remarks>
- /// <value>A string for thumbnail path; the field will not be updated if null.</value>
+ /// <value>A string for the thumbnail path; the field will not be updated if null.</value>
public string ThumbnailPath { get; set; }
}
/// <summary>
- /// Represents an order of a member of a playlist.
+ /// Represents an order of a member of the playlist.
/// </summary>
public class PlayOrder
{
/// <summary>
- /// Initializes a new instance of the <see cref="Playlist"/> class with the specified member id and order value.
+ /// Initializes a new instance of the <see cref="Playlist"/> class with the specified member ID and the order value.
/// </summary>
- /// <param name="memberId">The id of member.</param>
+ /// <param name="memberId">The ID of the member.</param>
/// <param name="orderValue">The order value.</param>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="memberId"/> is less than or equal to zero.\n
private int _memberId;
/// <summary>
- /// Gets or sets the member id.
+ /// Gets or sets the member ID.
/// </summary>
- /// <value>The member id.</value>
+ /// <value>The member ID.</value>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="value"/> is less than or equal to zero.
/// </exception>
private int _value;
/// <summary>
- /// Gets or sets the value indicating the order of the member in a playlist.
+ /// Gets or sets the value indicating the order of the member in the playlist.
/// </summary>
- /// <value>A integer value indicating the order of the member in a playlist.</value>
+ /// <value>An integer value indicating the order of the member in the playlist.</value>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="value"/> is less than zero.
/// </exception>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage playlists in the database.
+ /// Provides the commands to manage playlists in the database.
/// </summary>
/// <seealso cref="Playlist"/>
public class PlaylistCommand : MediaCommand
}
/// <summary>
- /// Retrieves the number of playlists with <see cref="CountArguments"/>.
+ /// Retrieves the number of playlists with the <see cref="CountArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of playlists.</returns>
/// <summary>
/// Retrieves the play order of the member.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberId">The member id of the playlist.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberId">The member ID of the playlist.</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>
/// Deletes a playlist from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="playlistId">The playlist id to delete.</param>
+ /// <param name="playlistId">The playlist ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</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>
- /// Inserts a playlist into the database from the specified m3u file.
+ /// Inserts the playlist into the database from the specified M3U file.
/// </summary>
/// <remarks>
- /// 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.
+ /// If you want to access an internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
+ /// If you want to access an external storage, you should add privilege http://tizen.org/privilege/externalstorage.
/// </remarks>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="name">The name of playlist.</param>
- /// <param name="path">The path to a m3u file to import.</param>
+ /// <param name="name">The name of the playlist.</param>
+ /// <param name="path">The path to a M3U file to import.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</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>
- /// Exports a playlist to a m3u file.
+ /// Exports the playlist to a M3U file.
/// </summary>
/// <remarks>
/// If the file already exists in the file system, then it will be overwritten.\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.
+ /// If you want to access an internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n
+ /// If you want to access an external storage, you should add privilege http://tizen.org/privilege/externalstorage.
/// </remarks>
/// <privilege>http://tizen.org/privilege/mediastorage</privilege>
/// <privilege>http://tizen.org/privilege/externalstorage</privilege>
- /// <param name="playlistId">The playlist id to export.</param>
- /// <param name="path">The path to a m3u file.</param>
+ /// <param name="playlistId">The playlist ID to export.</param>
+ /// <param name="path">The path to a M3U file.</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>
- /// Inserts a playlist into the database with the specified name.
+ /// Inserts the playlist into the database with the specified name.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="name">The name of playlist.</param>
+ /// <param name="name">The name of the playlist.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</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>
- /// Inserts a playlist into the database with the specified name and thumbnail path.
+ /// Inserts the playlist into the database with the specified name and the thumbnail path.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="name">The name of playlist.</param>
- /// <param name="thumbnailPath">The path of thumbnail for playlist. This value can be null.</param>
+ /// <param name="name">The name of the playlist.</param>
+ /// <param name="thumbnailPath">The path of the thumbnail for the playlist. This value can be null.</param>
/// <returns>The <see cref="Playlist"/> instance that contains the record information inserted.</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 playlists with <see cref="SelectArguments"/>.
+ /// Retrieves the playlists with the <see cref="SelectArguments"/>.
/// </summary>
/// <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>
}
/// <summary>
- /// Retrieves the playlist with the specified playlist id.
+ /// Retrieves the playlist with the specified playlist ID.
/// </summary>
- /// <param name="playlistId">The playlist id to select.</param>
+ /// <param name="playlistId">The playlist ID to select.</param>
/// <returns>The <see cref="Playlist"/> 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 media info of the playlist.
+ /// Retrieves the number of media information of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id to count media added to the playlist.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="playlistId">The playlist ID to count media added to the playlist.</param>
+ /// <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 number of media info of the playlist with <see cref="CountArguments"/>.
+ /// Retrieves the number of media information of the playlist with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="playlistId">The playlist id to count media added to the playlist.</param>
+ /// <param name="playlistId">The playlist ID to count the media added to the playlist.</param>
/// <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 member id of the media in the playlist.
+ /// Retrieves the member ID of the media in the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="mediaId">The media id.</param>
- /// <returns>The member id if the member was found in the playlist, otherwise -1.</returns>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="mediaId">The media ID.</param>
+ /// <returns>The member ID if the member was found in the playlist, otherwise -1.</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 info of the playlist.
+ /// Retrieves the media information of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id to query with.</param>
+ /// <param name="playlistId">The playlist ID to query with.</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 media info of the playlist with <see cref="SelectArguments"/>.
+ /// Retrieves the media information of the playlist with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="playlistId">The playlist id to query with.</param>
+ /// <param name="playlistId">The playlist ID to query with.</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>
- /// Updates a playlist with the specified values.
+ /// Updates the playlist with the specified values.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="playlistId">The playlist id to update.</param>
- /// <param name="values">The values for update.</param>
+ /// <param name="playlistId">The playlist ID to update.</param>
+ /// <param name="values">The values for the update.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>Only values set in <see cref="PlaylistUpdateValues"/> are updated.</remarks>
+ /// <remarks>Only values set in the <see cref="PlaylistUpdateValues"/> 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>
}
/// <summary>
- /// Adds media to a playlist.
+ /// Adds the media to the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id that the media will be added to.</param>
- /// <param name="mediaId">The media id to add to the playlist.</param>
+ /// <param name="playlistId">The playlist ID that the media will be added to.</param>
+ /// <param name="mediaId">The media ID to add to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media id will be ignored.</remarks>
+ /// <remarks>The invalid media ID will be ignored.</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 a media set to a playlist.
+ /// Adds the media set to the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id that the media will be added to.</param>
- /// <param name="mediaIds">The collection of media id to add to the playlist.</param>
+ /// <param name="playlistId">The playlist ID that the media will be added to.</param>
+ /// <param name="mediaIds">The collection of media ID to add to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media ids will be ignored.</remarks>
+ /// <remarks>The invalid media IDs will be ignored.</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>
- /// Removes a member from a playlist.
+ /// Removes a member from the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberId">The member id to be removed.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberId">The member ID to be removed.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid id will be ignored.</remarks>
+ /// <remarks>The invalid ID will be ignored.</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>
- /// Removes a media set from a playlist.
+ /// Removes a media set from the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="memberIds">The collection of member id to remove from to the playlist.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="memberIds">The collection of member ID to remove from to the playlist.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid ids will be ignored.</remarks>
+ /// <remarks>The invalid IDs will be ignored.</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>
- /// Updates a play order of a playlist.
+ /// Updates a play order of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
+ /// <param name="playlistId">The playlist ID.</param>
/// <param name="playOrder">The <see cref="PlayOrder"/> to apply.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <remarks>The <see cref="PlayOrder.MemberId"/> that is invalid will be ignored.</remarks>
}
/// <summary>
- /// Updates play orders of a playlist.
+ /// Updates play orders of the playlist.
/// </summary>
- /// <param name="playlistId">The playlist id.</param>
- /// <param name="orders">The collection of <see cref="PlayOrder"/> to apply.</param>
+ /// <param name="playlistId">The playlist ID.</param>
+ /// <param name="orders">The collection of the <see cref="PlayOrder"/> to apply.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <remarks>The <see cref="PlayOrder.MemberId"/> that is invalid will be ignored.</remarks>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents a member of <see cref="Playlist"/>.
+ /// Represents a member of the <see cref="Playlist"/>.
/// </summary>
public class PlaylistMember
{
/// <summary>
- /// Gets the member id.
+ /// Gets the member ID.
/// </summary>
- /// <value>The member id of playlist.</value>
+ /// <value>The member ID of the playlist.</value>
public int MemberId { get; }
/// <summary>
- /// Gets the media info of the member.
+ /// Gets the media information of the member.
/// </summary>
/// <value>The <see cref="MediaInfo"/> of the member.</value>
public MediaInfo MediaInfo { get; }
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Base class for query arguments.
+ /// The Base class for query arguments.
/// </summary>
/// <remarks>
- /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist
- /// and MediaInfo on basis of details like limit, order and condition.
+ /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist,
+ /// and MediaInfo on the basis of details like limit, order, and condition.
/// </remarks>
public class QueryArguments
{
/// <item><description>expression1 AND expression2 OR expression3 ... </description></item>
/// </list>
///
- /// Note that if you want to set quotation(" ' " or " " ") as value of LIKE operator, you should use two times.(" '' " or " "" ").
+ /// Note that if you want to set quotation (" ' " or " " ") as value of LIKE operator, you should use two times. (" '' " or " "" ").
/// And the optional ESCAPE clause is supported. Both percent symbol("%") and underscore symbol("_") are used in the LIKE pattern.
- /// If these characters are used as value of LIKE operation, then the expression following the ESCAPE clause of sqlite will be ignored.\n
+ /// If these characters are used as values of the LIKE operation, then the expression following the ESCAPE clause of sqlite will be ignored.\n
/// \n
/// For example,\n
- /// - column LIKE('#%') ESCAPE('#') - "#" is escape character, it will be ignored.
+ /// - column LIKE ('#%') ESCAPE ('#') - "#" is an escape character, it will be ignored.
/// </remarks>
/// <exception cref="ArgumentException"><paramref name="value"/> is a zero-length string, contains only white space.</exception>
/// <seealso cref="MediaInfoColumns"/>
private string _storageId;
/// <summary>
- /// Gets or sets the storage id for the given filter.
+ /// Gets or sets the storage ID for the given filter.
/// You can use this property when you want to search items only in the specific storage.
/// </summary>
- /// <value>The storage id to restrict storage to search, or null for all storages.</value>
+ /// <value>The storage ID to restrict storage to search, or null for all storages.</value>
/// <exception cref="ArgumentException"><paramref name="value"/> is a zero-length string, contains only white space.</exception>
public string StorageId
{
/// Provides the ability to filter the result of a Select command.
/// </summary>
/// <remarks>
- /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist
+ /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist,
/// and MediaInfo.
/// </remarks>
public class SelectArguments : QueryArguments
private int _startRowIndex;
/// <summary>
- /// Gets or sets the starting row position of a query(starting from zero).
+ /// Gets or sets the starting row position of a query (starting from zero).
/// </summary>
/// <value>An integer value that indicates the starting row position of a query.</value>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.\n</exception>
}
/// <summary>
- /// Provides the ability to filter the result of a Count command.
+ /// Provides the ability to filter the result of the Count command.
/// </summary>
/// <remarks>
- /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist
+ /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist,
/// and MediaInfo.
/// </remarks>
public class CountArguments : QueryArguments
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents location of the object bounded by rectangle defined by
- /// coordinates of top left corner, width and height.
+ /// Represents the location of the object bounded by the rectangle defined by
+ /// coordinates of top left corner, width, and height.
/// </summary>
public struct Rectangle
{
/// <summary>
- /// Initializes a new instance of the Rectangle with the specified values.
+ /// Initializes a new instance of the rectangle with the specified values.
/// </summary>
/// <param name="x">The x-coordinate of the upper-left corner of the rectangle.</param>
/// <param name="y">The y-coordinate of the upper-left corner of the rectangle.</param>
- /// <param name="width">The Width of the rectangle.</param>
- /// <param name="height">The Height of the rectangle.</param>
+ /// <param name="width">The width of the rectangle.</param>
+ /// <param name="height">The height of the rectangle.</param>
public Rectangle(int x, int y, int width, int height)
{
X = x;
$"X={X.ToString()}, Y={Y.ToString()}, Width={Width.ToString()}, Height={Height.ToString()}";
/// <summary>
- /// Returns the hash code for this Rectangle structure.
+ /// Returns the hash code for this rectangle structure.
/// </summary>
/// <returns>An integer that represents the hash code for this rectangle.</returns>
public override int GetHashCode() => new { X, Y, Width, Height }.GetHashCode();
/// <summary>
- /// Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure.
+ /// Tests whether object is a rectangle structure with the same location and size of this rectangle structure.
/// </summary>
- /// <param name="obj">A <see cref="Object"/> to compare.</param>
+ /// <param name="obj">The <see cref="Object"/> to compare.</param>
/// <returns>
- /// true if obj is a Rectangle structure and its X, Y, Width and Height properties are
- /// equal to the corresponding properties of this Rectangle structure; otherwise, false.
+ /// true if object is a rectangle structure and its x, y, width, and height properties are
+ /// equal to the corresponding properties of this rectangle structure; otherwise, false.
/// </returns>
public override bool Equals(object obj) => obj is Rectangle && this == (Rectangle)obj;
/// <summary>
- /// Tests whether two Rectangle structures have equal location and size.
+ /// Tests whether two rectangle structures have equal location and size.
/// </summary>
- /// <param name="rect1">A <see cref="Rectangle"/> to compare.</param>
- /// <param name="rect2">A <see cref="Rectangle"/> to compare.</param>
- /// <returns>true if the two Rectangle structures have equal X, Y, Width, and Height properties; otherwise, false.</returns>
+ /// <param name="rect1">The <see cref="Rectangle"/> to compare.</param>
+ /// <param name="rect2">The <see cref="Rectangle"/> to compare.</param>
+ /// <returns>true if the two rectangle structures have equal x, y, width, and height properties; otherwise, false.</returns>
public static bool operator ==(Rectangle rect1, Rectangle rect2)
=> rect1.X == rect2.X && rect1.Y == rect2.Y && rect1.Width == rect2.Width && rect1.Height == rect2.Height;
/// <summary>
- /// Tests whether two Rectangle structures differ in location or size.
+ /// Tests whether two rectangle structures differ in location or size.
/// </summary>
- /// <param name="rect1">A <see cref="Rectangle"/> to compare.</param>
- /// <param name="rect2">A <see cref="Rectangle"/> to compare.</param>
- /// <returns>true if any of the X, Y, Width or Height properties of the two Rectangle structures are unequal; otherwise false.</returns>
+ /// <param name="rect1">The <see cref="Rectangle"/> to compare.</param>
+ /// <param name="rect2">The <see cref="Rectangle"/> to compare.</param>
+ /// <returns>true if any of the x, y, width, or height properties of the two rectangle structures are unequal; otherwise false.</returns>
public static bool operator !=(Rectangle rect1, Rectangle rect2) => !(rect1 == rect2);
}
}
/// Represents the storage information for media.
/// </summary>
/// <remarks>
- /// The system generates the storage id when the external storage is added. and manages the media information
- /// in each of the storage by using storage id.
+ /// The system generates the storage ID when the external storage is added and manages the media information
+ /// in each of the storage by using the storage ID.
/// </remarks>
public class Storage
{
internal static Storage FromHandle(IntPtr handle) => new Storage(handle);
/// <summary>
- /// Gets the id of the storage.
+ /// Gets the ID of the storage.
/// </summary>
- /// <value>The unique id of the storage.</value>
+ /// <value>The unique ID of the storage.</value>
public string Id { get; }
/// <summary>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage external storages in the database.
+ /// Provides the commands to manage external storages in the database.
/// </summary>
/// <remarks>
- /// Internal storage is not managed.
+ /// The internal storage is not managed.
/// </remarks>
/// <seealso cref="Storage"/>
public class StorageCommand : MediaCommand
/// <summary>
/// Initializes a new instance of the <see cref="StorageCommand"/> 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 StorageCommand(MediaDatabase database) : base(database)
public int Count() => Count(arguments: null);
/// <summary>
- /// Retrieves the number of storages with <see cref="CountArguments"/>.
+ /// Retrieves the number of storages with the <see cref="CountArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of storages filtered.</returns>
}
/// <summary>
- /// Retrieves the storage with the specified id.
+ /// Retrieves the storage with the specified ID.
/// </summary>
- /// <param name="storageId">The storage id to select.</param>
+ /// <param name="storageId">The storage ID to select.</param>
/// <returns>The <see cref="Storage"/> 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>
public MediaDataReader<Storage> Select() => Select(arguments: null);
/// <summary>
- /// Retrieves the storages with <see cref="SelectArguments"/>.
+ /// Retrieves the storages 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>
- /// Retrieves the number of media info of the storage.
+ /// Retrieves the number of media information of the storage.
/// </summary>
- /// <param name="storageId">The storage id.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="storageId">The storage ID.</param>
+ /// <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>
public int CountMedia(string storageId) => CountMedia(storageId, null);
/// <summary>
- /// Retrieves the number of media info of the storage with <see cref="CountArguments"/>.
+ /// Retrieves the number of media information of the storage with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="storageId">The storage id to query with.</param>
+ /// <param name="storageId">The storage ID to query with.</param>
/// <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 info of the storage.
+ /// Retrieves the media information of the storage.
/// </summary>
- /// <param name="storageId">The storage id.</param>
+ /// <param name="storageId">The storage ID.</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>
public MediaDataReader<MediaInfo> SelectMedia(string storageId) => SelectMedia(storageId, null);
/// <summary>
- /// Retrieves the media info of the storage with <see cref="SelectArguments"/>.
+ /// Retrieves the media information of the storage with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="storageId">The storage id.</param>
+ /// <param name="storageId">The storage ID.</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>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Represents a special piece of information that may be associated with media.\n
+ /// Represents a special piece of information that may be associated with media.
/// Tagging allows a user to organize large number of items into logical groups providing
/// a simplified and faster way of accessing media items.
/// </summary>
}
/// <summary>
- /// Gets the id of the tag.
+ /// Gets the ID of the tag.
/// </summary>
- /// <value>The unique id of the tag.</value>
+ /// <value>The unique ID of the tag.</value>
public int Id { get; }
/// <summary>
namespace Tizen.Content.MediaContent
{
/// <summary>
- /// Provides commands to manage tags in the database.
+ /// Provides the commands to manage tags in the database.
/// </summary>
/// <seealso cref="Tag"/>
public class TagCommand : MediaCommand
/// <summary>
/// Initializes a new instance of the <see cref="TagCommand"/> 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 TagCommand(MediaDatabase database) : base(database)
}
/// <summary>
- /// Retrieves the number of tags with <see cref="CountArguments"/>.
+ /// Retrieves the number of tags with the <see cref="CountArguments"/>.
/// </summary>
/// <param name="arguments">The criteria to use to filter. This value can be null.</param>
/// <returns>The number of tags filtered.</returns>
/// Deletes a tag from the database.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="tagId">The tag id to delete.</param>
+ /// <param name="tagId">The tag ID to delete.</param>
/// <returns>true if the matched record was found and deleted, otherwise false.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaDatabase"/> has already been disposed of.</exception>
/// Updates a tag with the specified name.
/// </summary>
/// <privilege>http://tizen.org/privilege/content.write</privilege>
- /// <param name="tagId">The tag id to update.</param>
+ /// <param name="tagId">The tag ID to update.</param>
/// <param name="name">The new name.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
/// <exception cref="InvalidOperationException">The <see cref="MediaDatabase"/> is disconnected.</exception>
}
/// <summary>
- /// Retrieves the tag with the specified id.
+ /// Retrieves the tag with the specified ID.
/// </summary>
- /// <param name="tagId">The tag id to select.</param>
+ /// <param name="tagId">The tag ID to select.</param>
/// <returns>The <see cref="Tag"/> 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 tags with <see cref="SelectArguments"/>.
+ /// Retrieves the tags 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>
/// Retrieves the number of media info of the tag.
/// </summary>
- /// <param name="tagId">The tag id.</param>
- /// <returns>The number of media info.</returns>
+ /// <param name="tagId">The tag ID.</param>
+ /// <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 media info of the tag with <see cref="CountArguments"/>.
+ /// Retrieves the number of the media information of the tag with the <see cref="CountArguments"/>.
/// </summary>
- /// <param name="tagId">The tag id to query with.</param>
+ /// <param name="tagId">The tag ID to query with.</param>
/// <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 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 media info of the tag.
+ /// Retrieves the media information of the tag.
/// </summary>
- /// <param name="tagId">The tag id.</param>
+ /// <param name="tagId">The tag ID.</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 media info of the tag with <see cref="SelectArguments"/>.
+ /// Retrieves the media information of the tag with the <see cref="SelectArguments"/>.
/// </summary>
- /// <param name="tagId">The tag id.</param>
+ /// <param name="tagId">The tag ID.</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>
- /// Adds media to a tag.
+ /// Adds the media to a tag.
/// </summary>
- /// <param name="tagId">The tag id that the media will be added to.</param>
- /// <param name="mediaId">The media id to add to the tag.</param>
+ /// <param name="tagId">The tag ID that the media will be added to.</param>
+ /// <param name="mediaId">The media ID to add to the tag.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media id will be ignored.</remarks>
+ /// <remarks>The invalid media ID will be ignored.</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 a media set to a tag.
+ /// Adds the media set to a tag.
/// </summary>
- /// <param name="tagId">The tag id that the media will be added to.</param>
- /// <param name="mediaIds">The media id to add to the tag.</param>
+ /// <param name="tagId">The tag ID that the media will be added to.</param>
+ /// <param name="mediaIds">The media ID to add to the tag.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media ids will be ignored.</remarks>
+ /// <remarks>The invalid media IDs will be ignored.</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>
- /// Removes media from a tag.
+ /// Removes the media from a tag.
/// </summary>
- /// <param name="tagId">The tag id.</param>
- /// <param name="mediaId">The media id to remove from the tag.</param>
+ /// <param name="tagId">The tag ID.</param>
+ /// <param name="mediaId">The media ID to remove from the tag.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid media id will be ignored.</remarks>
+ /// <remarks>The invalid media ID will be ignored.</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>
- /// Removes a media set from a tag.
+ /// Removes the media set from a tag.
/// </summary>
- /// <param name="tagId">The tag id.</param>
- /// <param name="mediaIds">The collection of media id to remove from the tag.</param>
+ /// <param name="tagId">The tag ID.</param>
+ /// <param name="mediaIds">The collection of media ID to remove from the tag.</param>
/// <returns>true if the matched record was found and updated, otherwise false.</returns>
- /// <remarks>The invalid ids will be ignored.</remarks>
+ /// <remarks>The invalid IDs will be ignored.</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>