echo " Options:"
echo " -h, --help Show this usages message"
echo " -b, --build [module] Build a module"
- echo " -f, --full Build all modules in src/ directory. (pkg/Tizen.NET.Private.sln)"
+ echo " -f, --full Build all modules in src/ directory"
echo " -d, --dummy Build dummy modules"
echo " -p, --pack Make nuget packages"
echo " -c, --clean Clean all artifacts"
Tizen.Network.Smartcard.dll #mobile #mobile-emul #ivi #wearable
Tizen.Network.WiFi.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Network.WiFiDirect.dll #mobile #tv #ivi
-Tizen.NUI.dll #common #mobile #mobile-emul #tv
+Tizen.NUI.dll #common #mobile #mobile-emul #tv #wearable
Tizen.PhonenumberUtils.dll #mobile #mobile-emul #wearable
Tizen.Pims.Calendar.dll #common #mobile #mobile-emul #tv #wearable
Tizen.Pims.Contacts.dll #mobile #mobile-emul #wearable
--- /dev/null
+The MIT License (MIT)
+
+Copyright (c) .NET Foundation and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
return new UnauthorizedAccessException(err + " Permission denied (http://tizen.org/privilege/shortcut)");
case Interop.Shortcut.ErrorCode.NotSupported:
return new NotSupportedException(err + " Not Supported (http://tizen.org/feature/shortcut)");
+ case Interop.Shortcut.ErrorCode.OutOfMemory:
+ return new OutOfMemoryException(err + " error occurred.");
default:
Log.Error(LogTag, msg);
return new InvalidOperationException(err + " error occurred.");
namespace Tizen.Applications.Shortcut
{
using System;
- using System.Threading.Tasks;
/// <summary>
/// This class provides the some functions to add, delete shortcut.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="shortcut">Object that contain shortcut info.</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Add(HomeShortcutInfo shortcut)
{
Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="shortcut">Object that contain shortcut info.</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Add(WidgetShortcutInfo shortcut)
{
Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="shortcutName">Shortcut name string.</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Delete(string shortcutName)
{
Interop.Shortcut.ErrorCode err = Interop.Shortcut.ErrorCode.None;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="shortcut">Object that contain shortcut info.</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void Delete(ShortcutInfo shortcut)
{
if (shortcut == null)
OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory,
/// <summary>
- /// Permission denied.
- /// </summary>
- PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied,
-
- /// <summary>
/// I/O Error.
/// </summary>
IoError = Tizen.Internals.Errors.ErrorCode.IoError,
/// <summary>
- /// Not supported.
- /// </summary>
- NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported,
-
- /// <summary>
- /// Device or resource busy.
- /// </summary>
- ResourceBusy = Tizen.Internals.Errors.ErrorCode.ResourceBusy,
-
- /// <summary>
/// There is no space to add a new shortcut.
/// </summary>
NoSpace = -0x01160000 | 0x01,
Exist = -0x01160000 | 0x02,
/// <summary>
- /// Unrecoverable error.
- /// </summary>
- Fault = -0x01160000 | 0x04,
-
- /// <summary>
/// Not exist shortcut.
/// </summary>
NotExist = -0x01160000 | 0x08,
-
- /// <summary>
- /// Connection not established or communication problem.
- /// </summary>
- COMM = -0x01160000 | 0x40
}
-}
\ No newline at end of file
+}
{
using System;
using System.Collections.Generic;
+ using Tizen.Internals.Errors;
/// <summary>
/// The callback function that is invoked when add request occurred
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="addedEvent">The callback function pointer that is invoked when Add() is requested</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <remarks>
/// Previous registered delegate function should be unregister.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void RegisterEventHandler(ShortcutAdded addedEvent)
{
shortcutAdded = addedEvent;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="deletedEvent">The callback function pointer that is invoked when Delete() is requested</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <remarks>
/// Previous registered delegate function should be unregister.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static void RegisterEventHandler(ShortcutDeleted deletedEvent)
{
shortcutDeleted = deletedEvent;
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="addedEvent">The callback function pointer that used for RegisterCallback</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
public static void UnregisterEventHandler(ShortcutAdded addedEvent)
{
{
Interop.Shortcut.UnsetShortcutAddCallback();
shortcutAddCallback = null;
+
+ int err = ErrorFacts.GetLastResult();
+ if (err != (int)Interop.Shortcut.ErrorCode.None)
+ {
+ throw ShortcutErrorFactory.GetException((Interop.Shortcut.ErrorCode)err, "unable to unregister callback");
+ }
}
}
else
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="deletedEvent">The callback function pointer that used for RegisterCallback</param>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
public static void UnregisterEventHandler(ShortcutDeleted deletedEvent)
{
if (shortcutDeleteCallback != null)
{
+
Interop.Shortcut.UnsetShortcutDeleteCallback();
shortcutDeleteCallback = null;
+
+ int err = ErrorFacts.GetLastResult();
+ if (err != (int)Interop.Shortcut.ErrorCode.None)
+ {
+ throw ShortcutErrorFactory.GetException((Interop.Shortcut.ErrorCode) err, "unable to unregister callback");
+ }
}
}
else
/// <since_tizen> 3 </since_tizen>
/// <param name="appId">Application ID.</param>
/// <returns>The List of ShortcutTemplate.</returns>
- /// <feature>http://tizen.org/feature/shortcut </feature>
+ /// <feature>http://tizen.org/feature/shortcut</feature>
/// <privilege>http://tizen.org/privilege/shortcut</privilege>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
/// <exception cref="NotSupportedException">Thrown when Shortcut is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown in case of out of memory.</exception>
+ /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception>
public static IEnumerable<ShortcutTemplate> GetTemplateList(string appId)
{
shortcutTemplates.Clear();
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>
[DllImport(Libraries.Location, EntryPoint = "location_manager_is_enabled_method")]
internal static extern int IsEnabled(int locationMethod, out bool status);
+ [DllImport(Libraries.Location, EntryPoint = "location_manager_enable_method")]
+ internal static extern int EnableType(int locationMethod, bool status);
+
[DllImport(Libraries.Location, EntryPoint = "location_manager_is_supported_method")]
internal static extern bool IsSupported(int locationMethod);
}
}
/// <summary>
- /// This class contains the functionality for obtaining the geographical infomation and setting the boundary condition.
+ /// This class contains the functionality for obtaining the geographical information and setting the boundary condition.
/// Notifications on events like service becoming enabled or disabled, new position data being available,
/// and others can also be acquired.
/// </summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
- /// <feature>http://tizen.org/feature/location</feature>
+ /// <feature>http://tizen.org/feature/location.gps</feature>
+ /// <feature>http://tizen.org/feature/location.wps</feature>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
int ret = Interop.Locator.GetLocation(_handle, out altitude, out latitude, out longitude, out climb, out direction, out speed, out level, out accuracy, out vertical, out timestamp);
if (((LocationError)ret != LocationError.None))
{
- Log.Error(Globals.LogTag, "Error in get current location infomation," + (LocationError)ret);
+ Log.Error(Globals.LogTag, "Error in get current location information," + (LocationError)ret);
throw LocationErrorFactory.ThrowLocationException(ret);
}
}
namespace Tizen.Location
{
+ /// <summary>
+ /// This class contains the functionality for obtaining the geographical positioning type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static class LocatorHelper
{
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="locationType">The back-end positioning method to be used for LBS.</param>
+ /// <feature>http://tizen.org/feature/location.gps</feature>
+ /// <feature>http://tizen.org/feature/location.wps</feature>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public static bool IsSupportedType(LocationType locationType)
{
bool status = Interop.LocatorHelper.IsSupported((int)locationType);
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="locationType">The back-end positioning method to be used for LBS.</param>
+ /// <feature>http://tizen.org/feature/location.gps</feature>
+ /// <feature>http://tizen.org/feature/location.wps</feature>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
}
return status;
}
+
+ /// <summary>
+ /// Sets the specified geographical positioning type.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>http://tizen.org/privilege/location.enable</privilege>
+ /// <privlevel>platform</privlevel>
+ /// <param name="locationType">The back-end positioning method to be used for LBS.</param>
+ /// <param name="status">The location setting value.</param>
+ /// <feature>http://tizen.org/feature/location.gps</feature>
+ /// <feature>http://tizen.org/feature/location.wps</feature>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
+ public static void EnableType(LocationType locationType, bool status)
+ {
+ Log.Info(Globals.LogTag, "Sets the location setting status");
+ int ret = Interop.LocatorHelper.EnableType((int)locationType, status);
+ if (((LocationError)ret != LocationError.None))
+ {
+ Log.Error(Globals.LogTag, "Error Sets the Location type," + (LocationError)ret);
+ throw LocationErrorFactory.ThrowLocationException(ret);
+ }
+ }
}
}
/// The class constructor for the ServiceStateChangedEventArgs class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="state"> An enumeration of type LocationServiceState.</param>
+ /// <param name="state">An enumeration of type LocationServiceState.</param>
public ServiceStateChangedEventArgs(ServiceState state)
{
ServiceState = state;
/// <param name="state"> An enumeration of type BoundaryState.</param>
/// <param name="latitude">The latitude value [-90.0 ~ 90.0] (degrees).</param>
/// <param name="longitude">The longitude value [-180.0 ~ 180.0] (degrees).</param>
- /// <param name="altitude"> The altitude value.</param>
- /// <param name="timestamp"> The timestamp value.</param>
+ /// <param name="altitude">The altitude value.</param>
+ /// <param name="timestamp">The timestamp value.</param>
public ZoneChangedEventArgs(BoundaryState state, double latitude, double longitude, double altitude, DateTime timestamp)
{
BoundState = state;
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.AudioIO", "Tizen.Multimedia.AudioIO.csproj", "{6C20E06D-1039-4B5B-B983-A17224B858F5}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{70D00AC7-C4EB-4067-89DA-2D186AE8223D}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{F5C30594-8FC3-4D72-81E8-BD8B0CD91D40}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{3E19AB5E-EDA0-4126-9A71-F04699161E4F}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{70D00AC7-C4EB-4067-89DA-2D186AE8223D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{70D00AC7-C4EB-4067-89DA-2D186AE8223D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{70D00AC7-C4EB-4067-89DA-2D186AE8223D}.Release|Any CPU.Build.0 = Release|Any CPU
+ {F5C30594-8FC3-4D72-81E8-BD8B0CD91D40}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {F5C30594-8FC3-4D72-81E8-BD8B0CD91D40}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {F5C30594-8FC3-4D72-81E8-BD8B0CD91D40}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {F5C30594-8FC3-4D72-81E8-BD8B0CD91D40}.Release|Any CPU.Build.0 = Release|Any CPU
+ {3E19AB5E-EDA0-4126-9A71-F04699161E4F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {3E19AB5E-EDA0-4126-9A71-F04699161E4F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {3E19AB5E-EDA0-4126-9A71-F04699161E4F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {3E19AB5E-EDA0-4126-9A71-F04699161E4F}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {76DC7E80-8ACF-4FF8-854E-DCFF74BEE759}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Camera", "Tizen.Multimedia.Camera.csproj", "{1FE7280C-EF8F-4FE1-A52D-735B8C7D3470}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{D8C8633F-4C82-41F9-84CD-2E6F75F5D7D8}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{C6053CBC-9E59-4736-8114-D61EB22BC2A1}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{5252674B-22C9-408E-8581-E8E888DEDE4D}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{D8C8633F-4C82-41F9-84CD-2E6F75F5D7D8}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D8C8633F-4C82-41F9-84CD-2E6F75F5D7D8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D8C8633F-4C82-41F9-84CD-2E6F75F5D7D8}.Release|Any CPU.Build.0 = Release|Any CPU
+ {C6053CBC-9E59-4736-8114-D61EB22BC2A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {C6053CBC-9E59-4736-8114-D61EB22BC2A1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {C6053CBC-9E59-4736-8114-D61EB22BC2A1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {C6053CBC-9E59-4736-8114-D61EB22BC2A1}.Release|Any CPU.Build.0 = Release|Any CPU
+ {5252674B-22C9-408E-8581-E8E888DEDE4D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {5252674B-22C9-408E-8581-E8E888DEDE4D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {5252674B-22C9-408E-8581-E8E888DEDE4D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {5252674B-22C9-408E-8581-E8E888DEDE4D}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.MediaCodec", "Tizen.Multimedia.MediaCodec.csproj", "{BA07A897-9A81-4D82-BA88-A2F7C92E4237}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{8E0E98C3-7983-4CA8-8763-79C64464F9D0}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{E70369D0-2B2B-40FA-B67E-A2EDBE6C5466}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{1898FC3A-7F71-427B-B382-8DD0B3017B42}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{70653B3B-8178-492A-960B-AD60EF52998B}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{8E0E98C3-7983-4CA8-8763-79C64464F9D0}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8E0E98C3-7983-4CA8-8763-79C64464F9D0}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8E0E98C3-7983-4CA8-8763-79C64464F9D0}.Release|Any CPU.Build.0 = Release|Any CPU
+ {E70369D0-2B2B-40FA-B67E-A2EDBE6C5466}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {E70369D0-2B2B-40FA-B67E-A2EDBE6C5466}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {E70369D0-2B2B-40FA-B67E-A2EDBE6C5466}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {E70369D0-2B2B-40FA-B67E-A2EDBE6C5466}.Release|Any CPU.Build.0 = Release|Any CPU
+ {1898FC3A-7F71-427B-B382-8DD0B3017B42}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {1898FC3A-7F71-427B-B382-8DD0B3017B42}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {1898FC3A-7F71-427B-B382-8DD0B3017B42}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {1898FC3A-7F71-427B-B382-8DD0B3017B42}.Release|Any CPU.Build.0 = Release|Any CPU
+ {70653B3B-8178-492A-960B-AD60EF52998B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {70653B3B-8178-492A-960B-AD60EF52998B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {70653B3B-8178-492A-960B-AD60EF52998B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {70653B3B-8178-492A-960B-AD60EF52998B}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {D11D1196-7C4B-4BE8-97AA-548F160F9A6F}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.MediaPlayer", "Tizen.Multimedia.MediaPlayer.csproj", "{BB1AF9FB-C940-4623-B218-ECD1943169F8}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Log", "..\Tizen.Log\Tizen.Log.csproj", "{61A19070-B8F4-4672-A77F-3A77762AD6DF}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{4F3E9EBF-5B4E-4113-9394-EBBDA9F5951B}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{0B90CFD7-0154-4FA1-9253-7317B9469852}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{88CA5588-ED50-40E9-80DC-F1DD34F4E52A}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{61A19070-B8F4-4672-A77F-3A77762AD6DF}.Debug|Any CPU.Build.0 = Debug|Any CPU
{61A19070-B8F4-4672-A77F-3A77762AD6DF}.Release|Any CPU.ActiveCfg = Release|Any CPU
{61A19070-B8F4-4672-A77F-3A77762AD6DF}.Release|Any CPU.Build.0 = Release|Any CPU
+ {4F3E9EBF-5B4E-4113-9394-EBBDA9F5951B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {4F3E9EBF-5B4E-4113-9394-EBBDA9F5951B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {4F3E9EBF-5B4E-4113-9394-EBBDA9F5951B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {4F3E9EBF-5B4E-4113-9394-EBBDA9F5951B}.Release|Any CPU.Build.0 = Release|Any CPU
+ {0B90CFD7-0154-4FA1-9253-7317B9469852}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {0B90CFD7-0154-4FA1-9253-7317B9469852}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {0B90CFD7-0154-4FA1-9253-7317B9469852}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {0B90CFD7-0154-4FA1-9253-7317B9469852}.Release|Any CPU.Build.0 = Release|Any CPU
+ {88CA5588-ED50-40E9-80DC-F1DD34F4E52A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {88CA5588-ED50-40E9-80DC-F1DD34F4E52A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {88CA5588-ED50-40E9-80DC-F1DD34F4E52A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {88CA5588-ED50-40E9-80DC-F1DD34F4E52A}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {239AD666-133D-4D72-83C2-FD05704C52F7}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Metadata", "Tizen.Multimedia.Metadata.csproj", "{72F6EF8A-4D43-47E9-909D-B2317F83E636}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Log", "..\Tizen.Log\Tizen.Log.csproj", "{C409F1B4-D26C-43C7-AFB2-683D446F48F8}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia", "..\Tizen.Multimedia\Tizen.Multimedia.csproj", "{832B5F91-A2AB-4D34-AAFD-1F25FBF44422}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{9774C131-7D48-4FE3-8A0C-B58336DC2419}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{B5B29221-56C0-47C0-A04D-61C809EA07BD}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{F6DFE370-F2C3-4BF0-80F0-859BF0B937E8}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{485F0B7B-D7C1-4195-8F2D-9BEC2A85BAA1}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{C409F1B4-D26C-43C7-AFB2-683D446F48F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C409F1B4-D26C-43C7-AFB2-683D446F48F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C409F1B4-D26C-43C7-AFB2-683D446F48F8}.Release|Any CPU.Build.0 = Release|Any CPU
+ {832B5F91-A2AB-4D34-AAFD-1F25FBF44422}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {832B5F91-A2AB-4D34-AAFD-1F25FBF44422}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {832B5F91-A2AB-4D34-AAFD-1F25FBF44422}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {832B5F91-A2AB-4D34-AAFD-1F25FBF44422}.Release|Any CPU.Build.0 = Release|Any CPU
+ {9774C131-7D48-4FE3-8A0C-B58336DC2419}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {9774C131-7D48-4FE3-8A0C-B58336DC2419}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {9774C131-7D48-4FE3-8A0C-B58336DC2419}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {9774C131-7D48-4FE3-8A0C-B58336DC2419}.Release|Any CPU.Build.0 = Release|Any CPU
+ {B5B29221-56C0-47C0-A04D-61C809EA07BD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {B5B29221-56C0-47C0-A04D-61C809EA07BD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {B5B29221-56C0-47C0-A04D-61C809EA07BD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {B5B29221-56C0-47C0-A04D-61C809EA07BD}.Release|Any CPU.Build.0 = Release|Any CPU
+ {F6DFE370-F2C3-4BF0-80F0-859BF0B937E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {F6DFE370-F2C3-4BF0-80F0-859BF0B937E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {F6DFE370-F2C3-4BF0-80F0-859BF0B937E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {F6DFE370-F2C3-4BF0-80F0-859BF0B937E8}.Release|Any CPU.Build.0 = Release|Any CPU
+ {485F0B7B-D7C1-4195-8F2D-9BEC2A85BAA1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {485F0B7B-D7C1-4195-8F2D-9BEC2A85BAA1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {485F0B7B-D7C1-4195-8F2D-9BEC2A85BAA1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {485F0B7B-D7C1-4195-8F2D-9BEC2A85BAA1}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {E2A6AA3C-816F-42EA-AD90-619FA89A8D49}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Radio", "Tizen.Multimedia.Radio.csproj", "{2F4014F0-B4F3-405F-A270-CB9ED958A109}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{75DA9762-1230-4492-A171-698FE2654767}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{C34CF704-4FA7-437F-BDA1-1CFB5C10B3E9}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{808F2480-137A-4125-A630-F7DC74ECE7F8}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{54E87680-3639-4235-9A1E-A3AEDBDE02B7}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{75DA9762-1230-4492-A171-698FE2654767}.Debug|Any CPU.Build.0 = Debug|Any CPU
{75DA9762-1230-4492-A171-698FE2654767}.Release|Any CPU.ActiveCfg = Release|Any CPU
{75DA9762-1230-4492-A171-698FE2654767}.Release|Any CPU.Build.0 = Release|Any CPU
+ {C34CF704-4FA7-437F-BDA1-1CFB5C10B3E9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {C34CF704-4FA7-437F-BDA1-1CFB5C10B3E9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {C34CF704-4FA7-437F-BDA1-1CFB5C10B3E9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {C34CF704-4FA7-437F-BDA1-1CFB5C10B3E9}.Release|Any CPU.Build.0 = Release|Any CPU
+ {808F2480-137A-4125-A630-F7DC74ECE7F8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {808F2480-137A-4125-A630-F7DC74ECE7F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {808F2480-137A-4125-A630-F7DC74ECE7F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {808F2480-137A-4125-A630-F7DC74ECE7F8}.Release|Any CPU.Build.0 = Release|Any CPU
+ {54E87680-3639-4235-9A1E-A3AEDBDE02B7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {54E87680-3639-4235-9A1E-A3AEDBDE02B7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {54E87680-3639-4235-9A1E-A3AEDBDE02B7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {54E87680-3639-4235-9A1E-A3AEDBDE02B7}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {8DC2DD7C-1392-42E8-B093-A601AFD78D58}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Recorder", "Tizen.Multimedia.Recorder.csproj", "{78B69A8B-FCDA-40BF-B9F8-7EF17ECEEB63}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{4B348E66-5FE7-46C9-AE4D-BDEAD667CC80}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{C8A06A7A-73C2-435E-9D9B-E54B8DACC95C}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{B4A0715B-D4C6-4309-9470-5C12A109FAFE}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{4B348E66-5FE7-46C9-AE4D-BDEAD667CC80}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4B348E66-5FE7-46C9-AE4D-BDEAD667CC80}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4B348E66-5FE7-46C9-AE4D-BDEAD667CC80}.Release|Any CPU.Build.0 = Release|Any CPU
+ {C8A06A7A-73C2-435E-9D9B-E54B8DACC95C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {C8A06A7A-73C2-435E-9D9B-E54B8DACC95C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {C8A06A7A-73C2-435E-9D9B-E54B8DACC95C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {C8A06A7A-73C2-435E-9D9B-E54B8DACC95C}.Release|Any CPU.Build.0 = Release|Any CPU
+ {B4A0715B-D4C6-4309-9470-5C12A109FAFE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {B4A0715B-D4C6-4309-9470-5C12A109FAFE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {B4A0715B-D4C6-4309-9470-5C12A109FAFE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {B4A0715B-D4C6-4309-9470-5C12A109FAFE}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Remoting", "Tizen.Multimedia.Remoting.csproj", "{916CC498-AC26-4D6E-8880-39D06512E584}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{624D0C3F-9015-4CF7-8F92-E7FBE753C039}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{15F2B584-D50C-4DF6-AD62-28F6B1DAF3C0}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{F215E1FB-22FD-4EB5-8A56-094CE095B94B}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{8D796213-C2BF-4938-AAEF-D53EF0468A85}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{624D0C3F-9015-4CF7-8F92-E7FBE753C039}.Debug|Any CPU.Build.0 = Debug|Any CPU
{624D0C3F-9015-4CF7-8F92-E7FBE753C039}.Release|Any CPU.ActiveCfg = Release|Any CPU
{624D0C3F-9015-4CF7-8F92-E7FBE753C039}.Release|Any CPU.Build.0 = Release|Any CPU
+ {15F2B584-D50C-4DF6-AD62-28F6B1DAF3C0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {15F2B584-D50C-4DF6-AD62-28F6B1DAF3C0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {15F2B584-D50C-4DF6-AD62-28F6B1DAF3C0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {15F2B584-D50C-4DF6-AD62-28F6B1DAF3C0}.Release|Any CPU.Build.0 = Release|Any CPU
+ {F215E1FB-22FD-4EB5-8A56-094CE095B94B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {F215E1FB-22FD-4EB5-8A56-094CE095B94B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {F215E1FB-22FD-4EB5-8A56-094CE095B94B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {F215E1FB-22FD-4EB5-8A56-094CE095B94B}.Release|Any CPU.Build.0 = Release|Any CPU
+ {8D796213-C2BF-4938-AAEF-D53EF0468A85}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {8D796213-C2BF-4938-AAEF-D53EF0468A85}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {8D796213-C2BF-4938-AAEF-D53EF0468A85}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {8D796213-C2BF-4938-AAEF-D53EF0468A85}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {5976EB53-B44D-4454-B11C-C807DB62A7A0}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.StreamRecorder", "Tizen.Multimedia.StreamRecorder.csproj", "{E637475F-BFC1-40F3-A903-D548C240F677}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElmSharp", "..\ElmSharp\ElmSharp.csproj", "{1413EA41-9936-41A5-9BCF-9E1DA243DB7B}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{BC2D0788-EF91-4E36-BFC6-B91E48A223E2}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{F605BC25-8B3A-4C51-AF63-C49AABFB6793}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{3E60C6E2-D0C3-4471-9E2F-ADD1E3A8A3C7}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia", "..\Tizen.Multimedia\Tizen.Multimedia.csproj", "{36328359-B4AB-4AFD-A06E-4C0355B9472F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{958093FF-C0C1-4CAA-9B89-EFFF00790535}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.AudioIO", "..\Tizen.Multimedia.AudioIO\Tizen.Multimedia.AudioIO.csproj", "{80C1392F-E71C-4539-A970-BDE3FF04B951}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Camera", "..\Tizen.Multimedia.Camera\Tizen.Multimedia.Camera.csproj", "{EEA12578-E0D6-4852-90B8-020D238E29C4}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{1413EA41-9936-41A5-9BCF-9E1DA243DB7B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1413EA41-9936-41A5-9BCF-9E1DA243DB7B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1413EA41-9936-41A5-9BCF-9E1DA243DB7B}.Release|Any CPU.Build.0 = Release|Any CPU
+ {BC2D0788-EF91-4E36-BFC6-B91E48A223E2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {BC2D0788-EF91-4E36-BFC6-B91E48A223E2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {BC2D0788-EF91-4E36-BFC6-B91E48A223E2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {BC2D0788-EF91-4E36-BFC6-B91E48A223E2}.Release|Any CPU.Build.0 = Release|Any CPU
+ {F605BC25-8B3A-4C51-AF63-C49AABFB6793}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {F605BC25-8B3A-4C51-AF63-C49AABFB6793}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {F605BC25-8B3A-4C51-AF63-C49AABFB6793}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {F605BC25-8B3A-4C51-AF63-C49AABFB6793}.Release|Any CPU.Build.0 = Release|Any CPU
+ {3E60C6E2-D0C3-4471-9E2F-ADD1E3A8A3C7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {3E60C6E2-D0C3-4471-9E2F-ADD1E3A8A3C7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {3E60C6E2-D0C3-4471-9E2F-ADD1E3A8A3C7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {3E60C6E2-D0C3-4471-9E2F-ADD1E3A8A3C7}.Release|Any CPU.Build.0 = Release|Any CPU
+ {36328359-B4AB-4AFD-A06E-4C0355B9472F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {36328359-B4AB-4AFD-A06E-4C0355B9472F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {36328359-B4AB-4AFD-A06E-4C0355B9472F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {36328359-B4AB-4AFD-A06E-4C0355B9472F}.Release|Any CPU.Build.0 = Release|Any CPU
+ {958093FF-C0C1-4CAA-9B89-EFFF00790535}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {958093FF-C0C1-4CAA-9B89-EFFF00790535}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {958093FF-C0C1-4CAA-9B89-EFFF00790535}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {958093FF-C0C1-4CAA-9B89-EFFF00790535}.Release|Any CPU.Build.0 = Release|Any CPU
+ {80C1392F-E71C-4539-A970-BDE3FF04B951}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {80C1392F-E71C-4539-A970-BDE3FF04B951}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {80C1392F-E71C-4539-A970-BDE3FF04B951}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {80C1392F-E71C-4539-A970-BDE3FF04B951}.Release|Any CPU.Build.0 = Release|Any CPU
+ {EEA12578-E0D6-4852-90B8-020D238E29C4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {EEA12578-E0D6-4852-90B8-020D238E29C4}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {EEA12578-E0D6-4852-90B8-020D238E29C4}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {EEA12578-E0D6-4852-90B8-020D238E29C4}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {DD113101-5A21-474D-9B56-22610C624BDF}
+ EndGlobalSection
EndGlobal
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Util", "Tizen.Multimedia.Util.csproj", "{7B123B52-9A9F-4785-960E-C8AA5A9D2AF8}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Log", "..\Tizen.Log\Tizen.Log.csproj", "{65032A36-D61E-420E-AB34-CF3313895F0D}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{58122F37-7A06-48B2-815A-BF355D284F63}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{34C6C601-4FF0-440D-ADF6-5AA3A3DF5F58}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{CD96F19F-3BEA-43C7-AAC0-951EC6AADDC7}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{0284DB45-7FA4-4414-956A-8115BC508A8E}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{65032A36-D61E-420E-AB34-CF3313895F0D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{65032A36-D61E-420E-AB34-CF3313895F0D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{65032A36-D61E-420E-AB34-CF3313895F0D}.Release|Any CPU.Build.0 = Release|Any CPU
+ {58122F37-7A06-48B2-815A-BF355D284F63}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {58122F37-7A06-48B2-815A-BF355D284F63}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {58122F37-7A06-48B2-815A-BF355D284F63}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {58122F37-7A06-48B2-815A-BF355D284F63}.Release|Any CPU.Build.0 = Release|Any CPU
+ {34C6C601-4FF0-440D-ADF6-5AA3A3DF5F58}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {34C6C601-4FF0-440D-ADF6-5AA3A3DF5F58}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {34C6C601-4FF0-440D-ADF6-5AA3A3DF5F58}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {34C6C601-4FF0-440D-ADF6-5AA3A3DF5F58}.Release|Any CPU.Build.0 = Release|Any CPU
+ {CD96F19F-3BEA-43C7-AAC0-951EC6AADDC7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {CD96F19F-3BEA-43C7-AAC0-951EC6AADDC7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {CD96F19F-3BEA-43C7-AAC0-951EC6AADDC7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {CD96F19F-3BEA-43C7-AAC0-951EC6AADDC7}.Release|Any CPU.Build.0 = Release|Any CPU
+ {0284DB45-7FA4-4414-956A-8115BC508A8E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {0284DB45-7FA4-4414-956A-8115BC508A8E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {0284DB45-7FA4-4414-956A-8115BC508A8E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {0284DB45-7FA4-4414-956A-8115BC508A8E}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {1BA22031-74BE-402A-A5A5-387466ECA499}
+ EndGlobalSection
EndGlobal
using Tizen.Multimedia.Vision;
/// <summary>
-/// Interop APIs
+/// Interop APIs.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Interop for media vision APIs
+ /// Interop for Media Vision APIs.
/// </summary>
internal static partial class MediaVision
{
/// <summary>
- /// Interop for barcode detector APIs
+ /// Interop for Barcode Detector APIs.
/// </summary>
internal static partial class BarcodeDetector
{
}
/// <summary>
- /// Interop for barcode generator APIs
+ /// Interop for Barcode Generator APIs.
/// </summary>
internal static partial class BarcodeGenerator
{
using Tizen.Multimedia.Vision;
/// <summary>
-/// Interop APIs
+/// Interop APIs.
/// </summary>
internal static partial class Interop
{
}
/// <summary>
- /// Interop for media vision APIs
+ /// Interop for Media Vision APIs.
/// </summary>
internal static partial class MediaVision
{
}
/// <summary>
- /// Interop for media vision source APIs
+ /// Interop for Media Vision Source APIs.
/// </summary>
internal static partial class MediaSource
{
}
/// <summary>
- /// Interop for engine configuration APIs
+ /// Interop for Engine Configuration APIs.
/// </summary>
internal static partial class EngineConfig
{
using Tizen.Multimedia.Vision;
/// <summary>
-/// Interop APIs
+/// Interop APIs.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Interop for media vision APIs
+ /// Interop for Media Vision APIs.
/// </summary>
internal static partial class MediaVision
{
/// <summary>
- /// Interop for Face APIs
+ /// Interop for Face APIs.
/// </summary>
internal static partial class Face
{
}
/// <summary>
- /// Interop for FaceRecognitionModel APIs
+ /// Interop for FaceRecognitionModel APIs.
/// </summary>
internal static partial class FaceRecognitionModel
{
}
/// <summary>
- /// Interop for FaceTrackingModel APIs
+ /// Interop for FaceTrackingModel APIs.
/// </summary>
internal static partial class FaceTrackingModel
{
using Tizen.Multimedia.Vision;
/// <summary>
-/// Interop APIs
+/// Interop APIs.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Interop for Media vision APIs
+ /// Interop for Media Vision APIs.
/// </summary>
internal static partial class MediaVision
{
/// <summary>
- /// Interop for Image APIs
+ /// Interop for Image APIs.
/// </summary>
internal static partial class Image
{
}
/// <summary>
- /// Interop for ImageTrackingModel APIs
+ /// Interop for ImageTrackingModel APIs.
/// </summary>
internal static partial class ImageTrackingModel
{
using Tizen.Multimedia.Vision;
/// <summary>
-/// Interop APIs
+/// Interop APIs.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Interop for media vision APIs
+ /// Interop for Media Vision APIs.
/// </summary>
internal static partial class MediaVision
{
/// <summary>
- /// Interop for surveillance APIs
+ /// Interop for Surveillance APIs.
/// </summary>
internal static partial class Surveillance
{
}
/// <summary>
- /// The quadrangle location of detected barcode.
+ /// The quadrangle location of the detected barcode.
/// </summary>
/// <since_tizen> 3</since_tizen>
public Quadrangle Region { get; }
/// <summary>
- /// The decoded message of barcode.
+ /// The decoded message of the barcode.
/// </summary>
/// <since_tizen> 3</since_tizen>
public string Message { get; }
/// <summary>
- /// The type of detected barcode.
+ /// The type of the detected barcode.
/// </summary>
/// <since_tizen> 3</since_tizen>
public BarcodeType Type { get; }
/// Represents a configuration of <see cref="BarcodeDetector"/>.
/// </summary>
/// <seealso cref="BarcodeDetector"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class BarcodeDetectionConfiguration : EngineConfiguration
{
private const string KeyAttrTarget = "MV_BARCODE_DETECT_ATTR_TARGET";
/// Initializes a new instance of the <see cref="BarcodeDetectionConfiguration"/> class.
/// </summary>
/// <exception cref="System.NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeDetectionConfiguration() : base("barcode_detection")
{
}
/// </summary>
/// <exception cref="System.ArgumentException"><paramref name="value"/> is not valid.</exception>
/// <exception cref="System.ObjectDisposedException">The <see cref="BarcodeDetectionConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeDetectionTarget Target
{
get
/// <summary>
/// Specifies the target of <see cref="BarcodeDetector"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum BarcodeDetectionTarget
{
/// <summary>
/// 1D and 2D.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
All,
/// <summary>
/// 1D barcode only.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Barcode1D,
/// <summary>
/// 2D barcode only.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Barcode2D,
}
}
/// <summary>
/// Provides the ability to detect barcodes on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class BarcodeDetector
{
/// <summary>
- /// Detects barcodes on source and reads message from it.
+ /// Detects barcodes on the source and reads the message from it.
/// </summary>
/// <param name="source">The <see cref="MediaVisionSource"/> instance.</param>
/// <param name="roi">Region of interest - rectangular area on the source which will be used for
}
/// <summary>
- /// Detects barcodes on source and reads message from it with <see cref="BarcodeDetectionConfiguration"/>.
+ /// Detects barcodes on the source and reads the message from it with <see cref="BarcodeDetectionConfiguration"/>.
/// </summary>
/// <param name="source">The <see cref="MediaVisionSource"/> instance.</param>
/// <param name="roi">Region of interest - rectangular area on the source which will be used for
/// Represents a configuration of <see cref="BarcodeGenerator"/> instances.
/// </summary>
/// <seealso cref="BarcodeGenerator"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class BarcodeGenerationConfiguration : EngineConfiguration
{
private const string KeyTextAttr = "MV_BARCODE_GENERATE_ATTR_TEXT";
/// Initializes a new instance of the <see cref="BarcodeGenerationConfiguration"/> class.
/// </summary>
/// <exception cref="System.NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeGenerationConfiguration() : base("barcode_generation")
{
}
/// </summary>
/// <exception cref="System.ArgumentException"><paramref name="value"/> is not valid.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="BarcodeGenerationConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Visibility TextVisibility
{
get
/// The alpha value of the color will be ignored.
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="BarcodeGenerationConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Color ForegroundColor
{
get
/// The alpha value of the color will be ignored.
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="BarcodeGenerationConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Color BackgroundColor
{
get
{
/// <summary>
/// Provides the ability to generate barcodes and QR codes.
- /// Different encoding types <see cref="QrMode"/> , error correction codes <see cref="ErrorCorrectionLevel"/>
+ /// Different encoding types <see cref="QrMode"/>, error correction codes <see cref="ErrorCorrectionLevel"/>,
/// and code versions are supported for QRCodes.
/// </summary>
/// <seealso cref="BarcodeGenerationConfiguration"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class BarcodeGenerator
{
private const int NoneErrorCorrection = (int)ErrorCorrectionLevel.High + 1;
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <seealso cref="QrMode"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig)
{
return GenerateSource(message, qrConfig, null);
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
/// <seealso cref="QrMode"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig,
BarcodeGenerationConfiguration config)
{
/// <paramref name="message"/> contains illegal characters.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static MediaVisionSource GenerateSource(string message, BarcodeType type)
{
return GenerateSource(message, type, null);
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static MediaVisionSource GenerateSource(string message, BarcodeType type,
BarcodeGenerationConfiguration config)
{
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <seealso cref="QrMode"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static void GenerateImage(string message, QrConfiguration qrConfig,
BarcodeImageConfiguration imageConfig)
{
/// <see cref="BarcodeGenerationConfiguration.TextVisibility"/> is the <see cref="Visibility.Visible"/>.
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static void GenerateImage(string message, QrConfiguration qrConfig,
BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)
{
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig)
{
GenerateImage(message, type, imageConfig, null);
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static void GenerateImage(string message,
BarcodeType type, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)
{
/// <summary>
/// Represents a configuration for the image to be generated by <see cref="BarcodeGenerator"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class BarcodeImageConfiguration
{
/// <summary>
/// Initializes a new instance of the <see cref="BarcodeImageConfiguration"/> class.
/// </summary>
/// <remarks>
- /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n
- /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage.
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
/// <param name="size">The <see cref="Size"/> of the generated image.</param>
/// <param name="path">The path to the file to be generated.</param>
/// <code>
/// BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(new Size(500, 400), "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG);
/// </code>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeImageConfiguration(Size size, string path, BarcodeImageFormat imageFormat)
{
if (size.Width <= 0)
/// Initializes a new instance of the <see cref="BarcodeImageConfiguration"/> class.
/// </summary>
/// <remarks>
- /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n
- /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage.
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
/// <param name="width">The width of the image to be generated.</param>
/// <param name="height">The height of the image to be generated.</param>
/// <code>
/// BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG);
/// </code>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeImageConfiguration(int width, int height, string path, BarcodeImageFormat imageFormat)
: this(new Size(width, height), path, imageFormat)
{
/// <summary>
/// Gets the size of the image.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Size Size { get; }
/// <summary>
/// Gets the width of the image.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Width => Size.Width;
/// <summary>
/// Gets the height of the image.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Height => Size.Height;
/// <summary>
/// Gets the path to the file that has to be generated.
/// </summary>
/// <remarks>
- /// The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n
- /// The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage.
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Path { get; }
/// <summary>
/// Gets the format of the output image.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BarcodeImageFormat Format { get; }
}
}
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Specifies supported image formats for <see cref="BarcodeGenerator"/>
+ /// Specifies the supported image formats for <see cref="BarcodeGenerator"/>
/// </summary>
/// <seealso cref="BarcodeImageConfiguration"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum BarcodeImageFormat
{
/// <summary>
/// BMP image format.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Bmp,
/// <summary>
/// JPEG image format.
/// <summary>
/// PNG image format.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Png
}
}
/// Specifies the supported barcode types.
/// </summary>
/// <remarks>
- /// QR codes (versions 1 to 40) and set of 1D barcodes are supported
+ /// QR codes (versions 1 to 40) and set of 1D barcodes are supported.
/// </remarks>
/// <seealso cref="BarcodeDetector"/>
/// <seealso cref="BarcodeGenerator"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum BarcodeType
{
/// <summary>
/// 2D barcode - Quick Response code.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
QR,
/// <summary>
/// 1D barcode - Universal Product Code with 12-digit.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
UpcA,
/// <summary>
/// 1D barcode - Universal Product Code with 6-digit.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
UpcE,
/// <summary>
/// 1D barcode - International Article Number with 8-digit.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Ean8,
/// <summary>
/// 1D barcode - International Article Number with 13-digit.
/// <summary>
/// 1D barcode - Code 128.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Code128,
/// <summary>
/// 1D barcode - Code 39.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Code39,
/// <summary>
/// 1D barcode - Interleaved Two of Five.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
I25
}
}
/// <summary>
/// A base class for configuration classes.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public abstract class EngineConfiguration : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Releases the resources used by the <see cref="EngineConfiguration"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources, otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Specifies the supported QR code error correction level.
+ /// Specifies the supported QR code error correction levels.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ErrorCorrectionLevel
{
/// <summary>
/// Recovery up to 7% losses.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Low,
/// <summary>
/// Recovery up to 15% losses.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Medium,
/// <summary>
/// Recovery up to 25% losses.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Quartile,
/// <summary>
/// Recovery up to 30% losses.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
High
}
}
/// <summary>
/// Specifies the eyes state types.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum EyeCondition
{
/// <summary>
/// Eyes are open.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Open,
/// <summary>
/// Eyes are closed.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Closed,
/// <summary>
/// The eyes condition wasn't determined.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
NotFound
}
}
/// <summary>
/// Represents a configuration of <see cref="FaceDetector"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceDetectionConfiguration : EngineConfiguration
{
private const string KeyModelFilePath = "MV_FACE_DETECTION_MODEL_FILE_PATH";
/// Gets or sets the face detection haarcascade xml file for face detection.
/// </summary>
/// <exception cref="ArgumentNullException"><paramref name="value"/> is null.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string ModelFilePath
{
get
/// <summary>
- /// Gets or sets minimum height of face which will be detected.
+ /// Gets or sets the minimum height of a face which will be detected.
/// </summary>
/// <remarks>
- /// Default value is null (all detected faces will be applied), can be changed to specify the minimum face height.
+ /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face height.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int? MinHeight
{
get
}
/// <summary>
- /// Gets or sets minimum width of face which will be detected.
+ /// Gets or sets the minimum width of a face which will be detected.
/// </summary>
/// <remarks>
- /// Default value is null (all detected faces will be applied), can be changed to specify the minimum face width.
+ /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face width.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int? MinWidth
{
get
/// Gets or sets the roi of the face detection.
/// </summary>
/// <remarks>
- /// Default value is null (the roi will be a full image) can be changed to specify the roi for face detection.
+ /// Default value is null (the roi will be a full image), which can be changed to specify the roi for face detection.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">
/// The width of <paramref name="value"/> is less than or equal to zero.\n
/// -or-\n
/// The y position of <paramref name="value"/> is less than zero.\n
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle? Roi
{
get
/// <summary>
/// Provides the ability to detect faces on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class FaceDetector
{
/// -or-\n
/// The format of <paramref name="source"/> is not supported.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<Rectangle[]> DetectAsync(MediaVisionSource source)
{
return await DetectAsync(source, null);
/// <returns>A task that represents the asynchronous detect operation.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<Rectangle[]> DetectAsync(MediaVisionSource source,
FaceDetectionConfiguration config)
{
/// <summary>
/// Represents a configuration of <see cref="FaceRecognizer"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceRecognitionConfiguration : EngineConfiguration
{
private const string KeyModelType = "MV_FACE_RECOGNITION_MODEL_TYPE";
/// Initializes a new instance of the <see cref="FaceRecognitionConfiguration"/> class.
/// </summary>
/// <exception cref="System.NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceRecognitionConfiguration() : base("face_recognition")
{
}
/// Default value is <see cref="FaceRecognitionModelType.Lbph"/>.
/// </summary>
/// <exception cref="System.ArgumentException"><paramref name="value"/> is not valid.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceRecognitionModelType ModelType
{
get
/// <summary>
/// Represents the face recognition model interface.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceRecognitionModel : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Initializes a new instance of the <see cref="FaceRecognitionModel"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceRecognitionModel()
{
InteropModel.Create(out _handle).Validate("Failed to create FaceRecognitionModel");
/// Initializes a new instance of the <see cref="FaceRecognitionModel"/> class with the specified path.
/// </summary>
/// <remarks>
- /// Models have been saved by <see cref="Save()"/> can be loaded.
+ /// Models saved by <see cref="Save()"/> can be loaded.
/// </remarks>
/// <param name="modelPath">Path to the model to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// <seealso cref="Save(string)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceRecognitionModel(string modelPath)
{
if (modelPath == null)
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Save(string path)
{
if (path == null)
}
/// <summary>
- /// Adds face image example to be used for face recognition model learning.
+ /// Adds the face image example to be used for face recognition model learning.
/// </summary>
/// <param name="source">The <see cref="MediaVisionSource"/> that contains face image.</param>
/// <param name="label">The label that identifies face for which example is adding.
/// <paramref name="source"/> has already been dispose of.
/// </exception>
/// <seealso cref="Learn(FaceRecognitionConfiguration)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Add(MediaVisionSource source, int label)
{
if (source == null)
}
/// <summary>
- /// Adds face image example to be used for face recognition model learning.
+ /// Adds the face image example to be used for face recognition model learning.
/// </summary>
/// <param name="source">The <see cref="MediaVisionSource"/> that contains face image.</param>
/// <param name="label">The label that identifies face for which example is adding.
/// <paramref name="source"/> has already been dispose of.
/// </exception>
/// <seealso cref="Learn(FaceRecognitionConfiguration)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Add(MediaVisionSource source, int label, Rectangle area)
{
if (source == null)
/// <returns>true if the examples are successfully removed; otherwise, false if there is no example labeled with the specified label.</returns>
/// <seealso cref="Add(MediaVisionSource, int)"/>
/// <seealso cref="Add(MediaVisionSource, int, Rectangle)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool Remove(int label)
{
var ret = InteropModel.Remove(Handle, ref label);
/// Removes all face examples.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Reset()
{
InteropModel.Reset(Handle).Validate("Failed to reset image example");
/// <summary>
- /// Learns face recognition model.
+ /// Learns the face recognition model.
/// </summary>
/// <remarks>
- /// Before you start learning process, face recognition models has to be filled with training data - face image examples.
- /// These examples has to be provided by <see cref="Add(MediaVisionSource, int)"/> or <see cref="Add(MediaVisionSource, int, Rectangle)"/>.
- /// Recognition accuracy is usually increased when the different examples of the identical face are added more and more.
+ /// Before you start the learning process, face recognition models have to be filled with the training data - face image examples.
+ /// These examples have to be provided by <see cref="Add(MediaVisionSource, int)"/> or <see cref="Add(MediaVisionSource, int, Rectangle)"/>.
+ /// Recognition accuracy is usually increased when the different examples of the identical faces are added more and more.
/// But it depends on the used learning algorithm.
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">No examples added.</exception>
/// <seealso cref="Add(MediaVisionSource, int)"/>
/// <seealso cref="Add(MediaVisionSource, int, Rectangle)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Learn()
{
Learn(null);
}
/// <summary>
- /// Learns face recognition model with <see cref="FaceRecognitionConfiguration"/>.
+ /// Learns the face recognition model with <see cref="FaceRecognitionConfiguration"/>.
/// </summary>
/// <remarks>
- /// Before you start learning process, face recognition models has to be filled with training data - face image examples.
- /// These examples has to be provided by <see cref="Add(MediaVisionSource, int)"/> or <see cref="Add(MediaVisionSource, int, Rectangle)"/>.
- /// Recognition accuracy is usually increased when the different examples of the identical face are added more and more.
+ /// Before you start the learning process, face recognition models have to be filled with the training data - face image examples.
+ /// These examples have to be provided by <see cref="Add(MediaVisionSource, int)"/> or <see cref="Add(MediaVisionSource, int, Rectangle)"/>.
+ /// Recognition accuracy is usually increased when the different examples of the identical faces are added more and more.
/// But it depends on the used learning algorithm.
/// </remarks>
/// <param name="config">The configuration used for learning of the recognition models. This value can be null.</param>
/// <exception cref="InvalidOperationException">No examples added.</exception>
/// <seealso cref="Add(MediaVisionSource, int)"/>
/// <seealso cref="Add(MediaVisionSource, int, Rectangle)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Learn(FaceRecognitionConfiguration config)
{
InteropModel.Learn(EngineConfiguration.GetHandle(config), Handle).
}
/// <summary>
- /// Releases all resources used by the <see cref="FaceRecognitionModel"/> object.
+ /// Releases all the resources used by the <see cref="FaceRecognitionModel"/> object.
/// </summary>
public void Dispose()
{
/// Releases the resources used by the <see cref="FaceRecognitionModel"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
/// <summary>
/// Specifies the face recognition model learning algorithms.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum FaceRecognitionModelType
{
/// <summary>
/// Eigenfaces.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
EigenFaces = 1,
/// <summary>
/// Fisherfaces.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FisherFaces,
/// <summary>
/// Local Binary Patterns Histograms (LBPH); The default type.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Lbph
}
}
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Represents result of <see cref="FaceRecognizer"/> operations.
+ /// Represents the result of <see cref="FaceRecognizer"/> operations.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceRecognitionResult
{
internal FaceRecognitionResult(bool recognized, double confidence, int label, Rectangle? area)
/// <summary>
/// Gets the value indicating the recognition is successful.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool Success { get; }
/// <summary>
/// Gets the label of the recognized face.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Label { get; }
/// <summary>
/// Gets the location of the recognized face.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Rectangle? Area { get; }
/// <summary>
/// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples,
/// then threshold can be reduced (0.5-0.85).
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Confidence { get; }
}
}
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Provides the ability to recognize faces, face expressions and eye condition on image sources.
+ /// Provides the ability to recognize faces, face expressions, and eye condition on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class FaceRecognizer
{
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="source"/> has already been disposed of.</exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FaceRecognitionResult> RecognizeAsync(MediaVisionSource source,
FaceRecognitionModel recognitionModel)
{
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="source"/> has already been disposed of.</exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FaceRecognitionResult> RecognizeAsync(MediaVisionSource source,
FaceRecognitionModel recognitionModel, Rectangle bound)
{
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FaceRecognitionResult> RecognizeAsync(MediaVisionSource source,
FaceRecognitionModel recognitionModel, FaceRecognitionConfiguration config)
{
/// <summary>
- /// Performs face recognition on the source with <see cref="FaceRecognitionModel"/>, <see cref="FaceRecognitionConfiguration"/>
+ /// Performs face recognition on the source with <see cref="FaceRecognitionModel"/>, <see cref="FaceRecognitionConfiguration"/>
/// and a bounding box.
/// </summary>
/// <param name="source">The <see cref="MediaVisionSource"/> of the media to recognize faces for.</param>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FaceRecognitionResult> RecognizeAsync(MediaVisionSource source,
FaceRecognitionModel recognitionModel, Rectangle bound, FaceRecognitionConfiguration config)
{
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="source"/> has already been disposed of.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<EyeCondition> RecognizeEyeConditionAsync(MediaVisionSource source,
Rectangle bound)
{
}
/// <summary>
- /// Determines eye-blink condition on media source.
+ /// Determines eye-blink condition on the media source.
/// </summary>
/// <param name="source">The source of the media to recognize eye-blink condition for.</param>
/// <param name="bound">The bounding the face at the source.</param>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<EyeCondition> RecognizeEyeConditionAsync(MediaVisionSource source,
Rectangle bound, FaceRecognitionConfiguration config)
{
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="source"/> has already been disposed of.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FacialExpression> RecognizeFacialExpressionAsync(MediaVisionSource source,
Rectangle bound)
{
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FacialExpression> RecognizeFacialExpressionAsync(MediaVisionSource source,
Rectangle bound, FaceRecognitionConfiguration config)
{
/// <summary>
/// Provides the ability to track faces on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class FaceTracker
{
/// </summary>
/// <param name="source">The source of the media to recognize face for.</param>
/// <param name="trackingModel">The model will be used for tracking.</param>
- /// <param name="doLearn">The value indicating whether model learning while tracking. If it is true then model will try to learn
- /// (if it supports learning feature), otherwise model will be not learned during the invoking tracking iteration.
+ /// <param name="doLearn">The value indicating whether model learning while tracking. If it is true, then the model will try to learn
+ /// (if it supports learning feature), otherwise the model will be not learned during the invoking tracking iteration.
/// Learning process improves tracking correctness, but can decrease tracking performance.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// <exception cref="ArgumentNullException">
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="InvalidOperationException"><paramref name="trackingModel"/> is not prepared.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<FaceTrackingResult> TrackAsync(MediaVisionSource source,
FaceTrackingModel trackingModel, bool doLearn)
{
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Represents face tracking model.
+ /// Represents the face tracking model.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceTrackingModel : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Initializes a new instance of the <see cref="FaceTrackingModel"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceTrackingModel()
{
InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel.");
/// Initializes a new instance of the <see cref="FaceTrackingModel"/> class with the specified path.
/// </summary>
/// <remarks>
- /// Models has been saved by <see cref="Save()"/> can be loaded.
+ /// Models saved by <see cref="Save()"/> can be loaded.
/// </remarks>
/// <param name="modelPath">Path to the model to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// <seealso cref="Save()"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FaceTrackingModel(string modelPath)
{
if (modelPath == null)
}
/// <summary>
- /// Initializes tracking model by the location of the face to be tracked.
+ /// Initializes the tracking model by the location of the face to be tracked.
///
- /// It is usually called once after tracking model is created and each time before tracking
- /// is started for the new sequence of sources which is not the direct continuation of
- /// the sequence for which tracking has been performed before. But it is allowed to call it
+ /// It is usually called once after the tracking model is created, and each time before tracking
+ /// is started for the new sequence of sources, which is not the direct continuation of
+ /// the sequence for which tracking has been performed before. But, it is allowed to call it
/// between tracking sessions to allow Media Vision start to track more accurately.
/// </summary>
/// <remarks>
/// -or-\n
/// <paramref name="source"/> has already bean disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Prepare(MediaVisionSource source, Quadrangle region)
{
if (source == null)
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Save(string path)
{
if (path == null)
}
/// <summary>
- /// Releases all resources used by the <see cref="FaceTrackingModel"/> object.
+ /// Releases all the resources used by the <see cref="FaceTrackingModel"/> object.
/// </summary>
public void Dispose()
{
/// Releases the resources used by the <see cref="FaceTrackingModel"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Represents result of face tracking operation.
+ /// Represents the result of face tracking operation.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FaceTrackingResult
{
internal FaceTrackingResult(bool success, double confidence, Quadrangle region)
public bool Success { get; }
/// <summary>
- /// Gets the region which determines new position of the tracked face on the source.
+ /// Gets the region which determines the new position of the tracked face on the source.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Quadrangle Region { get; }
/// <summary>
- /// The confidence of the tracking model that new location of the face was determined correctly
- /// (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0.
+ /// The confidence of the tracking model that a new location of the face was determined correctly
+ /// (value from 0.0 to 1.0). If no location was determined during the last track iteration, then the value is 0.0.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Confidence { get; }
}
}
/// <summary>
/// Specifies the expression types for faces.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum FacialExpression
{
/// <summary>
/// Unknown face expression.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Unknown,
/// <summary>
/// Face expression is neutral.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Neutral,
/// <summary>
/// Face expression is smiling.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Smile,
/// <summary>
/// Face expression is sadness.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Sadness,
/// <summary>
/// Face expression is surprise.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Surprise,
/// <summary>
/// Face expression is anger.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Anger,
/// <summary>
/// Face expression is fear.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Fear,
/// <summary>
/// Face expression is disgust.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Disgust
}
}
/// <summary>
/// Represents a configuration of fill operations of <see cref="ImageObject"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageFillConfiguration : EngineConfiguration
{
private const string KeyScaleFactor = "MV_IMAGE_RECOGNITION_OBJECT_SCALE_FACTOR";
/// <summary>
/// A read-only field that represents the default value of <see cref="ObjectScaleFactor"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultScaleFactor = 1.2;
/// <summary>
/// Initializes a new instance of the <see cref="ImageFillConfiguration"/> class.
/// </summary>
/// <exception cref="System.NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageFillConfiguration() : base("image_recognition")
{
}
/// The default value is 1.2.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="ImageFillConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double ObjectScaleFactor
{
get
/// The default value is 1000.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="ImageFillConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int ObjectMaxKeyPoints
{
get
/// <summary>
/// Represents an image object.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageObject : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Initializes a new instance of the <see cref="ImageObject"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageObject()
{
InteropImage.Create(out _handle).Validate("Failed to create image object");
/// Initializes a new instance of the <see cref="ImageObject"/> class from the specified file.
/// </summary>
/// <remarks>
- /// ImageObject has been saved by <see cref="Save(string)"/> can be loaded.
+ /// ImageObject has been saved by <see cref="Save()"/> can be loaded.
/// </remarks>
/// <param name="path">Path to the image object to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// <seealso cref="Save(string)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageObject(string path)
{
if (path == null)
/// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration)"/>
/// <seealso cref="Fill(MediaVisionSource, Rectangle)"/>
/// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration, Rectangle)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double RecognitionRate
{
get
/// </returns>
/// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
/// <seealso cref="SetLabel(int)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int? GetLabel()
{
var ret = InteropImage.GetLabel(Handle, out var label);
/// Sets the label for the <see cref="ImageObject"/>.
/// </summary>
/// <seealso cref="GetLabel"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void SetLabel(int label)
{
InteropImage.SetLabel(Handle, label).Validate("Failed to set label");
/// -or-\n
/// <paramref name="source"/> has already been disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Fill(MediaVisionSource source)
{
InvokeFill(source, null, null);
/// -or-\n
/// <paramref name="config"/> has already been disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Fill(MediaVisionSource source, ImageFillConfiguration config)
{
InvokeFill(source, config, null);
/// -or-\n
/// <paramref name="source"/> has already been disposed of.\n
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Fill(MediaVisionSource source, Rectangle rect)
{
InvokeFill(source, null, rect);
/// -or-\n
/// <paramref name="config"/> has already been disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect)
{
InvokeFill(source, config, rect);
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Save(string path)
{
if (path == null)
#region IDisposable-support
/// <summary>
- /// Releases all resources used by the <see cref="ImageObject"/> object.
+ /// Releases all the resources used by the <see cref="ImageObject"/> object.
/// </summary>
public void Dispose()
{
/// Releases the resources used by the <see cref="ImageObject"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
/// <summary>
/// Represents a configuration of <see cref="ImageRecognizer"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageRecognitionConfiguration : EngineConfiguration
{
private const string KeySceneScaleFactor = "MV_IMAGE_RECOGNITION_SCENE_SCALE_FACTOR";
/// <summary>
/// A read-only field that represents the default value of <see cref="KeySceneScaleFactor"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultSceneScaleFactor = 1.2;
/// <summary>
/// A read-only field that represents the default value of <see cref="SceneMaxKeyPoints"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DefaultSceneMaxKeypoints = 5000;
/// <summary>
/// A read-only field that represents the default value of <see cref="MinKeyPointMatches"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DefaultMinKeyPointMatches = 30;
/// <summary>
/// A read-only field that represents the default value of <see cref="RequiredMatchingPart"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultRequiredMatchPart = 0.05;
/// <summary>
/// A read-only field that represents the default value of <see cref="TolerantPartMatchError"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultTolerantPartMatchError = 0.1;
/// <summary>
/// Initializes a new instance of the <see cref="ImageRecognitionConfiguration"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageRecognitionConfiguration() : base("image_recognition")
{
}
/// The default is 1.2.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageRecognitionConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double SceneScaleFactor
{
get
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageRecognitionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int SceneMaxKeyPoints
{
get
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageRecognitionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int MinKeyPointMatches
{
get
/// Gets or sets the required matching part for the image recognition.
/// To recognize occluded or hidden an image by other images, required relative part of the matches in respect to the total
/// amount of matching keypoints required for image recognition. Too low value will result in unsustainable behavior,
- /// but effect of object overlapping will be reduced.
+ /// but the effect of object overlapping will be reduced.
/// </summary>
/// <value>
/// The value indicating required relative part of the matches; can be from 0 to 1, inclusive.
/// -or-\n
/// <paramref name="value"/> is greater than one.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double RequiredMatchingPart
{
get
/// <summary>
/// Represents a result of RecognizeAsync operations of <see cref="ImageRecognizer"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageRecognitionResult
{
/// <summary>
/// The region of recognized image object on the source image.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Quadrangle Region { get; }
/// <summary>
/// <summary>
/// Provides the ability to recognize images on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class ImageRecognizer
{
/// <summary>
/// <exception cref="ArgumentException"><paramref name="imageObjects"/> has no elements.(The length is zero.)</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="source"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<IEnumerable<ImageRecognitionResult>> RecognizeAsync(
MediaVisionSource source, ImageObject[] imageObjects)
{
/// -or-\n
/// <paramref name="config"/> has already been disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<IEnumerable<ImageRecognitionResult>> RecognizeAsync(MediaVisionSource source,
ImageObject[] imageObjects, ImageRecognitionConfiguration config)
{
/// <summary>
/// Provides the ability to track images on image sources.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static class ImageTracker
{
/// <summary>
/// Tracks the given image tracking model on the current frame.
/// </summary>
- /// <param name="source">The current image of sequence where image tracking model will be tracked.</param>
+ /// <param name="source">The current image of sequence where the image tracking model will be tracked.</param>
/// <param name="trackingModel">The image tracking model which processed as target of tracking.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// <exception cref="ArgumentNullException">
/// </exception>
/// <exception cref="ArgumentException"><paramref name="trackingModel"/> has no target.</exception>
/// <seealso cref="ImageTrackingModel.SetTarget(ImageObject)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<Quadrangle> TrackAsync(MediaVisionSource source,
ImageTrackingModel trackingModel)
{
/// <summary>
/// Tracks the given image tracking model on the current frame and <see cref="ImageTrackingConfiguration"/>.
/// </summary>
- /// <param name="source">The current image of sequence where image tracking model will be tracked.</param>
+ /// <param name="source">The current image of sequence where the image tracking model will be tracked.</param>
/// <param name="trackingModel">The image tracking model which processed as target of tracking.</param>
/// <param name="config">The configuration used for tracking. This value can be null.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// </exception>
/// <exception cref="ArgumentException"><paramref name="trackingModel"/> has no target.</exception>
/// <seealso cref="ImageTrackingModel.SetTarget(ImageObject)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static async Task<Quadrangle> TrackAsync(MediaVisionSource source,
ImageTrackingModel trackingModel, ImageTrackingConfiguration config)
{
/// <summary>
/// Represents a configuration of <see cref="ImageTracker"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageTrackingConfiguration : ImageRecognitionConfiguration
{
private const string KeyHistoryAmount = "MV_IMAGE_TRACKING_HISTORY_AMOUNT";
/// <summary>
/// A read-only field that represents the default value of <see cref="HistoryAmount"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DefaultHistoryAmount = 3;
/// <summary>
/// A read-only field that represents the default value of <see cref="ExpectedOffset"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultExpectedOffset = 0;
/// <summary>
/// A read-only field that represents the default value of <see cref="IsStabilizationEnabled"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly bool DefaultStabilizationEnabled = true;
/// <summary>
/// A read-only field that represents the default value of <see cref="StabilizationTolerantShift"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultStabilizationTolerantShift = 0.00006;
/// <summary>
/// A read-only field that represents the default value of <see cref="StabilizationSpeed"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultStabilizationSpeed = 0.3;
/// <summary>
/// A read-only field that represents the default value of <see cref="StabilizationAcceleration"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly double DefaultStabilizationAcceleration = 0.1;
/// <summary>
/// Initializes a new instance of the <see cref="ImageTrackingConfiguration"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageTrackingConfiguration()
{
}
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int HistoryAmount
{
get
/// Gets or sets the expected tracking offset.
/// </summary>
/// <value>
- /// Relative offset value, for which the object offset is expected (relative to the object size in the current frame).\n
+ /// Relative offset value for which the object offset is expected (relative to the object size in the current frame).\n
/// The default is 0.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double ExpectedOffset
{
get
/// -or-\n
/// <paramref name="value"/> is greater than one.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double StabilizationAcceleration
{
get
/// The default is 0.3.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double StabilizationSpeed
{
get
/// The default is 0.00006.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double StabilizationTolerantShift
{
get
/// Gets or sets the state of the contour stabilization during tracking process.
/// </summary>
/// <value>
- /// true if the contour stabilization is enabled; otherwise, false.\n
+ /// true if the contour stabilization is enabled; otherwise false.\n
/// The default is true.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool IsStabilizationEnabled
{
get
/// <summary>
/// Represents the image tracking model interface.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ImageTrackingModel : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Initializes a new instance of the <see cref="ImageTrackingModel"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageTrackingModel()
{
InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel");
/// Initializes a new instance of the <see cref="ImageTrackingModel"/> class with the specified path.
/// </summary>
/// <remarks>
- /// Model have been saved by <see cref="Save()"/> can be loaded.
+ /// Model saved by <see cref="Save()"/> can be loaded.
/// </remarks>
/// <param name="modelPath">Path to the model to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// <seealso cref="Save()"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ImageTrackingModel(string modelPath)
{
if (modelPath == null)
}
/// <summary>
- /// Sets target of image tracking model.\n
- /// Sets image object which will be tracked by using tracking functionality with this tracking model.
+ /// Sets the target of the image tracking model.\n
+ /// Sets the image object which will be tracked by using tracking functionality with this tracking model.
/// </summary>
/// <param name="imageObject">Image object which will be set as the target for tracking.</param>
/// <exception cref="ArgumentNullException"><paramref name="imageObject"/> is null.</exception>
/// -or-\n
/// <paramref name="imageObject"/> has already been disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void SetTarget(ImageObject imageObject)
{
if (imageObject == null)
/// <summary>
/// Refreshes the state of image tracking model.\n
- /// Clears moving history and change state to undetected. It is usually called each time before tracking is started
- /// for the new sequence of sources which is not the direct continuation of the sequence for which tracking has been performed before.
+ /// Clears the moving history and change state to undetected. It is usually called each time before tracking is started
+ /// for the new sequence of sources, which is not the direct continuation of the sequence for which tracking has been performed before.
/// Tracking algorithm will try to find image by itself.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingModel"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Refresh()
{
InteropModel.Refresh(Handle, IntPtr.Zero).Validate("Failed to refresh state");
}
/// <summary>
- /// Saves tracking model to the file.
+ /// Saves the tracking model to the file.
/// </summary>
/// <param name="path">Path to the file to save the model.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingModel"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Save(string path)
{
if (path == null)
/// Releases the resources used by the <see cref="ImageTrackingModel"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
{
MediaVisionErrorCode = -0x019D0000,
/// <summary>
- /// Successful
+ /// Successful.
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Not supported
+ /// Not supported.
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Message too long
+ /// Message too long.
/// </summary>
MsgTooLong = ErrorCode.MsgTooLong,
/// <summary>
- /// No data
+ /// No data.
/// </summary>
NoData = ErrorCode.NoData,
/// <summary>
- /// Key not available
+ /// Key not available.
/// </summary>
KeyNotAvailable = ErrorCode.KeyNotAvailable,
/// <summary>
- /// Out of memory
+ /// Out of memory.
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Invalid operation
+ /// Invalid operation.
/// </summary>
InvalidOperation = ErrorCode.InvalidOperation,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
PermissionDenied = ErrorCode.NotPermitted,
/// <summary>
- /// Not supported format
+ /// Not supported format.
/// </summary>
NotSupportedFormat = MediaVisionErrorCode | 0x01,
/// <summary>
/// </summary>
Internal = MediaVisionErrorCode | 0x02,
/// <summary>
- /// Invalid data
+ /// Invalid data.
/// </summary>
InvalidData = MediaVisionErrorCode | 0x03,
/// <summary>
- /// Invalid path (Since 3.0)
+ /// Invalid path (Since 3.0).
/// </summary>
InvalidPath = MediaVisionErrorCode | 0x04
}
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Represents the media vision source to keep information on image or video frame data as raw buffer.
+ /// Represents the media vision source to keep information on the image or video frame data as raw buffer.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MediaVisionSource : IBufferOwner, IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ArgumentNullException"><paramref name="mediaPacket"/> is null.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="mediaPacket"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public MediaVisionSource(MediaPacket mediaPacket)
: this(handle => FillMediaPacket(handle, mediaPacket))
{
/// -or-\n
/// <paramref name="colorSpace"/> is invalid.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public MediaVisionSource(byte[] buffer, uint width, uint height, ColorSpace colorSpace)
: this(handle => FillBuffer(handle, buffer, width, height, colorSpace))
{
/// Gets the buffer of the media source.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="MediaVisionSource"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IMediaBuffer Buffer
{
get
}
/// <summary>
- /// Gets height of the media source.
+ /// Gets the height of the media source.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="MediaVisionSource"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public uint Height
{
get
}
/// <summary>
- /// Gets width of the media source.
+ /// Gets the width of the media source.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="MediaVisionSource"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public uint Width
{
get
/// Gets <see cref="ColorSpace"/> of the media source.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="MediaVisionSource"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ColorSpace Colorspace
{
get
/// Releases the resources used by the <see cref="MediaVisionSource"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
/// <summary>
/// Provides data for the <see cref="MovementDetector.Detected"/> event.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MovementDetectedEventArgs : EventArgs
{
/// <summary>
/// Initializes a new instance of the <see cref="MovementDetectedEventArgs"/> class.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public MovementDetectedEventArgs(IEnumerable<Rectangle> areas)
{
Areas = areas;
/// <summary>
/// Gets a set of rectangular regions where movement was detected.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Rectangle> Areas { get; }
}
}
/// <summary>
/// Represents a configuration of <see cref="MovementDetector"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MovementDetectionConfiguration : SurveillanceEngineConfiguration
{
private const string KeyThreshold = "MV_SURVEILLANCE_MOVEMENT_DETECTION_THRESHOLD";
/// <summary>
/// A read-only field that represents the default value of <see cref="Threshold"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DefaultThreshold = 10;
/// Initializes a new instance of the <see cref="MovementDetectionConfiguration"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public MovementDetectionConfiguration()
{
}
/// to specify the sensitivity of the movement detector.
/// </summary>
/// <value>
- /// The value indicating the sensitivity of the <see cref="MovementDetector"/> from 0 to 255 inclusive
+ /// The value indicating the sensitivity of <see cref="MovementDetector"/> from 0 to 255 inclusive,
/// where 255 means that no movements will be detected and 0 means that all frame changes
/// will be interpreted as movements.\n
/// The default is 10.
/// -or-\n
/// <paramref name="value"/> is greater than 255.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Threshold
{
get
/// Provides the ability to detect movement on image sources.
/// </summary>
/// <seealso cref="MovementDetectionConfiguration"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MovementDetector : SurveillanceEngine
{
private const string KeyNumberOfRegions = "NUMBER_OF_MOVEMENT_REGIONS";
/// Initializes a new instance of the <see cref="MovementDetector"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public MovementDetector() : base(MovementDetectedEventType)
{
}
/// Occurs when the movement detected.
/// </summary>
/// <remarks>The event handler will be executed on an internal thread.</remarks>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<MovementDetectedEventArgs> Detected;
internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId,
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="MovementDetector"/> has already been disposed of.</exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void AddSource(SurveillanceSource source)
{
AddSource(source, null);
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void AddSource(SurveillanceSource source, MovementDetectionConfiguration config)
{
InvokeAddSource(source, config);
/// <summary>
/// Provides data for the <see cref="PersonAppearanceDetector.Detected"/> event.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonAppearanceDetectedEventArgs : EventArgs
{
/// <summary>
/// Initializes a new instance of the <see cref="PersonAppearanceDetectedEventArgs"/> class.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonAppearanceDetectedEventArgs(IEnumerable<Rectangle> appeared,
IEnumerable<Rectangle> disappeared, IEnumerable<Rectangle> tracked)
{
/// <summary>
/// Gets a set of rectangular regions where appearances of the persons were detected.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Rectangle> AppearanceAreas { get; }
/// <summary>
/// Gets a set of rectangular regions where disappearances of the persons were detected.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Rectangle> DisappearanceAreas { get; }
/// <summary>
/// Gets a set of rectangular regions where persons were tracked.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Rectangle> TrackedAreas { get; }
}
}
/// <summary>
/// Represents a configuration of <see cref="PersonAppearanceDetector"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonAppearanceDetectionConfiguration : SurveillanceEngineConfiguration
{
private const string KeySkipFramesCount = "MV_SURVEILLANCE_SKIP_FRAMES_COUNT";
/// <summary>
/// A read-only field that represents the default value of <see cref="SkipFramesCount"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static readonly int DefaultSkipFramesCount = 0;
/// <summary>
/// Initializes a new instance of the <see cref="PersonAppearanceDetectionConfiguration"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonAppearanceDetectionConfiguration()
{
}
/// <exception cref="ObjectDisposedException">The <see cref="PersonAppearanceDetectionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
/// <seealso cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int SkipFramesCount
{
get
/// Provides the ability to detect person appearance changes on image sources.
/// </summary>
/// <seealso cref="PersonAppearanceDetectionConfiguration"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonAppearanceDetector : SurveillanceEngine
{
private const string KeyAppearedNumber = "NUMBER_OF_APPEARED_PERSONS";
/// Initializes a new instance of the <see cref="PersonAppearanceDetector"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonAppearanceDetector() : base(PersonAppearanceEventType)
{
}
/// Occurs when the any appearance changes detected.
/// </summary>
/// <remarks>The event handler will be executed on an internal thread.</remarks>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<PersonAppearanceDetectedEventArgs> Detected;
internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId,
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="PersonAppearanceDetector"/> has already been disposed of.</exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void AddSource(SurveillanceSource source)
{
AddSource(source, null);
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void AddSource(SurveillanceSource source, PersonAppearanceDetectionConfiguration config)
{
InvokeAddSource(source, config);
/// <summary>
/// Represents a configuration of <see cref="PersonRecognizer"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonRecognitionConfiguration : SurveillanceEngineConfiguration
{
private const string KeyFaceRecognitionModelFilePath = "MV_SURVEILLANCE_FACE_RECOGNITION_MODEL_FILE_PATH";
/// <param name="modelPath">Path to the face recognition model.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonRecognitionConfiguration(string modelPath)
{
FaceRecognitionModelPath = modelPath;
/// </summary>
/// <exception cref="ArgumentNullException"><paramref name="value"/> is null.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="PersonRecognitionConfiguration"/> already has been disposed of.</exception>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string FaceRecognitionModelPath
{
get
/// <summary>
/// Represents a result of <see cref="PersonRecognizer"/> instances.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonRecognitionInfo
{
/// <summary>
/// Initializes a new instance of the <see cref="PersonRecognitionInfo"/> class.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonRecognitionInfo(Rectangle area, int label, double confidence)
{
Area = area;
/// <summary>
/// Gets the label that correspond to the recognized person.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Label { get; }
/// <summary>
/// Gets the confidence value that correspond to the recognized person.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Confidence { get; }
}
}
/// <summary>
/// Provides data for the <see cref="PersonRecognizer.Recognized"/> event.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonRecognizedEventArgs : EventArgs
{
/// <summary>
/// Initializes a new instance of the <see cref="PersonRecognizedEventArgs"/> class.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonRecognizedEventArgs(IEnumerable<PersonRecognitionInfo> recognitionInfo)
{
Recognitions = recognitionInfo;
/// <summary>
/// Gets a set of information that correspond to the recognized persons.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PersonRecognitionInfo> Recognitions { get; }
}
}
/// Provides the ability to recognize person on image sources.
/// </summary>
/// <seealso cref="PersonRecognitionConfiguration"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PersonRecognizer : SurveillanceEngine
{
private const string KeyCount = "NUMBER_OF_PERSONS";
/// Initializes a new instance of the <see cref="PersonRecognizer"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PersonRecognizer() : base(PersonRecognizedEventType)
{
}
/// </summary>
/// <remarks>The event handler will be executed on an internal thread.</remarks>
/// <seealso cref="PersonRecognitionConfiguration.FaceRecognitionModelPath"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<PersonRecognizedEventArgs> Recognized;
internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId,
/// </exception>
/// <exception cref="NotSupportedException">The model file is not supported format or file.</exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void AddSource(SurveillanceSource source, PersonRecognitionConfiguration config)
{
if (config == null)
/// <summary>
/// Represents a QR configuration of <see cref="BarcodeGenerator"/>.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class QrConfiguration
{
/// <summary>
/// -or-
/// <paramref name="ecc"/> is invalid.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public QrConfiguration(QrMode qrMode, ErrorCorrectionLevel ecc, int version)
{
if (version < 1 || version > 40)
/// <summary>
/// Gets the encoding mode for the message.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public QrMode Mode { get; }
/// <summary>
/// Gets the error correction level.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ErrorCorrectionLevel ErrorCorrectionLevel { get; }
/// <summary>
/// Gets the QR code version.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Version { get; }
}
}
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Specifies the supported QR code encoding mode.
+ /// Specifies the supported QR code encoding modes.
/// </summary>
/// <since_tizen> 3</since_tizen>
public enum QrMode
/// <summary>
/// Numeric digits.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Numeric,
/// <summary>
/// Alphanumeric characters, '$', '%', '*', '+', '-', '.', '/' and ':'.
/// <summary>
/// Raw 8-bit bytes.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Byte,
/// <summary>
/// UTF-8 character encoding.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Utf8
}
}
/// <summary>
/// Represents a region with 4 <see cref="Point"/>s.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Quadrangle
{
/// <summary>
- /// Initialize a new instance of the <see cref="Quadrangle"/> class with an array of <see cref="Point"/>.
+ /// Initializes a new instance of the <see cref="Quadrangle"/> class with an array of <see cref="Point"/>.
/// </summary>
/// <remarks><paramref name="points"/> must have 4 elements.</remarks>
- /// <param name="points">four points that define object bounding quadrangle.</param>
- /// <exception cref="ArgumentException">The
Length of <paramref name="points"/> is not 4.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <param name="points">Four points that define the object bounding quadrangle.</param>
+ /// <exception cref="ArgumentException">The
length of <paramref name="points"/> is not 4.</exception>
+ /// <since_tizen> 3 </since_tizen>
public Quadrangle(Point[] points)
{
if (points.Length != 4)
/// <summary>
/// Gets four points that define the object bounding quadrangle.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Point[] Points { get; }
/// <summary>
/// <summary>
/// SurveillanceEngineConfiguration is a base class for surveillance configurations.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class SurveillanceEngineConfiguration : EngineConfiguration
{
internal SurveillanceEngineConfiguration() : base("face_recognition", "image_recognition")
{
/// <summary>
/// SurveillanceEngine is a base class for surveillance event triggers.
- /// Media Vision Surveillance provides functionality can be utilized for creation of video surveillance systems.
+ /// Media Vision Surveillance provides the functionality which can be utilized for creation of video surveillance systems.
/// </summary>
/// <seealso cref="MovementDetector"/>
/// <seealso cref="PersonAppearanceDetector"/>
/// <seealso cref="PersonRecognizer"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public abstract class SurveillanceEngine : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// <summary>
/// Initializes a new instance of the <see cref="SurveillanceEngine"/> class.
/// </summary>
- /// <param name="eventType">The type of the event trigger</param>
+ /// <param name="eventType">The type of the event trigger.</param>
internal SurveillanceEngine(string eventType)
{
EventTriggerCreate(eventType, out _handle).Validate("Failed to create surveillance event trigger.");
}
/// <summary>
- /// Sets and gets ROI (Region Of Interest).
+ /// Sets and gets the ROI (Region Of Interest).
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="SurveillanceEngine"/> has already been disposed of.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Point[] Roi
{
get
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="SurveillanceEngine"/> has already been disposed of.</exception>
/// <exception cref="ArgumentException"><paramref name="source"/> has not been added.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveSource(SurveillanceSource source)
{
if (source == null)
/// <summary>
- /// Releases all resources used by the <see cref="SurveillanceEngine"/> object.
+ /// Releases all the resources used by the <see cref="SurveillanceEngine"/> object.
/// </summary>
public void Dispose()
{
/// Releases the resources used by the <see cref="SurveillanceEngine"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
protected virtual void Dispose(bool disposing)
{
namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Provides the ability to push source to surveillance engines.
+ /// Provides the ability to push the source to surveillance engines.
/// </summary>
/// <seealso cref="MovementDetector"/>
/// <seealso cref="PersonAppearanceDetector"/>
/// <seealso cref="PersonRecognizer"/>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class SurveillanceSource
{
private static int _nextStreamId = int.MinValue;
/// <summary>
/// Initializes a new instance of the <see cref="SurveillanceSource"/> class.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public SurveillanceSource()
{
StreamId = GetNextStreamId();
}
/// <summary>
- /// Pushes source to the surveillance system to detect events.
+ /// Pushes the source to the surveillance system to detect events.
/// </summary>
/// <param name="source">The media source used for surveillance.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
-
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
-VisualStudioVersion = 15.0.26430.12
+VisualStudioVersion = 15.0.26730.12
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Multimedia.Vision", "Tizen.Multimedia.Vision.csproj", "{2BF51BFD-D43A-45D8-BAD6-E41B12B775A5}"
EndProject
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElmSharp", "..\ElmSharp\ElmSharp.csproj", "{E48B2C17-F195-4513-83BC-AC8FEED2A18B}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Applications.Common", "..\Tizen.Applications.Common\Tizen.Applications.Common.csproj", "{64939D2A-1985-44CF-A86C-1F0C6182855F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{E8F9F8C4-F64B-4BEC-8276-3D3889941206}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{82CFA43E-C1DD-4CA3-A590-6BF6B5161B36}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen", "..\Tizen\Tizen.csproj", "{74F57E7F-650D-4677-AA7C-B2A898C91517}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Log", "..\Tizen.Log\Tizen.Log.csproj", "{43582AEF-2F1E-40FF-8B48-9051A98043A9}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{5F4C6E94-6FC5-4267-B4D6-5565E5979B78}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{E48B2C17-F195-4513-83BC-AC8FEED2A18B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{E48B2C17-F195-4513-83BC-AC8FEED2A18B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{E48B2C17-F195-4513-83BC-AC8FEED2A18B}.Release|Any CPU.Build.0 = Release|Any CPU
+ {64939D2A-1985-44CF-A86C-1F0C6182855F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {64939D2A-1985-44CF-A86C-1F0C6182855F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {64939D2A-1985-44CF-A86C-1F0C6182855F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {64939D2A-1985-44CF-A86C-1F0C6182855F}.Release|Any CPU.Build.0 = Release|Any CPU
+ {E8F9F8C4-F64B-4BEC-8276-3D3889941206}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {E8F9F8C4-F64B-4BEC-8276-3D3889941206}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {E8F9F8C4-F64B-4BEC-8276-3D3889941206}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {E8F9F8C4-F64B-4BEC-8276-3D3889941206}.Release|Any CPU.Build.0 = Release|Any CPU
+ {82CFA43E-C1DD-4CA3-A590-6BF6B5161B36}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {82CFA43E-C1DD-4CA3-A590-6BF6B5161B36}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {82CFA43E-C1DD-4CA3-A590-6BF6B5161B36}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {82CFA43E-C1DD-4CA3-A590-6BF6B5161B36}.Release|Any CPU.Build.0 = Release|Any CPU
+ {74F57E7F-650D-4677-AA7C-B2A898C91517}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {74F57E7F-650D-4677-AA7C-B2A898C91517}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {74F57E7F-650D-4677-AA7C-B2A898C91517}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {74F57E7F-650D-4677-AA7C-B2A898C91517}.Release|Any CPU.Build.0 = Release|Any CPU
+ {43582AEF-2F1E-40FF-8B48-9051A98043A9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {43582AEF-2F1E-40FF-8B48-9051A98043A9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {43582AEF-2F1E-40FF-8B48-9051A98043A9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {43582AEF-2F1E-40FF-8B48-9051A98043A9}.Release|Any CPU.Build.0 = Release|Any CPU
+ {5F4C6E94-6FC5-4267-B4D6-5565E5979B78}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {5F4C6E94-6FC5-4267-B4D6-5565E5979B78}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {5F4C6E94-6FC5-4267-B4D6-5565E5979B78}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {5F4C6E94-6FC5-4267-B4D6-5565E5979B78}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
+ GlobalSection(ExtensibilityGlobals) = postSolution
+ SolutionGuid = {D658DC62-9F57-4437-86B8-954FF2E26DB4}
+ EndGlobalSection
EndGlobal
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.Information", "..\Tizen.System.Information\Tizen.System.Information.csproj", "{14A1C9D0-F301-4A1D-BAE0-A39B85E840CA}"
EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.NUI", "..\Tizen.NUI\Tizen.NUI.csproj", "{9440B262-BA9A-4490-8E5A-7ABFA21E7CB7}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.System.SystemSettings", "..\Tizen.System.SystemSettings\Tizen.System.SystemSettings.csproj", "{852634E0-31DD-4469-B538-30C63F993433}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
{14A1C9D0-F301-4A1D-BAE0-A39B85E840CA}.Debug|Any CPU.Build.0 = Debug|Any CPU
{14A1C9D0-F301-4A1D-BAE0-A39B85E840CA}.Release|Any CPU.ActiveCfg = Release|Any CPU
{14A1C9D0-F301-4A1D-BAE0-A39B85E840CA}.Release|Any CPU.Build.0 = Release|Any CPU
+ {9440B262-BA9A-4490-8E5A-7ABFA21E7CB7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {9440B262-BA9A-4490-8E5A-7ABFA21E7CB7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {9440B262-BA9A-4490-8E5A-7ABFA21E7CB7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {9440B262-BA9A-4490-8E5A-7ABFA21E7CB7}.Release|Any CPU.Build.0 = Release|Any CPU
+ {852634E0-31DD-4469-B538-30C63F993433}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {852634E0-31DD-4469-B538-30C63F993433}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {852634E0-31DD-4469-B538-30C63F993433}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {852634E0-31DD-4469-B538-30C63F993433}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
/// <param name="viewUri">The view URI to get records from</param>
/// <param name="BookId">The calendar book ID to filter</param>
/// <param name="calendarDBVersion">The calendar database version</param>
- /// <param name="currentDBVersion">The current calendar database versio></param>
+ /// <param name="currentDBVersion">The current calendar database version</param>
/// <returns>
/// The record list
/// </returns>
/// <summary>
/// Equals CalendarTime
/// </summary>
- /// <param name="other">The CalendarTime to be compared</param>
+ /// <param name="obj">The CalendarTime to be compared</param>
/// <returns>
/// A 32-bit signed integer that indicates the relative order of the objects being compared.
/// </returns>
namespace Tizen.Pims.Calendar
{
- /// <summary>
- /// This class provides enumurations about calendar information.
- /// </summary>
+ /// <summary>
+ /// This class provides enumerations about calendar information.
+ /// </summary>
/// <remarks>
/// Most enumerations are based on vcalendar, icalendar(ver 2.0) specification.
/// https://www.ietf.org/rfc/rfc2445.txt
/// </remarks>
- public static class CalendarTypes
- {
- /// <summary>
- /// Enumeration for Default book
- /// </summary>
- public enum DefaultBook
- {
- /// <summary>
- /// Default event calendar book.
- /// </summary>
- Event,
- /// <summary>
- /// Default Todo calendar book.
- /// </summary>
- Todo,
- /// <summary>
- /// Default Birthday calendar book.
- /// </summary>
- Birthday,
- }
+ public static class CalendarTypes
+ {
+ /// <summary>
+ /// Enumeration for Default book
+ /// </summary>
+ public enum DefaultBook
+ {
+ /// <summary>
+ /// Default event calendar book.
+ /// </summary>
+ Event,
+ /// <summary>
+ /// Default Todo calendar book.
+ /// </summary>
+ Todo,
+ /// <summary>
+ /// Default Birthday calendar book.
+ /// </summary>
+ Birthday,
+ }
- /// <summary>
- /// Enumeration for Store type
- /// </summary>
- public enum StoreType
- {
- /// <summary>
- /// Book type
- /// </summary>
- Book,
- /// <summary>
- /// Event type
- /// </summary>
- Event,
- /// <summary>
- /// Todo type
- /// </summary>
- Todo,
- }
+ /// <summary>
+ /// Enumeration for Store type
+ /// </summary>
+ public enum StoreType
+ {
+ /// <summary>
+ /// Book type
+ /// </summary>
+ Book,
+ /// <summary>
+ /// Event type
+ /// </summary>
+ Event,
+ /// <summary>
+ /// Todo type
+ /// </summary>
+ Todo,
+ }
- /// <summary>
- /// Enumeration for the book mode.
- /// </summary>
- public enum BookMode
- {
- /// <summary>
- /// All modules can read and write records of this calendar_book
- /// </summary>
- Default,
- /// <summary>
- /// All modules can only read records of this calendar book
- /// </summary>
- ReadOnly,
- }
+ /// <summary>
+ /// Enumeration for the book mode.
+ /// </summary>
+ public enum BookMode
+ {
+ /// <summary>
+ /// All modules can read and write records of this calendar_book
+ /// </summary>
+ Default,
+ /// <summary>
+ /// All modules can only read records of this calendar book
+ /// </summary>
+ ReadOnly,
+ }
- /// <summary>
- /// Enumeration for the event status.
- /// </summary>
- public enum EventStatus
- {
- /// <summary>
- /// No status
- /// </summary>
- None = 0x01,
- /// <summary>
- /// The event is tentative
- /// </summary>
- Tentative = 0x02,
- /// <summary>
- /// The event is confirmed
- /// </summary>
- Confirmed = 0x04,
- /// <summary>
- /// The event is cancelled
- /// </summary>
- Cancelled = 0x08,
- }
+ /// <summary>
+ /// Enumeration for the event status.
+ /// </summary>
+ public enum EventStatus
+ {
+ /// <summary>
+ /// No status
+ /// </summary>
+ None = 0x01,
+ /// <summary>
+ /// The event is tentative
+ /// </summary>
+ Tentative = 0x02,
+ /// <summary>
+ /// The event is confirmed
+ /// </summary>
+ Confirmed = 0x04,
+ /// <summary>
+ /// The event is cancelled
+ /// </summary>
+ Cancelled = 0x08,
+ }
- /// <summary>
- /// Enumeration for for the status of a to-do.
- /// </summary>
- public enum TodoStatus
- {
- /// <summary>
- /// No status
- /// </summary>
- None = 0x0100,
- /// <summary>
- /// Needs action status
- /// </summary>
- NeedAction = 0x0200,
- /// <summary>
- /// Completed status
- /// </summary>
- Completed = 0x0400,
- /// <summary>
- /// Work in process status
- /// </summary>
- InProcess = 0x0800,
- /// <summary>
- /// Cancelled status
- /// </summary>
- Cancelled = 0x1000,
- }
+ /// <summary>
+ /// Enumeration for for the status of a to-do.
+ /// </summary>
+ public enum TodoStatus
+ {
+ /// <summary>
+ /// No status
+ /// </summary>
+ None = 0x0100,
+ /// <summary>
+ /// Needs action status
+ /// </summary>
+ NeedAction = 0x0200,
+ /// <summary>
+ /// Completed status
+ /// </summary>
+ Completed = 0x0400,
+ /// <summary>
+ /// Work in process status
+ /// </summary>
+ InProcess = 0x0800,
+ /// <summary>
+ /// Cancelled status
+ /// </summary>
+ Cancelled = 0x1000,
+ }
- /// <summary>
- /// Enumeration for the busy status of an event.
- /// </summary>
- public enum BusyStatus
- {
- /// <summary>
- /// The free status
- /// </summary>
- Free,
- /// <summary>
- /// The busy status
- /// </summary>
- Busy,
- /// <summary>
- /// The unavailable status
- /// </summary>
- Unavailable,
- /// <summary>
- /// The tentative status
- /// </summary>
- Tentative,
- }
+ /// <summary>
+ /// Enumeration for the busy status of an event.
+ /// </summary>
+ public enum BusyStatus
+ {
+ /// <summary>
+ /// The free status
+ /// </summary>
+ Free,
+ /// <summary>
+ /// The busy status
+ /// </summary>
+ Busy,
+ /// <summary>
+ /// The unavailable status
+ /// </summary>
+ Unavailable,
+ /// <summary>
+ /// The tentative status
+ /// </summary>
+ Tentative,
+ }
- /// <summary>
- /// Enumeration for the calendar sensitivity type.
- /// </summary>
- public enum Sensitivity
- {
- /// <summary>
- /// Public Sensitivity
- /// </summary>
- Public,
- /// <summary>
- /// Private Sensitivity
- /// </summary>
- Private,
- /// <summary>
- /// Confidential Sensitivity
- /// </summary>
- Confidential,
- }
+ /// <summary>
+ /// Enumeration for the calendar sensitivity type.
+ /// </summary>
+ public enum Sensitivity
+ {
+ /// <summary>
+ /// Public Sensitivity
+ /// </summary>
+ Public,
+ /// <summary>
+ /// Private Sensitivity
+ /// </summary>
+ Private,
+ /// <summary>
+ /// Confidential Sensitivity
+ /// </summary>
+ Confidential,
+ }
- /// <summary>
- /// Enumeration for the meeting status.
- /// </summary>
- public enum MeetingStatus
- {
- /// <summary>
- /// No meeting
- /// </summary>
- NoMeeting,
- /// <summary>
- /// Meeting exists
- /// </summary>
- Meeting,
- /// <summary>
- /// Meeting received
- /// </summary>
- Received,
- /// <summary>
- /// Meeting cancelled
- /// </summary>
- Cancelled,
- }
+ /// <summary>
+ /// Enumeration for the meeting status.
+ /// </summary>
+ public enum MeetingStatus
+ {
+ /// <summary>
+ /// No meeting
+ /// </summary>
+ NoMeeting,
+ /// <summary>
+ /// Meeting exists
+ /// </summary>
+ Meeting,
+ /// <summary>
+ /// Meeting received
+ /// </summary>
+ Received,
+ /// <summary>
+ /// Meeting cancelled
+ /// </summary>
+ Cancelled,
+ }
- /// <summary>
- /// Enumeration for the calendar event item's priority
- /// </summary>
- public enum Priority
- {
- /// <summary>
- /// No priority
- /// </summary>
- None = 0x01,
- /// <summary>
- /// Low priority
- /// </summary>
- High = 0x02,
- /// <summary>
- /// Normal priority
- /// </summary>
- Normal = 0x04,
- /// <summary>
- /// High priority
- /// </summary>
- Low = 0x08,
- }
+ /// <summary>
+ /// Enumeration for the calendar event item's priority
+ /// </summary>
+ public enum Priority
+ {
+ /// <summary>
+ /// No priority
+ /// </summary>
+ None = 0x01,
+ /// <summary>
+ /// Low priority
+ /// </summary>
+ High = 0x02,
+ /// <summary>
+ /// Normal priority
+ /// </summary>
+ Normal = 0x04,
+ /// <summary>
+ /// High priority
+ /// </summary>
+ Low = 0x08,
+ }
- /// <summary>
- /// Enumeration for the frequency of an event's recurrence.
- /// </summary>
- public enum Recurrence
- {
- /// <summary>
- /// No recurrence event
- /// </summary>
- None,
- /// <summary>
- /// An event occurs every day
- /// </summary>
- Daily,
- /// <summary>
- /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week
- /// </summary>
- Weekly,
- /// <summary>
- /// An event occurs on the same day of every month
- /// </summary>
- Monthly,
- /// <summary>
- /// An event occurs on the same day of every year
- /// </summary>
- Yearly,
- }
+ /// <summary>
+ /// Enumeration for the frequency of an event's recurrence.
+ /// </summary>
+ public enum Recurrence
+ {
+ /// <summary>
+ /// No recurrence event
+ /// </summary>
+ None,
+ /// <summary>
+ /// An event occurs every day
+ /// </summary>
+ Daily,
+ /// <summary>
+ /// An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week
+ /// </summary>
+ Weekly,
+ /// <summary>
+ /// An event occurs on the same day of every month
+ /// </summary>
+ Monthly,
+ /// <summary>
+ /// An event occurs on the same day of every year
+ /// </summary>
+ Yearly,
+ }
- /// <summary>
- /// Enumeration for the range type.
- /// </summary>
- public enum RangeType
- {
- /// <summary>
- /// Range until
- /// </summary>
- Until,
- /// <summary>
- /// Range count
- /// </summary>
- Count,
- /// <summary>
- /// No range
- /// </summary>
- None,
- }
+ /// <summary>
+ /// Enumeration for the range type.
+ /// </summary>
+ public enum RangeType
+ {
+ /// <summary>
+ /// Range until
+ /// </summary>
+ Until,
+ /// <summary>
+ /// Range count
+ /// </summary>
+ Count,
+ /// <summary>
+ /// No range
+ /// </summary>
+ None,
+ }
- /// <summary>
- /// Enumeration for the system type.
- /// </summary>
- public enum SystemType
- {
- /// <summary>
- /// Locale's default calendar
- /// </summary>
- Default,
- /// <summary>
- /// Locale's default calendar
- /// </summary>
- Gregorian,
- /// <summary>
- /// East Asian lunisolar calendar
- /// </summary>
- Lunisolar,
- }
+ /// <summary>
+ /// Enumeration for the system type.
+ /// </summary>
+ public enum SystemType
+ {
+ /// <summary>
+ /// Locale's default calendar
+ /// </summary>
+ Default,
+ /// <summary>
+ /// Locale's default calendar
+ /// </summary>
+ Gregorian,
+ /// <summary>
+ /// East Asian lunisolar calendar
+ /// </summary>
+ Lunisolar,
+ }
- /// <summary>
- /// Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on.
- /// </summary>
- public enum TickUnit
- {
- /// <summary>
- /// No reminder set
- /// </summary>
- None = -1,
- /// <summary>
- /// Specific in seconds
- /// </summary>
- Specific = 1,
- /// <summary>
- /// Alarm time unit in minutes
- /// </summary>
- Minute = 60,
- /// <summary>
- /// Alarm time unit in hours
- /// </summary>
- Hour = 3600,
- /// <summary>
- /// Alarm time unit in days
- /// </summary>
- Day = 86400,
- /// <summary>
- /// Alarm time unit in weeks
- /// </summary>
- Week = 604800,
- }
+ /// <summary>
+ /// Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on.
+ /// </summary>
+ public enum TickUnit
+ {
+ /// <summary>
+ /// No reminder set
+ /// </summary>
+ None = -1,
+ /// <summary>
+ /// Specific in seconds
+ /// </summary>
+ Specific = 1,
+ /// <summary>
+ /// Alarm time unit in minutes
+ /// </summary>
+ Minute = 60,
+ /// <summary>
+ /// Alarm time unit in hours
+ /// </summary>
+ Hour = 3600,
+ /// <summary>
+ /// Alarm time unit in days
+ /// </summary>
+ Day = 86400,
+ /// <summary>
+ /// Alarm time unit in weeks
+ /// </summary>
+ Week = 604800,
+ }
- /// <summary>
- /// Enumeration for weekdays.
- /// </summary>
- public enum WeekDay
- {
- /// <summary>
- /// Sunday
- /// </summary>
- Sunday = 1,
- /// <summary>
- /// Monday
- /// </summary>
- Monday,
- /// <summary>
- /// Tuesday
- /// </summary>
- Tuesday,
- /// <summary>
- /// Wednesday
- /// </summary>
- Wednesday,
- /// <summary>
- /// Thursday
- /// </summary>
- Thursday,
- /// <summary>
- /// Friday
- /// </summary>
- Friday,
- /// <summary>
- /// Saturday
- /// </summary>
- Saturday,
- }
+ /// <summary>
+ /// Enumeration for weekdays.
+ /// </summary>
+ public enum WeekDay
+ {
+ /// <summary>
+ /// Sunday
+ /// </summary>
+ Sunday = 1,
+ /// <summary>
+ /// Monday
+ /// </summary>
+ Monday,
+ /// <summary>
+ /// Tuesday
+ /// </summary>
+ Tuesday,
+ /// <summary>
+ /// Wednesday
+ /// </summary>
+ Wednesday,
+ /// <summary>
+ /// Thursday
+ /// </summary>
+ Thursday,
+ /// <summary>
+ /// Friday
+ /// </summary>
+ Friday,
+ /// <summary>
+ /// Saturday
+ /// </summary>
+ Saturday,
+ }
- /// <summary>
- /// Enumeration to specify the type of calendar user specified by the property.
- /// </summary>
- public enum Cutype
- {
- /// <summary>
+ /// <summary>
+ /// Enumeration to specify the type of calendar user specified by the property.
+ /// </summary>
+ public enum Cutype
+ {
+ /// <summary>
/// An individual
- /// </summary>
- Individual,
- /// <summary>
+ /// </summary>
+ Individual,
+ /// <summary>
/// A group of individuals
- /// </summary>
- Group,
- /// <summary>
+ /// </summary>
+ Group,
+ /// <summary>
/// A physical resource
- /// </summary>
- Resource,
- /// <summary>
+ /// </summary>
+ Resource,
+ /// <summary>
/// A room resource
- /// </summary>
- Room,
- /// <summary>
+ /// </summary>
+ Room,
+ /// <summary>
/// Otherwise not known
- /// </summary>
- Unknown,
- }
+ /// </summary>
+ Unknown,
+ }
- /// <summary>
- /// Enumeration for the attendee role.
- /// </summary>
- public enum AttendeeRole
- {
- /// <summary>
- /// Participation is required
- /// </summary>
- ReqParticipant,
- /// <summary>
- /// Accepted status
- /// </summary>
- OptParticipant,
- /// <summary>
- /// Non-Participant
- /// </summary>
- NonParticipant,
- /// <summary>
- /// Chairperson
- /// </summary>
- Chair,
- }
+ /// <summary>
+ /// Enumeration for the attendee role.
+ /// </summary>
+ public enum AttendeeRole
+ {
+ /// <summary>
+ /// Participation is required
+ /// </summary>
+ ReqParticipant,
+ /// <summary>
+ /// Accepted status
+ /// </summary>
+ OptParticipant,
+ /// <summary>
+ /// Non-Participant
+ /// </summary>
+ NonParticipant,
+ /// <summary>
+ /// Chairperson
+ /// </summary>
+ Chair,
+ }
- /// <summary>
- /// Enumeration for the attendee status.
- /// </summary>
- public enum AttendeeStatus
- {
- /// <summary>
- /// Pending status
- /// </summary>
- Pending,
- /// <summary>
- /// Accepted status
- /// </summary>
- Accepted,
- /// <summary>
- /// Declined status
- /// </summary>
- Declined,
- /// <summary>
- /// Tentative status
- /// </summary>
- Tentative,
- /// <summary>
- /// Delegated status
- /// </summary>
- Delegated,
- /// <summary>
- /// Completed status
- /// </summary>
- Completed,
- /// <summary>
- /// In process status
- /// </summary>
- InProcess,
- }
+ /// <summary>
+ /// Enumeration for the attendee status.
+ /// </summary>
+ public enum AttendeeStatus
+ {
+ /// <summary>
+ /// Pending status
+ /// </summary>
+ Pending,
+ /// <summary>
+ /// Accepted status
+ /// </summary>
+ Accepted,
+ /// <summary>
+ /// Declined status
+ /// </summary>
+ Declined,
+ /// <summary>
+ /// Tentative status
+ /// </summary>
+ Tentative,
+ /// <summary>
+ /// Delegated status
+ /// </summary>
+ Delegated,
+ /// <summary>
+ /// Completed status
+ /// </summary>
+ Completed,
+ /// <summary>
+ /// In process status
+ /// </summary>
+ InProcess,
+ }
- /// <summary>
- /// Enumeration for the alarm action.
- /// </summary>
- public enum Action
- {
- /// <summary>
- /// Audio action
- /// </summary>
- Audio,
- /// <summary>
- /// Display action
- /// </summary>
- Display,
- /// <summary>
- /// Email action
- /// </summary>
- Email,
- }
- }
+ /// <summary>
+ /// Enumeration for the alarm action.
+ /// </summary>
+ public enum Action
+ {
+ /// <summary>
+ /// Audio action
+ /// </summary>
+ Audio,
+ /// <summary>
+ /// Display action
+ /// </summary>
+ Display,
+ /// <summary>
+ /// Email action
+ /// </summary>
+ Email,
+ }
+ }
}
/// Parsing vcalendar file callback function.
/// </summary>
/// <param name="record">The record</param>
- /// <returns></returns>
+ /// <returns>true to continue with the next iteration of the loop, otherwise false to break out of the loop</returns>
public delegate bool ParseCallback(CalendarRecord record);
/// <summary>
}
/// <summary>
- /// The parameter which data is combinded.
+ /// The parameter which data is combined.
/// </summary>
/// <value>
/// The combination of reminder data(Value string like id=value&time=value&tick=value&unit=value&type=value)
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a certificate.
+ /// The class that represents a certificate.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Certificate
{
/// <summary>
- /// Load Certificate from the given file path.
+ /// Loads Certificate from the given file path.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="filePath">The path of certificate file to be loaded.</param>
/// <returns>Loaded certificate class instance.</returns>
/// <exception cref="ArgumentNullException">
- /// filePath should not be null
+ /// The filePath should not be null
/// </exception>
/// <exception cref="InvalidOperationException">
/// Invalid certificate file format. Provided file path does not exist or
public class CertificateManager : Manager
{
/// <summary>
- /// Gets a certificate from secure repository.
+ /// Gets a certificate from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="alias">The name of a certificate to retrieve.</param>
+ /// <param name="alias">The name of a certificate to be retrieved.</param>
/// <param name="password">
/// The password used in decrypting a certificate value. If password of
/// policy is provided in SaveCertificate(), the same password should be
/// </param>
/// <returns>A certificate specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in an invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Certificate does not exist with the alias or certificate-protecting
+ /// The certificate does not exist with the alias or certificate-protecting
/// password isn't matched.
/// </exception>
static public Certificate Get(string alias, string password)
}
/// <summary>
- /// Gets all alias of certificates which the client can access.
+ /// Gets all aliases of certificates, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of certificates which the client can access.</returns>
+ /// <returns>All aliases of certificates, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores a certificate inside secure repository based on the provided policy.
+ /// Stores a certificate inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a certificate to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. cert argument is invalid format.
+ /// The alias argument is in the invalid format. cert argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Certificate with alias does already exist.
+ /// The certificate with alias already exist.
/// </exception>
static public void Save(string alias, Certificate cert, Policy policy)
{
/// </param>
/// <returns>A newly created certificate chain.</returns>
/// <exception cref="ArgumentNullException">
- /// certificate argument is null.
+ /// The certificate argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Some of certificate in arguments is invalid.
+ /// Some of the certificates in arguments are invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Some of certificate in arguments is expired or not valid yet.
+ /// Some of the certificates in arguments are expired or not valid yet.
/// Certificate cannot build chain.
- /// Root certificate is not in trusted system certificate store.
+ /// The root certificate is not in the trusted system certificate store.
/// </exception>
/// <remarks>
/// The trusted root certificate of the chain should exist in the system's
/// certificate storage.
/// </remarks>
/// <remarks>
- /// The trusted root certificate of the chain in system's certificate storage
+ /// The trusted root certificate of the chain in the system's certificate storage
/// is added to the certificate chain.
/// </remarks>
static public IEnumerable<Certificate> GetCertificateChain(
/// </param>
/// <returns>A newly created certificate chain.</returns>
/// <exception cref="ArgumentNullException">
- /// certificate argument is null.
+ /// The certificate argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Some of certificate in arguments is invalid.
+ /// Some of the certificates in arguments are invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Some of certificate in arguments is expired or not valid yet.
+ /// Some of the certificates in arguments are expired or not valid yet.
/// Certificate cannot build chain.
- /// Root certificate is not in trusted system certificate store.
+ /// The root certificate is not in the trusted system certificate store.
/// </exception>
/// <remarks>
- /// The trusted root certificate of the chain in system's certificate storage
+ /// The trusted root certificate of the chain in the system's certificate storage
/// is added to the certificate chain.
/// </remarks>
static public IEnumerable<Certificate> GetCertificateChain(
}
/// <summary>
- /// Perform OCSP which checks certificate is whether revoked or not.
+ /// Perform OCSP, which checks whether the certificate is revoked or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="certificateChain">
- /// Valid certificate chain to perform OCSP check.
+ /// Valid certificate chain to perform the OCSP check.
/// </param>
- /// <returns>A status result of OCSP check.</returns>
+ /// <returns>A status result of the OCSP check.</returns>
/// <exception cref="ArgumentNullException">
- /// certificateChain argument is null.
+ /// The certificateChain argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// certificateChain is not valid chain or certificate.
+ /// The certificateChain is not valid chain or certificate.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// some of certificate in chain is expired or not valid yet.
+ /// Some of the certificates in chain are expired or not valid yet.
/// </exception>
static public OcspStatus CheckOcsp(IEnumerable<Certificate> certificateChain)
{
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with CBC mode.
+ /// A class for holding parameters for the AES algorithm with the CBC mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCbcCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCbc.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with CFB mode.
+ /// A class for holding parameters for the AES algorithm with the CFB mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCfbCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCfb.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for AES algorithm.
+ /// An abstract class for holding parameters for the AES algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public abstract class AesCipherParameters : CipherParameters
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with counter mode.
+ /// A class for holding parameters for the AES algorithm with the counter mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesCtrCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr.</remarks>
}
/// <summary>
- /// Length of counter block in bits.
+ /// Length of the counter block in bits.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>Optional, only 128b is supported at the moment.</remarks>
- /// <exception cref="ArgumentOutOfRangeException">value should be positive.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">The value should be positive.</exception>
public long CounterLength
{
get
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for AES algorithm with GCM mode.
+ /// A class for holding parameters for the AES algorithm with the GCM mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AesGcmCipherParameters : AesCipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesGcm.</remarks>
/// GCM tag length in bits.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>One of {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used.</remarks>
- /// <exception cref="ArgumentOutOfRangeException">TagLength should be one of {32, 64, 96, 104, 112, 120, 128}</exception>
+ /// <remarks>One of {32, 64, 96, 104, 112, 120, 128} (optional), if not present the length 128 is used.</remarks>
+ /// <exception cref="ArgumentOutOfRangeException">TagLength should be one of {32, 64, 96, 104, 112, 120, 128}.</exception>
public long TagLength
{
get
}
/// <summary>
- /// Additional authentication data(optional)
+ /// Additional authentication data (optional).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] AAD
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// This class provides the methods encrypting and decrypting data.
+ /// This class provides the methods for encrypting and decrypting data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Cipher
}
/// <summary>
- /// Decrypts data using selected key and algorithm.
+ /// Decrypts data using the selected key and the algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="keyAlias">Alias of the key to be used for decryption.</param>
/// <param name="password">
/// The password used in decrypting a key value. If password of policy is
- /// provided in SaveKey(), the same password should be provided
+ /// provided in SaveKey(), the same password should be provided.
/// </param>
/// <param name="cipherText">
/// Data to be decrypted (some algorithms may require additional information
/// </param>
/// <returns>Decrypted data.</returns>
/// <exception cref="ArgumentNullException">
- /// keyAlias or cipherText is null.
+ /// The keyAlias or cipherText is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Mandatory algorithm parameter is missing or invalid.
- /// Optional algorithm parameter is invalid.
+ /// The mandatory algorithm parameter is missing or invalid.
+ /// The optional algorithm parameter is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with keyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the keyAlias.
/// </exception>
/// <remarks>
/// The key type specified by keyAlias should be compatible with the algorithm
/// provided in SaveKey(), the same password should be provided.
/// </param>
/// <param name="plainText">
- /// Data to be encrypted. In case of AES algorithm there are no restrictions on
- /// the size of data. For RSA the size must be smaller or equal to (key_size_in
- /// bytes - 42). Example: for 1024 RSA key the maximum data size is
+ /// Data to be encrypted. In case of the AES algorithm, there are no restrictions on
+ /// the size of data. For RSA, the size must be smaller or equal to (key_size_in
+ /// bytes - 42). Example: For 1024 RSA key, the maximum data size is
/// 1024/8 - 42 = 86.
/// </param>
/// <returns>Encrypted data.</returns>
/// <exception cref="ArgumentNullException">
- /// keyAlias or plainText is null.
+ /// The keyAlias or plainText is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Mandatory algorithm parameter is missing or invalid.
- /// Optional algorithm parameter is invalid.
+ /// The mandatory algorithm parameter is missing or invalid.
+ /// The optional algorithm parameter is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with keyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the keyAlias.
/// </exception>
/// <remarks>
- /// The key type specified by keyAlias should be compatible with the algorithm
+ /// The key type specified by the keyAlias should be compatible with the algorithm
/// specified in Parameters.
/// </remarks>
public byte[] Encrypt(string keyAlias, string password, byte[] plainText)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for crypto cipher algorithm types.
+ /// Enumeration for the crypto cipher algorithm types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CipherAlgorithmType : int
{
/// <summary>
- /// AES-CTR algorithm
+ /// The AES-CTR algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCtr(mandatory),
/// - ParameterName.IV = 16 - byte initialization vector(mandatory)
/// </summary>
AesCtr = 0x01,
/// <summary>
- /// AES-CBC algorithm
+ /// The AES-CBC algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCbc(mandatory),
/// - ParameterName.IV = 16-byte initialization vector(mandatory)
/// </summary>
AesCbc,
/// <summary>
- /// AES-GCM algorithm
+ /// The AES-GCM algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesGcm(mandatory),
/// - ParameterName.IV = initialization vector(mandatory)
/// </summary>
AesGcm,
/// <summary>
- /// AES-CFB algorithm
+ /// Th AES-CFB algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = AesCfb(mandatory),
/// - ParameterName.IV = 16-byte initialization vector(mandatory)
/// </summary>
AesCfb,
/// <summary>
- /// RSA-OAEP algorithm
+ /// The RSA-OAEP algorithm.
/// Supported parameters:
/// - ParameterName.AlgorithmType = RsaOaep(required),
/// - ParameterName.Label = label to be associated with the message
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for cipher algorithm parameters.
+ /// Enumeration for the cipher algorithm parameters.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CipherParameterName : int
{
/// <summary>
- /// Algorithm Type
+ /// The Algorithm Type.
/// </summary>
AlgorithmType = 0x01,
/// <summary>
- /// Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM)
+ /// Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM).
/// </summary>
IV = 101,
/// <summary>
- /// Integer - ctr length in bits
+ /// Integer - ctr length in bits.
/// </summary>
CounterLength = 102,
/// <summary>
- /// Additional authenticated data(AAD)
+ /// Additional authenticated data(AAD).
/// </summary>
AAD = 103,
/// <summary>
- /// Tag Length
+ /// Tag Length.
/// </summary>
TagLength = 104,
/// <summary>
- /// Label
+ /// Label.
/// </summary>
Label = 105
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for encryption and decryption.
+ /// An abstract class for holding parameters for encryption and decryption.
/// </summary>
/// <since_tizen> 3 </since_tizen>
abstract public class CipherParameters
private SafeCipherParametersHandle _handle;
/// <summary>
- /// Cipher algorithm type.
+ /// The Cipher algorithm type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CipherAlgorithmType Algorithm
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for DSA signature algorithm.
+ /// A class for holding parameters for the DSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public DsaSignatureParameters() : base(SignatureAlgorithmType.Dsa)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for ECDSA signature algorithm.
+ /// A class for holding parameters for the ECDSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class EcdsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public EcdsaSignatureParameters() : base(SignatureAlgorithmType.Ecdsa)
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for hash algorithm
+ /// Enumeration for the hash algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum HashAlgorithm : int
{
/// <summary>
- /// No Hash Algorithm
+ /// The no hash algorithm.
/// </summary>
None = 0,
/// <summary>
- /// Hash Algorithm SHA1
+ /// The hash algorithm SHA1.
/// </summary>
Sha1,
/// <summary>
- /// Hash Algorithm SHA256
+ /// The hash algorithm SHA256.
/// </summary>
Sha256,
/// <summary>
- /// Hash Algorithm SHA384
+ /// The hash algorithm SHA384.
/// </summary>
Sha384,
/// <summary>
- /// Hash Algorithm SHA512
+ /// The hash algorithm SHA512.
/// </summary>
Sha512
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for RSA algorithm with OAEP mode.
+ /// A class for holding parameters for the RSA algorithm with the OAEP mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RsaOaepCipherParameters : CipherParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.RsaOaep.</remarks>
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for RSA padding algorithm
+ /// Enumeration for the RSA padding algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum RsaPaddingAlgorithm : int
{
/// <summary>
- /// No Padding
+ /// No padding.
/// </summary>
None = 0,
/// <summary>
- /// PKCS#1 Padding
+ /// PKCS#1 padding.
/// </summary>
Pkcs1,
/// <summary>
- /// X9.31 padding
+ /// X9.31 padding.
/// </summary>
X931
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A class holding parameters for RSA signature algorithm.
+ /// A class for holding parameters for the RSA signature algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RsaSignatureParameters : SignatureParameters
{
/// <summary>
- /// A default constructor
+ /// A default constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>The RsaPadding is set to RsaPaddingAlgorithm.None.</remarks>
}
/// <summary>
- /// RSA padding algorithm
+ /// The RSA padding algorithm.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public RsaPaddingAlgorithm RsaPadding
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// This class provides the methods creating and verifying a signature.
+ /// This class provides the methods for creating and verifying a signature.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Signature
/// <param name="message">The message that is signed with a private key.</param>
/// <returns>A newly created signature.</returns>
/// <exception cref="ArgumentNullException">
- /// privateKeyAlias or message is null.
+ /// The privateKeyAlias or message is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// privateKeyAlias is invalid format.
+ /// The privateKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with privateKeyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the privateKeyAlias.
/// </exception>
/// <remarks>
- /// The key type specified by privateKeyAlias should be compatible with the
+ /// The key type specified by the privateKeyAlias should be compatible with the
/// algorithm specified in Parameters.
/// </remarks>
/// <remarks>
- /// If password of policy is provided during storing a key, the same password
+ /// If the password of policy is provided during storing a key, the same password
/// should be provided.
/// </remarks>
public byte[] Sign(string privateKeyAlias, string password, byte[] message)
/// The signature status. True is returned when the signature is valid.
/// </returns>
/// <exception cref="ArgumentNullException">
- /// publicKeyAlias, message or signature is null.
+ /// The publicKeyAlias, message or signature is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// publicKeyAlias is invalid format.
+ /// The publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key-protecting password isn't matched.
- /// Key does not exist with publicKeyAlias.
+ /// The key-protecting password isn't matched.
+ /// The key does not exist with the publicKeyAlias.
/// </exception>
/// <remarks>
/// The key type specified by publicKeyAlias should be compatible with the
public enum SignatureAlgorithmType : int
{
/// <summary>
- /// RSA signature algorithm
+ /// The RSA signature algorithm.
/// </summary>
Rsa = 0x01,
/// <summary>
- /// DSA signature algorithm
+ /// The DSA signature algorithm.
/// </summary>
Dsa,
/// <summary>
- /// ECDSA signature algorithm
+ /// The ECDSA signature algorithm.
/// </summary>
Ecdsa
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// Enumeration for signature algorithm parameters.
+ /// Enumeration for the signature algorithm parameters.
/// </summary>
/// <since_tizen> 3 </since_tizen>
internal enum SignatureParameterName : int
{
/// <summary>
- /// Signaturea Algorithm Type
+ /// The signature algorithm type.
/// </summary>
AlgorithmType = 0x01,
/// <summary>
- /// Hash Algorithm Type
+ /// The hash algorithm type.
/// </summary>
HashAlgorithm,
/// <summary>
- /// RSA Padding Algorithm Type
+ /// The RSA padding algorithm type.
/// </summary>
RsaPaddingAlgorithm
}
namespace Tizen.Security.SecureRepository.Crypto
{
/// <summary>
- /// A abstract class holding parameters for signing and verification.
+ /// An abstract class for holding parameters for signing and verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
abstract public class SignatureParameters
private Dictionary<SignatureParameterName, int> _parameters;
/// <summary>
- /// Signature algorithm type.
+ /// The signature algorithm type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public SignatureAlgorithmType SignatureAlgorithm
}
/// <summary>
- /// Hash algorithm used in signing anve verification.
+ /// The hash algorithm used in signing anve verification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public HashAlgorithm HashAlgorithm
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for data format
+ /// Enumeration for data format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DataFormat : int
{
/// <summary>
- /// DER format base64 encoded data
+ /// The DER format base64 encoded data.
/// </summary>
DerBase64 = 0,
/// <summary>
- /// DER encoded data
+ /// The DER encoded data.
/// </summary>
Der,
/// <summary>
- /// PEM encoded data. It consists of the DER format base64 encoded
+ /// The PEM encoded data. It consists of the DER format base64 encoded
/// with additional header and footer lines.
/// </summary>
Pem
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing and retrieving data.
+ /// This class provides the methods for storing and retrieving data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DataManager : Manager
{
/// <summary>
- /// Gets data from secure repository.
+ /// Gets data from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a certificate to retrieve.</param>
/// </param>
/// <returns>Data specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null.
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Data does not exist with the alias or data-protecting password isn't matched.
}
/// <summary>
- /// Gets all alias of data which the client can access.
+ /// Gets all aliases of data, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of data which the client can access.</returns>
+ /// <returns>All aliases of data, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores data inside secure repository based on the provided policy.
+ /// Stores data inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of data to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. Data policy cannot be unextractable.
+ /// The alias argument is in the invalid format. Data policy cannot be unextractable.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Data with alias does already exist.
+ /// Data with alias already exist.
/// </exception>
static public void Save(string alias, byte[] data, Policy policy)
{
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for elliptic curve
+ /// Enumeration for the elliptic curve.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum EllipticCurveType : int
{
/// <summary>
- /// Elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain
+ /// The elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain.
/// </summary>
Prime192V1 = 0,
/// <summary>
- /// "SEC 2" recommended elliptic curve domain - secp256r1
+ /// The "SEC 2" recommended elliptic curve domain - secp256r1.
/// </summary>
Prime256V1,
/// <summary>
- /// NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2
+ /// The NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2.
/// </summary>
Secp384R1
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a key.
+ /// The class that represents a key.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Key
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing, retrieving, and creating keys.
+ /// This class provides the methods for storing, retrieving, and creating keys.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class KeyManager : Manager
{
/// <summary>
- /// Gets a key from secure repository.
+ /// Gets a key from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a key to retrieve.</param>
/// </param>
/// <returns>A key specified by alias.</returns>
/// <exception cref="ArgumentNullException">
- /// Alias argument is null.
+ /// The alias argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key does not exist with the alias or key-protecting password isn't matched.
+ /// The key does not exist with the alias or the key-protecting password isn't matched.
/// </exception>
static public Key Get(string alias, string password)
{
}
/// <summary>
- /// Gets all alias of keys which the client can access.
+ /// Gets all aliases of keys, which the client can access.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>All alias of keys which the client can access.</returns>
+ /// <returns>All aliases of keys, which the client can access.</returns>
/// <exception cref="ArgumentException">No alias to get.</exception>
static public IEnumerable<string> GetAliases()
{
}
/// <summary>
- /// Stores a key inside secure repository based on the provided policy.
+ /// Stores a key inside the secure repository based on the provided policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of a key to be stored.</param>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. key argument is invalid format.
+ /// The alias argument is in the invalid format. key argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with alias does already exist.
+ /// The key with alias does already exist.
/// </exception>
/// <remarks>
- /// Type in key may be set to KeyType.None as an input.
- /// Type is determined inside secure reposioty during storing keys.
+ /// The type in key may be set to KeyType.None as an input.
+ /// The type is determined inside the secure reposioty during storing keys.
/// </remarks>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void Save(string alias, Key key, Policy policy)
}
/// <summary>
- /// Creates RSA private/public key pair and stores them inside secure repository
+ /// Creates the RSA private/public key pair and stores them inside the secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
+ /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with the
+ /// If the password in policy is provided, the key is additionally encrypted with the
/// password in policy.
/// </remarks>
static public void CreateRsaKeyPair(
}
/// <summary>
- /// Creates DSA private/public key pair and stores them inside secure repository
+ /// Creates the DSA private/public key pair and stores them inside the secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
+ /// The size is invalid. privateKeyAlias or publicKeyAlias is invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateDsaKeyPair(
}
/// <summary>
- /// Creates ECDSA private/public key pair and stores them inside secure repository
+ /// Creates the ECDSA private/public key pair and stores them inside secure repository
/// based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// Any of argument is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is
+ /// The elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is in the
/// invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateEcdsaKeyPair(
}
/// <summary>
- /// Creates AES key and stores it inside secure repository based on each policy.
+ /// Creates the AES key and stores it inside the secure repository based on each policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="size">
- /// The size of key strength to be created. 128, 192 and 256 are supported.
+ /// The size of the key strength to be created. 128, 192 and 256 are supported.
/// </param>
/// <param name="keyAlias">The name of key to be stored.</param>
/// <param name="policy">The policy about how to store the key securely.</param>
/// <exception cref="ArgumentNullException">
- /// keyAlias or policy is null.
+ /// The keyAlias or policy is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// Key size is invalid. keyAlias is invalid format.
+ /// The key size is invalid. keyAlias is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
- /// Key with privateKeyAlias or publicKeyAlias does already exist.
+ /// The key with privateKeyAlias or publicKeyAlias does already exist.
/// </exception>
/// <remarks>
- /// If password in policy is provided, the key is additionally encrypted with
+ /// If the password in policy is provided, the key is additionally encrypted with
/// the password in policy.
/// </remarks>
static public void CreateAesKey(int size, string keyAlias, Policy policy)
public enum KeyType : int
{
/// <summary>
- /// Key type not specified
+ /// Key type not specified.
/// </summary>
None = 0,
/// <summary>
- /// RSA public key
+ /// The RSA public key.
/// </summary>
RsaPublic,
/// <summary>
- /// RSA private key
+ /// The RSA private key.
/// </summary>
RsaPrivate,
/// <summary>
- /// ECDSA public key
+ /// The ECDSA public key.
/// </summary>
EcdsaPublic,
/// <summary>
- /// ECDSA private key
+ /// The ECDSA private key.
/// </summary>
EcdsaPrivate,
/// <summary>
- /// DSA public key
+ /// The DSA public key.
/// </summary>
DsaPublic,
/// <summary>
- /// DSA private key
+ /// The DSA private key.
/// </summary>
DsaPrivate,
/// <summary>
- /// AES key
+ /// The AES key.
/// </summary>
Aes
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class is a base class of XxxManager classes. It provides the common methods
+ /// This class is a base class of the XxxManager classes. It provides the common methods
/// for all sub classes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Manager
{
/// <summary>
- /// Creates a new full alias which is concatenation of owner id and alias.
+ /// Creates a new full alias, which is concatenation of owner ID and alias.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="ownerId">Data owner's id. This should be package id if data
+ /// <param name="ownerId">Data owner's ID. This should be package ID if data
/// owner is application. If you want to access data stored by system services,
/// use CreateFullSystemAlias() instead.</param>
/// <param name="alias">Data alias.</param>
}
/// <summary>
- /// Creates a new full alias which is concatenation of system service's
- /// owner id and alias.
+ /// Creates a new full alias, which is concatenation of system service's
+ /// owner ID and alias.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="alias">Data alias which is owned by system service.</param>
+ /// <param name="alias">Data alias, which is owned by system service.</param>
static public string CreateFullSystemAlias(string alias)
{
return Manager.CreateFullAlias(Manager.SystemOwnerId, alias);
}
/// <summary>
- /// Removes a an entry (no matter of type) from the key manager.
+ /// Removes an entry (no matter of type) from the key manager.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">Item alias to be removed.</param>
- /// <exception cref="ArgumentNullException">alias is null.</exception>
- /// <exception cref="ArgumentException">alias is invalid format.</exception>
- /// <exception cref="InvalidOperationException">alias does not exist.</exception>
+ /// <exception cref="ArgumentNullException">The alias is null.</exception>
+ /// <exception cref="ArgumentException">The alias is in the invalid format.</exception>
+ /// <exception cref="InvalidOperationException">The alias does not exist.</exception>
/// <remarks>
- /// To remove item, client must have remove permission to the specified item.
+ /// To remove item, client must remove permission to the specified item.
/// </remarks>
/// <remarks>The item owner can remove by default.</remarks>
static public void RemoveAlias(string alias)
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">Item alias for which access will be granted.</param>
/// <param name="otherPackageId">
- /// Package id of the application that will gain access rights.
+ /// Package ID of the application that will gain access rights.
/// </param>
/// <param name="permissions">
/// Mask of permissions(Permission enum) granted for an application with
/// otherPackageId.
/// </param>
/// <exception cref="ArgumentNullException">
- /// alias or otherPackageId is null.
+ /// The alias or otherPackageId is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// alias or otherPackageId is invalid format.
+ /// The alias or otherPackageId is in the invalid format.
/// </exception>
- /// <exception cref="InvalidOperationException">alias does not exist.</exception>
+ /// <exception cref="InvalidOperationException">The alias does not exist.</exception>
/// <remarks>Data identified by alias should exist.</remarks>
/// <remarks>The item owner can set permissions.</remarks>
static public void SetPermission(
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Enumeration for OCSP status.
+ /// Enumeration for the OCSP status.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum OcspStatus : int
{
/// <summary>
- /// OCSP status is good
+ /// The OCSP status is good.
/// </summary>
Good = 0x00,
/// <summary>
- /// The certificate is revoked
+ /// The certificate is revoked.
/// </summary>
Revoked = 0x01,
/// <summary>
- /// Unknown error
+ /// Unknown error.
/// </summary>
Unknown = 0x02,
/// <summary>
- /// The certificate does not provide OCSP extension
+ /// The certificate does not provide the OCSP extension.
/// </summary>
Unsupported = 0x03,
/// <summary>
- /// The invalid URL in certificate OCSP extension
+ /// The invalid URL in the certificate OCSP extension.
/// </summary>
InvalidUrl = 0x04,
/// <summary>
- /// The invalid response from OCSP server
+ /// The invalid response from the OCSP server.
/// </summary>
InvalidResponse = 0x05,
/// <summary>
- /// OCSP remote server error
+ /// The OCSP remote server error.
/// </summary>
RemoteError = 0x06,
/// <summary>
- /// Network connection error
+ /// The Network connection error.
/// </summary>
NetworkError = 0x07,
/// <summary>
- /// Internal error
+ /// An Internal error.
/// </summary>
InternalError = 0x08
}
public enum Permission : int
{
/// <summary>
- /// Clear permissions
+ /// Clear permissions.
/// </summary>
None = 0x00,
/// <summary>
- /// Eead allowed
+ /// Read allowed.
/// </summary>
Read = 0x01,
/// <summary>
- /// Remove allowed
+ /// Remove allowed.
/// </summary>
Remove = 0x02
}
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// Class that represents a PKCS#12 contents.
+ /// The class that represents a PKCS#12 contents.
/// It has a private key or its certificate or all the members of a chain of trust.
/// </summary>
/// <since_tizen> 3 </since_tizen>
private SafeCertificateListHandle _certChainHandle = null;
/// <summary>
- /// Load Pkcs12 from the given PKCS#12 file path.
+ /// Loads the Pkcs12 from the given PKCS#12 file path.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="filePath">The path of PKCS12 file to be loaded.</param>
+ /// <param name="filePath">The path of the PKCS12 file to be loaded.</param>
/// <param name="filePassword">The passphrase used to decrypt the PCKS12 file.
- /// If PKCS12 file is not encrypted, passphrase can be null.</param>
- /// <exception cref="ArgumentNullException">filePath is null.</exception>
+ /// If the PKCS12 file is not encrypted, passphrase can be null.</param>
+ /// <exception cref="ArgumentNullException">The filePath is null.</exception>
/// <exception cref="InvalidOperationException">
/// No file on filePath.
/// No permission to access file.
- /// File is invalid PKCS12 format.
+ /// File is in the invalid PKCS12 format.
/// File cannot be extracted with provided filePassword.
/// </exception>
static public Pkcs12 Load(string filePath, string filePassword)
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="privateKey">A private key.</param>
- /// <param name="certificate">A certificate corresponding the private key</param>
+ /// <param name="certificate">A certificate corresponding the private key.</param>
/// <param name="caChain">
/// A certificate chain of CA(Certificate Authority) that issued the certificate.
/// </param>
}
/// <summary>
- /// A certificate corresponding the private key.
+ /// A certificate corresponding to the private key.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public Certificate Certificate
namespace Tizen.Security.SecureRepository
{
/// <summary>
- /// This class provides the methods storing, retrieving Pkcs12 contents.
+ /// This class provides the methods for storing and retrieving the Pkcs12 contents.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class Pkcs12Manager : Manager
{
/// <summary>
- /// Gets Pkcs12 contents from secure repository.
+ /// Gets Pkcs12 contents from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="alias">The name of data to retrieve.</param>
/// <param name="keyPassword">
/// The password used in decrypting a private key value. If password of
- /// keyPolicy is provided in SavePkcs12(), the same password should be provided
+ /// keyPolicy is provided in SavePkcs12(), the same password should be provided.
/// </param>
/// <param name="cerificatePassword">
/// The password used in decrypting a certificate value. If password of
/// certificatePolicy is provided in SavePkcs12(), the same password should be
- /// provided
+ /// provided.
/// </param>
/// <returns>A Pkcs12 data specified by alias.</returns>
- /// <exception cref="ArgumentNullException">Alias argument is null.</exception>
+ /// <exception cref="ArgumentNullException">The alias argument is null.</exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format.
+ /// The alias argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Pkcs12 does not exist with the alias.
/// </param>
/// <exception cref="ArgumentNullException">Any of argument is null.</exception>
/// <exception cref="ArgumentException">
- /// Alias argument is invalid format. Pkcs12 argument is invalid format.
+ /// The alias argument is in the invalid format. Pkcs12 argument is in the invalid format.
/// </exception>
/// <exception cref="InvalidOperationException">
/// Pkcs12 with alias does already exist.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="password">Used to encrypt data secure repository.</param>
- /// <param name="extractable">If true key may be extracted from secure repository.</param>
+ /// <param name="extractable">If true, key may be extracted from the secure repository.</param>
public Policy(String password, bool extractable)
{
Password = password;
/// <summary>
/// Used to encrypt data secure repository. If it is not null, the data
- /// (or key, or certificate) is stored encrypted with this password inside secure repository
+ /// (or key, or certificate) is stored encrypted with this password inside secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public String Password
}
/// <summary>
- /// If true key may be extracted from secure repository.
+ /// If true, key may be extracted from the secure repository.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool Extractable
namespace Tizen.Security
{
/// <summary>
- /// The class provides the information of the given privilege and API version.
+ /// This class provides the information of the given privilege and the API version.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class Privilege
/// Gets the display name of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <returns>The display name of given privilege at given api version</returns>
+ /// <remarks>If there's no matching privilege, then it returns last token of the given privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <returns>The display name of the given privilege at the given API version.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDisplayName(string apiVersion, string privilege)
{
string displayName;
/// Gets the display name of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <param name="packageType">The type of application package</param>
- /// <returns>The display name of given privilege at given api version and the package type</returns>
+ /// <remarks>If there's no matching privilege, then it returns last token of the given privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <param name="packageType">The type of application package.</param>
+ /// <returns>The display name of the given privilege at the given API version and the package type.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDisplayName(string apiVersion, string privilege, PackageType packageType)
{
string displayName;
/// Gets the description of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <returns>The description of given privilege at given api version</returns>
+ /// <remarks>If there's no matching privilege, then it returns description string for undefined privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <returns>The description of given privilege at the given API version</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDescription(string apiVersion, string privilege)
{
string description;
/// Gets the description of the given privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks>
- /// <param name="apiVersion">The api version</param>
- /// <param name="privilege">The privilege</param>
- /// <param name="packageType">The type of application package</param>
- /// <returns>The description of given privilege at given api version and the package type</returns>
+ /// <remarks>If there's no matching privilege, then it returns description string for undefined privilege.</remarks>
+ /// <param name="apiVersion">The API version.</param>
+ /// <param name="privilege">The privilege.</param>
+ /// <param name="packageType">The type of application package.</param>
+ /// <returns>The description of given privilege at the given API version and the package type.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetDescription(string apiVersion, string privilege, PackageType packageType)
{
string description;
/// Gets the display name of the privacy group in which the given privilege is included.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="privilege">The privilege</param>
+ /// <param name="privilege">The privilege.</param>
/// <remarks>The privilege must be privacy related.</remarks>
- /// <returns>The privacy group's display name that the given privilege is included in</returns>
+ /// <returns>The privacy group's display name that the given privilege is included in.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static string GetPrivacyDisplayName(string privilege)
{
string displayName;
/// Gets the status of the given privacy related privilege.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="privilege">The privilege</param>
+ /// <param name="privilege">The privilege.</param>
/// <remarks>The privilege must be privacy related.</remarks>
- /// <returns>status true if the privilege is on and false if the privilege is off.</returns>
+ /// <returns>Status true if the privilege is on and false if the privilege is off.</returns>
/// <exception cref="System.ArgumentNullException">Thrown when there is a null parameter.</exception>
/// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
- /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception>
+ /// <exception cref="System.OutOfMemoryException">Thrown when out of memory occurs.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when an internal error occurs.</exception>
public static bool GetPrivacyPrivilegeStatus(string privilege)
{
bool status;
namespace Tizen.Sensor
{
/// <summary>
- /// Accelerometer changed event arguments. Class for storing the data returned by accelerometer
+ /// The Accelerometer changed event arguments class is used for storing the data returned by a accelerometer.
/// </summary>
public class AccelerometerDataUpdatedEventArgs : EventArgs
{
namespace Tizen.Sensor
{
/// <summary>
- /// FaceDownGestureDetector changed event arguments. Class for storing the data returned by face down gesture detector.
+ /// The FaceDownGestureDetector changed event arguments class is used for storing the data returned by a face down gesture detector.
/// </summary>
public class FaceDownGestureDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the face down state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Face down state </value>
+ /// <value> The face down state. </value>
public DetectorState FaceDown { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// GravitySensor changed event arguments. Class for storing the data returned by gravity sensor
+ /// The GravitySensor changed event arguments class is used for storing the data returned by a gravity sensor.
/// </summary>
public class GravitySensorDataUpdatedEventArgs : EventArgs
{
/// <value> Z </value>
public float Z { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// Gyroscope changed event arguments. Class for storing the data returned by gyroscope
+ /// The Gyroscope changed event arguments class is used for storing the data returned by a gyroscope.
/// </summary>
public class GyroscopeDataUpdatedEventArgs : EventArgs
{
namespace Tizen.Sensor
{
/// <summary>
- /// GyroscopeRotationVectorSensor changed event arguments. Class for storing the data returned by gyroscope rotation vector sensor
+ /// The GyroscopeRotationVectorSensor changed event arguments class is used for storing the data returned by a gyroscope rotation vector sensor.
/// </summary>
public class GyroscopeRotationVectorSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// HeartRateMonitor changed event arguments. Class for storing the data returned by heart rate monitor
+ /// The HeartRateMonitor changed event arguments class is used for storing the data returned by a heart rate monitor.
/// </summary>
public class HeartRateMonitorDataUpdatedEventArgs : EventArgs
{
}
/// <summary>
- /// Gets the value of the heartRate.
+ /// Gets the value of the heart rate.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Heart rate </value>
+ /// <value> The heart rate. </value>
public int HeartRate { get; private set; }
}
}
\ No newline at end of file
namespace Tizen.Sensor
{
/// <summary>
- /// HumiditySensor changed event arguments. Class for storing the data returned by humidity sensor
+ /// The HumiditySensor changed event arguments class is used for storing the data returned by a humidity sensor.
/// </summary>
public class HumiditySensorDataUpdatedEventArgs : EventArgs
{
/// <value> Humidity </value>
public float Humidity { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// InVehicleActivityDetector changed event arguments. Class for storing the data returned by in-vehicle activity detector
+ /// The InVehicleActivityDetector changed event arguments class is used for storing the data returned by a in-vehicle activity detector.
/// </summary>
public class InVehicleActivityDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the in-vehicle state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> In-vehicle state </value>
+ /// <value> The in-vehicle state. </value>
public DetectorState InVehicle { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// LightSensor changed event arguments. Class for storing the data returned by light sensor
+ /// The LightSensor changed event arguments class is used for storing the data returned by a light sensor.
/// </summary>
public class LightSensorDataUpdatedEventArgs : EventArgs
{
/// Gets the level of the light.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Light level </value>
+ /// <value> The light level. </value>
public float Level { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// LinearAccelerationSensor changed event arguments. Class for storing the data returned by linear acceleration sensor
+ /// The LinearAccelerationSensor changed event arguments class is used for storing the data returned by a linear acceleration sensor.
/// </summary>
public class LinearAccelerationSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Z </value>
public float Z { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// Magnetometer changed event arguments. Class for storing the data returned by magnetometer sensor
+ /// The Magnetometer changed event arguments class is used for storing the data returned by a magnetometer sensor.
/// </summary>
public class MagnetometerDataUpdatedEventArgs : EventArgs
{
/// <value> Z </value>
public float Z { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// MagnetometerRotationVectorSensor changed event arguments. Class for storing the data returned by magnetometer rotation vector sensor
+ /// The MagnetometerRotationVectorSensor changed event arguments class is used for storing the data returned by a magnetometer rotation vector sensor.
/// </summary>
public class MagnetometerRotationVectorSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// OrientationSensor changed event arguments. Class for storing the data returned by orientation sensor
+ /// The OrientationSensor changed event arguments class is used for storing the data returned by a orientation sensor.
/// </summary>
public class OrientationSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Roll </value>
public float Roll { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// Pedometer changed event arguments. Class for storing the data returned by pedometer
+ /// The Pedometer changed event arguments class is used for storing the data returned by a pedometer.
/// </summary>
public class PedometerDataUpdatedEventArgs : EventArgs
{
}
/// <summary>
- /// Gets the step count
+ /// Gets the step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Step count </value>
+ /// <value> The step count. </value>
public uint StepCount { get; private set; }
/// <summary>
- /// Gets the walking step count
+ /// Gets the walking step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Walk step count </value>
+ /// <value> The walk step count. </value>
public uint WalkStepCount { get; private set; }
/// <summary>
- /// Gets the running step count
+ /// Gets the running step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Run step count</value>
+ /// <value> The run step count.</value>
public uint RunStepCount { get; private set; }
/// <summary>
- /// Gets the moving distance
+ /// Gets the moving distance.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Moving distance </value>
+ /// <value> The moving distance.</value>
public float MovingDistance { get; private set; }
/// <summary>
- /// Gets the calorie burned
+ /// Gets the calorie burned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Calorie burned </value>
+ /// <value> The calorie burned.</value>
public float CalorieBurned { get; private set; }
/// <summary>
- /// Gets the last speed
+ /// Gets the last speed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last speed </value>
+ /// <value> The last speed. </value>
public float LastSpeed { get; private set; }
/// <summary>
- /// Gets the last stepping frequency
+ /// Gets the last stepping frequency.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last stepping frequency </value>
+ /// <value> The last stepping frequency.</value>
public float LastSteppingFrequency { get; private set; }
/// <summary>
- /// Gets the last step status
+ /// Gets the last step status.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last stepping status </value>
+ /// <value> The last stepping status. </value>
public PedometerState LastStepStatus { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// PickUpGestureDetector changed event arguments. Class for storing the data returned by pick up gesture detector
+ /// The PickUpGestureDetector changed event arguments class is used for storing the data returned by a pickup gesture detector.
/// </summary>
public class PickUpGestureDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the pick up state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Pick up state </value>
+ /// <value> The pick up state. </value>
public DetectorState PickUp { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// PressureSensor changed event arguments. Class for storing the data returned by pressure sensor
+ /// The PressureSensor changed event arguments class is used for storing the data returned by a pressure sensor.
/// </summary>
public class PressureSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Pressure </value>
public float Pressure { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// ProximitySensor changed event arguments. Class for storing the data returned by proximity sensor
+ /// The ProximitySensor changed event arguments class is used for storing the data returned by a proximity sensor.
/// </summary>
public class ProximitySensorDataUpdatedEventArgs : EventArgs
{
/// Gets the proximity state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Proximity state </value>
+ /// <value> The proximity state. </value>
public ProximitySensorState Proximity { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// RotationVectorSensor changed event arguments. Class for storing the data returned by rotation vector sensor
+ /// The RotationVectorSensor changed event arguments class is used for storing the data returned by a rotation vector sensor.
/// </summary>
public class RotationVectorSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// RunningActivityDetector changed event arguments. Class for storing the data returned by running activity detector
+ /// The RunningActivityDetector changed event arguments class is used for storing the data returned by a running activity detector.
/// </summary>
public class RunningActivityDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the running state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Running state </value>
+ /// <value> The running state. </value>
public DetectorState Running { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// Sensor accuracy changed event arguments Class. Contains the parameters to be returned through accuracy callback
+ /// The sensor accuracy changed event arguments class contains the parameters to be returned through the accuracy callback.
/// </summary>
public class SensorAccuracyChangedEventArgs : EventArgs
{
/// Gets the time stamp.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Time span </value>
+ /// <value> The time span. </value>
public TimeSpan TimeSpan { get; private set; }
/// <summary>
namespace Tizen.Sensor
{
/// <summary>
- /// SleepMonitor changed event arguments. Class for storing the data returned by sleep monitor
+ /// The SleepMonitor changed event arguments class is used for storing the data returned by a sleep monitor.
/// </summary>
public class SleepMonitorDataUpdatedEventArgs : EventArgs
{
/// Gets the value of the sleep state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Sleep state </value>
+ /// <value> The sleep state. </value>
public SleepMonitorState SleepState { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// StationaryActivityDetector changed event arguments. Class for storing the data returned by stationary activity detector
+ /// The StationaryActivityDetector changed event arguments class is used for storing the data returned by a stationary activity detector.
/// </summary>
public class StationaryActivityDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the stationary state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Stationary state </value>
+ /// <value> The stationary state. </value>
public DetectorState Stationary { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// TemperatureSensor changed event arguments. Class for storing the data returned by temperature sensor
+ /// The TemperatureSensor changed event arguments class is used for storing the data returned by a temperature sensor.
/// </summary>
public class TemperatureSensorDataUpdatedEventArgs : EventArgs
{
/// <value> Temperature </value>
public float Temperature { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// UltravioletSensor changed event arguments. Class for storing the data returned by ultraviolet sensor
+ /// The UltravioletSensor changed event arguments class is used for storing the data returned by a ultraviolet sensor.
/// </summary>
public class UltravioletSensorDataUpdatedEventArgs : EventArgs
{
/// Gets the value of the ultraviolet index.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Ultraviolet index </value>
+ /// <value> The ultraviolet index. </value>
public float UltravioletIndex { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// UncalibratedGyroscope changed event arguments. Class for storing the data returned by uncalibrated gyroscope
+ /// The UncalibratedGyroscope changed event arguments class is used for storing the data returned by a uncalibrated gyroscope.
/// </summary>
public class UncalibratedGyroscopeDataUpdatedEventArgs : EventArgs
{
/// Gets the BiasX component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> X bias </value>
+ /// <value> The X bias. </value>
public float BiasX { get; private set; }
/// <summary>
/// Gets the BiasY component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Y bias </value>
+ /// <value> The Y bias. </value>
public float BiasY { get; private set; }
/// <summary>
/// Gets the BiasZ component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Z bias </value>
+ /// <value> The Z bias. </value>
public float BiasZ { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// UncalibratedMagnetometer changed event arguments. Class for storing the data returned by uncalibrated magnetometer
+ /// The UncalibratedMagnetometer changed event arguments class is used for storing the data returned by a uncalibrated magnetometer.
/// </summary>
public class UncalibratedMagnetometerDataUpdatedEventArgs : EventArgs
{
/// Gets the BiasX component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> X bias </value>
+ /// <value> The X bias. </value>
public float BiasX { get; private set; }
/// <summary>
/// Gets the BiasY component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Y bias </value>
+ /// <value> The Y bias. </value>
public float BiasY { get; private set; }
/// <summary>
/// Gets the BiasZ component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Z bias </value>
+ /// <value> The Z bias. </value>
public float BiasZ { get; private set; }
}
-}
\ No newline at end of file
+}
namespace Tizen.Sensor
{
/// <summary>
- /// WalkingActivityDetector changed event arguments. Class for storing the data returned by walking activity detector
+ /// The WalkingActivityDetector changed event arguments class is used for storing the data returned by a walking activity detector.
/// </summary>
public class WalkingActivityDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the walking state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Walking state </value>
+ /// <value> The walking state. </value>
public DetectorState Walking { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// WristUpGestureDetector changed event arguments. Class for storing the data returned by wrist up gesture detector
+ /// The WristUpGestureDetector changed event arguments class is used for storing the data returned by a wrist up gesture detector.
/// </summary>
public class WristUpGestureDetectorDataUpdatedEventArgs : EventArgs
{
/// Gets the wrist up state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Wrist up state </value>
+ /// <value> The wrist up state. </value>
public DetectorState WristUp { get; private set; }
}
}
namespace Tizen.Sensor
{
/// <summary>
- /// Accelerometer Sensor Class. Used for registering callbacks for accelerometer and getting accelerometer data
+ /// The Accelerometer Sensor class is used for registering callbacks for the accelerometer and getting the accelerometer data.
/// </summary>
public sealed class Accelerometer : Sensor
{
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether accelerometer sensor is supported by device.
+ /// Returns true or false based on whether accelerometer sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of accelerometer sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of accelerometer sensors </value>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <value> The count of accelerometer sensors. </value>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.accelerometer</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors.
/// </param>
public Accelerometer(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in accelerometer sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the accelerometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<AccelerometerDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// Activity Detector class for storing common activity information
+ /// The Activity Detector class is used for storing the common activity information.
/// </summary>
public abstract class ActivityDetector : Sensor
{
};
/// <summary>
- /// Gets the activity accuracy of activity detector
+ /// Gets the activity accuracy of the activity detector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Activity accuracy </value>
+ /// <value> The activity accuracy. </value>
public SensorDataAccuracy ActivityAccuracy { get; protected set; }
internal ActivityDetector(uint index) : base(index)
namespace Tizen.Sensor
{
/// <summary>
- /// FaceDownGestureDetector Class. Used for registering callbacks for face down gesture detector and getting the face down state
+ /// The FaceDownGestureDetector class is used for registering callbacks for the face down gesture detector and getting the face down state.
/// </summary>
public sealed class FaceDownGestureDetector : Sensor
{
/// Gets the state of the face down gesture.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Face down state </value>
+ /// <value> The face down state. </value>
public DetectorState FaceDown { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether face down gesture detector is supported by device.
+ /// Returns true or false based on whether the face down gesture detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of face down gesture detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of face down gesture detectors </value>
+ /// <value> The count of face down gesture detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in face down gesture detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the face down gesture detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<FaceDownGestureDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// GravitySensor Class. Used for registering callbacks for gravity sensor and getting gravity data
+ /// The GravitySensor class is used for registering callbacks for the gravity sensor and getting the gravity data.
/// </summary>
public sealed class GravitySensor : Sensor
{
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether gravity sensor is supported by device.
+ /// Returns true or false based on whether the gravity sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of gravity sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of gravity sensors </value>
+ /// <value> The count of gravity sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gravity</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors.
/// </param>
public GravitySensor (uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in gravity sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the gravity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<GravitySensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// Gyroscope Sensor Class. Used for registering callbacks for gyroscope and getting gyroscope data
+ /// The Gyroscope Sensor class is used for registering callbacks for the gyroscope and getting the gyroscope data.
/// </summary>
public sealed class Gyroscope : Sensor
{
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether gyroscope sensor is supported by device.
+ /// Returns true or false based on whether the gyroscope sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
}
/// <summary>
- /// Returns the number of gyroscope sensors available on the device.
+ /// Returns the number of the gyroscope sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of gyroscope sensors </value>
+ /// <value> The count of the gyroscope sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors.
/// </param>
public Gyroscope(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in gyroscope sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// GyroscopeRotationVectorSensor Class. Used for registering callbacks for gyroscope rotation vector sensor and getting gyroscope rotation vector data
+ /// The GyroscopeRotationVectorSensor class is used for registering callbacks for the gyroscope rotation vector sensor and getting the gyroscope rotation vector data.
/// </summary>
public sealed class GyroscopeRotationVectorSensor : Sensor
{
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Accuracy of the gyroscope rotation vector data.
+ /// Gets the accuracy of the gyroscope rotation vector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
/// <summary>
- /// Returns true or false based on whether gyroscope rotation vector sensor is supported by device.
+ /// Returns true or false based on whether the gyroscope rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
}
/// <summary>
- /// Returns the number of gyroscope rotation vector sensors available on the device.
+ /// Returns the number of the gyroscope rotation vector sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of accelerometer rotation vector sensors </value>
+ /// <value> The count of accelerometer rotation vector sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope_rotation_vector</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors.
/// </param>
public GyroscopeRotationVectorSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in gyroscope rotation vector sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// HeartRateMonitor Class. Used for registering callbacks for heart rate monitor and getting heart rate data
+ /// The HeartRateMonitor class is used for registering callbacks for the heart rate monitor and getting the heart rate data.
/// </summary>
public sealed class HeartRateMonitor : Sensor
{
/// Gets the value of the heart rate monitor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Heart rate </value>
+ /// <value> The heart rate. </value>
public int HeartRate { get; private set; } = int.MinValue;
/// <summary>
- /// Returns true or false based on whether heart rate monitor is supported by device.
+ /// Returns true or false based on whether the heart rate monitor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of heart rate monitors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of heart rate monitors </value>
+ /// <value> The count of heart rate monitors. </value>
public static int Count
{
get
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <privlevel>public</privlevel>
/// <feature>http://tizen.org/feature/sensor.heart_rate_monitor</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors.
/// </param>
public HeartRateMonitor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the heart rate monitor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<HeartRateMonitorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// HumiditySensor Class. Used for registering callbacks for humidity sensor and getting humidity data
+ /// The HumiditySensor class is used for registering callbacks for the humidity sensor and getting the humidity data.
/// </summary>
public sealed class HumiditySensor : Sensor
{
public float Humidity { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether humidity sensor is supported by device.
+ /// Returns true or false based on whether the humidity sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of humidity sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of humidity sensors </value>
+ /// <value> The count of humidity sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.humidity</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors.
/// </param>
public HumiditySensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in humidity sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// InVehicleActivityDetector Class. Used for registering callbacks for in vehicle activity detector and getting the in vehicle state
+ /// The InVehicleActivityDetector class is used for registering callbacks for the in-vehicle activity detector and getting the in-vehicle state.
/// </summary>
public sealed class InVehicleActivityDetector : ActivityDetector
{
private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of in-vehicle activity detector
+ /// Gets the state of the in-vehicle activity detector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> In-vehicle state </value>
+ /// <value> The in-vehicle state. </value>
public DetectorState InVehicle { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether in-vehicle activity detector is supported by device.
+ /// Returns true or false based on whether the in-vehicle activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of in-vehicle activity detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of in-vehicle activity detectors </value>
+ /// <value> The count of in-vehicle activity detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in in-vehicle activity detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the in-vehicle activity detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<InVehicleActivityDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// LightSensor Class. Used for registering callbacks for light sensor and getting light data
+ /// The LightSensor class is used for registering callbacks for the light sensor and getting the light data.
/// </summary>
public sealed class LightSensor : Sensor
{
private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer";
/// <summary>
- /// Gets the Level of the light.
+ /// Gets the level of the light.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Light level </value>
+ /// <value> The light level. </value>
public float Level { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether light sensor is supported by device.
+ /// Returns true or false based on whether the light sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of light sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of light sensors </value>
+ /// <value> The count of light sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.photometer</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors.
/// </param>
public LightSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in light sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the light sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// LinearAccelerationSensor Class. Used for registering callbacks for linear acceleration sensor and getting linear acceleration data
+ /// The LinearAccelerationSensor class is used for registering callbacks for the linear acceleration sensor and getting the linear acceleration data.
/// </summary>
public sealed class LinearAccelerationSensor : Sensor
{
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether linear acceleration sensor is supported by device.
+ /// Returns true or false based on whether the linear acceleration sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of linear acceleration sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of linear acceleration sensors </value>
+ /// <value> The count of linear acceleration sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.linear_acceleration</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors.
/// </param>
public LinearAccelerationSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in linear acceleration sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the linear acceleration sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<LinearAccelerationSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// Magnetometer Class. Used for registering callbacks for magnetometer and getting magnetometer data
+ /// The Magnetometer class is used for registering callbacks for the magnetometer and getting the magnetometer data.
/// </summary>
public sealed class Magnetometer : Sensor
{
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether magnetometer is supported by device.
+ /// Returns true or false based on whether magnetometer is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of magnetometers available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of magnetometers </value>
+ /// <value> The count of magnetometers. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.magnetometer</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors.
/// </param>
public Magnetometer(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in magnetometer data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<MagnetometerDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// MagnetometerRotationVectorSensor Class. Used for registering callbacks for magnetometer rotation vector sensor and getting magnetometer rotation vector data
+ /// The MagnetometerRotationVectorSensor class is used for registering callbacks for the magnetometer rotation vector sensor and getting the magnetometer rotation vector data.
/// </summary>
public sealed class MagnetometerRotationVectorSensor : Sensor
{
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Accuracy of the magnetometer rotation vector data.
+ /// Gets the accuracy of the magnetometer rotation vector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
/// <summary>
- /// Returns true or false based on whether magnetometer rotation vector sensor is supported by device.
+ /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of magnetometer rotation vector sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of magnetometer rotation vector sensors </value>
+ /// <value> The count of magnetometer rotation vector sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
/// </param>
public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in magnetometer rotation vector sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// OrientationSensor Class. Used for registering callbacks for orientation sensor and getting orientation data
+ /// The OrientationSensor class is used for registering callbacks for the orientation sensor and getting the orientation data.
/// </summary>
public sealed class OrientationSensor : Sensor
{
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
/// <summary>
- /// Gets the Azimuth component of the orientation.
+ /// Gets the azimuth component of the orientation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Azimuth </value>
public float Azimuth { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Pitch component of the orientation.
+ /// Gets the pitch component of the orientation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Pitch </value>
public float Pitch { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Roll component of the orientation.
+ /// Gets the roll component of the orientation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Roll </value>
public float Roll { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether orientation sensor is supported by device.
+ /// Returns true or false based on whether the orientation sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of orientation sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of orientation sensors </value>
+ /// <value> The count of orientation sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.tiltmeter</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors.
/// </param>
public OrientationSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in orientation sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the orientation sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<OrientationSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// Pedometer Sensor Class. Used for registering callbacks for pedometer and getting pedometer data
+ /// The Pedometer Sensor class is used for registering callbacks for the pedometer and getting the pedometer data.
/// </summary>
public sealed class Pedometer : Sensor
{
private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer";
/// <summary>
- /// Gets the step count
+ /// Gets the step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Step count </value>
+ /// <value> The step count. </value>
public uint StepCount { get; private set; } = 0;
/// <summary>
- /// Gets the walking step count
+ /// Gets the walking step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Walk step count </value>
+ /// <value> The walk step count. </value>
public uint WalkStepCount { get; private set; } = 0;
/// <summary>
- /// Gets the running step count
+ /// Gets the running step count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Run step count </value>
+ /// <value> The run step count. </value>
public uint RunStepCount { get; private set; } = 0;
/// <summary>
- /// Gets the moving distance
+ /// Gets the moving distance.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Moving distance </value>
+ /// <value> The moving distance. </value>
public float MovingDistance { get; private set; } = 0;
/// <summary>
- /// Gets the calorie burned
+ /// Gets the calorie burned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Calorie Burned </value>
+ /// <value> The calorie burned. </value>
public float CalorieBurned { get; private set; } = 0;
/// <summary>
- /// Gets the last speed
+ /// Gets the last speed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last speed </value>
+ /// <value> The last speed. </value>
public float LastSpeed { get; private set; } = 0;
/// <summary>
- /// Gets the last stepping frequency
+ /// Gets the last stepping frequency.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last stepping frequency </value>
+ /// <value> The last stepping frequency. </value>
public float LastSteppingFrequency { get; private set; } = 0;
/// <summary>
- /// Gets the last step status
+ /// Gets the last step status.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Last step status </value>
+ /// <value> The last step status. </value>
public PedometerState LastStepStatus { get; private set; } = PedometerState.Unknown;
/// <summary>
- /// Returns true or false based on whether pedometer sensor is supported by device.
+ /// Returns true or false based on whether the pedometer sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of pedometer sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of pedometer sensors </value>
+ /// <value> The count of pedometer sensors. </value>
public static int Count
{
get
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <privlevel>public</privlevel>
/// <feature>http://tizen.org/feature/sensor.pedometer</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors.
/// </param>
public Pedometer(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in pedometer sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the pedometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// PickUpGestureDetector Class. Used for registering callbacks for pick up activity detector and getting the pick up state
+ /// The PickUpGestureDetector class is used for registering callbacks for the pick up activity detector and getting the pick up state.
/// </summary>
public sealed class PickUpGestureDetector : Sensor
{
/// Gets the state of the pick up gesture.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Pick up state </value>
+ /// <value> The pick up state. </value>
public DetectorState PickUp { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether pick up gesture detector is supported by device.
+ /// Returns true or false based on whether the pick up gesture detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of pick up gesture detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of pick up gesture detectors </value>
+ /// <value> The count of pick up gesture detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in pick up gesture detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the pick up gesture detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<PickUpGestureDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// PressureSensor Class. Used for registering callbacks for pressure sensor and getting pressure data
+ /// The PressureSensor class is used for registering callbacks for the pressure sensor and getting the pressure data.
/// </summary>
public sealed class PressureSensor : Sensor
{
public float Pressure { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether pressure sensor is supported by device.
+ /// Returns true or false based on whether the pressure sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of pressure sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of pressure sensors </value>
+ /// <value> The count of pressure sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.barometer</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors.
/// </param>
public PressureSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in pressure sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the pressure sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// ProximitySensor Class. Used for registering callbacks for proximity sensor and getting proximity data
+ /// The ProximitySensor class is used for registering callbacks for the proximity sensor and getting the proximity data.
/// </summary>
public sealed class ProximitySensor : Sensor
{
/// Gets the proximity state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Proximity state </value>
+ /// <value> The proximity state. </value>
public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown;
/// <summary>
- /// Returns true or false based on whether proximity sensor is supported by device.
+ /// Returns true or false based on whether the proximity sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of proximity sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of proximity sensors </value>
+ /// <value> The count of proximity sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.proximity</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors.
/// </param>
public ProximitySensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in proximity sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// RotationVectorSensor Class. Used for registering callbacks for rotation vector sensor and getting rotation vector data
+ /// The RotationVectorSensor class is used for registering callbacks for the rotation vector sensor and getting the rotation vector data.
/// </summary>
public sealed class RotationVectorSensor : Sensor
{
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Accuracy of the rotation vector data.
+ /// Gets the accuracy of the rotation vector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
/// <summary>
- /// Returns true or false based on whether rotation vector sensor is supported by device.
+ /// Returns true or false based on whether the rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of rotation vector sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of rotation vector sensors </value>
+ /// <value> The count of rotation vector sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.rotation_vector</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors.
/// </param>
public RotationVectorSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in rotation vector sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<RotationVectorSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// RunningActivityDetector Class. Used for registering callbacks for running activity detector and getting the running state
+ /// The RunningActivityDetector class is used for registering callbacks for running the activity detector and getting the running state.
/// </summary>
public sealed class RunningActivityDetector : ActivityDetector
{
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of running activity detector
+ /// Gets the state of the running activity detector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Running state </value>
+ /// <value> The running state. </value>
public DetectorState Running { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether running activity detector is supported by device.
+ /// Returns true or false based on whether the running activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
}
/// <summary>
- /// Returns the number of running activity detector available on the device.
+ /// Returns the number of running activity detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of running activity detectors </value>
+ /// <value> The count of running activity detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in running activity detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in running the activity detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<RunningActivityDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// SleepMonitor Class. Used for registering callbacks for sleep monitor and getting sleep data
+ /// The SleepMonitor class is used for registering callbacks for the sleep monitor and getting the sleep data.
/// </summary>
public sealed class SleepMonitor : Sensor
{
/// Gets the value of the sleep state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Sleep state </value>
+ /// <value> The sleep state. </value>
public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown;
/// <summary>
- /// Returns true or false based on whether sleep monitor is supported by device.
+ /// Returns true or false based on whether the sleep monitor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of sleep monitors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of sleep monitors </value>
+ /// <value> The count of sleep monitors. </value>
public static int Count
{
get
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <privlevel>public</privlevel>
/// <feature>http://tizen.org/feature/sensor.sleep_monitor</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.
/// </param>
public SleepMonitor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in sleep monitor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// StationaryActivityDetector Class. Used for registering callbacks for stationary activity detector and getting the stationary state
+ /// The StationaryActivityDetector class is used for registering callbacks for the stationary activity detector and getting the stationary state.
/// </summary>
public sealed class StationaryActivityDetector : ActivityDetector
{
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of stationary activity detector
+ /// Gets the state of the stationary activity detector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Stationary state </value>
+ /// <value> The stationary state. </value>
public DetectorState Stationary { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether stationary activity detector is supported by device.
+ /// Returns true or false based on whether the stationary activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of stationary activity detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of stationary activity detectors </value>
+ /// <value> The count of stationary activity detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in stationary activity detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the stationary activity detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<StationaryActivityDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// TemperatureSensor Class. Used for registering callbacks for temperature sensor and getting temperature data
+ /// The TemperatureSensor class is used for registering callbacks for the temperature sensor and getting the temperature data.
/// </summary>
public sealed class TemperatureSensor : Sensor
{
public float Temperature { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether temperature sensor is supported by device.
+ /// Returns true or false based on whether the temperature sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of temperature sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of temperature sensors </value>
+ /// <value> The count of temperature sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.temperature</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors.
/// </param>
public TemperatureSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in temperature sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the temperature sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// UltravioletSensor Class. Used for registering callbacks for ultraviolet sensor and getting ultraviolet data
+ /// The UltravioletSensor class is used for registering callbacks for the ultraviolet sensor and getting the ultraviolet data.
/// </summary>
public sealed class UltravioletSensor : Sensor
{
/// Gets the value of the ultraviolet sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Ultraviolet index </value>
+ /// <value> The ultraviolet index. </value>
public float UltravioletIndex { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether ultraviolet sensor is supported by device.
+ /// Returns true or false based on whether the ultraviolet sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of ultraviolet sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of ultraviolet sensors </value>
+ /// <value> The count of ultraviolet sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.ultraviolet</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors.
/// </param>
public UltravioletSensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in ultraviolet sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the ultraviolet sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// UncalibratedGyroscope Sensor Class. Used for registering callbacks for uncalibrated gyroscope and getting uncalibrated gyroscope data
+ /// The UncalibratedGyroscope sensor class is used for registering callbacks for the uncalibrated gyroscope and getting the uncalibrated gyroscope data.
/// </summary>
public sealed class UncalibratedGyroscope : Sensor
{
/// Gets the BiasX component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> X bias </value>
+ /// <value> The X bias. </value>
public float BiasX { get; private set; } = 0;
/// <summary>
/// Gets the BiasY component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Y bias </value>
+ /// <value> The Y bias. </value>
public float BiasY { get; private set; } = 0;
/// <summary>
/// Gets the BiasZ component of the uncalibrated gyroscope data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Z bias </value>
+ /// <value> The Z bias. </value>
public float BiasZ { get; private set; } = 0;
/// <summary>
- /// Returns true or false based on whether uncalibrated gyroscope sensor is supported by device.
+ /// Returns true or false based on whether the uncalibrated gyroscope sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
}
/// <summary>
- /// Returns the number of uncalibrated gyroscope sensors available on the device.
+ /// Returns the number of the uncalibrated gyroscope sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of uncalibrated gyroscope sensors </value>
+ /// <value> The count of the uncalibrated gyroscope sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope.uncalibrated</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors.
/// </param>
public UncalibratedGyroscope(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in uncalibrated gyroscope sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated gyroscope sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
namespace Tizen.Sensor
{
/// <summary>
- /// UncalibratedMagnetometer Sensor Class. Used for registering callbacks for uncalibrated magnetometer and getting uncalibrated magnetometer data
+ /// The UncalibratedMagnetometer sensor class is used for registering callbacks for the uncalibrated magnetometer and getting the uncalibrated magnetometer data.
/// </summary>
public sealed class UncalibratedMagnetometer : Sensor
{
/// Gets the BiasX component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> X bias </value>
+ /// <value> The X bias. </value>
public float BiasX { get; private set; } = 0;
/// <summary>
/// Gets the BiasY component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Y bias </value>
+ /// <value> The Y bias. </value>
public float BiasY { get; private set; } = 0;
/// <summary>
/// Gets the BiasZ component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Z bias </value>
+ /// <value> The Z bias. </value>
public float BiasZ { get; private set; } = 0;
/// <summary>
- /// Returns true or false based on whether uncalibrated magnetometer sensor is supported by device.
+ /// Returns true or false based on whether the uncalibrated magnetometer sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of uncalibrated magnetometer sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of uncalibrated magnetometer sensors </value>
+ /// <value> The count of uncalibrated magnetometer sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.magnetometer.uncalibrated</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
/// </param>
public UncalibratedMagnetometer(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in uncalibrated magnetometer sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated magnetometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<UncalibratedMagnetometerDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
namespace Tizen.Sensor
{
/// <summary>
- /// WalkingActivityDetector Class. Used for registering callbacks for walking activity detector and getting the walking state
+ /// The WalkingActivityDetector class is used for registering callbacks for the walking activity detector and getting the walking state.
/// </summary>
public sealed class WalkingActivityDetector : ActivityDetector
{
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of walking activity detector
+ /// Gets the state of the walking activity detector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Walking state </value>
+ /// <value> The walking state. </value>
public DetectorState Walking { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether walking activity detector is supported by device.
+ /// Returns true or false based on whether the walking activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of walking activity detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of walking activity detectors </value>
+ /// <value> The count of walking activity detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in walking activity gesture detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the walking activity gesture detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<WalkingActivityDetectorDataUpdatedEventArgs> DataUpdated;
namespace Tizen.Sensor
{
/// <summary>
- /// WristUpGestureDetector Class. Used for registering callbacks for wrist up gesture detector and getting the wrist up state
+ /// The WristUpGestureDetector class is used for registering callbacks for the wrist up gesture detector and getting the wrist up state.
/// </summary>
public sealed class WristUpGestureDetector : Sensor
{
/// Gets the state of the wrist up gesture.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Wrist up state </value>
+ /// <value> The wrist up state. </value>
public DetectorState WristUp { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether wrist up gesture detector is supported by device.
+ /// Returns true or false based on whether the wrist up gesture detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of wrist up gesture detectors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of wrist up gesture detectors </value>
+ /// <value> The count of wrist up gesture detectors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.wrist_up</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
/// Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors.
/// </param>
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in wrist up gesture detector data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the wrist up gesture detector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<WristUpGestureDetectorDataUpdatedEventArgs> DataUpdated;
}
/// <summary>
- /// Sensor class for storing hardware information about a particular sensor
+ /// The Sensor class is used for storing the hardware information about a particular sensor.
/// </summary>
public abstract class Sensor : IDisposable
{
}
/// <summary>
- /// Property: For getting the name of the sensor
+ /// Property: Gets the name of the sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The name of sensor </value>
+ /// <value> The name of the sensor. </value>
public string Name
{
get
/// Property: Gets the vendor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The vendor name of sensor </value>
+ /// <value> The vendor name of the sensor. </value>
public string Vendor
{
get
}
/// <summary>
- /// Property: Gets the minimum value of range of sensor data.
+ /// Property: Gets the minimum value of the range of the sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The lower bound of range of sensor reading </value>
+ /// <value> The lower bound of the range of the sensor reading. </value>
public float MinValue
{
get
}
/// <summary>
- /// Property: Gets the maximum value of range of sensor data.
+ /// Property: Gets the maximum value of the range of the sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The upper bound of range of sensor reading </value>
+ /// <value> The upper bound of the range of the sensor reading. </value>
public float MaxValue
{
get
/// Property: Gets the resolution.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The resolution </value>
+ /// <value> The resolution. </value>
public float Resolution
{
get
/// Property: Gets the minimum interval.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The minimum update interval </value>
+ /// <value> The minimum update interval. </value>
public int MinInterval
{
get
}
/// <summary>
- /// Property: Gets the fifo count.
+ /// Property: Gets the FIFO count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The size of the hardware FIFO </value>
+ /// <value> The size of the hardware FIFO. </value>
public int FifoCount
{
get
/// Property: Gets the maximum batch count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The maximum batch count </value>
+ /// <value> The maximum batch count. </value>
public int MaxBatchCount
{
get
}
/// <summary>
- /// Sets the interval of the sensor for sensor data event
- /// Callbacks will be called at frequency of this interval
+ /// Sets the interval of the sensor for the sensor data event.
+ /// Callbacks will be called at the frequency of this interval.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <value> The interval of the sensor </value>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <value> The interval of the sensor. </value>
public uint Interval
{
set
}
/// <summary>
- /// Sets the max batch latency for the sensor corresponding to the sensor data event.
+ /// Sets the maximum batch latency for the sensor corresponding to the sensor data event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <value> The max batch latency </value>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <value> The maximum batch latency. </value>
public uint MaxBatchLatency
{
set
/// Sets the pause policy of the sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>The pause policy</value>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <value> The pause policy </value>
+ /// <value>The pause policy.</value>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <value> The pause policy. </value>
public SensorPausePolicy PausePolicy
{
set
/// Gets or sets the time span.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The time span </value>
+ /// <value> The time span. </value>
public TimeSpan TimeSpan
{
set
/// Indicates whether this sensor is sensing.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if this sensor is sensing; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if this sensor is sensing; otherwise <c>false</c>.</value>
public bool IsSensing
{
get
/// <summary>
/// Starts the sensor.
- /// After this the event handlers will start receiving events.
+ /// After this, event handlers will start receiving events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
public void Start()
{
Log.Info(Globals.LogTag, "Starting the sensor");
}
/// <summary>
- /// Stop the sensor.
- /// After this the event handlers will stop receiving the events
+ /// Stops the sensor.
+ /// After this, event handlers will stop receiving events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
public void Stop()
{
Log.Info(Globals.LogTag, "Stopping the sensor");
internal enum SensorType
{
/// <summary>
- /// All sensors. This can be used to retrieve Sensor class object for all available sensors.
+ /// All sensors. This can be used to retrieve the Sensor class object for all available sensors.
/// </summary>
All = -1,
/// <summary>
/// </summary>
OrientationSensor = 5,
/// <summary>
- /// Gyroscope sensor.
+ /// The Gyroscope sensor.
/// </summary>
Gyroscope = 6,
/// <summary>
/// </summary>
HeartRateMonitor = 13,
/// <summary>
- /// Uncalibrated Gyroscope sensor.
+ /// The Uncalibrated Gyroscope sensor.
/// </summary>
UncalibratedGyroscope = 17,
/// <summary>
/// </summary>
UncalibratedMagnetometer = 18,
/// <summary>
- /// Gyroscope-based rotation vector sensor.
+ /// The Gyroscope-based rotation vector sensor.
/// </summary>
GyroscopeRotationVectorSensor = 19,
/// <summary>
}
/// <summary>
- /// Sensor attribute.
+ /// The sensor attribute.
/// </summary>
internal enum SensorAttribute
{
}
/// <summary>
- /// SensorDataAccuracy Enum definition for all possible sensor data accuracy Values.
+ /// The SensorDataAccuracy Enum definition for all possible sensor data accuracy values.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SensorDataAccuracy
}
/// <summary>
- /// Sensor Option Enum definition for sensor option Values
+ /// The Sensor Option Enum definition for sensor option values.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SensorPausePolicy
}
/// <summary>
- /// Pedometer state.
+ /// The pedometer state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum PedometerState
}
/// <summary>
- /// Sleep monitor state.
+ /// The sleep monitor state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SleepMonitorState
}
/// <summary>
- /// Proximity sensor state.
+ /// The proximity sensor state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ProximitySensorState
}
/// <summary>
- /// Detector sensor state.
+ /// The detector sensor state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DetectorState
projects / platform / core / csapi / tizenfx.git / commitdiff