accelerometer.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
  6. <meta name="HandheldFriendly" content="true">
  7. <meta name="MobileOptimized" content="320">
  8. <title>Accelerometer Document</title>
  9. <link rel="stylesheet" type="text/css" href="res/doc.css" charset="utf-8">
  10. <link rel="stylesheet" type="text/css" href="res/prettify.sons.css" charset="utf-8">
  11. <script type="text/javascript" src="res/doc.js" charset="utf-8"></script><script type="text/javascript" src="res/prettify.js" charset="utf-8"></script>
  12. </head>
  13. <body><div id="content" class="content">
  14. <h1><a name="plus.accelerometer">accelerometer</a></h1>
  15. <p>Accelerometer模块管理设备加速度传感器,用于获取设备加速度信息,包括x(屏幕水平方向)、y(垂直屏幕水平方向)、z(垂直屏幕平面方向)三个方向的加速度信息。通过plus.accelerometer获取设备加速度传感器管理对象。</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.accelerometer.getCurrentAcceleration">getCurrentAcceleration</a>: 获取当前设备的加速度信息</li>
  20. <li>
  21. <a href="#plus.accelerometer.watchAcceleration">watchAcceleration</a>: 监听设备加速度变化信息</li>
  22. <li>
  23. <a href="#plus.accelerometer.clearWatch">clearWatch</a>: 关闭监听设备加速度信息</li>
  24. </ul>
  25. <h2>对象:</h2>
  26. <ul>
  27. <li>
  28. <a href="#plus.accelerometer.Acceleration">Acceleration</a>: 设备加速度信息对象</li>
  29. <li>
  30. <a href="#plus.accelerometer.AccelerometerOption">AccelerometerOption</a>: 监听设备加速度感应器参数</li>
  31. </ul>
  32. <h2>回调方法:</h2>
  33. <ul>
  34. <li>
  35. <a href="#plus.accelerometer.AccelerometerSuccessCallback">AccelerometerSuccessCallback</a>: 获取设备加速度信息成功的回调函数</li>
  36. <li>
  37. <a href="#plus.accelerometer.AccelerometerErrorCallback">AccelerometerErrorCallback</a>: 获取设备加速度信息失败的回调函数</li>
  38. </ul>
  39. <h2>权限:</h2>
  40. <p>5+功能模块(permissions)</p>
  41. <pre class="prettyprint linenums">
  42. {
  43. // ...
  44. "permissions":{
  45. // ...
  46. "Accelerometer": {
  47. "description": "加速度传感器"
  48. }
  49. }
  50. }
  51. </pre>
  52. <h1><a name="plus.accelerometer.Acceleration">Acceleration</a></h1>
  53. <p>设备加速度信息对象</p>
  54. <pre class="prettyprint linenums">
  55. interface Acceleration {
  56. readonly attribute Number xAxis;
  57. readonly attribute Number yAxis;
  58. readonly attribute Number zAxis;
  59. }
  60. </pre>
  61. <h2>说明:</h2>
  62. <p class="des">
  63. JSON对象,保存获取设备的加速度信息,包括x、y、z三个方向的加速度信息。
  64. </p>
  65. <h2>属性:</h2>
  66. <ul>
  67. <li>xAxis: <em>(<font class="type">Number</font>
  68. 类型
  69. )</em>x轴方向的加速度<br><p>获取当前设备x轴方向的加速度,浮点型数据,与物理学中的加速度值一致。</p>
  70. </li>
  71. <li>yAxis: <em>(<font class="type">Number</font>
  72. 类型
  73. )</em>y轴方向的加速度<br><p>获取当前设备y轴方向的加速度,浮点型数据,与物理学中的加速度值一致。</p>
  74. </li>
  75. <li>zAxis: <em>(<font class="type">Number</font>
  76. 类型
  77. )</em>z轴方向的加速度<br><p>获取当前设备z轴方向的加速度,浮点型数据,与物理学中的加速度值一致。</p>
  78. </li>
  79. </ul>
  80. <h1><a name="plus.accelerometer.AccelerometerOption">AccelerometerOption</a></h1>
  81. <p>监听设备加速度感应器参数</p>
  82. <pre class="prettyprint linenums">
  83. interface Acceleration {
  84. readonly attribute DOMString frequency;
  85. }
  86. </pre>
  87. <h2>说明:</h2>
  88. <p class="des">
  89. JSON对象,用于设置获取设备加速度信息的参数。
  90. </p>
  91. <h2>属性:</h2>
  92. <ul><li>frequency: <em>(<font class="type">Number</font>
  93. 类型
  94. )</em>更新加速度信息间隔时间<br><p>监听器获取加速度信息的时间间隔,单位为ms,默认值为500ms</p>
  95. </li></ul>
  96. <h1><a name="plus.accelerometer.AccelerometerSuccessCallback">AccelerometerSuccessCallback</a></h1>
  97. <p>获取设备加速度信息成功的回调函数</p>
  98. <pre class="prettyprint linenums">
  99. void onSuccess( acceleration ) {
  100. // Get acceleration code.
  101. }
  102. </pre>
  103. <h2>参数:</h2>
  104. <ul><li>acceleration:
  105. <em>(
  106. <a href="#plus.accelerometer.Acceleration">Acceleration</a>
  107. )
  108. 必选 </em>设备的加速度信息<br>
  109. Acceleration类型对象,用于获取各方向的详细加速度值。
  110. </li></ul>
  111. <h2>返回值:</h2>
  112. <font class="type">void</font>
  113. : 无<h1><a name="plus.accelerometer.AccelerometerErrorCallback">AccelerometerErrorCallback</a></h1>
  114. <p>获取设备加速度信息失败的回调函数</p>
  115. <pre class="prettyprint linenums">
  116. function void onAccelerometerError(Exception error) {
  117. // Handle error
  118. var code = error.code; // 错误编码
  119. var message = error.message; // 错误描述信息
  120. }
  121. </pre>
  122. <h2>参数:</h2>
  123. <ul><li>error:
  124. <em>(
  125. <font class="type">Exception</font>
  126. )
  127. 必选 </em>获取加速度操作的错误信息<br>
  128. 可通过error.code(Number类型)获取错误编码;
  129. 可通过error.message(String类型)获取错误描述信息。
  130. </li></ul>
  131. <h2>返回值:</h2>
  132. <font class="type">void</font>
  133. : 无<br><br>
  134. </div></body>
  135. </html>