-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.System</name>
- </assembly>
- <members>
- <member name="T:Tizen.System.BatteryLevelStatus">
- <summary>
- Enumeration for the battery levels.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.BatteryLevelStatus.Empty">
- <summary>
- The battery goes empty.
- Prepare for the safe termination of the application,
- because the device starts a shutdown process soon
- after entering this level.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.BatteryLevelStatus.Critical">
- <summary>
- The battery charge is at a critical state.
- You may have to stop using the multimedia features,
- because they are not guaranteed to work correctly
- with this battery status.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.BatteryLevelStatus.Low">
- <summary>
- The battery has little charge left.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.BatteryLevelStatus.High">
- <summary>
- The battery status is not to be careful.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.BatteryLevelStatus.Full">
- <summary>
- The battery status is fully charged.
- It means no more charge.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.Battery">
- <summary>
- The Battery class provides the properties and events for the device battery.
- </summary>
- <remarks>
- The Battery API provides the way to get the current battery capacity value (Percent),
- the battery state, and the charging state. It also provides the events for an application
- to receive the battery status change events from the device.
- To receive the battery event, the application should register with the respective EventHandler.
- </remarks>
- <code>
- Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);
- Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);
- </code>
- </member>
- <member name="P:Tizen.System.Battery.Percent">
- <summary>
- Gets the battery charge percentage.
- </summary>
- <since_tizen> 3 </since_tizen>
- <value>It returns an integer value from 0 to 100 that indicates the remaining
- battery charge as a percentage of the maximum level.</value>
- </member>
- <member name="P:Tizen.System.Battery.Level">
- <summary>
- Gets the current battery level.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.System.Battery.IsCharging">
- <summary>
- Gets the current charging state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.PercentChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.LevelChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.ChargingStateChanged" -->
- <member name="T:Tizen.System.BatteryPercentChangedEventArgs">
- <summary>
- BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.
- </summary>
- </member>
- <member name="P:Tizen.System.BatteryPercentChangedEventArgs.Percent">
- <summary>
- The current capacity of the battery.
- Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.BatteryLevelChangedEventArgs">
- <summary>
- BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.
- </summary>
- </member>
- <member name="P:Tizen.System.BatteryLevelChangedEventArgs.Level">
- <summary>
- The level indicates the current battery level status which is a type of the BatteryLevelStatus.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.BatteryChargingStateChangedEventArgs">
- <summary>
- BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.
- </summary>
- </member>
- <member name="P:Tizen.System.BatteryChargingStateChangedEventArgs.IsCharging">
- <summary>
- The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.DisplayStateChangedEventArgs">
- <summary>
- DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.
- </summary>
- </member>
- <member name="P:Tizen.System.DisplayStateChangedEventArgs.State">
- <summary>
- The state indicates the current display state of the device which is an enumeration of the type DisplayState.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.LedBrightnessChangedEventArgs">
- <summary>
- LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.
- </summary>
- </member>
- <member name="P:Tizen.System.LedBrightnessChangedEventArgs.Brightness">
- <summary>
- Brightness indicates the current brightness level of the display as an integer.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.DisplayState">
- <summary>
- Enumeration for the available display states.
- An application cannot put the device into the power off state or the suspend state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.DisplayState.Normal">
- <summary>
- Normal state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.DisplayState.Dim">
- <summary>
- Screen dim state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.DisplayState.Off">
- <summary>
- Screen off state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.Display">
- <summary>
- The Display class provides the properties and events to control the display status and brightness.
- </summary>
- <remarks>
- The Display API provides the way to get the current display brightness value,
- the display state, and the total number of available displays.
- It also provides the events for an application to receive the display state change events from the device.
- To receive the display event, the application should register with an associated EventHandler.
- </remarks>
- <privilege>
- http://tizen.org/privilege/display
- </privilege>
- <code>
- Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
- Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);
- </code>
- </member>
- <member name="P:Tizen.System.Display.NumberOfDisplays">
- <summary>
- The number of available display devices.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.System.Display.Displays">
- <summary>
- Gets all the available displays.
- The display at the index zero is always assigned to the main display.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.System.Display.MaxBrightness">
- <summary>
- The maximum brightness value that can be set for the specific display.
- </summary>
- <since_tizen> 3 </since_tizen>
- <code>
- Display display = Display.Displays[0];
- Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
- </code>
- </member>
- <member name="P:Tizen.System.Display.Brightness">
- <summary>
- The brightness value of the display.
- </summary>
- <remarks>
- The brightness value should be less than or equal to the MaxBrightness value.
- </remarks>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <code>
- Display display = Display.Displays[0];
- Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
- </code>
- </member>
- <member name="P:Tizen.System.Display.State">
- <summary>
- The current device display state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.Display.StateChanged" -->
- <member name="T:Tizen.System.Vibrator">
- <summary>
- The Vibrator class provides the properties and methods to control a vibrator.
- </summary>
- <remarks>
- The Vibrator API provides the way to access the vibrators in the device.
- It allows the management of the device's vibrator parameters, such as the vibration count and level.
- It provides the methods to vibrate and stop the vibration.
- </remarks>
- <privilege>
- http://tizen.org/privilege/haptic
- </privilege>
- <code>
- Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);
- </code>
- </member>
- <member name="P:Tizen.System.Vibrator.NumberOfVibrators">
- <summary>
- Gets the number of the available vibrators.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.System.Vibrator.Vibrators">
- <summary>
- Gets all the available vibrators.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.System.Vibrator.Vibrate(System.Int32,System.Int32)">
- <summary>
- Vibrates during the specified time with a constant intensity.
- This function can be used to start monotonous vibration for the specified time.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="duration">The play duration in milliseconds.</param>
- <param name="feedback">The amount of the intensity variation (0 ~ 100).</param>
- <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- <code>
- Vibrator vibrator = Vibrator.Vibrators[0];
- try
- {
- vibrator.Vibrate(2000, 70);
- }
- Catch(Exception e)
- {
- }
- </code>
- </member>
- <member name="M:Tizen.System.Vibrator.Stop">
- <summary>
- Stops all the vibration effects which are being played.
- This function can be used to stop all the effects started by Vibrate().
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.ArgumentException"> In case an invalid vibrator instance is used.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- <code>
- Vibrator vibrator = Vibrator.Vibrators[0];
- try
- {
- vibrator.Stop();
- }
- Catch(Exception e)
- {
- }
- </code>
- </member>
- <member name="M:Tizen.System.Vibrator.Dispose">
- <summary>
- Dispose API for closing the internal resources.
- This function can be used to stop all the effects started by Vibrate().
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.IR">
- <summary>
- The IR API provides the functions to control the IR transmitter.
- The IR API provides the way to get the information if IR is available and then transmit the IR command.
- </summary>
- <privilege>
- http://tizen.org/privilege/use_ir
- </privilege>
- <code>
- Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);
- </code>
- </member>
- <member name="P:Tizen.System.IR.IsAvailable">
- <summary>
- Gets the information whether the IR module is available.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <!-- Badly formed XML comment ignored for member "M:Tizen.System.IR.Transmit(System.Int32,System.Collections.Generic.IList{System.Int32})" -->
- <member name="T:Tizen.System.Led">
- <summary>
- The LED class provides the properties and methods to control the attached LED device.
- </summary>
- <remarks>
- The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device.
- Related features:
- http://tizen.org/feature/led
- http://tizen.org/feature/camera.back.flash
- It is recommended to design the feature related codes in your application for reliability.
- You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application.
- </remarks>
- <privilege>
- http://tizen.org/privilege/led
- </privilege>
- <code>
- Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);
- Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
- </code>
- </member>
- <member name="P:Tizen.System.Led.MaxBrightness">
- <summary>
- Gets the maximum brightness value of the LED that is located next to the camera.
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- </summary>
- </member>
- <member name="P:Tizen.System.Led.Brightness">
- <summary>
- Gets the brightness value of the LED that is located next to the camera.
- </summary>
- <remarks>The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value.
- Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any).
- </remarks>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- <code>
- Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
- Tizen.System.Led.Brightness = 50;
- Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
- </code>
- </member>
- <member name="M:Tizen.System.Led.Play(System.Int32,System.Int32,Tizen.Common.Color)">
- <summary>
- Plays the LED that is located at the front of the device.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="on">Turn on time in milliseconds.</param>
- <param name="off">Turn off time in milliseconds.</param>
- <param name="color">
- The Color value
- The first byte means opaque and the other 3 bytes are the RGB values.
- </param>
- <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- <code>
- try
- {
- Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
- }
- Catch(Exception e)
- {
- }
- </code>
- </member>
- <member name="M:Tizen.System.Led.Stop">
- <summary>
- Stops the LED that is located at the front of the device.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
- <code>
- try
- {
- Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
- //wait for a while and stop...
- Led.Stop();
- }
- Catch(Exception e)
- {
- }
- </code>
- </member>
- <member name="E:Tizen.System.Led.BrightnessChanged">
- <summary>
- StateChanged is raised when the LED state is changed.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.System.Power">
- <summary>
- The Power class provides methods to control the power service.
- </summary>
- <remarks>
- The Power API provides the way to control the power service.
- It can be made to hold the specific state to avoid the CPU state internally.
- </remarks>
- <privilege>
- http://tizen.org/privilege/display
- </privilege>
- </member>
- <member name="M:Tizen.System.Power.RequestCpuLock(System.Int32)">
- <summary>
- Locks the CPU for a specified time.
- After the given timeout (in milliseconds), unlock the given lock state automatically.
- </summary>
- <remarks>
- If the process dies, then every lock will be removed.
- </remarks>
- <since_tizen> 3 </since_tizen>
- <param name="timeout">
- The positive number in milliseconds or 0 for the permanent lock.
- So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero.
- </param>
- <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <code>
- Tizen.System.Power.RequestCpuLock(2000);
- </code>
- </member>
- <member name="M:Tizen.System.Power.ReleaseCpuLock">
- <summary>
- Releases the CPU lock state.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <code>
- Tizen.System.Power.ReleaseCpuLock();
- </code>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.System</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Tizen.System.BatteryLevelStatus">\r
+ <summary>\r
+ Enumeration for the battery levels.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.BatteryLevelStatus.Empty">\r
+ <summary>\r
+ The battery goes empty.\r
+ Prepare for the safe termination of the application,\r
+ because the device starts a shutdown process soon\r
+ after entering this level.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.BatteryLevelStatus.Critical">\r
+ <summary>\r
+ The battery charge is at a critical state.\r
+ You may have to stop using the multimedia features,\r
+ because they are not guaranteed to work correctly\r
+ with this battery status.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.BatteryLevelStatus.Low">\r
+ <summary>\r
+ The battery has little charge left.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.BatteryLevelStatus.High">\r
+ <summary>\r
+ The battery status is not to be careful.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.BatteryLevelStatus.Full">\r
+ <summary>\r
+ The battery status is fully charged.\r
+ It means no more charge.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.Battery">\r
+ <summary>\r
+ The Battery class provides the properties and events for the device battery.\r
+ </summary>\r
+ <remarks>\r
+ The Battery API provides the way to get the current battery capacity value (Percent),\r
+ the battery state, and the charging state. It also provides the events for an application\r
+ to receive the battery status change events from the device.\r
+ To receive the battery event, the application should register with the respective EventHandler.\r
+ </remarks>\r
+ <code>\r
+ Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);\r
+ Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Battery.Percent">\r
+ <summary>\r
+ Gets the battery charge percentage.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <value>It returns an integer value from 0 to 100 that indicates the remaining\r
+ battery charge as a percentage of the maximum level.</value>\r
+ </member>\r
+ <member name="P:Tizen.System.Battery.Level">\r
+ <summary>\r
+ Gets the current battery level.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.System.Battery.IsCharging">\r
+ <summary>\r
+ Gets the current charging state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <!-- "E:Tizen.System.Battery.PercentChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "E:Tizen.System.Battery.LevelChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "E:Tizen.System.Battery.ChargingStateChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="T:Tizen.System.BatteryPercentChangedEventArgs">\r
+ <summary>\r
+ BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.BatteryPercentChangedEventArgs.Percent">\r
+ <summary>\r
+ The current capacity of the battery.\r
+ Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.BatteryLevelChangedEventArgs">\r
+ <summary>\r
+ BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.BatteryLevelChangedEventArgs.Level">\r
+ <summary>\r
+ The level indicates the current battery level status which is a type of the BatteryLevelStatus.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.BatteryChargingStateChangedEventArgs">\r
+ <summary>\r
+ BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.BatteryChargingStateChangedEventArgs.IsCharging">\r
+ <summary>\r
+ The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.DisplayStateChangedEventArgs">\r
+ <summary>\r
+ DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.DisplayStateChangedEventArgs.State">\r
+ <summary>\r
+ The state indicates the current display state of the device which is an enumeration of the type DisplayState.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.LedBrightnessChangedEventArgs">\r
+ <summary>\r
+ LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.LedBrightnessChangedEventArgs.Brightness">\r
+ <summary>\r
+ Brightness indicates the current brightness level of the display as an integer.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.DisplayState">\r
+ <summary>\r
+ Enumeration for the available display states.\r
+ An application cannot put the device into the power off state or the suspend state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.DisplayState.Normal">\r
+ <summary>\r
+ Normal state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.DisplayState.Dim">\r
+ <summary>\r
+ Screen dim state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.DisplayState.Off">\r
+ <summary>\r
+ Screen off state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.Display">\r
+ <summary>\r
+ The Display class provides the properties and events to control the display status and brightness.\r
+ </summary>\r
+ <remarks>\r
+ The Display API provides the way to get the current display brightness value,\r
+ the display state, and the total number of available displays.\r
+ It also provides the events for an application to receive the display state change events from the device.\r
+ To receive the display event, the application should register with an associated EventHandler.\r
+ </remarks>\r
+ <privilege>\r
+ http://tizen.org/privilege/display\r
+ </privilege>\r
+ <code>\r
+ Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);\r
+ Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Display.NumberOfDisplays">\r
+ <summary>\r
+ The number of available display devices.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.System.Display.Displays">\r
+ <summary>\r
+ Gets all the available displays.\r
+ The display at the index zero is always assigned to the main display.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.System.Display.MaxBrightness">\r
+ <summary>\r
+ The maximum brightness value that can be set for the specific display.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <code>\r
+ Display display = Display.Displays[0];\r
+ Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Display.Brightness">\r
+ <summary>\r
+ The brightness value of the display.\r
+ </summary>\r
+ <remarks>\r
+ The brightness value should be less than or equal to the MaxBrightness value.\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <code>\r
+ Display display = Display.Displays[0];\r
+ Console.WriteLine("Display current Brightness is: {0}", display.Brightness);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Display.State">\r
+ <summary>\r
+ The current device display state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <!-- "E:Tizen.System.Display.StateChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="T:Tizen.System.Vibrator">\r
+ <summary>\r
+ The Vibrator class provides the properties and methods to control a vibrator.\r
+ </summary>\r
+ <remarks>\r
+ The Vibrator API provides the way to access the vibrators in the device.\r
+ It allows the management of the device's vibrator parameters, such as the vibration count and level.\r
+ It provides the methods to vibrate and stop the vibration.\r
+ </remarks>\r
+ <privilege>\r
+ http://tizen.org/privilege/haptic\r
+ </privilege>\r
+ <code>\r
+ Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Vibrator.NumberOfVibrators">\r
+ <summary>\r
+ Gets the number of the available vibrators.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.System.Vibrator.Vibrators">\r
+ <summary>\r
+ Gets all the available vibrators.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.System.Vibrator.Vibrate(System.Int32,System.Int32)">\r
+ <summary>\r
+ Vibrates during the specified time with a constant intensity.\r
+ This function can be used to start monotonous vibration for the specified time.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="duration">The play duration in milliseconds.</param>\r
+ <param name="feedback">The amount of the intensity variation (0 ~ 100).</param>\r
+ <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ <code>\r
+ Vibrator vibrator = Vibrator.Vibrators[0];\r
+ try\r
+ {\r
+ vibrator.Vibrate(2000, 70);\r
+ }\r
+ Catch(Exception e)\r
+ {\r
+ }\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Vibrator.Stop">\r
+ <summary>\r
+ Stops all the vibration effects which are being played.\r
+ This function can be used to stop all the effects started by Vibrate().\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.ArgumentException"> In case an invalid vibrator instance is used.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ <code>\r
+ Vibrator vibrator = Vibrator.Vibrators[0];\r
+ try\r
+ {\r
+ vibrator.Stop();\r
+ }\r
+ Catch(Exception e)\r
+ {\r
+ }\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Vibrator.Dispose">\r
+ <summary>\r
+ Dispose API for closing the internal resources.\r
+ This function can be used to stop all the effects started by Vibrate().\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.IR">\r
+ <summary>\r
+ The IR API provides the functions to control the IR transmitter.\r
+ The IR API provides the way to get the information if IR is available and then transmit the IR command.\r
+ </summary>\r
+ <privilege>\r
+ http://tizen.org/privilege/use_ir\r
+ </privilege>\r
+ <code>\r
+ Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.IR.IsAvailable">\r
+ <summary>\r
+ Gets the information whether the IR module is available.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <!-- "M:Tizen.System.IR.Transmit(System.Int32,System.Collections.Generic.IList{System.Int32})" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="T:Tizen.System.Led">\r
+ <summary>\r
+ The LED class provides the properties and methods to control the attached LED device.\r
+ </summary>\r
+ <remarks>\r
+ The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device.\r
+ Related features:\r
+ http://tizen.org/feature/led\r
+ http://tizen.org/feature/camera.back.flash\r
+ It is recommended to design the feature related codes in your application for reliability.\r
+ You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application.\r
+ </remarks>\r
+ <privilege>\r
+ http://tizen.org/privilege/led\r
+ </privilege>\r
+ <code>\r
+ Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);\r
+ Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);\r
+ </code>\r
+ </member>\r
+ <member name="P:Tizen.System.Led.MaxBrightness">\r
+ <summary>\r
+ Gets the maximum brightness value of the LED that is located next to the camera.\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.System.Led.Brightness">\r
+ <summary>\r
+ Gets the brightness value of the LED that is located next to the camera.\r
+ </summary>\r
+ <remarks>The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value.\r
+ Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any).\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ <code>\r
+ Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);\r
+ Tizen.System.Led.Brightness = 50;\r
+ Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Led.Play(System.Int32,System.Int32,Tizen.Common.Color)">\r
+ <summary>\r
+ Plays the LED that is located at the front of the device.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="on">Turn on time in milliseconds.</param>\r
+ <param name="off">Turn off time in milliseconds.</param>\r
+ <param name="color">\r
+ The Color value\r
+ The first byte means opaque and the other 3 bytes are the RGB values.\r
+ </param>\r
+ <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ <code>\r
+ try\r
+ {\r
+ Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));\r
+ }\r
+ Catch(Exception e)\r
+ {\r
+ }\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Led.Stop">\r
+ <summary>\r
+ Stops the LED that is located at the front of the device.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>\r
+ <code>\r
+ try\r
+ {\r
+ Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));\r
+ //wait for a while and stop...\r
+ Led.Stop();\r
+ }\r
+ Catch(Exception e)\r
+ {\r
+ }\r
+ </code>\r
+ </member>\r
+ <member name="E:Tizen.System.Led.BrightnessChanged">\r
+ <summary>\r
+ StateChanged is raised when the LED state is changed.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.System.Power">\r
+ <summary>\r
+ The Power class provides methods to control the power service.\r
+ </summary>\r
+ <remarks>\r
+ The Power API provides the way to control the power service.\r
+ It can be made to hold the specific state to avoid the CPU state internally.\r
+ </remarks>\r
+ <privilege>\r
+ http://tizen.org/privilege/display\r
+ </privilege>\r
+ </member>\r
+ <member name="M:Tizen.System.Power.RequestCpuLock(System.Int32)">\r
+ <summary>\r
+ Locks the CPU for a specified time.\r
+ After the given timeout (in milliseconds), unlock the given lock state automatically.\r
+ </summary>\r
+ <remarks>\r
+ If the process dies, then every lock will be removed.\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="timeout">\r
+ The positive number in milliseconds or 0 for the permanent lock.\r
+ So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero.\r
+ </param>\r
+ <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <code>\r
+ Tizen.System.Power.RequestCpuLock(2000);\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Power.ReleaseCpuLock">\r
+ <summary>\r
+ Releases the CPU lock state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <code>\r
+ Tizen.System.Power.ReleaseCpuLock();\r
+ </code>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff