Name: csapi-tizenfx
Summary: Assemblies of Tizen .NET
-Version: 4.0.0.184
+Version: 4.0.0.194
Release: 1
Group: Development/Libraries
License: Apache-2.0
Tizen.System.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.System.Feedback.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.System.Information.dll #common #mobile #mobile-emul #tv #ivi #wearable
-Tizen.System.MediaKey.dll #common #mobile #mobile-emul #ivi #wearable
+Tizen.System.MediaKey.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.System.PlatformConfig.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.System.Storage.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.System.SystemSettings.dll #common #mobile #mobile-emul #tv #ivi #wearable
--- /dev/null
+using System;
+using System.Collections.Generic;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace ElmSharp.Wearable
+{
+ /// <summary>
+ /// RotaryEventManager serve functions for global Rotary event like Galaxy Gear.
+ /// </summary>
+ public static class RotaryEventManager
+ {
+ static Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb> s_rotaryEventHandlers = new Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb>();
+
+ /// <summary>
+ /// Rotated will triggered when rotatable device like Galaxy Gear Bezel is rotated.
+ /// </summary>
+ public static event RotaryEventHandler Rotated
+ {
+ add
+ {
+ if (s_rotaryEventHandlers.ContainsKey(value)) return;
+
+ Interop.Eext.Eext_Rotary_Handler_Cb cb = (data, infoPtr) =>
+ {
+ var info = Interop.Eext.FromIntPtr(infoPtr);
+ value.Invoke(new RotaryEventArgs
+ {
+ IsClockwise = info.Direction == Interop.Eext.Eext_Rotary_Event_Direction.Clockwise,
+ Timestamp = info.TimeStamp
+ });
+ return true;
+ };
+ Interop.Eext.eext_rotary_event_handler_add(cb, IntPtr.Zero);
+ s_rotaryEventHandlers[value] = cb;
+ }
+
+ remove
+ {
+ Interop.Eext.Eext_Rotary_Handler_Cb cb;
+ if (s_rotaryEventHandlers.TryGetValue(value, out cb))
+ {
+ Interop.Eext.eext_rotary_event_handler_del(cb);
+ s_rotaryEventHandlers.Remove(value);
+ }
+ }
+ }
+ }
+
+
+ /// <summary>
+ /// RotaryEventManager serve extension functions for Rotary event to EvasObject on device like Galaxy Gear.
+ /// </summary>
+ public static class EvasObjectExtensions
+ {
+ static Dictionary<EvasObject, RotaryEventHandler> s_rotaryObjectEventHandlers = new Dictionary<EvasObject, RotaryEventHandler>();
+ static Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb> s_rotaryObjectEventMap = new Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb>();
+
+ /// <summary>
+ /// Add a handler for Rotary event on specific EvasObject.
+ /// </summary>
+ /// <param name="obj">Target EvasObject</param>
+ /// <param name="handler">Event handler for Rotary event</param>
+ public static void AddRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
+ {
+ EnableRotaryEventHandler(obj);
+
+ if (s_rotaryObjectEventHandlers.ContainsKey(obj))
+ {
+ s_rotaryObjectEventHandlers[obj] += handler;
+ }
+ else
+ {
+ s_rotaryObjectEventHandlers[obj] = handler;
+ }
+ }
+
+ /// <summary>
+ /// Remove a handler on specific EvasObject for Rotary event.
+ /// </summary>
+ /// <param name="obj">Target EvasObject</param>
+ /// <param name="handler">Event handler for Rotary event</param>
+ public static void RemoveRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
+ {
+ if (s_rotaryObjectEventHandlers.ContainsKey(obj))
+ {
+ s_rotaryObjectEventHandlers[obj] -= handler;
+ if (s_rotaryObjectEventHandlers[obj] == null)
+ {
+ DisableRotaryEventHandler(obj, false);
+ s_rotaryObjectEventHandlers.Remove(obj);
+ }
+ }
+ }
+
+ /// <summary>
+ /// Activate this object can take Rotary event.
+ /// </summary>
+ /// <param name="obj">Target object</param>
+ public static void Activate(this EvasObject obj)
+ {
+ Interop.Eext.eext_rotary_object_event_activated_set(obj, true);
+ }
+
+ /// <summary>
+ /// Deactivate this object is blocked from Rotary event.
+ /// </summary>
+ /// <param name="obj">Target object</param>
+ public static void Deactivate(this EvasObject obj)
+ {
+ Interop.Eext.eext_rotary_object_event_activated_set(obj, false);
+ }
+
+ static void EnableRotaryEventHandler(EvasObject obj)
+ {
+ if (!s_rotaryObjectEventMap.ContainsKey(obj))
+ {
+ Interop.Eext.Eext_Rotary_Event_Cb cb = (d, o, i) =>
+ {
+ RotaryEventHandler events;
+ if (s_rotaryObjectEventHandlers.TryGetValue(obj, out events))
+ {
+ var info = Interop.Eext.FromIntPtr(i);
+ events?.Invoke(new RotaryEventArgs
+ {
+ IsClockwise = info.Direction == Interop.Eext.Eext_Rotary_Event_Direction.Clockwise,
+ Timestamp = info.TimeStamp
+ });
+ }
+ return true;
+ };
+ Interop.Eext.eext_rotary_object_event_callback_add(obj, cb, IntPtr.Zero);
+ s_rotaryObjectEventMap[obj] = cb;
+ obj.Deleted += (s, e) => DisableRotaryEventHandler(obj, true);
+ }
+ }
+
+ static void DisableRotaryEventHandler(EvasObject obj, bool removeHandler)
+ {
+ Interop.Eext.Eext_Rotary_Event_Cb cb;
+ if (s_rotaryObjectEventMap.TryGetValue(obj, out cb))
+ {
+ Interop.Eext.eext_rotary_object_event_callback_del(obj, cb);
+ s_rotaryObjectEventMap.Remove(obj);
+ }
+ if (removeHandler && s_rotaryObjectEventHandlers.ContainsKey(obj))
+ {
+ s_rotaryObjectEventHandlers.Remove(obj);
+ }
+ }
+ }
+
+ /// <summary>
+ /// Handler for Rotary event
+ /// </summary>
+ /// <param name="args">Rotary event information</param>
+ public delegate void RotaryEventHandler(RotaryEventArgs args);
+
+ /// <summary>
+ /// RotaryEventArgs serve information for triggered rotary event.
+ /// </summary>
+ public class RotaryEventArgs : EventArgs
+ {
+ /// <summary>
+ /// IsClockwise is true when Rotary device rotated clockwise direction or false on counter clockwise.
+ /// </summary>
+ public bool IsClockwise { get; set; }
+
+ /// <summary>
+ /// Timestamp of rotary event
+ /// </summary>
+ public uint Timestamp { get; set; }
+ }
+}
internal static partial class Interop
{
-
internal static partial class Eext
{
+ const short EEXT_CALLBACK_PRIORITY_AFTER = 100;
+ const short EEXT_CALLBACK_PRIORITY_BEFORE = -100;
+ const short EEXT_CALLBACK_PRIORITY_DEFAULT = 0;
+
+ internal delegate bool Eext_Rotary_Event_Cb(IntPtr data, IntPtr obj, IntPtr info);
+ internal delegate bool Eext_Rotary_Handler_Cb(IntPtr data, IntPtr info);
+
+ internal enum Eext_Rotary_Event_Direction
+ {
+ Clockwise,
+ CounterClockwise
+ }
+
+ internal struct Eext_Rotary_Event_Info
+ {
+ public Eext_Rotary_Event_Direction Direction;
+ public uint TimeStamp;
+ }
+
+ internal static Eext_Rotary_Event_Info FromIntPtr(IntPtr infoPtr)
+ {
+ var info = Marshal.PtrToStructure<Eext_Rotary_Event_Info>(infoPtr);
+ return info;
+ }
+
[DllImport(Libraries.Eext)]
internal static extern IntPtr eext_rotary_object_event_activated_set(IntPtr circleObject, bool activated);
+
+ [DllImport(Libraries.Eext)]
+ internal static extern bool eext_rotary_object_event_callback_add(IntPtr obj, Eext_Rotary_Event_Cb func, IntPtr data);
+
+ [DllImport(Libraries.Eext)]
+ internal static extern bool eext_rotary_object_event_callback_priority_add(IntPtr obj, short priority, Eext_Rotary_Event_Cb func, IntPtr data);
+
+ [DllImport(Libraries.Eext)]
+ internal static extern IntPtr eext_rotary_object_event_callback_del(IntPtr obj, Eext_Rotary_Event_Cb func);
+
+ [DllImport(Libraries.Eext)]
+ internal static extern bool eext_rotary_event_handler_add(Eext_Rotary_Handler_Cb func, IntPtr data);
+
+ [DllImport(Libraries.Eext)]
+ internal static extern IntPtr eext_rotary_event_handler_del(Eext_Rotary_Handler_Cb func);
}
}
\ No newline at end of file
{
IntPtr _nativeEventInfo;
- EvasEventFlag _eventFlags;
-
/// <summary>
/// BackButton name in Platform
/// </summary>
/// <param name="dz">The amount of degrees from 0.0 to 360.0 to rotate around Z axis</param>
/// <param name="cx">The rotation's center horizontal position</param>
/// <param name="cy">The rotation's center vertical position</param>
- /// <param name="cz">The rotation's center vertical position</param>
+ /// <param name="cz">The rotation's center depth position</param>
public void Rotate3D(double dx, double dy, double dz, int cx, int cy, int cz)
{
Interop.Evas.evas_map_util_3d_rotate(_evasMap, dx, dy, dz, cx, cy, cz);
}
/// <summary>
- /// Gets or sets the gengrid select mode by <see cref="GenGridSelectionMode"/>.
+ /// Gets or sets the gengrid select mode by <see cref="GenItemSelectionMode"/>.
/// </summary>
public GenItemSelectionMode SelectionMode
{
/// </summary>
public GenItemClass ItemClass { get; protected set; }
- /// <summary>
- /// It's a abstract property. It's implemented by <see cref="GenGridItem.TooltipContent"/> and <see cref="GenListItem.TooltipContent"/>.
- /// </summary>
public GetTooltipContentDelegate TooltipContentDelegate
{
get
}
}
+ /// <summary>
+ /// It's a abstract property.
+ /// </summary>
public abstract GenItemSelectionMode SelectionMode { get; set; }
public abstract string Cursor { get; set; }
protected abstract void UpdateTooltipDelegate();
}
-}
\ No newline at end of file
+}
/// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
/// They are defined by an event string, which identifies them uniquely.
/// </summary>
- /// <typeparam name="TEventArgs">The parameter for the event.</typeparam>
public class SmartEvent : IInvalidatable
{
private SmartEvent<EventArgs> _smartEvent;
/// <param name="label">The label of the item</param>
/// <param name="icon">A string with the icon name or the absolute path of an image file</param>
/// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
- /// <seealso cref="InsertAfter(ToolbarItem, string)"/>
public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon)
{
ToolbarItem item = new ToolbarItem(label, icon);
internal static partial class Interop
{
/// <summary>
- /// Wrapper class for maintaining names of dependent native libraries.
+ /// The Wrapper class for maintaining names of dependent native libraries.
/// </summary>
internal static partial class Libraries
{
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// Enumeration for the Sync option
+ /// Enumeration for the sync option.
/// </summary>
[Flags]
public enum SyncOption
{
/// <summary>
- /// Sync job will be operated normally
+ /// The sync job will be operated normally.
/// </summary>
None = 0,
/// <summary>
- /// Sync job will be operated as soon as possible
+ /// The sync job will be operated as soon as possible.
/// </summary>
Expedited = 0X01,
/// <summary>
- /// Sync job will not be performed again when it fails
+ /// The sync job will not be performed again when it fails.
/// </summary>
NoRetry = 0X02,
}
/// <summary>
- /// Enumeration for the Sync period
+ /// Enumeration for the sync period.
/// </summary>
public enum SyncPeriod
{
/// <summary>
- /// Sync within 30 minutes
+ /// Sync within 30 minutes.
/// </summary>
ThirtyMin = 0,
/// <summary>
- /// Sync within 1 hour
+ /// Sync within 1 hour.
/// </summary>
OneHour,
/// <summary>
- /// Sync within 2 hours
+ /// Sync within 2 hours.
/// </summary>
TwoHours,
/// <summary>
- /// Sync within 3 hours
+ /// Sync within 3 hours.
/// </summary>
ThreeHours,
/// <summary>
- /// Sync within 6 hours
+ /// Sync within 6 hours.
/// </summary>
SixHours,
/// <summary>
- /// Sync within 12 hours
+ /// Sync within 12 hours.
/// </summary>
TwelveHours,
/// <summary>
- /// Sync within 1 day
+ /// Sync within 1 day.
/// </summary>
OneDay,
}
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// The class contains the delegates to be called upon scheduling a sync operation
+ /// This class contains the delegates to be called upon scheduling a sync operation.
/// </summary>
public class SyncAdapter
{
Interop.Adapter.SyncAdapterCancelSyncCallback _cancelSyncCallback;
/// <summary>
- /// Callback function for Sync Adapter's start sync request
+ /// The callback function for the sync adapter's start sync request.
/// </summary>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
- /// <returns> true if sync operation is success, @c false otherwise. </returns>
+ /// <returns> true if the sync operation is success, @c false otherwise. </returns>
public delegate bool StartSyncCallback(SyncJobData syncParameters);
/// <summary>
- /// Callback function for Sync Adapter's cancel sync request.
+ /// The callback function for the sync adapter's cancel sync request.
/// </summary>
/// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param>
public delegate void CancelSyncCallback(SyncJobData syncParameters);
/// <summary>
- /// Sets client (Sync Adapter) callback functions
+ /// Sets the client (sync adapter) callback functions.
/// </summary>
- /// <param name="startSyncCb"> A callback function to be called by Sync Manager for performing sync operation. </param>
- /// <param name="cancelSyncCb"> A callback function to be called by Sync Manager for cancelling sync operation. </param>
+ /// <param name="startSyncCb"> A callback function to be called by the sync manager for performing the sync operation. </param>
+ /// <param name="cancelSyncCb"> A callback function to be called by the sync manager for cancelling the sync operation. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API cannot be a sync adapter. </exception>
public void SetSyncEventCallbacks(StartSyncCallback startSyncCb, CancelSyncCallback cancelSyncCb)
}
/// <summary>
- /// Unsets client (Sync Adapter) callback functions
+ /// Unsets the client (sync adapter) callback functions.
/// </summary>
/// <exception cref="System.Exception"> Thrown when sync manager internal error occurs. </exception>
public void UnsetSyncEventCallbacks()
{
/// <summary>
/// The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations.
- /// Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
+ /// The sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations.
/// </summary>
public static class SyncClient
{
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
static SyncClient()
{
}
/// <summary>
- /// Requests Sync Manager to perform one time sync operation
+ /// Requests the sync manager to perform one time sync operation.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <exception cref="ArgumentNullException"> Thrown when any of the arugments are null. </exception>
- /// <exception cref="InvalidOperationException"> Thrown when the application calling this api doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
+ /// <returns> An unique value which can manage sync jobs. The number of sync job ID is limite as it is less than hundred. </returns>
public static int RequestOnDemandSyncJob(SyncJobData request, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Requests Sync Manager to perform periodic sync operations
+ /// Requests the sync manager to perform periodic sync operations.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="period"> Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="period"> Determines the time interval of the periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee the exact time. The minimum value is 30 minutes. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <privilege>http://tizen.org/privilege/alarm.set</privilege>
- /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception>
+ /// <exception cref="UnauthorizedAccessException"> In case of a privilege not defined. </exception>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns>
public static int AddPeriodicSyncJob(SyncJobData request, SyncPeriod period, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Requests Sync Manager to perform sync operations whenever corresponding DB changed
+ /// Requests the sync manager to perform sync operations whenever the corresponding DB is changed.
/// </summary>
- /// <param name="request"> Sync job information of the sync job request. </param>
- /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param>
+ /// <param name="request"> The sync job information of the sync job request. </param>
+ /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
/// <privilege>http://tizen.org/privilege/contact.read</privilege>
- /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception>
+ /// <exception cref="UnauthorizedAccessException"> In case of a privilege is not defined. </exception>
/// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception>
/// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception>
- /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns>
+ /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns>
public static int AddDataChangeSyncJob(SyncJobData request, SyncOption syncOptions)
{
if (request == null || request.SyncJobName == null)
}
/// <summary>
- /// Get all the sync jobs registered with the sync manager
+ /// Gets all the sync jobs registered with the sync manager.
/// </summary>
/// <returns>
/// Returns the list of SyncJobData corresponding to sync requests.
}
/// <summary>
- /// Requests Sync Manager to remove corresponding sync job job based on id
+ /// Requests the sync manager to remove the corresponding sync job based on the ID.
/// </summary>
- /// <param name="id"> A unique value of each sync job, it can be used to search specific sync job and remove it. </param>
+ /// <param name="id"> A unique value of each sync job, it can be used to search a specific sync job and remove it. </param>
/// <exception cref="ArgumentException"> Thrown if the input arugments is invalid. </exception>
public static void RemoveSyncJob(int id)
{
namespace Tizen.Account.SyncManager
{
/// <summary>
- /// Class represents information about a sync job request
+ /// This class represents information about the sync job request.
/// </summary>
public class SyncJobData
{
/// <summary>
- /// Represents calendar capability
+ /// Represents the calendar capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the calendar database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string CalendarCapability = "http://tizen.org/sync/capability/calendar";
/// <summary>
- /// Represents contact capability
+ /// Represents the contact capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the contact database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string ContactCapability = "http://tizen.org/sync/capability/contact";
/// <summary>
- /// Represents image capability
+ /// Represents the image capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the image database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string ImageCapability = "http://tizen.org/sync/capability/image";
/// <summary>
- /// Represents video capability
+ /// Represents the video capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the video database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string VideoCapability = "http://tizen.org/sync/capability/video";
/// <summary>
- /// Represents sound capability
+ /// Represents the sound capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the sound database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string SoundCapability = "http://tizen.org/sync/capability/sound";
/// <summary>
- /// Represents music capability
+ /// Represents the music capability.
/// </summary>
/// <remarks>
- /// If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object.
+ /// If you want to receive notification about the music database change, assign it to the SyncJobName property of the SyncJobData object.
/// </remarks>
public const string MusicCapability = "http://tizen.org/sync/capability/music";
/// <summary>
- /// The account instance on which sync operation was requested or @c null in the case of accountless sync operation
+ /// The account instance on which the sync operation was requested or @c null in the case of the accountless sync operation.
/// </summary>
public AccountManager.Account Account { get; set; }
/// <summary>
- /// User data which contains additional information related registered sync job
+ /// User data which contains an additional information related to the registered sync job.
/// </summary>
public Bundle UserData { get; set; }
/// <summary>
- /// A string representing a sync job which has been operated or capability setting to operate data change sync job
+ /// A string representing a sync job which has been operated or capability setting to operate the data change sync job.
/// </summary>
public string SyncJobName { get; set; }
}
/// <summary>
/// Gets the name of application.
/// </summary>
- public string AppId { get; internal set; } = string.Empty;
+ public string AppId { get; internal set; }
/// <summary>
/// Gets the specific information for creating a new shortcut.
/// </summary>
- public string Uri { get; internal set; } = string.Empty;
+ public string Uri { get; internal set; }
}
}
\ No newline at end of file
/// <summary>
/// Gets the name of the created shortcut icon.
/// </summary>
- public string ShortcutName { get; internal set; } = string.Empty;
+ public string ShortcutName { get; internal set; }
/// <summary>
/// Gets the absolute path of an icon file for this shortcut.
/// </summary>
- public string IconPath { get; internal set; } = string.Empty;
+ public string IconPath { get; internal set; }
/// <summary>
/// Gets a value indicating whether to allow or not to allow duplication.
/// <summary>
/// Gets the name of package.
/// </summary>
- public string AppId { get; internal set; } = string.Empty;
+ public string AppId { get; internal set; }
/// <summary>
/// Gets the name of the created shortcut icon.
/// </summary>
- public string ShortcutName { get; internal set; } = string.Empty;
+ public string ShortcutName { get; internal set; }
}
}
\ No newline at end of file
/// <summary>
/// Gets the Application ID.
/// </summary>
- public string AppId { get; internal set; } = string.Empty;
+ public string AppId { get; internal set; }
/// <summary>
/// Gets the name of the created shortcut icon.
/// </summary>
- public string ShortcutName { get; internal set; } = string.Empty;
+ public string ShortcutName { get; internal set; }
/// <summary>
/// Gets the absolute path of an icon file for this shortcut.
/// </summary>
- public string IconPath { get; internal set; } = string.Empty;
+ public string IconPath { get; internal set; }
/// <summary>
/// Gets the user data. A property of shortcut element in manifest file.
/// </summary>
- public string ExtraKey { get; internal set; } = string.Empty;
+ public string ExtraKey { get; internal set; }
/// <summary>
/// Gets the user data. A property of shortcut element in manifest file.
/// </summary>
- public string ExtraData { get; internal set; } = string.Empty;
+ public string ExtraData { get; internal set; }
}
}
\ No newline at end of file
/// <summary>
/// Gets the Widget ID.
/// </summary>
- public string WidgetId { get; internal set; } = string.Empty;
+ public string WidgetId { get; internal set; }
/// <summary>
/// Gets the size of widget.
{
var tcs = new TaskCompletionSource<bool>();
- using (var cbKeeper = ObjectKeeper.Get(GetScanCompletedCallback(tcs)))
+ using (var cbKeeper = ObjectKeeper.Get(GetScanCompletedCallback(tcs, cancellationToken)))
using (RegisterCancellationAction(tcs, folderPath, cancellationToken))
{
-
Interop.Content.ScanFolder(folderPath, recursive, cbKeeper.Target)
.ThrowIfError("Failed to scan");
}
}
- private static Interop.Content.MediaScanCompletedCallback GetScanCompletedCallback(TaskCompletionSource<bool> tcs)
+ private static Interop.Content.MediaScanCompletedCallback GetScanCompletedCallback(TaskCompletionSource<bool> tcs,
+ CancellationToken cancellationToken)
{
return (scanResult, _) =>
{
if (scanResult == MediaContentError.None)
{
- tcs.TrySetResult(true);
+ if (cancellationToken.IsCancellationRequested)
+ {
+ tcs.TrySetCanceled();
+ }
+ else
+ {
+ tcs.TrySetResult(true);
+ }
}
else
{
}
Interop.Content.CancelScanFolder(folderPath).ThrowIfError("Failed to cancel scanning");
- tcs.TrySetCanceled();
});
}
/// <since_tizen> 3 </since_tizen>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public string Nmea
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int ActiveCount
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int InViewCount
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public IList<SatelliteInformation> Satellites
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
{
/// The azimuth information of the satellite.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Azimuth { get; private set; }
/// <summary>
/// The elevation information of the satellite.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Elevation { get; private set; }
/// <summary>
/// The PRN of the satellite.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Prn { get; private set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public bool EnableMock
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Start()
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void SetMockLocation(Location location)
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void ClearMock()
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Task<Location> GetLocationAsync(int timeout)
{
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <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="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Location GetLocation()
{
/// The class constructor for the SettingChangedEventArgs class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="method">The positioing method used for the location information.</param>
+ /// <param name="type">The positioing method used for the location information.</param>
/// <param name="enable">The status of the method.</param>
public SettingChangedEventArgs(LocationType type, bool enable)
{
}
/// <summary>
- /// The camera class provides methods to capture photos and support setting up notifications
- /// for state changes of capturing, previewing, focusing, information about resolution and binary format
- /// and functions for picture manipulations like sepia negative and many more.
- /// It also notifies you when a significant picture parameter changes e.g. focus.
+ /// This camera class provides methods to capture photos and supports setting up notifications
+ /// for state changes of capturing, previewing, focusing, and informing about the resolution and the binary format,
+ /// and functions for picture manipulations like sepia, negative, and many more.
+ /// It also notifies you when a significant picture parameter changes, (For example, focus).
/// </summary>
public class Camera : IDisposable, IDisplayable<CameraError>
{
private CameraState _state = CameraState.None;
/// <summary>
- /// Initializes a new instance of the <see cref="Camera"/> Class.
+ /// Initializes a new instance of the <see cref="Camera"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The camera device to access</param>
+ /// <param name="device">The camera device to access.</param>
public Camera(CameraDevice device)
{
CameraErrorFactory.ThrowIfError(Native.Create(device, out _handle),
#region Dispose support
/// <summary>
- /// Releases the unmanaged resources used by the Camera.
+ /// Releases the unmanaged resources used by the camera.
/// </summary>
/// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Releases all resources used by the Camera.
+ /// Releases all resources used by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
#region EventHandlers
/// <summary>
- /// Event that occurs when the camera interrupt is started by policy.
+ /// An event that occurs when the camera interrupt is started by the policy.
/// </summary>
public event EventHandler<CameraInterruptStartedEventArgs> InterruptStarted;
private Native.InterruptStartedCallback _interruptStartedCallback;
/// <summary>
- /// Event that occurs when an camera is interrupted by policy.
+ /// An event that occurs when an camera is interrupted by the policy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraInterruptedEventArgs> Interrupted;
private Native.InterruptedCallback _interruptedCallback;
/// <summary>
- /// Event that occurs when there is an asynchronous error.
+ /// An event that occurs when there is an asynchronous error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraErrorOccurredEventArgs> ErrorOccurred;
private Native.ErrorCallback _errorCallback;
/// <summary>
- /// Event that occurs when the auto focus state is changed.
+ /// An event that occurs when the auto focus state is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraFocusStateChangedEventArgs> FocusStateChanged;
private Native.FocusStateChangedCallback _focusStateChangedCallback;
/// <summary>
- /// Event that occurs when a face is detected in preview frame.
+ /// An event that occurs when a face is detected in the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<FaceDetectedEventArgs> FaceDetected;
private Native.FaceDetectedCallback _faceDetectedCallback;
/// <summary>
- /// Event that occurs during capture of image.
+ /// An event that occurs during capture of an image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraCapturingEventArgs> Capturing;
private Native.CapturingCallback _capturingCallback;
/// <summary>
- /// Event that occurs after the capture of the image.
+ /// An event that occurs after the capture of the image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<EventArgs> CaptureCompleted;
private object _hdrCaptureProgressEventLock = new object();
/// <summary>
- /// Event that occurs when there is change in HDR capture progress.
- /// Check whether <see cref="CameraCapabilities.IsHdrCaptureSupported"/> is supported or not before add this EventHandler.
+ /// An event that occurs when there is a change in the HDR capture progress.
+ /// Checks whether the <see cref="CameraCapabilities.IsHdrCaptureSupported"/> is supported or not before adding this EventHandler.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="NotSupportedException">In case of HDR feature is not supported.</exception>
}
/// <summary>
- /// Event that occurs when camera state is changed.
+ /// An event that occurs when the camera state is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<CameraStateChangedEventArgs> StateChanged;
private static int _deviceStateCallbackId;
/// <summary>
- /// Event that occurs after the <see cref="CameraDeviceState"/> is changed.
+ /// An event that occurs after the <see cref="CameraDeviceState"/> is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
private event EventHandler<PreviewEventArgs> _preview;
private object _previewEventLock = new object();
/// <summary>
- /// Event that occurs once per frame when previewing.
- /// Preview callback is registered when user add callback explicitly to avoid useless P/Invoke.
+ /// An event that occurs once per frame when previewing.
+ /// Preview callback is registered when an user adds a callback explicitly to avoid useless P/Invoke.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<PreviewEventArgs> Preview
private object _mediaPacketPreviewEventLock = new object();
/// <summary>
- /// Event that occurs once per frame when previewing.
- /// Preview callback is registered when user add callback explicitly to avoid useless P/Invoke.
+ /// An event that occurs once per frame when previewing.
+ /// Preview callback is registered when an user adds a callback explicitly to avoid useless P/Invoke.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<MediaPacketPreviewEventArgs> MediaPacketPreview
#region Properties
/// <summary>
- /// Get/Set the various camera settings.
+ /// Gets or sets the various camera settings.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraSettings Settings { get; }
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// This must be set before StartPreview() method.
- /// In Custom ROI display mode, DisplayRoiArea property must be set before calling this method.
+ /// This must be set before the StartPreview() method.
+ /// In custom ROI display mode, DisplayRoiArea property must be set before calling this method.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public Display Display
{
/// Gets the state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> None, Created, Preview, Capturing, Captured </value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value> None, Created, Preview, Capturing, Captured.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraState State
{
get
}
/// <summary>
- /// The hint for display reuse.
+ /// The hint for the display reuse.
/// If the hint is set to true, the display will be reused when the camera device is changed with
- /// ChangeDevice method.
+ /// the ChangeDevice method.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="InvalidOperationException">Invalid state.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="InvalidOperationException">An invalid state.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool DisplayReuseHint
{
get
}
/// <summary>
- /// Gets the facing direction of camera module.
+ /// Gets the facing direction of the camera module.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFacingDirection"/> that specifies the facing direction of camera device.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFacingDirection"/> that specifies the facing direction of the camera device.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFacingDirection Direction
{
get
/// <since_tizen> 3 </since_tizen>
/// <value>This returns 2, if the device supports primary and secondary cameras.
/// Otherwise 1, if the device only supports primary camera.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int CameraCount
{
get
/// </remarks>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="NotSupportedException">In case of ChangeDevice feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="NotSupportedException">In case of the ChangeDevice feature is not supported.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void ChangeDevice(CameraDevice device)
{
ValidateState(CameraState.Created);
/// Gets the device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The device to get state.</param>
- /// <returns>Returns the state of camera device</returns>
+ /// <param name="device">The device to get the state.</param>
+ /// <returns>Returns the state of the camera device.</returns>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
/// Gets the flash state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="device">The device to get state.</param>
- /// <returns>Returns the flash state of camera device</returns>
+ /// <param name="device">The device to get the state.</param>
+ /// <returns>Returns the flash state of the camera device.</returns>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
/// If needed set fps <see cref="CameraSettings.PreviewFps"/>, preview resolution
/// <see cref="CameraSettings.PreviewResolution"/>, or preview format <see cref="CameraSettings.PreviewPixelFormat"/>
/// before using this method.
- /// The camera must be in the <see cref="CameraState.Created"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Created"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartPreview()
{
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopPreview()
{
/// http://tizen.org/privilege/camera
/// </privilege>
/// <remarks>
- /// This function causes the transition of the camera state from Capturing to Captured
+ /// This function causes the transition of the camera state from capturing to captured
/// automatically and the corresponding EventHandlers will be invoked.
- /// The preview should be restarted by calling <see cref="StartPreview"/> method after capture is completed.
+ /// The preview should be restarted by calling the <see cref="StartPreview"/> method after capture is completed.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartCapture()
{
/// <param name="cancellationToken">The cancellation token to cancel capturing.</param>
/// <seealso cref="CancellationToken"/>
/// <remarks>
- /// If this is not supported zero shutter lag occurs. The capture resolution could be
+ /// If this is not supported, zero shutter lag occurs. The capture resolution could be
/// changed to the preview resolution. This function causes the transition of the camera state
- /// from Capturing to Captured automatically and the corresponding Eventhandlers will be invoked.
- /// Each captured image will be delivered through Eventhandler set using <see cref="Capturing"/> event.
- /// The preview should be restarted by calling <see cref="StartPreview"/> method after capture is completed.
+ /// from capturing to captured automatically and the corresponding Eventhandlers will be invoked.
+ /// Each captured image will be delivered through Eventhandler set using the <see cref="Capturing"/> event.
+ /// The preview should be restarted by calling the <see cref="StartPreview"/> method after capture is completed.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartCapture(int count, int interval, CancellationToken cancellationToken)
{
/// <summary>
/// Starts camera auto-focusing, asynchronously.
- /// The camera must be in the <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Preview"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="continuous">Continuous auto focus</param>
+ /// <param name="continuous">Continuous auto focus.</param>
/// <privilege>
/// http://tizen.org/privilege/camera
/// </privilege>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartFocusing(bool continuous)
{
/// <summary>
/// Stops camera auto focusing.
- /// The camera must be in the <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/> state.
+ /// The camera must be in the <see cref="CameraState.Preview"/> or the <see cref="CameraState.Captured"/> state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopFocusing()
{
/// </privilege>
/// <remarks>
/// This should be called after <see cref="StartPreview"/> is started.
- /// The Eventhandler set using <see cref="FaceDetected"/> invoked when the face is detected in preview frame.
- /// Internally it starts continuous focus and focusing on the detected face.
+ /// The Eventhandler set using <see cref="FaceDetected"/> is invoked when the face is detected in the preview frame.
+ /// Internally, it starts continuously focus and focusing on the detected face.
/// </remarks>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StartFaceDetection()
{
/// </privilege>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
/// <exception cref="UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
public void StopFaceDetection()
{
/// <summary>
/// Gets the face detection feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsFaceDetectionSupported { get; }
/// <summary>
/// Gets the media packet preview callback feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsMediaPacketPreviewCallbackSupported { get; }
/// <summary>
/// Gets the zero shutter lag feature's supported state.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsZeroShutterLagSupported { get; }
/// <summary>
- /// Gets continuous capture feature's supported state.
- /// true if supported, otherwise false.
+ /// Gets the continuous capture feature's supported state.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsContinuousCaptureSupported { get; }
/// <summary>
- /// Gets the support state of HDR capture.
- /// true if supported, otherwise false.
+ /// Gets the support state of the HDR capture.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsHdrCaptureSupported { get; }
/// <summary>
/// Gets the support state of the anti-shake feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsAntiShakeSupported { get; }
/// <summary>
/// Gets the support state of the video stabilization feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsVideoStabilizationSupported { get; }
/// <summary>
/// Gets the support state of auto contrast feature.
- /// true if supported, otherwise false.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsAutoContrastSupported { get; }
/// <summary>
- /// Gets the support state of brightness feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the brightness feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsBrigtnessSupported { get; }
/// <summary>
- /// Gets the support state of exposure feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the exposure feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsExposureSupported { get; }
/// <summary>
- /// Gets the support state of zoom feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the zoom feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsZoomSupported { get; }
/// <summary>
- /// Gets the support state of pan feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the pan feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsPanSupported { get; }
/// <summary>
- /// Gets the support state of tilt feature.
- /// true if supported, otherwise false.
+ /// Gets the support state of the tilt feature.
/// </summary>
+ /// <value>true if supported, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
public bool IsTiltSupported { get; }
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported preview resolutions.
- /// by recorder.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Size> SupportedPreviewResolutions
{
get
/// <returns>
/// It returns a list containing all the supported capture resolutions.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Size> SupportedCaptureResolutions
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPixelFormat"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPixelFormat> SupportedCapturePixelFormats
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPixelFormat"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPixelFormat> SupportedPreviewPixelFormats
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> SupportedPreviewFps
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/> by resolution.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> GetSupportedPreviewFpsByResolution(int width, int height)
{
return GetSupportedPreviewFpsByResolutions(width, height);
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFps"/> by resolution.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFps> GetSupportedPreviewFpsByResolution(Size size)
{
return GetSupportedPreviewFpsByResolutions(size.Width, size.Height);
/// <returns>
/// It returns a list containing all the supported <see cref="CameraAutoFocusMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraAutoFocusMode> SupportedAutoFocusModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraExposureMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraExposureMode> SupportedExposureModes
{
get
}
/// <summary>
- /// Retrieves all the Iso level supported by the camera.
+ /// Retrieves all the ISO levels supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraIsoLevel"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraIsoLevel> SupportedIsoLevels
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraTheaterMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraTheaterMode> SupportedTheaterModes
{
get
}
/// <summary>
- /// Retrieves all the whitebalance modes supported by the camera.
+ /// Retrieves all the white balance modes supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraWhiteBalance"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraWhiteBalance> SupportedWhiteBalances
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraFlashMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraFlashMode> SupportedFlashModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraSceneMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraSceneMode> SupportedSceneModes
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="CameraEffectMode"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraEffectMode> SupportedEffects
{
get
}
/// <summary>
- /// Retrieves all the stream rotation supported by the camera.
+ /// Retrieves all the stream rotations supported by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// An IEnumerable containing all the supported <see cref="Rotation"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Rotation> SupportedStreamRotations
{
get
/// <returns>
/// It returns a list containing all the supported <see cref="Flips"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<Flips> SupportedStreamFlips
{
get
}
/// <summary>
- /// Retrieves all the ptz types by the camera.
+ /// Retrieves all the PTZ types by the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
/// It returns a list containing all the supported <see cref="CameraPtzType"/>.
/// </returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public IEnumerable<CameraPtzType> SupportedPtzTypes
{
get
public StillImage MainImage { get; }
/// <summary>
- /// The image data of the postview.
+ /// The image data of the post view.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public StillImage PostView { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
+ /// An extended EventArgs class which contains details about the previous and the current state
/// of the camera when its state is changed.
/// </summary>
public class CameraDeviceStateChangedEventArgs : EventArgs
}
/// <summary>
- /// Camera device type.
+ /// The camera device type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraDevice Device { get; }
/// <summary>
- /// Current state of the camera device.
+ /// The current state of the camera device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraDeviceState State { get; }
{
/// <summary>
/// The CameraDisplay class allows you to manage display for the camera.
- /// It allows to set and get various display properties such as
- /// rotation, display visibility and display mode.
+ /// It allows to set and get various display properties, such as
+ /// rotation, display visibility, and display mode.
/// </summary>
public class CameraDisplaySettings
{
/// </remarks>
/// <value>A <see cref="CameraDisplayMode"/> that specifies the display mode.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public CameraDisplayMode Mode
{
get
/// <summary>
/// The display visibility.
- /// True if camera display visible, otherwise false.
/// </summary>
+ /// <value>true if camera display is visible, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public bool Visible
{
get
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
- /// <value>A <see cref="Rotation"/> that specifies the rotation of camera device.</value>
+ /// <value>A <see cref="Rotation"/> that specifies the rotation of the camera device.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Rotation Rotation
{
get
/// <remarks>
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
- /// <value>A <see cref="Flips"/> that specifies camera flip type.</value>
+ /// <value>A <see cref="Flips"/> that specifies the camera flip type.</value>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Flips Flip
{
get
/// This property is meaningful only in overlay or EVAS surface display type.
/// </remarks>
/// <exception cref="InvalidOperationException">Display type is incorrect.</exception>
- /// <exception cref="ObjectDisposedException" > The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException" > The camera already has been disposed of.</exception>
public Rectangle RoiArea
{
get
namespace Tizen.Multimedia
{
/// <summary>
- /// Enumeration for Camera device.
+ /// Enumeration for the camera device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraDevice
{
/// <summary>
- /// Rear Camera device.
+ /// The rear camera device.
/// </summary>
Rear,
/// <summary>
- /// Front Camera device.
+ /// The front camera device.
/// </summary>
Front
}
/// <summary>
- /// Enumeration for Camera device state.
+ /// Enumeration for the camera device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraDeviceState
/// </summary>
Opened,
/// <summary>
- /// Now previewing or capturing or is being used for video recording.
+ /// Now previewing or capturing or is being used for the video recording.
/// </summary>
Working
}
/// <summary>
- /// Enumeration for the facing direction of camera module .
+ /// Enumeration for the facing direction of camera module.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraFacingDirection
/// </summary>
Rear,
/// <summary>
- /// Front direction
+ /// Front direction.
/// </summary>
Front
}
public enum CameraFlashState
{
/// <summary>
- /// Flash is not used now through camera API.
+ /// Flash is not used now through the camera API.
/// </summary>
NotUsed,
/// <summary>
- /// Flash is used now through camera API.
+ /// Flash is used now through the camera API.
/// </summary>
Used
}
/// </summary>
Released,
/// <summary>
- /// Focus in progress
+ /// Focus in progress.
/// </summary>
Ongoing,
/// <summary>
- /// Focus succeeded
+ /// Focus succeeded.
/// </summary>
Focused,
/// <summary>
/// </summary>
Nv12,
/// <summary>
- /// NV12 Tiled pixel format.
+ /// NV12 tiled pixel format.
/// </summary>
Nv12t,
/// <summary>
/// </summary>
None,
/// <summary>
- /// Security policy
+ /// Security policy.
/// </summary>
Security = 4,
/// <summary>
- /// Resource conflict
+ /// Resource conflict.
/// </summary>
ResourceConflict
}
}
/// <summary>
- /// Enumeration for the auto focus mode.
+ /// Enumeration for the auto-focus mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraAutoFocusMode
{
/// <summary>
- /// auto-focus is not set.
+ /// Auto-focus is not set.
/// </summary>
None,
/// <summary>
- /// auto-focus in the normal mode.
+ /// Auto-focus is in the normal mode.
/// </summary>
Normal,
/// <summary>
- /// auto-focus in the macro mode(close distance).
+ /// Auto-focus is in the macro mode (close distance).
/// </summary>
Macro,
/// <summary>
- /// auto-focus in the full mode(all range scan, limited by device spec).
+ /// Auto-focus is in the full mode (all range scan, limited by device spec).
/// </summary>
Full
}
/// </summary>
VintageWarm,
/// <summary>
- /// Vintage cold .
+ /// Vintage cold.
/// </summary>
VintageCold,
/// <summary>
/// </summary>
Cartoon,
/// <summary>
- /// Selective color - Red.
+ /// Selective color - red.
/// </summary>
SelectiveRed,
/// <summary>
- /// Selective color - Green.
+ /// Selective color - green.
/// </summary>
SelectiveGreen,
/// <summary>
- /// Selective color - Blue.
+ /// Selective color - blue.
/// </summary>
SelectiveBlue,
/// <summary>
- /// Selective color - Yellow.
+ /// Selective color - yellow.
/// </summary>
SelectiveYellow,
/// <summary>
- /// Selective color - Red and Yellow.
+ /// Selective color - red and yellow.
/// </summary>
SelectiveRedYellow,
/// <summary>
- /// Other Graphic effects.
+ /// Other graphic effects.
/// </summary>
OtherGraphics
}
}
/// <summary>
- /// Enumeration for preview FPS.
+ /// Enumeration for the preview fps.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraFps
{
/// <summary>
- /// Auto FPS.
+ /// Auto fps.
/// </summary>
Auto = 0,
/// <summary>
- /// 7 FPS.
+ /// 7 fps.
/// </summary>
Fps7 = 7,
/// <summary>
- /// 8 FPS.
+ /// 8 fps.
/// </summary>
Fps8 = 8,
/// <summary>
- /// 15 FPS.
+ /// 15 fps.
/// </summary>
Fps15 = 15,
/// <summary>
- /// 20 FPS.
+ /// 20 fps.
/// </summary>
Fps20 = 20,
/// <summary>
- /// 24 FPS.
+ /// 24 fps.
/// </summary>
Fps24 = 24,
/// <summary>
- /// 25 FPS.
+ /// 25 fps.
/// </summary>
Fps25 = 25,
/// <summary>
- /// 30 FPS.
+ /// 30 fps.
/// </summary>
Fps30 = 30,
/// <summary>
- /// 60 FPS.
+ /// 60 fps.
/// </summary>
Fps60 = 60,
/// <summary>
- /// 90 FPS.
+ /// 90 fps.
/// </summary>
Fps90 = 90,
/// <summary>
- /// 120 FPS.
+ /// 120 fps.
/// </summary>
Fps120 = 120
}
/// <summary>
- /// Enumeration for HDR capture mode.
+ /// Enumeration for the HDR capture mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraHdrMode
{
/// <summary>
- /// Disable HDR capture.
+ /// Disable the HDR capture.
/// </summary>
Disable,
/// <summary>
- /// Enable HDR capture.
+ /// Enable the HDR capture.
/// </summary>
Enable,
/// <summary>
- /// Enable HDR capture and keep original image data.
+ /// Enable the HDR capture mode and keep original image data.
/// </summary>
KeepOriginal
}
}
/// <summary>
- /// Enumeration for PTZ(Pan Tilt Zoom) movement type.
+ /// Enumeration for the PTZ(Pan Tilt Zoom) movement type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraPtzMoveType
/// </summary>
Absoulute,
/// <summary>
- /// Move a specific distance from the current position.
+ /// Move to a specific distance from the current position.
/// </summary>
Relative
}
/// <summary>
- /// Enumeration for PTZ(Pan Tilt Zoom) type.
+ /// Enumeration for the PTZ(Pan Tilt Zoom) type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraPtzType
/// </summary>
Sports,
/// <summary>
- /// Party & Indoor.
+ /// Party and indoor.
/// </summary>
PartyAndIndoor,
/// <summary>
- /// Beach & Indoor.
+ /// Beach and indoor.
/// </summary>
BeachAndIndoor,
/// <summary>
/// </summary>
Sunset,
/// <summary>
- /// Dusk & Dawn.
+ /// Dusk and dawn.
/// </summary>
DuskAndDawn,
/// <summary>
public enum CameraTagOrientation
{
/// <summary>
- /// Row #0 is at the top, Column #0 is to the left.
+ /// Row #0 is at the top, column #0 is to the left.
/// </summary>
TopLeft = 1,
/// <summary>
- /// Row #0 is at the top, Column #0 is to the right.
+ /// Row #0 is at the top, column #0 is to the right.
/// </summary>
TopRight = 2,
/// <summary>
- /// Row #0 is at the bottom, Column #0 is to the right.
+ /// Row #0 is at the bottom, column #0 is to the right.
/// </summary>
BottomRight = 3,
/// <summary>
- /// Row #0 is at the bottom, Column #0 is to the left.
+ /// Row #0 is at the bottom, column #0 is to the left.
/// </summary>
BottomLeft = 4,
/// <summary>
- /// Row #0 is at the left, Column #0 is to the top.
+ /// Row #0 is at the left, column #0 is to the top.
/// </summary>
LeftTop = 5,
/// <summary>
- /// Row #0 is at the right, Column #0 is to the top.
+ /// Row #0 is at the right, column #0 is to the top.
/// </summary>
RightTop = 6,
/// <summary>
- /// Row #0 is at the right, Column #0 is to the bottom.
+ /// Row #0 is at the right, column #0 is to the bottom.
/// </summary>
RightBottom = 7,
/// <summary>
- /// Row #0 is at the left, Column #0 is to the bottom.
+ /// Row #0 is at the left, column #0 is to the bottom.
/// </summary>
LeftBottom = 8
}
public enum CameraTheaterMode
{
/// <summary>
- /// Disable theater mode - External display shows same image as device display.
+ /// Disable the theater mode - the external display shows same image as the device display.
/// </summary>
Disable,
/// <summary>
- /// Clone mode - Preview image is displayed on external display with full screen mode. Also preview image is shown by the UI on device display.
+ /// Clone the mode - the preview image is displayed on an external display with full screen mode. Also, the preview image is shown by the UI on the device display.
/// </summary>
Clone,
/// <summary>
- /// Enable theater mode - Preview image is displayed on external display with full screen mode, but preview image is not shown on device display.
+ /// Enable the theater mode - the preview image is displayed on an external display with full screen mode, but the preview image is not shown on the device display.
/// </summary>
Enable
}
/// <summary>
- ///Enumeration for the white balance levels of the camera.
+ /// Enumeration for the white balance levels of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraWhiteBalance
/// </summary>
LetterBox,
/// <summary>
- /// Origin size.
+ /// Original size.
/// </summary>
OriginSize,
/// <summary>
}
/// <summary>
- /// Enumeration for camera failure error.
+ /// Enumeration for the camera failure error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CameraErrorCode
}
/// <summary>
- /// Enumeration for Image datatype.
+ /// Enumeration for the image datatype.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum PlaneType
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about error status and
- /// state of the camera when it failed.
+ /// An extended EventArgs class which contains details about the error status and the
+ /// state of the camera when it fails.
/// </summary>
public class CameraErrorOccurredEventArgs : EventArgs
{
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about focus state of the
- /// camera.
+ /// An extended EventArgs class which contains details about the focus state of the camera.
/// </summary>
public class CameraFocusStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Focus state of the camera.
+ /// The focus state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraFocusState State { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
- /// of the camera when its interrupted.
+ /// An extended EventArgs class which contains details about the previous and the current state
+ /// of the camera when it is interrupted.
/// </summary>
public class CameraInterruptedEventArgs : EventArgs
{
}
/// <summary>
- /// Previous state of the camera.
+ /// The previous state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Previous { get; }
/// <summary>
- /// Current state of the camera.
+ /// The current state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Current { get; }
#region Auto Focus
/// <summary>
- /// Sets auto focus area.
+ /// Sets the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// <see cref="CameraAutoFocusMode"/> should not be the <see cref="CameraAutoFocusMode.None"/>.
/// </remarks>
- /// <param name="x">X position</param>
- /// <param name="y">Y position</param>
+ /// <param name="x">X position.</param>
+ /// <param name="y">Y position.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetAutoFocusArea(int x, int y)
{
CameraErrorFactory.ThrowIfError(Native.SetAutoFocusArea(_camera.GetHandle(), x, y),
}
/// <summary>
- /// Sets auto focus area.
+ /// Sets the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// <see cref="CameraAutoFocusMode"/> should not be the <see cref="CameraAutoFocusMode.None"/>.
/// </remarks>
- /// <param name="pos"><see cref="Point"/> structure including X, Y position</param>
+ /// <param name="pos"><see cref="Point"/> structure including X, Y position.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
/// <exception cref="InvalidOperationException">In case of any invalid operations.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetAutoFocusArea(Point pos)
{
CameraErrorFactory.ThrowIfError(Native.SetAutoFocusArea(_camera.GetHandle(), pos.X, pos.Y),
/// Clears the auto focus area.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void ClearFocusArea()
{
CameraErrorFactory.ThrowIfError(Native.ClearAutoFocusArea(_camera.GetHandle()),
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraAutoFocusMode"/> that specifies the auto focus mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraAutoFocusMode AutoFocusMode
{
get
/// The contrast level of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Contrast
{
get
/// If true auto contrast is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool AutoContrast
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the mininum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ContrastRange
/// The brightness level of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Brightness
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range BrightnessRange
/// The exposure value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int Exposure
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraExposureMode"/> that specifies the exposure mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraExposureMode ExposureMode
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ExposureRange
#region Zoom
/// <summary>
/// The zoom level.
- /// The range for zoom level is received from ZoomRange property.
+ /// The range for the zoom level is received from the ZoomRange property.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int ZoomLevel
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range ZoomRange
#endregion Zoom
/// <summary>
- /// The whitebalance mode.
+ /// The white balance mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraWhiteBalance"/> that specifies the white balance mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraWhiteBalance WhiteBalance
{
get
/// The ISO level.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraIsoLevel"/> that specifies ISO level.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraIsoLevel"/> that specifies the ISO level.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraIsoLevel IsoLevel
{
get
/// <summary>
/// The quality of the image.
- /// The range for image quality is 1 to 100.
+ /// The range for the image quality is 1 to 100.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int ImageQuality
{
get
/// The preview frame rate.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFps"/> that specifies preview frame rate.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFps"/> that specifies the preview frame rate.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFps PreviewFps
{
get
}
/// <summary>
- /// Gets or sets the resolution of preview
+ /// Gets or sets the resolution of the preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size PreviewResolution
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Depending on the capture resolution aspect ratio and display resolution,
+ /// Depending on the capture resolution aspect ratio and the display resolution,
/// the recommended preview resolution is determined.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size RecommendedPreviewResolution
{
get
/// The preview data format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of preview data.</value>
+ /// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of the preview data.</value>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPixelFormat PreviewPixelFormat
{
get
/// Resolution of the captured image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ArgumentException">In case of invalid parameters</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ArgumentException">In case of invalid parameters.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Size CaptureResolution
{
get
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraPixelFormat"/> that specifies the pixel format of captured image.</value>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPixelFormat CapturePixelFormat
{
get
#region Encoded preview
/// <summary>
- /// The bit rate of encoded preview.
+ /// The bit rate of the encoded preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int EncodedPreviewBitrate
{
get
}
/// <summary>
- /// GOP(Group Of Pictures) interval of encoded preview.
+ /// The GOP(Group Of Pictures) interval of the encoded preview.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int EncodedPreviewGopInterval
{
get
/// The theater mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraTheaterMode"/> that specifies theater mode.</value>
+ /// <value>A <see cref="CameraTheaterMode"/> that specifies the theater mode.</value>
/// <remarks>
/// If you want to display the preview image on the external display with the full screen mode,
/// use this property.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraTheaterMode TheaterMode
{
get
/// The camera effect mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraEffectMode"/> that specifies effect mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraEffectMode"/> that specifies the effect mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraEffectMode Effect
{
get
/// The scene mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraSceneMode"/> that specifies scene mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraSceneMode"/> that specifies the scene mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraSceneMode SceneMode
{
get
/// The camera's flash mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraFlashMode"/> that specifies flash mode.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraFlashMode"/> that specifies the flash mode.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraFlashMode FlashMode
{
get
/// Gets the camera lens orientation angle.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int LensOrientation
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="Rotation"/> that specifies the rotation of camera device.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Rotation StreamRotation
{
get
/// The stream flip.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="Flips"/> that specifies camera flip type.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="Flips"/> that specifies the camera flip type.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Flips StreamFlip
{
get
}
/// <summary>
- /// The mode of HDR(High dynamic range) capture.
+ /// The mode of the HDR(High dynamic range) capture.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>A <see cref="CameraHdrMode"/> that specifies the HDR mode.</value>
/// <remarks>
- /// Taking multiple pictures at different exposure levels and intelligently stitching them together
+ /// Taking multiple pictures at different exposure levels and intelligently stitching them together,
/// so that we eventually arrive at a picture that is representative in both dark and bright areas.
- /// If this attribute is set, then eventhandler set for HdrCaptureProgress event is invoked.
+ /// If this attribute is set, then event handler set for the HdrCaptureProgress event is invoked.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraHdrMode HdrMode
{
get
/// <summary>
/// The anti shake feature.
- /// If true the antishake feature is enabled, otherwise false.
+ /// If true, the antishake feature is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool AntiShake
{
get
}
/// <summary>
- /// Enables/Disables the video stabilization feature.
- /// If true video stabilization is enabled, otherwise false.
+ /// Enables or disables the video stabilization feature.
+ /// If true, video stabilization is enabled, otherwise false.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
/// If video stabilization is enabled, zero shutter lag is disabled.
/// This feature is used to record a video.
/// </remarks>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool VideoStabilization
{
get
/// In some countries, this operation is not permitted.
/// </remarks>
/// <exception cref="InvalidOperationException">Disabling shutter sound is not permitted.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void DisableShutterSound(bool shutterSound)
{
CameraErrorFactory.ThrowIfError(Native.DisableShutterSound(_camera.GetHandle(), shutterSound),
#region PTZ(Pan Tilt Zoom), Pan, Tilt
/// <summary>
- /// Sets the type of PTZ(Pan Tilt Zoom). Mechanical or Electronic.
+ /// Sets the type of the PTZ(Pan Tilt Zoom). Mechanical or electronic.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>A <see cref="CameraPtzType"/> that specifies the type of PTZ.</value>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <value>A <see cref="CameraPtzType"/> that specifies the type of the PTZ.</value>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraPtzType PtzType
{
set
/// Sets the position to move horizontally.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">ptz move type. <seealso cref="CameraPtzMoveType"/></param>
- /// <param name="panStep">pan step</param>
+ /// <param name="type">The PTZ move type. <seealso cref="CameraPtzMoveType"/>.</param>
+ /// <param name="panStep">The pan step.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetPan(CameraPtzMoveType type, int panStep)
{
ValidationUtil.ValidateEnum(typeof(CameraPtzMoveType), type, nameof(type));
/// Gets the current position of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Returns the camera's horizontal position</returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <returns>Returns the camera's horizontal position.</returns>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int GetPan()
{
CameraErrorFactory.ThrowIfError(Native.GetPan(_camera.GetHandle(), out int val),
/// Sets the position to move vertically.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">ptz move type</param>
- /// <param name="tiltStep">tilt step</param>
+ /// <param name="type">the PTZ move type.</param>
+ /// <param name="tiltStep">The tilt step.</param>
/// <exception cref="ArgumentException">In case of invalid parameters.</exception>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void SetTilt(CameraPtzMoveType type, int tiltStep)
{
ValidationUtil.ValidateEnum(typeof(CameraPtzMoveType), type, nameof(type));
/// Gets the current position of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Returns the current vertical position</returns>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <returns>Returns the current vertical position.</returns>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public int GetTilt()
{
CameraErrorFactory.ThrowIfError(Native.GetTilt(_camera.GetHandle(), out int val),
}
/// <summary>
- /// Gets lower limit and upper limit for pan position.
+ /// Gets the lower limit and the upper limit for the pan position.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range PanRange
}
/// <summary>
- /// Gets lower limit and upper limit for tilt position.
+ /// Gets the lower limit and the upper limit for the tilt position.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// If min value is greater than the max value, it means this feature is not supported.
+ /// If the minimum value is greater than the maximum value, it means this feature is not supported.
/// </remarks>
/// <exception cref="NotSupportedException">In case of this feature is not supported.</exception>
public Range TiltRange
#region EXIF tag
/// <summary>
/// The scene mode.
- /// true if EXIF tags are enabled in JPEG file, otherwise false.
/// </summary>
+ /// <value>true if EXIF tags are enabled in the JPEG file, otherwise false.</value>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public bool EnableTag
{
get
/// The camera image description in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public string ImageDescriptionTag
{
get
/// The software information in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public string SoftwareTag
{
get
}
/// <summary>
- /// The geotag(GPS data) in the EXIF tag.
+ /// The geo tag(GPS data) in the EXIF tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public Location GeoTag
{
get
}
/// <summary>
- /// Removes the geotag(GPS data) in the EXIF(Exchangeable image file format) tag.
+ /// Removes the geo tag(GPS data) in the EXIF(EXchangeable Image File format) tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public void RemoveGeoTag()
{
CameraErrorFactory.ThrowIfError(Native.RemoveGeotag(_camera.GetHandle()),
/// The camera orientation in the tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="ObjectDisposedException">The camera already has been disposed.</exception>
+ /// <exception cref="ObjectDisposedException">The camera already has been disposed of.</exception>
public CameraTagOrientation OrientationTag
{
get
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about previous and current state
+ /// An extended EventArgs class which contains details about the previous and the current state
/// of the camera when its state is changed.
/// </summary>
public class CameraStateChangedEventArgs : EventArgs
}
/// <summary>
- /// Previous state of the camera.
+ /// Gets the previous state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Previous { get; }
/// <summary>
- /// Current state of the camera.
+ /// Gets the current state of the camera.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public CameraState Current { get; }
/// <summary>
- /// true if the state changed by policy such as Resource Conflict or Security, otherwise false
- /// in normal state change.
+ /// Gets the value indicating whether the state is changed by policy.
/// </summary>
+ /// <value>
+ /// true if the state changed by policy such as resource conflict or security, otherwise false.
+ /// </value>
/// <since_tizen> 3 </since_tizen>
public bool ByPolicy { get; }
}
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing Encoded image data.
+ /// The class containing the encoded image data.
/// </summary>
public class EncodedPlane : IPreviewPlane
{
}
/// <summary>
- /// The buffer containing encoded image data.
+ /// The buffer containing the encoded image data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Data { get; }
{
/// <summary>
/// An extended EventArgs class which contains details about all the faces detected.
- /// If user need to remain faces data, user have to copy the data.
+ /// If the user needs to keep the faces data, the user has to copy the data.
/// </summary>
public class FaceDetectedEventArgs : EventArgs
{
}
/// <summary>
- /// List containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
+ /// The list containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IEnumerable<FaceDetectionData> Faces { get; }
}
/// <summary>
- /// The Id of each face.
+ /// The ID of each face.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Id { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about the hdr capture progress.
+ /// An extended EventArgs class which contains details about the HDR capture progress.
/// </summary>
public class HdrCaptureProgressEventArgs : EventArgs
{
}
/// <summary>
- /// Hdr Capture progress in percent.
+ /// The HDR capture progress in percent.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Percent { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// Location class containing GPS data details.
+ /// The location class containing GPS data details.
/// </summary>
public class Location
{
/// <summary>
- /// Public constructor.
+ /// The public constructor.
/// </summary>
- /// <param name="latitude">Latitude data</param>
- /// <param name="longitude">Longitude data</param>
- /// <param name="altitude">Altitude data</param>
+ /// <param name="latitude">The latitude data.</param>
+ /// <param name="longitude">The longitude data.</param>
+ /// <param name="altitude">The altitude data.</param>
public Location(double latitude, double longitude, double altitude)
{
Latitude = latitude;
}
/// <summary>
- /// The Latitude data.
+ /// The latitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Latitude { get; }
/// <summary>
- /// The Longitude data.
+ /// The longitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Longitude { get; }
/// <summary>
- /// The Altitude data.
+ /// The altitude data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public double Altitude { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// An extended EventArgs class which contains details about the Media packet preview frame.
+ /// An extended EventArgs class which contains details about the media packet preview frame.
/// </summary>
public class MediaPacketPreviewEventArgs : EventArgs
{
}
/// <summary>
- /// Media Packet data.
+ /// The media packet data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public MediaPacket Packet { get; }
}
/// <summary>
- /// PreviewData frame.
+ /// The PreviewData frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public PreviewFrame Preview { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing preview image data.
+ /// The class containing the preview image data.
/// </summary>
public class PreviewFrame
{
public Size Resolution { get; }
/// <summary>
- /// The timestamp of preview frame.
+ /// The time stamp of the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint TimeStamp { get; }
/// <summary>
- /// The type of preview plane. <see cref="Tizen.Multimedia.PlaneType"/>
+ /// The type of the preview plane. <see cref="Tizen.Multimedia.PlaneType"/>
/// </summary>
/// <since_tizen> 3 </since_tizen>
public PlaneType PlaneType { get; }
/// <summary>
- /// The buffer including preview frame.
+ /// The buffer including the preview frame.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IPreviewPlane Plane { get; }
namespace Tizen.Multimedia
{
/// <summary>
- /// The class containing image data which has single plane.
+ /// The class containing the image data, which has a single plane.
/// </summary>
public class SinglePlane : IPreviewPlane
{
public Size Resolution { get; }
/// <summary>
- /// The buffer containing still image.
+ /// The buffer containing the still image.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Data { get; }
[DllImport(Libraries.MediaController, EntryPoint = "mc_server_unset_playback_state_command_received_cb")]
internal static extern MediaControllerError UnsetPlaybackStateCmdRecvCb(IntPtr handle);
+
+ [DllImport(Libraries.MediaController, EntryPoint = "mc_db_connect")]
+ internal static extern MediaControllerError ConnectDb(out IntPtr dbHandle);
+
+ [DllImport(Libraries.MediaController, EntryPoint = "mc_db_disconnect")]
+ internal static extern MediaControllerError DisconnectDb(IntPtr dbHandle);
+
+ [DllImport(Libraries.MediaController, EntryPoint = "mc_db_check_server_table_exist")]
+ internal static extern MediaControllerError CheckServerExist(IntPtr dbHandle, string appId, out bool value);
}
}
public static class MediaControlServer
{
private static IntPtr _handle = IntPtr.Zero;
+ private static bool? _isRunning;
/// <summary>
/// Gets a value indicating whether the server is running.
/// <seealso cref="Stop"/>
public static bool IsRunning
{
- get => _handle != IntPtr.Zero;
+ get
+ {
+ if (_isRunning.HasValue == false)
+ {
+ _isRunning = GetRunningState();
+ }
+
+ return _isRunning.Value;
+ }
+ }
+
+ private static bool GetRunningState()
+ {
+ IntPtr handle = IntPtr.Zero;
+ try
+ {
+ Native.ConnectDb(out handle).ThrowIfError("Failed to retrieve the running state.");
+
+ Native.CheckServerExist(handle, Applications.Application.Current.ApplicationInfo.ApplicationId,
+ out var value).ThrowIfError("Failed to retrieve the running state.");
+
+ return value;
+ }
+ finally
+ {
+ if (handle != IntPtr.Zero)
+ {
+ Native.DisconnectDb(handle);
+ }
+ }
}
- private static void ThrowIfNotRunning()
+ private static void EnsureInitializedIfRunning()
{
+ if (_handle != IntPtr.Zero)
+ {
+ return;
+ }
+
if (IsRunning == false)
{
throw new InvalidOperationException("The server is not running.");
}
+
+ Initialize();
}
private static IntPtr Handle
{
get
{
- ThrowIfNotRunning();
+ EnsureInitializedIfRunning();
return _handle;
}
}
- /// <summary>
- /// Starts the media control server.
- /// </summary>
- /// <remarks>
- /// When the server starts, <see cref="MediaControllerManager.ServerStarted"/> will be raised.
- /// </remarks>
- /// <privilege>http://tizen.org/privilege/mediacontroller.server</privilege>
- /// <exception cref="InvalidOperationException">
- /// The server has already started.\n
- /// -or-\n
- /// An internal error occurs.
- /// </exception>
- /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege.</exception>
- /// <seealso cref="MediaControllerManager.ServerStarted"/>
- public static void Start()
+ private static void Initialize()
{
- if (IsRunning)
- {
- throw new InvalidOperationException("The server is already running.");
- }
-
Native.Create(out _handle).ThrowIfError("Failed to create media controller server.");
try
{
RegisterPlaybackCommandReceivedEvent();
+ _isRunning = true;
}
catch
{
}
/// <summary>
+ /// Starts the media control server.
+ /// </summary>
+ /// <remarks>
+ /// When the server starts, <see cref="MediaControllerManager.ServerStarted"/> will be raised.
+ /// </remarks>
+ /// <privilege>http://tizen.org/privilege/mediacontroller.server</privilege>
+ /// <exception cref="InvalidOperationException">An internal error occurs.</exception>
+ /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege.</exception>
+ /// <seealso cref="MediaControllerManager.ServerStarted"/>
+ public static void Start()
+ {
+ Initialize();
+ }
+
+ /// <summary>
/// Stops the media control server.
/// </summary>
/// <remarks>
/// <seealso cref="MediaControllerManager.ServerStopped"/>
public static void Stop()
{
- ThrowIfNotRunning();
+ EnsureInitializedIfRunning();
Native.Destroy(_handle).ThrowIfError("Failed to stop the server.");
_handle = IntPtr.Zero;
_playbackCommandCallback = null;
+ _isRunning = false;
}
/// <summary>
/// <summary>
/// Default constructor. Initializes an object of the CellularAuthInformation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public CellularAuthInformation()
{
}
/// <summary>
/// Adds a route to the routing table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="family">The address family.</param>
/// <param name="interfaceName">The name of the network interface.</param>
/// <param name="hostAddress">The IP address of the host.</param>
/// <summary>
/// Removes a route from the routing table.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <param name="family">The address family.</param>
/// <param name="interfaceName">The name of network interface.</param>
/// <param name="hostAddress">The IP address of the host.</param>
/// <summary>
/// The DHCP server address. It is only supported for the IPV4 address family.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Server address of the DHCP.</value>
System.Net.IPAddress DhcpServerAddress { get; }
}
ResourceFoundEventArgs e = new ResourceFoundEventArgs()
{
RequestId = requestId,
+ EventContinue = true,
Resource = resource
};
ResourceFound?.Invoke(null, e);
PlatformInformationFoundEventArgs e = new PlatformInformationFoundEventArgs()
{
RequestId = requestId,
+ EventContinue = true,
PlatformId = (platformId != IntPtr.Zero) ? Marshal.PtrToStringAnsi(platformId) : string.Empty,
ManufacturerName = (manufacturerName != IntPtr.Zero) ? Marshal.PtrToStringAnsi(manufacturerName) : string.Empty,
ManufacturerURL = (manufacturerUrl != IntPtr.Zero) ? Marshal.PtrToStringAnsi(manufacturerUrl) : string.Empty,
* limitations under the License.
*/
+using System;
+
namespace Tizen.Network.Nsd
{
/// <summary>
}
/// <summary>
- /// Gets the result of a specific AP scan.
+ /// Gets the result of ScanSpecificAPAsync(string essid) API.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>A list containing the WiFiAP objects.</returns>
/// <summary>
/// The Received signal strength indication(RSSI).
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 4 </since_tizen>
/// <value>Represents Rssi level of WiFi.</value>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
namespace Tizen.Pims.Calendar
{
/// <summary>
- /// Delegate for detecting the calendar database changes.
- /// </summary>
- /// <param name="uri">The record uri</param>
- /// <remarks>
- /// The delegate must be registered using AddDBChangedDelegate.
- /// It's invoked when the designated view changes.
- /// </remarks>
- public delegate void CalendarDBChanged(string uri);
-
- /// <summary>
/// CalendarDatabase provides methods to manage calendar information from/to the database.
/// </summary>
/// <remarks>
public class CalendarDatabase
{
private Object thisLock = new Object();
- private Dictionary<string, CalendarDBChanged> _callbackMap = new Dictionary<string, CalendarDBChanged>();
- private Dictionary<string, Interop.Database.DBChangedCallback> _delegateMap = new Dictionary<string, Interop.Database.DBChangedCallback>();
+ private Dictionary<string, EventHandler<DBChangedEventArgs>> _eventHandlerMap = new Dictionary<string, EventHandler<DBChangedEventArgs>>();
+ private Dictionary<string, Interop.Database.DBChangedCallback> _callbackMap = new Dictionary<string, Interop.Database.DBChangedCallback>();
private Interop.Database.DBChangedCallback _dbChangedDelegate;
internal CalendarDatabase()
/// Registers a callback function to be invoked when a record changes.
/// </summary>
/// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
- /// <param name="callback">The callback function to register</param>
+ /// <param name="DBChanged">The EventHandler to register</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
- public void AddDBChangedDelegate(string viewUri, CalendarDBChanged callback)
+ public void AddDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
Log.Debug(Globals.LogTag, "AddDBChangedDelegate");
- _dbChangedDelegate = (string uri, IntPtr userData) =>
- {
- _callbackMap[uri](uri);
- };
- int error = Interop.Database.AddChangedCallback(viewUri, _dbChangedDelegate, IntPtr.Zero);
- if (CalendarError.None != (CalendarError)error)
- {
- Log.Error(Globals.LogTag, "AddDBChangedDelegate Failed with error " + error);
- throw CalendarErrorFactory.GetException(error);
- }
- _callbackMap[viewUri] += callback;
- _delegateMap[viewUri] = _dbChangedDelegate;
+ if (!_callbackMap.ContainsKey(viewUri))
+ {
+ _callbackMap[viewUri] = (string uri, IntPtr userData) =>
+ {
+ DBChangedEventArgs args = new DBChangedEventArgs(uri);
+ _eventHandlerMap[uri]?.Invoke(this, args);
+ };
+
+ int error = Interop.Database.AddChangedCallback(viewUri, _dbChangedDelegate, IntPtr.Zero);
+ if (CalendarError.None != (CalendarError)error)
+ {
+ Log.Error(Globals.LogTag, "AddDBChangedDelegate Failed with error " + error);
+ throw CalendarErrorFactory.GetException(error);
+ }
+ }
+
+ EventHandler<DBChangedEventArgs> handler = null;
+ if (!_eventHandlerMap.TryGetValue(viewUri, out handler))
+ _eventHandlerMap.Add(viewUri, null);
+
+ _eventHandlerMap[viewUri] = handler + DBChanged;
}
/// <summary>
/// Deregisters a callback function.
/// </summary>
/// <param name="viewUri">The view URI of the record to subscribe for change notifications</param>
- /// <param name="callback">The callback function to register</param>
+ /// <param name="DBChanged">The EventHandler to deregister</param>
/// <privilege>http://tizen.org/privilege/calendar.read</privilege>
[SuppressMessage("Microsoft.Design", "CA1054:UriParametersShouldNotBeStrings")]
- public void RemoveDBChangedDelegate(string viewUri, CalendarDBChanged callback)
+ public void RemoveDBChangedDelegate(string viewUri, EventHandler<DBChangedEventArgs> DBChanged)
{
Log.Debug(Globals.LogTag, "RemoveDBChangedDelegate");
- int error = Interop.Database.RemoveChangedCallback(viewUri, _delegateMap[viewUri], IntPtr.Zero);
- if (CalendarError.None != (CalendarError)error)
+ EventHandler<DBChangedEventArgs> handler = null;
+ if (!_eventHandlerMap.TryGetValue(viewUri, out handler))
+ _eventHandlerMap.Add(viewUri, null);
+ else
+ _eventHandlerMap[viewUri] = handler - DBChanged;
+
+ if (_eventHandlerMap[viewUri] == null)
{
- Log.Error(Globals.LogTag, "RemoveDBChangedDelegate Failed with error " + error);
- throw CalendarErrorFactory.GetException(error);
- }
- _callbackMap[viewUri] -= callback;
- _delegateMap.Remove(viewUri);
+ int error = Interop.Database.RemoveChangedCallback(viewUri, _callbackMap[viewUri], IntPtr.Zero);
+ if (CalendarError.None != (CalendarError)error)
+ {
+ Log.Error(Globals.LogTag, "RemoveDBChangedDelegate Failed with error " + error);
+ throw CalendarErrorFactory.GetException(error);
+ }
+ _callbackMap.Remove(viewUri);
+ }
}
/// <summary>
--- /dev/null
+/*
+* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+*
+* Licensed under the Apache License, Version 2.0 (the License);
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an AS IS BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+using System;
+
+namespace Tizen.Pims.Calendar
+{
+ /// <summary>
+ /// Event arguments passed when calendar database is changed
+ /// </summary>
+ public class DBChangedEventArgs : EventArgs
+ {
+ internal DBChangedEventArgs(string viewUri)
+ {
+ ViewUri = viewUri;
+ }
+
+ /// <summary>
+ /// The calendar view URI changed.
+ /// </summary>
+ public string ViewUri
+ {
+ get;
+ internal set;
+ }
+ }
+}
internal static SensorEventStruct IntPtrToEventStruct(IntPtr unmanagedVariable)
{
- SensorEventStruct outStruct = (SensorEventStruct)Marshal.PtrToStructure(unmanagedVariable, typeof(SensorEventStruct));
+ SensorEventStruct outStruct = (SensorEventStruct)Marshal.PtrToStructure<SensorEventStruct>(unmanagedVariable);
return outStruct;
}
}
/// <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 application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">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.
/// <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 application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">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.
/// <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 application has no privilege to use the sensor.</exception>
+ /// <exception cref="UnauthorizedAccessException">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.
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.stationaryActivityDetector"/> class.
+ /// Initializes a new instance of the <see cref="Tizen.Sensor.StationaryActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.walkingActivityDetector"/> class.
+ /// Initializes a new instance of the <see cref="Tizen.Sensor.WalkingActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
/// CapacityChanged is triggered when the battery charge percentage is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="sender"></param>
- /// <param name="e">BatteryCapacityChangedEventArgs is an object that contains the changed battery capacity (Percent).</param>
/// <code>
/// public static async Task BatteryEventHandler()
/// {
/// LevelChanged is triggered when the battery level is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="sender"></param>
- /// <param name="e">BatteryLevelChangedEventArgs is an object that contains the changed battery level.</param>
/// <code>
/// public static async Task BatteryEventHandler()
/// {
/// This event is triggered when the charger is connected/disconnected.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="sender"></param>
- /// <param name="e">BatteryChargingStateChangedEventArgs is an object that contains the changed battery charging state.</param>
/// <code>
/// public static async Task BatteryEventHandler()
/// {
/// StateChanged is raised when the LED state is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="sender">The source of the event.</param>
- /// <param name="e">LedBrightnessChangedEventArgs is an object that contains the changed brightness.</param>
public static event EventHandler<LedBrightnessChangedEventArgs> BrightnessChanged
{
add
/// Tizen.Tracer.End() ends the most recently called Tizen.Tracer.Begin().
/// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
/// </remarks>
- /// <seealso cref="Tizen.Tracer.Begin()"/>
+ /// <seealso cref="Tizen.Tracer.Begin(String)"/>
public static void End ()
{
Interop.Tracer.End ();
/// </remarks>
/// <param name="cookie">An unique identifier for distinguishing simultaneous events.</param>
/// <param name="name">The name of an event (optionally containing format specifiers).</param>
- /// <seealso cref="Tizen.Tracer.AsyncEnd()"/>
+ /// <seealso cref="Tizen.Tracer.AsyncEnd(int, String)"/>
public static void AsyncBegin (int cookie, String name)
{
Interop.Tracer.AsyncBegin (cookie, name);
/// </remarks>
/// <param name="cookie">An unique identifier for distinguishing simultaneous events.</param>
/// <param name="name">The name of an event (optionally containing format specifiers).</param>
- /// <seealso cref="Tizen.Tracer.AsyncBegin()"/>
+ /// <seealso cref="Tizen.Tracer.AsyncBegin(int, String)"/>
public static void AsyncEnd (int cookie, String name)
{
Interop.Tracer.AsyncEnd (cookie, name);
namespace Tizen.WebView
{
+ /// <summary>
+ /// This class provides methods to initialize and shutdown Chromium-efl.
+ /// </summary>
public static class Chromium
{
/// <summary>
- /// Initializes Chromium's instance
+ /// Initializes Chromium's instance.
/// </summary>
/// <returns>A reference count of Chromium's instance</returns>
public static int Initialize()
}
/// <summary>
- /// Decreases a reference count of WebKit's instance, possibly destroying it
+ /// Decreases a reference count of WebKit's instance, possibly destroying it.
/// </summary>
/// <returns>A reference count of Chromium's instance</returns>
public static int Shutdown()
/// </summary>
public enum CacheModel
{
- DocumentViewer, /* Use the smallest cache capacity */
- DocumentBrowser, /* Use bigger cache capacity than DocumentBrowser */
- PrimaryWebBrowser /* Use the biggest cache capacity. */
+ /// <summary>
+ /// Use the smallest cache capacity.
+ /// </summary>
+ DocumentViewer,
+ /// <summary>
+ /// Use bigger cache capacity than DocumentBrowser.
+ /// </summary>
+ DocumentBrowser,
+ /// <summary>
+ /// Use the biggest cache capacity.
+ /// </summary>
+ PrimaryWebBrowser
}
+ /// <summary>
+ /// This class encapsulates all pages related to the specific use of Chromium-efl.
+ /// </summary>
+ /// <remarks>
+ /// Applications have the option of creating a context different from the default one and using it for a group of pages.
+ /// All pages in the same context share the same preferences, visited link set, local storage, and so on.
+ /// </remarks>
public class Context
{
private IntPtr _handle;
/// </summary>
public enum CookieAcceptPolicy
{
- Always, /* Accepts every cookie sent from any page */
- Never, /* Rejects all cookies */
- NoThirdParty /* Accepts only cookies set by the main document loaded */
+ /// <summary>
+ /// Accepts every cookie sent from any page.
+ /// </summary>
+ Always,
+ /// <summary>
+ /// Rejects all cookies.
+ /// </summary>
+ Never,
+ /// <summary>
+ /// Accepts only cookies set by the main document loaded.
+ /// </summary>
+ NoThirdParty
}
/// <summary>
/// </summary>
public enum CookiePersistentStorage
{
- Text, /* Cookies are stored in a text file in the Mozilla "cookies.txt" format */
- SqlLite /* Cookies are stored in a SQLite file in the current Mozilla format. */
+ /// <summary>
+ /// Cookies are stored in a text file in the Mozilla "cookies.txt" format.
+ /// </summary>
+ Text,
+ /// <summary>
+ /// Cookies are stored in a SQLite file in the current Mozilla format.
+ /// </summary>
+ SqlLite
}
+ /// <summary>
+ /// This class provides methods for the cookie manager.
+ /// </summary>
public class CookieManager
{
private IntPtr _handle;
/// <summary>
/// Sets the storage where non-session cookies are stored persistently to read/write the cookies.
/// </summary>
- ///<privilege>
- /// http://tizen.org/privilege/mediastorage
- /// http://tizen.org/privilege/externalstorage
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/mediastorage</privilege>
+ /// <privilege>http://tizen.org/privilege/externalstorage</privilege>
/// <param name="path">The path where to read/write Cookies</param>
/// <param name="storage">The type of storage</param>
public void SetPersistentStorage(string path, CookiePersistentStorage storage)
namespace Tizen.WebView
{
+ /// <summary>
+ /// This class provides properties for setting the preference of a specific WebView.
+ /// </summary>
public class Settings
{
private IntPtr _handle;
/// </summary>
Canceled,
/// <summary>
- /// Can't show page for this MIME Type
+ /// Can't show page for this MIME Type.
/// </summary>
CantSupportMimetype,
/// <summary>
/// </summary>
FailedFileIo,
/// <summary>
- /// Cannot connect to network
+ /// Cannot connect to network.
/// </summary>
CantConnect,
/// <summary>
- /// Fail to look up host from DNS
+ /// Fail to look up host from DNS.
/// </summary>
CantLookupHost,
/// <summary>
- /// Fail to SSL/TLS handshake
+ /// Fail to SSL/TLS handshake.
/// </summary>
FailedTlsHandshake,
/// <summary>
- /// Received certificate is invalid
+ /// Received certificate is invalid.
/// </summary>
InvalidCertificate,
/// <summary>
/// </summary>
Authentication,
/// <summary>
- /// Web server has internal server error
+ /// Web server has internal server error.
/// </summary>
InternalServer,
}
projects / platform / core / csapi / tizenfx.git / commitdiff