1 <?xml version="1.0"?>
\r
4 <name>Tizen.System</name>
\r
7 <member name="T:Tizen.System.BatteryLevelStatus">
\r
9 Enumeration for the battery levels.
\r
11 <since_tizen> 3 </since_tizen>
\r
13 <member name="F:Tizen.System.BatteryLevelStatus.Empty">
\r
15 The battery goes empty.
\r
16 Prepare for the safe termination of the application,
\r
17 because the device starts a shutdown process soon
\r
18 after entering this level.
\r
20 <since_tizen> 3 </since_tizen>
\r
22 <member name="F:Tizen.System.BatteryLevelStatus.Critical">
\r
24 The battery charge is at a critical state.
\r
25 You may have to stop using the multimedia features,
\r
26 because they are not guaranteed to work correctly
\r
27 with this battery status.
\r
29 <since_tizen> 3 </since_tizen>
\r
31 <member name="F:Tizen.System.BatteryLevelStatus.Low">
\r
33 The battery has little charge left.
\r
35 <since_tizen> 3 </since_tizen>
\r
37 <member name="F:Tizen.System.BatteryLevelStatus.High">
\r
39 The battery status is not to be careful.
\r
41 <since_tizen> 3 </since_tizen>
\r
43 <member name="F:Tizen.System.BatteryLevelStatus.Full">
\r
45 The battery status is fully charged.
\r
46 It means no more charge.
\r
48 <since_tizen> 3 </since_tizen>
\r
50 <member name="T:Tizen.System.Battery">
\r
52 The Battery class provides the properties and events for the device battery.
\r
55 The Battery API provides the way to get the current battery capacity value (Percent),
\r
56 the battery state, and the charging state. It also provides the events for an application
\r
57 to receive the battery status change events from the device.
\r
58 To receive the battery event, the application should register with the respective EventHandler.
\r
61 Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);
\r
62 Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);
\r
65 <member name="P:Tizen.System.Battery.Percent">
\r
67 Gets the battery charge percentage.
\r
69 <since_tizen> 3 </since_tizen>
\r
70 <value>It returns an integer value from 0 to 100 that indicates the remaining
\r
71 battery charge as a percentage of the maximum level.</value>
\r
73 <member name="P:Tizen.System.Battery.Level">
\r
75 Gets the current battery level.
\r
77 <since_tizen> 3 </since_tizen>
\r
79 <member name="P:Tizen.System.Battery.IsCharging">
\r
81 Gets the current charging state.
\r
83 <since_tizen> 3 </since_tizen>
\r
85 <!-- "E:Tizen.System.Battery.PercentChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->
\r
86 <!-- "E:Tizen.System.Battery.LevelChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->
\r
87 <!-- "E:Tizen.System.Battery.ChargingStateChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->
\r
88 <member name="T:Tizen.System.BatteryPercentChangedEventArgs">
\r
90 BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.
\r
93 <member name="P:Tizen.System.BatteryPercentChangedEventArgs.Percent">
\r
95 The current capacity of the battery.
\r
96 Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level.
\r
98 <since_tizen> 3 </since_tizen>
\r
100 <member name="T:Tizen.System.BatteryLevelChangedEventArgs">
\r
102 BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.
\r
105 <member name="P:Tizen.System.BatteryLevelChangedEventArgs.Level">
\r
107 The level indicates the current battery level status which is a type of the BatteryLevelStatus.
\r
109 <since_tizen> 3 </since_tizen>
\r
111 <member name="T:Tizen.System.BatteryChargingStateChangedEventArgs">
\r
113 BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.
\r
116 <member name="P:Tizen.System.BatteryChargingStateChangedEventArgs.IsCharging">
\r
118 The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.
\r
120 <since_tizen> 3 </since_tizen>
\r
122 <member name="T:Tizen.System.DisplayStateChangedEventArgs">
\r
124 DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.
\r
127 <member name="P:Tizen.System.DisplayStateChangedEventArgs.State">
\r
129 The state indicates the current display state of the device which is an enumeration of the type DisplayState.
\r
131 <since_tizen> 3 </since_tizen>
\r
133 <member name="T:Tizen.System.LedBrightnessChangedEventArgs">
\r
135 LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.
\r
138 <member name="P:Tizen.System.LedBrightnessChangedEventArgs.Brightness">
\r
140 Brightness indicates the current brightness level of the display as an integer.
\r
142 <since_tizen> 3 </since_tizen>
\r
144 <member name="T:Tizen.System.DisplayState">
\r
146 Enumeration for the available display states.
\r
147 An application cannot put the device into the power off state or the suspend state.
\r
149 <since_tizen> 3 </since_tizen>
\r
151 <member name="F:Tizen.System.DisplayState.Normal">
\r
155 <since_tizen> 3 </since_tizen>
\r
157 <member name="F:Tizen.System.DisplayState.Dim">
\r
161 <since_tizen> 3 </since_tizen>
\r
163 <member name="F:Tizen.System.DisplayState.Off">
\r
167 <since_tizen> 3 </since_tizen>
\r
169 <member name="T:Tizen.System.Display">
\r
171 The Display class provides the properties and events to control the display status and brightness.
\r
174 The Display API provides the way to get the current display brightness value,
\r
175 the display state, and the total number of available displays.
\r
176 It also provides the events for an application to receive the display state change events from the device.
\r
177 To receive the display event, the application should register with an associated EventHandler.
\r
180 http://tizen.org/privilege/display
\r
183 Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
\r
184 Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);
\r
187 <member name="P:Tizen.System.Display.NumberOfDisplays">
\r
189 The number of available display devices.
\r
191 <since_tizen> 3 </since_tizen>
\r
193 <member name="P:Tizen.System.Display.Displays">
\r
195 Gets all the available displays.
\r
196 The display at the index zero is always assigned to the main display.
\r
198 <since_tizen> 3 </since_tizen>
\r
200 <member name="P:Tizen.System.Display.MaxBrightness">
\r
202 The maximum brightness value that can be set for the specific display.
\r
204 <since_tizen> 3 </since_tizen>
\r
206 Display display = Display.Displays[0];
\r
207 Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
\r
210 <member name="P:Tizen.System.Display.Brightness">
\r
212 The brightness value of the display.
\r
215 The brightness value should be less than or equal to the MaxBrightness value.
\r
217 <since_tizen> 3 </since_tizen>
\r
218 <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
\r
219 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
221 Display display = Display.Displays[0];
\r
222 Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
\r
225 <member name="P:Tizen.System.Display.State">
\r
227 The current device display state.
\r
229 <since_tizen> 3 </since_tizen>
\r
231 <!-- "E:Tizen.System.Display.StateChanged" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->
\r
232 <member name="T:Tizen.System.Vibrator">
\r
234 The Vibrator class provides the properties and methods to control a vibrator.
\r
237 The Vibrator API provides the way to access the vibrators in the device.
\r
238 It allows the management of the device's vibrator parameters, such as the vibration count and level.
\r
239 It provides the methods to vibrate and stop the vibration.
\r
242 http://tizen.org/privilege/haptic
\r
245 Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);
\r
248 <member name="P:Tizen.System.Vibrator.NumberOfVibrators">
\r
250 Gets the number of the available vibrators.
\r
252 <since_tizen> 3 </since_tizen>
\r
254 <member name="P:Tizen.System.Vibrator.Vibrators">
\r
256 Gets all the available vibrators.
\r
258 <since_tizen> 3 </since_tizen>
\r
260 <member name="M:Tizen.System.Vibrator.Vibrate(System.Int32,System.Int32)">
\r
262 Vibrates during the specified time with a constant intensity.
\r
263 This function can be used to start monotonous vibration for the specified time.
\r
265 <since_tizen> 3 </since_tizen>
\r
266 <param name="duration">The play duration in milliseconds.</param>
\r
267 <param name="feedback">The amount of the intensity variation (0 ~ 100).</param>
\r
268 <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
\r
269 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
270 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
271 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
273 Vibrator vibrator = Vibrator.Vibrators[0];
\r
276 vibrator.Vibrate(2000, 70);
\r
283 <member name="M:Tizen.System.Vibrator.Stop">
\r
285 Stops all the vibration effects which are being played.
\r
286 This function can be used to stop all the effects started by Vibrate().
\r
288 <since_tizen> 3 </since_tizen>
\r
289 <exception cref="T:System.ArgumentException"> In case an invalid vibrator instance is used.</exception>
\r
290 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
291 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
292 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
294 Vibrator vibrator = Vibrator.Vibrators[0];
\r
304 <member name="M:Tizen.System.Vibrator.Dispose">
\r
306 Dispose API for closing the internal resources.
\r
307 This function can be used to stop all the effects started by Vibrate().
\r
309 <since_tizen> 3 </since_tizen>
\r
311 <member name="T:Tizen.System.IR">
\r
313 The IR API provides the functions to control the IR transmitter.
\r
314 The IR API provides the way to get the information if IR is available and then transmit the IR command.
\r
317 http://tizen.org/privilege/use_ir
\r
320 Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);
\r
323 <member name="P:Tizen.System.IR.IsAvailable">
\r
325 Gets the information whether the IR module is available.
\r
327 <since_tizen> 3 </since_tizen>
\r
329 <!-- "M:Tizen.System.IR.Transmit(System.Int32,System.Collections.Generic.IList{System.Int32})" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->
\r
330 <member name="T:Tizen.System.Led">
\r
332 The LED class provides the properties and methods to control the attached LED device.
\r
335 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
337 http://tizen.org/feature/led
\r
338 http://tizen.org/feature/camera.back.flash
\r
339 It is recommended to design the feature related codes in your application for reliability.
\r
340 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
343 http://tizen.org/privilege/led
\r
346 Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);
\r
347 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
\r
350 <member name="P:Tizen.System.Led.MaxBrightness">
\r
352 Gets the maximum brightness value of the LED that is located next to the camera.
\r
353 <since_tizen> 3 </since_tizen>
\r
354 <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
\r
355 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
356 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
359 <member name="P:Tizen.System.Led.Brightness">
\r
361 Gets the brightness value of the LED that is located next to the camera.
\r
363 <remarks>The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value.
\r
364 Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any).
\r
366 <since_tizen> 3 </since_tizen>
\r
367 <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
\r
368 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
369 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
371 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
\r
372 Tizen.System.Led.Brightness = 50;
\r
373 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
\r
376 <member name="M:Tizen.System.Led.Play(System.Int32,System.Int32,Tizen.Common.Color)">
\r
378 Plays the LED that is located at the front of the device.
\r
380 <since_tizen> 3 </since_tizen>
\r
381 <param name="on">Turn on time in milliseconds.</param>
\r
382 <param name="off">Turn off time in milliseconds.</param>
\r
383 <param name="color">
\r
385 The first byte means opaque and the other 3 bytes are the RGB values.
\r
387 <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
\r
388 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
389 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
390 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
394 Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
\r
401 <member name="M:Tizen.System.Led.Stop">
\r
403 Stops the LED that is located at the front of the device.
\r
405 <since_tizen> 3 </since_tizen>
\r
406 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
407 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
408 <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
\r
412 Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
\r
413 //wait for a while and stop...
\r
421 <member name="E:Tizen.System.Led.BrightnessChanged">
\r
423 StateChanged is raised when the LED state is changed.
\r
425 <since_tizen> 3 </since_tizen>
\r
426 <param name="sender">The source of the event.</param>
\r
427 <param name="e">LedBrightnessChangedEventArgs is an object that contains the changed brightness.</param>
\r
429 <member name="T:Tizen.System.Power">
\r
431 The Power class provides methods to control the power service.
\r
434 The Power API provides the way to control the power service.
\r
435 It can be made to hold the specific state to avoid the CPU state internally.
\r
438 http://tizen.org/privilege/display
\r
441 <member name="M:Tizen.System.Power.RequestCpuLock(System.Int32)">
\r
443 Locks the CPU for a specified time.
\r
444 After the given timeout (in milliseconds), unlock the given lock state automatically.
\r
447 If the process dies, then every lock will be removed.
\r
449 <since_tizen> 3 </since_tizen>
\r
450 <param name="timeout">
\r
451 The positive number in milliseconds or 0 for the permanent lock.
\r
452 So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero.
\r
454 <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
\r
455 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
456 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
458 Tizen.System.Power.RequestCpuLock(2000);
\r
461 <member name="M:Tizen.System.Power.ReleaseCpuLock">
\r
463 Releases the CPU lock state.
\r
465 <since_tizen> 3 </since_tizen>
\r
466 <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
\r
467 <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
\r
469 Tizen.System.Power.ReleaseCpuLock();
\r