magnetometer

来自于：开发者立即使用

checkUp startListener stopListener

概述

magnetometer 模块概述

magnetometer封装了iOS系统的磁力感应，使用此模块可轻松实现对可以让你监控在地球的磁场中的变化的功能。

模块接口

checkUp

检查设备是否有磁力感应

checkUp(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{

    code:              //0代表设备有磁力感应，1代表设备没有磁力感应

}

err：

  • 类型：JSON 对象
  • 内部字段：
{
                    //无返回值
}

示例代码

var magnetometer= api.require('magnetometer');
magnetometer.checkUp(function(ret,err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.0.0及更高版本

startListener

打开磁力感应

startListener({params}, callback(ret, err))

params

time：

  • 类型：字符串
  • 描述：（必选）采集信息间隔时间，以秒为单位。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    x:              //地磁场强度沿x轴(μT)
    y:              //地磁场强度沿y轴(μT)
    z:              //地磁场强度沿z轴(μT)
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
                    //无返回值
}

示例代码

var magnetometer= api.require('magnetometer');
magnetometer.startListener({
    time : '0.1'
},function(ret, err){
    var msg =  JSON.stringify(ret);
    api.toast({
        msg: msg
    });
});

补充说明

经过测试，当间隔时间设置较长时，5s机型第一返回值时间会变长，建议设置0.1秒。

可用性

iOS系统

可提供的1.0.0及更高版本

stopListener

关闭磁力感应

stopListener()

示例代码

var magnetometer = api.require('magnetometer');
magnetometer.stopListener();

可用性

iOS系统

可提供的1.0.0及更高版本