API Reference

Plugins

Native.js


accelerometer

Accelerometer模块管理设备加速度传感器,用于获取设备加速度信息,包括x(屏幕水平方向)、y(垂直屏幕水平方向)、z(垂直屏幕平面方向)三个方向的加速度信息。通过plus.accelerometer获取设备加速度传感器管理对象。

方法:

对象:

回调方法:

模块:

5+功能模块(permissions)


{
// ...
"permissions":{
	// ...
	"Accelerometer": {
		"description": "加速度传感器"
	}
}
}
			

getCurrentAcceleration

获取当前设备的加速度信息


void plus.accelerometer.getCurrentAcceleration( successCB, errorCB );
				

说明:

加速度是设备在当前方向上所做相对运动变化(增、减量)的运动传感器。加速度信息包括x、y、z三个方向的信息。 加速度信息可通过successCB回调函数返回。加速度信息获取失败则调用回调函数errorCB。

参数:

返回值:

void : 无

示例:


// 获取加速度信息
function getCurrentAcceleration(){
	plus.accelerometer.getCurrentAcceleration( function( a ) {
		plus.nativeUI.alert( "Acceleration\nx:" + a.xAxis + "\ny:" + a.yAxis + "\nz:" + a.zAxis );
	} );
}
				

uni-app使用plus注意事项

watchAcceleration

监听设备加速度变化信息


Number plus.accelerometer.watchAcceleration( successCB, errorCB, option );
				

说明:

加速度是设备在当前方向上所做相对运动变化(增、减量)的运动传感器。加速度信息包括x、y、z三个方向的信息。 watchAcceleration每隔固定时间就获取一次设备的加速度信息,通过successCB回调函数返回。可通过option的frequency参数设定获取设备加速度信息的时间间隔。 加速度信息获取失败则调用回调函数errorCB。

参数:

返回值:

Number : 用于标识加速度信息监听器,可通过clearWatch方法取消监听。

示例:


var wid = null;
// 监听设备加速度变化
function watchAcceleration(){
	wid = plus.accelerometer.watchAcceleration( function ( a ) {
		console.log( "x:" + a.xAxis + "\ny:" + a.yAxis + "\nz:" + a.zAxis);
	}, function ( e ) {
		plus.nativeUI.alert("watchAcceleration error: " + JSON.stringify(e)); 
	} ); 
}
				

uni-app使用plus注意事项

clearWatch

关闭监听设备加速度信息


void plus.accelerometer.clearWatch( watchId );
				

说明:

关闭监听设备加速度信息,应用关闭调用watchAcceleration方法的开启的监听操作。

参数:

返回值:

void : 无

示例:


var wid = null;
// wid = plus.accelerometer.watchAcceleration(...);
// 关闭监听设备加速度
function clearWatch(){
	plus.accelerometer.clearWatch(wid);
	wid = null;
}
				

uni-app使用plus注意事项

Acceleration

设备加速度信息对象


interface Acceleration {
	readonly attribute Number xAxis;
	readonly attribute Number yAxis;
	readonly attribute Number zAxis;  
}
				

说明:

JSON对象,保存获取设备的加速度信息,包括x、y、z三个方向的加速度信息。

属性:

AccelerometerOption

监听设备加速度感应器参数


interface Acceleration {
	readonly attribute DOMString frequency;
}
				

说明:

JSON对象,用于设置获取设备加速度信息的参数。

属性:

示例:


var wid = null;
// 监听设备加速度变化
function watchAcceleration(){
	wid = plus.accelerometer.watchAcceleration( function ( a ) {
		console.log( "x:" + a.xAxis + "\ny:" + a.yAxis + "\nz:" + a.zAxis);
	}, function ( e ) {
		plus.nativeUI.alert("watchAcceleration error: " + JSON.stringify(e)); 
	}, {frequency:1000}); // 设置更新间隔时间为1s
}
				

uni-app使用plus注意事项

AccelerometerSuccessCallback

获取设备加速度信息成功的回调函数


void onSuccess( acceleration ) {
	// Get acceleration code.
}
				

参数:

返回值:

void : 无

AccelerometerErrorCallback

获取设备加速度信息失败的回调函数


function void onAccelerometerError(Exception error) {
	// Handle error
	var code = error.code; // 错误编码
	var message = error.message; // 错误描述信息
}
				

参数:

返回值:

void : 无