proximity

Proximity模块管理设备距离传感器，可获取当前设备的接近距离信息，通过plus.proximity可获取设备距离传感管理对象。

方法：

回调方法：

权限：

5+功能模块（permissions）

  2. {
  3. // ...
  4. "permissions":{
  5.     // ...
  6.     "Proximity": {
  7.         "description": "距离感应器"
  8.     }
  9. }
  10. }
  11.

getCurrentProximity

获取当前设备的接近距离信息

  2. void plus.proximity.getCurrentProximity( successCB, errorCB );
  3.

说明：

获取当前接近设备的距离信息，距离值单位为厘米。如果感应器无法获取准确的距离值，则在接近设备时返回0，否则返回Infinity。 获取成功则调用successCB回调函数返接近回距离值。获取失败则调用errorCB回调函数错误信息。

参数：

返回值：

void: 无

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

示例：

  3. <!DOCTYPE html>
  4. <html>
  5.     <head>
  6.     <meta charset="utf-8">
  7.     <title>Proximity Example</title>
  8.     <script type="text/javascript" >
  9. // 扩展API加载完毕后调用onPlusReady回调函数 
  10. document.addEventListener( "plusready", onPlusReady, false );
  11. // 扩展API加载完毕，现在可以正常调用扩展API
  12. function onPlusReady() {
  13. }
  14. function getProximity() {
  15.     plus.proximity.getCurrentProximity( function ( d ) {
  16.             alert( "Get distance success: "+d );
  17.         }, function ( e ) {
  18.             alert( "Error: "+e.message );
  19.         } );
  20. }
  21.     </script>
  22.     </head>
  23.     <body >
  24.         <input type='button' onclick='getProximity();' value='Proximity'/>
  25.     </body>
  26. </html>
  28.

uni-app使用plus注意事项

watchProximity

监听设备接近距离的变化

  2. Number plus.proximity.watchProximity( changeCB, errorCB );
  3.

说明：

watchProximity将监听设备的接近距离信息变化事件，当接近距离发生变化时通过changeCB回调函数返回距离值。监听距离变化事件失败则通过errorCB回调函数返回错误信息。

参数：

返回值：

Number: 用于标识接近距离变化事件监听器，可通过clearWatch方法取消监听。

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

示例：

  2. <!DOCTYPE html>
  3. <html>
  4.     <head>
  5.     <meta charset="utf-8">
  6.     <title>Proximity Example</title>
  7.     <script type="text/javascript" >
  8. // 扩展API加载完毕后调用onPlusReady回调函数 
  9. document.addEventListener( "plusready", onPlusReady, false );
  10. // 扩展API加载完毕，现在可以正常调用扩展API
  11. function onPlusReady() {
  12.     plus.proximity.watchProximity( function ( d ) {
  13.         document.getElementById("inf").innerText="Proximity: "+d;
  14.     }, function ( e ) {
  15.         alert( "Error: " + e.message ); 
  16.     } ); 
  17. }
  18.     </script>
  19.     </head>
  20.     <body >
  21.         Proximity watch<br/>
  22.         <span id="inf"></span>
  23.     </body>
  24. </html>
  25.

uni-app使用plus注意事项

clearWatch

关闭监听设备接近距离变化


void plus.proximity.clearWatch( watchId );

参数：

  • watchId: (Number)必选 需要取消的距离监听器标识，调用watchProximity方法的返回值。

返回值：

void: 无

平台支持：

  • Android- 2.2+(支持): 支持
  • iOS- 4.3+(支持): 支持

ProximitySuccessCallback

获取设备接近距离信息成功的回调函数


void onSuccess( distance ) {
    // Get distance success code.
}

参数：

  • distance: (Number)必选 设备接近距离设备接近距离传感器获取的距离值，单位为厘米。如果感应器无法获取准确的距离值，则在接近设备时返回0，否则返回Infinity。

返回值：

void: 无

ProximityErrorCallback

获取设备接近距离信息失败的回调函数


void onError( error ) {
    // Get distance error code.
}

参数：

  • error: (DOMException)必选 失败信息

返回值：

void: 无