X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=Artifacts%2Fbin%2Fpublic%2FTizen.System.xml;h=963c2ff6f18960e52adcf40e5870bd8718403f2f;hb=12c9ab8b3191a614dc9006b57c1cba6e1f3b6d13;hp=d0a26d80da9954288e25825009a7beaa08c83aa7;hpb=4a5f0d13f882565b23d5d4a11dc1c378fc164568;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git
diff --git a/Artifacts/bin/public/Tizen.System.xml b/Artifacts/bin/public/Tizen.System.xml
index d0a26d8..963c2ff 100644
--- a/Artifacts/bin/public/Tizen.System.xml
+++ b/Artifacts/bin/public/Tizen.System.xml
@@ -1,473 +1,473 @@
-
-
-
- Tizen.System
-
-
-
-
- Enumeration for the battery levels.
-
- 3
-
-
-
- The battery goes empty.
- Prepare for the safe termination of the application,
- because the device starts a shutdown process soon
- after entering this level.
-
- 3
-
-
-
- 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.
-
- 3
-
-
-
- The battery has little charge left.
-
- 3
-
-
-
- The battery status is not to be careful.
-
- 3
-
-
-
- The battery status is fully charged.
- It means no more charge.
-
- 3
-
-
-
- The Battery class provides the properties and events for the device battery.
-
-
- 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.
-
-
- Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);
- Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);
-
-
-
-
- Gets the battery charge percentage.
-
- 3
- It returns an integer value from 0 to 100 that indicates the remaining
- battery charge as a percentage of the maximum level.
-
-
-
- Gets the current battery level.
-
- 3
-
-
-
- Gets the current charging state.
-
- 3
-
-
-
-
-
-
- BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.
-
-
-
-
- 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.
-
- 3
-
-
-
- BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.
-
-
-
-
- The level indicates the current battery level status which is a type of the BatteryLevelStatus.
-
- 3
-
-
-
- BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.
-
-
-
-
- The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.
-
- 3
-
-
-
- DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.
-
-
-
-
- The state indicates the current display state of the device which is an enumeration of the type DisplayState.
-
- 3
-
-
-
- LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.
-
-
-
-
- Brightness indicates the current brightness level of the display as an integer.
-
- 3
-
-
-
- Enumeration for the available display states.
- An application cannot put the device into the power off state or the suspend state.
-
- 3
-
-
-
- Normal state.
-
- 3
-
-
-
- Screen dim state.
-
- 3
-
-
-
- Screen off state.
-
- 3
-
-
-
- The Display class provides the properties and events to control the display status and brightness.
-
-
- 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.
-
-
- http://tizen.org/privilege/display
-
-
- Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
- Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);
-
-
-
-
- The number of available display devices.
-
- 3
-
-
-
- Gets all the available displays.
- The display at the index zero is always assigned to the main display.
-
- 3
-
-
-
- The maximum brightness value that can be set for the specific display.
-
- 3
-
- Display display = Display.Displays[0];
- Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
-
-
-
-
- The brightness value of the display.
-
-
- The brightness value should be less than or equal to the MaxBrightness value.
-
- 3
- When an invalid parameter value is set.
- If the privilege is not set.
-
- Display display = Display.Displays[0];
- Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
-
-
-
-
- The current device display state.
-
- 3
-
-
-
-
- The Vibrator class provides the properties and methods to control a vibrator.
-
-
- 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.
-
-
- http://tizen.org/privilege/haptic
-
-
- Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);
-
-
-
-
- Gets the number of the available vibrators.
-
- 3
-
-
-
- Gets all the available vibrators.
-
- 3
-
-
-
- Vibrates during the specified time with a constant intensity.
- This function can be used to start monotonous vibration for the specified time.
-
- 3
- The play duration in milliseconds.
- The amount of the intensity variation (0 ~ 100).
- When an invalid parameter value is set.
- If the privilege is not set.
- In case of any system error.
- In case the device does not support this behavior.
-
- Vibrator vibrator = Vibrator.Vibrators[0];
- try
- {
- vibrator.Vibrate(2000, 70);
- }
- Catch(Exception e)
- {
- }
-
-
-
-
- Stops all the vibration effects which are being played.
- This function can be used to stop all the effects started by Vibrate().
-
- 3
- In case an invalid vibrator instance is used.
- If the privilege is not set.
- In case of any system error.
- In case the device does not support this behavior.
-
- Vibrator vibrator = Vibrator.Vibrators[0];
- try
- {
- vibrator.Stop();
- }
- Catch(Exception e)
- {
- }
-
-
-
-
- Dispose API for closing the internal resources.
- This function can be used to stop all the effects started by Vibrate().
-
- 3
-
-
-
- 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.
-
-
- http://tizen.org/privilege/use_ir
-
-
- Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);
-
-
-
-
- Gets the information whether the IR module is available.
-
- 3
-
-
-
-
- The LED class provides the properties and methods to control the attached LED device.
-
-
- 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.
-
-
- http://tizen.org/privilege/led
-
-
- Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);
- Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
-
-
-
-
- Gets the maximum brightness value of the LED that is located next to the camera.
- 3
- When an invalid parameter value is set.
- If the privilege is not set.
- In case the device does not support this behavior.
-
-
-
-
- Gets the brightness value of the LED that is located next to the camera.
-
- 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).
-
- 3
- When an invalid parameter value is set.
- If the privilege is not set.
- In case the device does not support this behavior.
-
- 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);
-
-
-
-
- Plays the LED that is located at the front of the device.
-
- 3
- Turn on time in milliseconds.
- Turn off time in milliseconds.
-
- The Color value
- The first byte means opaque and the other 3 bytes are the RGB values.
-
- When an invalid parameter value is set.
- If the privilege is not set.
- In case of any system error.
- In case the device does not support this behavior.
-
- try
- {
- Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
- }
- Catch(Exception e)
- {
- }
-
-
-
-
- Stops the LED that is located at the front of the device.
-
- 3
- If the privilege is not set.
- In case of any system error.
- In case the device does not support this behavior.
-
- try
- {
- Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
- //wait for a while and stop...
- Led.Stop();
- }
- Catch(Exception e)
- {
- }
-
-
-
-
- StateChanged is raised when the LED state is changed.
-
- 3
- The source of the event.
- LedBrightnessChangedEventArgs is an object that contains the changed brightness.
-
-
-
- The Power class provides methods to control the power service.
-
-
- 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.
-
-
- http://tizen.org/privilege/display
-
-
-
-
- Locks the CPU for a specified time.
- After the given timeout (in milliseconds), unlock the given lock state automatically.
-
-
- If the process dies, then every lock will be removed.
-
- 3
-
- 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.
-
- When an invalid parameter value is set.
- If the privilege is not set.
- In case of any system error.
-
- Tizen.System.Power.RequestCpuLock(2000);
-
-
-
-
- Releases the CPU lock state.
-
- 3
- If the privilege is not set.
- In case of any system error.
-
- Tizen.System.Power.ReleaseCpuLock();
-
-
-
-
+
+
+
+ Tizen.System
+
+
+
+
+ Enumeration for the battery levels.
+
+ 3
+
+
+
+ The battery goes empty.
+ Prepare for the safe termination of the application,
+ because the device starts a shutdown process soon
+ after entering this level.
+
+ 3
+
+
+
+ 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.
+
+ 3
+
+
+
+ The battery has little charge left.
+
+ 3
+
+
+
+ The battery status is not to be careful.
+
+ 3
+
+
+
+ The battery status is fully charged.
+ It means no more charge.
+
+ 3
+
+
+
+ The Battery class provides the properties and events for the device battery.
+
+
+ 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.
+
+
+ Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);
+ Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);
+
+
+
+
+ Gets the battery charge percentage.
+
+ 3
+ It returns an integer value from 0 to 100 that indicates the remaining
+ battery charge as a percentage of the maximum level.
+
+
+
+ Gets the current battery level.
+
+ 3
+
+
+
+ Gets the current charging state.
+
+ 3
+
+
+
+
+
+
+ BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.
+
+
+
+
+ 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.
+
+ 3
+
+
+
+ BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.
+
+
+
+
+ The level indicates the current battery level status which is a type of the BatteryLevelStatus.
+
+ 3
+
+
+
+ BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.
+
+
+
+
+ The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.
+
+ 3
+
+
+
+ DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.
+
+
+
+
+ The state indicates the current display state of the device which is an enumeration of the type DisplayState.
+
+ 3
+
+
+
+ LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.
+
+
+
+
+ Brightness indicates the current brightness level of the display as an integer.
+
+ 3
+
+
+
+ Enumeration for the available display states.
+ An application cannot put the device into the power off state or the suspend state.
+
+ 3
+
+
+
+ Normal state.
+
+ 3
+
+
+
+ Screen dim state.
+
+ 3
+
+
+
+ Screen off state.
+
+ 3
+
+
+
+ The Display class provides the properties and events to control the display status and brightness.
+
+
+ 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.
+
+
+ http://tizen.org/privilege/display
+
+
+ Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
+ Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);
+
+
+
+
+ The number of available display devices.
+
+ 3
+
+
+
+ Gets all the available displays.
+ The display at the index zero is always assigned to the main display.
+
+ 3
+
+
+
+ The maximum brightness value that can be set for the specific display.
+
+ 3
+
+ Display display = Display.Displays[0];
+ Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
+
+
+
+
+ The brightness value of the display.
+
+
+ The brightness value should be less than or equal to the MaxBrightness value.
+
+ 3
+ When an invalid parameter value is set.
+ If the privilege is not set.
+
+ Display display = Display.Displays[0];
+ Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
+
+
+
+
+ The current device display state.
+
+ 3
+
+
+
+
+ The Vibrator class provides the properties and methods to control a vibrator.
+
+
+ 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.
+
+
+ http://tizen.org/privilege/haptic
+
+
+ Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);
+
+
+
+
+ Gets the number of the available vibrators.
+
+ 3
+
+
+
+ Gets all the available vibrators.
+
+ 3
+
+
+
+ Vibrates during the specified time with a constant intensity.
+ This function can be used to start monotonous vibration for the specified time.
+
+ 3
+ The play duration in milliseconds.
+ The amount of the intensity variation (0 ~ 100).
+ When an invalid parameter value is set.
+ If the privilege is not set.
+ In case of any system error.
+ In case the device does not support this behavior.
+
+ Vibrator vibrator = Vibrator.Vibrators[0];
+ try
+ {
+ vibrator.Vibrate(2000, 70);
+ }
+ Catch(Exception e)
+ {
+ }
+
+
+
+
+ Stops all the vibration effects which are being played.
+ This function can be used to stop all the effects started by Vibrate().
+
+ 3
+ In case an invalid vibrator instance is used.
+ If the privilege is not set.
+ In case of any system error.
+ In case the device does not support this behavior.
+
+ Vibrator vibrator = Vibrator.Vibrators[0];
+ try
+ {
+ vibrator.Stop();
+ }
+ Catch(Exception e)
+ {
+ }
+
+
+
+
+ Dispose API for closing the internal resources.
+ This function can be used to stop all the effects started by Vibrate().
+
+ 3
+
+
+
+ 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.
+
+
+ http://tizen.org/privilege/use_ir
+
+
+ Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);
+
+
+
+
+ Gets the information whether the IR module is available.
+
+ 3
+
+
+
+
+ The LED class provides the properties and methods to control the attached LED device.
+
+
+ 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.
+
+
+ http://tizen.org/privilege/led
+
+
+ Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);
+ Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
+
+
+
+
+ Gets the maximum brightness value of the LED that is located next to the camera.
+ 3
+ When an invalid parameter value is set.
+ If the privilege is not set.
+ In case the device does not support this behavior.
+
+
+
+
+ Gets the brightness value of the LED that is located next to the camera.
+
+ 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).
+
+ 3
+ When an invalid parameter value is set.
+ If the privilege is not set.
+ In case the device does not support this behavior.
+
+ 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);
+
+
+
+
+ Plays the LED that is located at the front of the device.
+
+ 3
+ Turn on time in milliseconds.
+ Turn off time in milliseconds.
+
+ The Color value
+ The first byte means opaque and the other 3 bytes are the RGB values.
+
+ When an invalid parameter value is set.
+ If the privilege is not set.
+ In case of any system error.
+ In case the device does not support this behavior.
+
+ try
+ {
+ Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
+ }
+ Catch(Exception e)
+ {
+ }
+
+
+
+
+ Stops the LED that is located at the front of the device.
+
+ 3
+ If the privilege is not set.
+ In case of any system error.
+ In case the device does not support this behavior.
+
+ try
+ {
+ Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
+ //wait for a while and stop...
+ Led.Stop();
+ }
+ Catch(Exception e)
+ {
+ }
+
+
+
+
+ StateChanged is raised when the LED state is changed.
+
+ 3
+ The source of the event.
+ LedBrightnessChangedEventArgs is an object that contains the changed brightness.
+
+
+
+ The Power class provides methods to control the power service.
+
+
+ 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.
+
+
+ http://tizen.org/privilege/display
+
+
+
+
+ Locks the CPU for a specified time.
+ After the given timeout (in milliseconds), unlock the given lock state automatically.
+
+
+ If the process dies, then every lock will be removed.
+
+ 3
+
+ 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.
+
+ When an invalid parameter value is set.
+ If the privilege is not set.
+ In case of any system error.
+
+ Tizen.System.Power.RequestCpuLock(2000);
+
+
+
+
+ Releases the CPU lock state.
+
+ 3
+ If the privilege is not set.
+ In case of any system error.
+
+ Tizen.System.Power.ReleaseCpuLock();
+
+
+
+