Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 81857245 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!9514 修改docs文档 

Merge pull request !9514 from 陈飞飞/master
上级 af85432a 535a0e8d
隐藏空白更改
内联 并排
Showing with 114 addition and 91 deletion
zh-cn/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @ 81857245
......@@ -29,7 +29,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler
监听加速度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -52,7 +52,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler
);
```
### LINEAR_ACCELERATION<sup>deprecated</sup>
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;LinearAccelerometerResponse&gt;, options?: Options): void
......@@ -60,7 +60,7 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Line
从API Version9开始该接口不再维护，推荐使用sensor.on.LINEAR_ACCELEROMETER<sup>9+</sup>
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -116,7 +116,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback
监听未校准加速度计传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -173,7 +173,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeRes
监听陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
**需要权限**：ohos.permission.GYROSCOPE ，该权限为系统权限
**需要权限**：ohos.permission.GYROSCOPE，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -201,7 +201,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback&lt;G
监听未校准陀螺仪传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
**需要权限**：ohos.permission.GYROSCOPE ，该权限为系统权限
**需要权限**：ohos.permission.GYROSCOPE，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -304,7 +304,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerRes
### AMBIENT_TEMPERATURE
on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;AmbientTemperatureResponse&gt;, options?: Options): void
on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;AmbientTemperatureResponse&gt;, options?: Options): void
监听环境温度传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
......@@ -318,6 +318,7 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;Ambie
| options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
**示例：**
```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
console.info('Temperature: ' + data.temperature);
......@@ -335,6 +336,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magneti
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
......@@ -361,6 +363,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
......@@ -421,6 +424,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityRespo
| options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
**示例：**
```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
console.info('Humidity: ' + data.humidity);
......@@ -438,6 +442,7 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerRes
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
......@@ -445,6 +450,7 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerRes
| options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 |
**示例：**
```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
console.info('Atmospheric pressure: ' + data.pressure);
......@@ -527,7 +533,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;Orientatio
);
```
### HEART_RATE<sup>deprecated</sup>
### HEART_RATE<sup>(deprecated)</sup>
on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;, options?: Options): void
......@@ -642,11 +648,12 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Accele
监听加速度传感器的数据变化一次。
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
......@@ -662,7 +669,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Accele
);
```
### LINEAR_ACCELERATION<sup>deprecated</sup>
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;LinearAccelerometerResponse&gt;): void
......@@ -670,7 +677,7 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Li
从API Version9开始该接口不再维护，推荐使用sensor.once.LINEAR_ACCELEROMETER<sup>9+</sup>
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -696,7 +703,7 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,callback:Callback&lt;L
订阅一次线性加速度传感器数据。
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -722,7 +729,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba
监听未校准加速度传感器的数据变化一次。
**需要权限**：ohos.permission.ACCELEROMETER ，该权限为系统权限
**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -775,7 +782,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeR
监听陀螺仪传感器的数据变化一次。
**需要权限**：ohos.permission.GYROSCOPE ，该权限为系统权限
**需要权限**：ohos.permission.GYROSCOPE，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -801,7 +808,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l
监听未校准陀螺仪传感器的数据变化一次。
**需要权限**：ohos.permission.GYROSCOPE ，该权限为系统权限
**需要权限**：ohos.permission.GYROSCOPE，该权限为系统权限
**系统能力**：SystemCapability.Sensors.Sensor
......@@ -925,6 +932,7 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magne
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
......@@ -976,6 +984,7 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityR
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
......@@ -1064,12 +1073,14 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightR
**系统能力**：SystemCapability.Sensors.Sensor
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。 |
**示例：**
```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
console.info(' Illumination: ' + data.intensity);
......@@ -1126,7 +1137,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback&lt;Rota
);
```
### HEART_RATE<sup>deprecated</sup>
### HEART_RATE<sup>(deprecated)</sup>
once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;): void
......@@ -1437,7 +1448,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback);
```
### HEART_RATE<sup>deprecated</sup>
### HEART_RATE<sup>(deprecated)</sup>
off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback&lt;HeartRateResponse&gt;): void
......@@ -1515,7 +1526,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback);
```
### LINEAR_ACCELERATION<sup>deprecated</sup>
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback&lt;LinearAccelerometerResponse&gt;): void
......@@ -2385,7 +2396,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
## sensor.getSensorLists<sup>9+</sup>
getSensorLists(callback: AsyncCallback<Array&lt;sensor&gt;>): void
getSensorLists(callback: AsyncCallback<Array&lt;Sensor&gt;>): void
获取设备上的所有传感器信息。
......@@ -2393,20 +2404,20 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback<Array&lt;[Sensor](#sensor)&gt;> | 是 | 返回传感器列表。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback<Array&lt;[Sensor](#sensor9)&gt;> | 是 | 返回传感器列表。 |
**示例：**
```js
sensor.getSensorList((error, data) => {
sensor.getSensorLists((error, data) => {
if (error) {
console.error('getSensorList failed');
console.error('getSensorLists failed');
} else {
console.info("getSensorList callback in" + data.length);
console.info("getSensorLists callback in" + data.length);
for (var i = 0; i < data.length; i++) {
console.info("getSensorList " + JSON.stringify(data[i]));
console.info("getSensorLists " + JSON.stringify(data[i]));
}
}
});
......@@ -2422,26 +2433,26 @@ sensor.getSensorList((error, data) => {
**返回值：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ---------------- |
| promise | Promise<Array&lt;[Sensor](#sensor)&gt;> | 是 | 返回传感器列表。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ---------------- |
| promise | Promise<Array&lt;[Sensor](#sensor9)&gt;> | 是 | 返回传感器列表。 |
**示例：**
```js
sensor.getSensorList().then((data) => {
console.info("getSensorList promise in" + data.length);
sensor.getSensorLists().then((data) => {
console.info("getSensorLists promise in" + data.length);
for (var i = 0; i < data.length; i++) {
console.info("getSensorList " + JSON.stringify(data[i]));
console.info("getSensorLists " + JSON.stringify(data[i]));
}
}, (error)=>{
console.error('getSensorList failed');
console.error('getSensorLists failed');
});
```
## sensor.getSingleSensor<sup>9+</sup>
getSingleSensor(type：SensorType, callback: AsyncCallback&lt;sensor&gt;): void
getSingleSensor(type: SensorType, callback: AsyncCallback&lt;Sensor&gt;): void
获取指定类型的传感器信息。
......@@ -2449,12 +2460,12 @@ getSingleSensor(type：SensorType, callback: AsyncCallback&lt;sensor&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------- |
| type | SensorType | 是 | 传感器类型。 |
| callback | AsyncCallback&lt;[Sensor](#sensor)&gt; | 是 | 返回传感器信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- |
| type | SensorType | 是 | 传感器类型。 |
| callback | AsyncCallback&lt;[Sensor](#sensor9)&gt; | 是 | 返回传感器信息。 |
**示例：**
**示例：**
```js
sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (error, data) => {
......@@ -2468,7 +2479,7 @@ getSingleSensor(type：SensorType, callback: AsyncCallback&lt;sensor&gt;): void
## sensor.getSingleSensor<sup>9+</sup>
getSingleSensor(type: SensorType,): Promise&lt;Sensor&gt;
getSingleSensor(type: SensorType): Promise&lt;Sensor&gt;
获取指定类型的传感器信息。
......@@ -2482,9 +2493,9 @@ getSingleSensor(type：SensorType, callback: AsyncCallback&lt;sensor&gt;): void
**返回值：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------------------- | ---- | ---------------- |
| promise | Promise&lt;[Sensor](#sensor)&gt; | 是 | 返回传感器信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------- | ---- | ---------------- |
| promise | Promise&lt;[Sensor](#sensor9)&gt; | 是 | 返回传感器信息。 |
**示例：**
......@@ -2503,31 +2514,31 @@ sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER).then((dat
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 默认值 | 说明 |
| ---------------------------------------- | ---- | ----------- |
| SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 |
| SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD | 6 | 磁场传感器。 |
| SENSOR_TYPE_ID_BAROMETER | 8 | 气压计传感器。 |
| SENSOR_TYPE_ID_HALL | 10 | 霍尔传感器。 |
| SENSOR_TYPE_ID_PROXIMITY | 12 | 接近光传感器。 |
| SENSOR_TYPE_ID_HUMIDITY | 13 | 湿度传感器。 |
| SENSOR_TYPE_ID_ORIENTATION | 256 | 方向传感器。 |
| SENSOR_TYPE_ID_GRAVITY | 257 | 重力传感器。 |
| SENSOR_TYPE_ID_LINEAR_ACCELERATION<sup>deprecated</sup> | 258 | 线性加速度传感器。 |
| SENSOR_TYPE_ID_LINEAR_ACCELEROMETER | 258 | 线性加速度传感器。 |
| SENSOR_TYPE_ID_ROTATION_VECTOR | 259 | 旋转矢量传感器。 |
| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 260 | 环境温度传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261 | 未校准磁场传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 263 | 未校准陀螺仪传感器。 |
| SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 264 | 有效运动传感器。 |
| SENSOR_TYPE_ID_PEDOMETER_DETECTION | 265 | 计步检测传感器。 |
| SENSOR_TYPE_ID_PEDOMETER | 266 | 计步传感器。 |
| SENSOR_TYPE_ID_HEART_RATE<sup>deprecated</sup> | 278 | 心率传感器。 |
| SENSOR_TYPE_ID_HEART_BEAT_RATE | 278 | 心率传感器。 |
| SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 |
| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |
| 名称 | 默认值 | 说明 |
| --------------------------------------------------------- | ------ | ---------------------- |
| SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 |
| SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD | 6 | 磁场传感器。 |
| SENSOR_TYPE_ID_BAROMETER | 8 | 气压计传感器。 |
| SENSOR_TYPE_ID_HALL | 10 | 霍尔传感器。 |
| SENSOR_TYPE_ID_PROXIMITY | 12 | 接近光传感器。 |
| SENSOR_TYPE_ID_HUMIDITY | 13 | 湿度传感器。 |
| SENSOR_TYPE_ID_ORIENTATION | 256 | 方向传感器。 |
| SENSOR_TYPE_ID_GRAVITY | 257 | 重力传感器。 |
| SENSOR_TYPE_ID_LINEAR_ACCELERATION<sup>(deprecated)</sup> | 258 | 线性加速度传感器。 |
| SENSOR_TYPE_ID_LINEAR_ACCELEROMETER<sup>9+</sup> | 258 | 线性加速度传感器。 |
| SENSOR_TYPE_ID_ROTATION_VECTOR | 259 | 旋转矢量传感器。 |
| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 260 | 环境温度传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261 | 未校准磁场传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 263 | 未校准陀螺仪传感器。 |
| SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 264 | 有效运动传感器。 |
| SENSOR_TYPE_ID_PEDOMETER_DETECTION | 265 | 计步检测传感器。 |
| SENSOR_TYPE_ID_PEDOMETER | 266 | 计步传感器。 |
| SENSOR_TYPE_ID_HEART_RATE<sup>(deprecated)</sup> | 278 | 心率传感器。 |
| SENSOR_TYPE_ID_HEART_BEAT_RATE<sup>9+</sup> | 278 | 心率传感器。 |
| SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 |
| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |
## Response
......@@ -2540,7 +2551,7 @@ sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER).then((dat
| --------- | -------- | ---- | ---- | ------------------------ |
| timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 |
## Sensor
## Sensor<sup>9+</sup>
指示传感器信息。
......
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @ 81857245
......@@ -55,12 +55,12 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | :------------- |
| effect | [VibrateEffect](#vibrateeffect) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute) | 是 | 马达振动属性。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
**返回值：**
......@@ -77,10 +77,10 @@ vibrator.vibrate({
}, {
id: 0,
usage: 'alarm'
}).then((result)=>{
}).then(()=>{
console.log("Promise returned to indicate a successful vibration");
}).catch((error)=>{
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
})
```
......@@ -105,7 +105,7 @@ vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
```js
vibrator.vibrate(1000,function(error){
if(error){
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
......@@ -138,7 +138,7 @@ vibrate(effectId: EffectId): Promise&lt;void&gt;
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
});
```
......@@ -164,7 +164,7 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
......@@ -183,11 +183,11 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallb
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | :--------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
示例：
......@@ -200,7 +200,7 @@ vibrator.vibrate({
usage: 'alarm'
}, (error)=>{
if(error){
console.log(TAG + " fail, error.code:"+error.code+",error.message:"+error.message);
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
......@@ -234,7 +234,7 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
});
```
......@@ -260,7 +260,7 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
console.log("error.code"+error.code+"error.message"+error.message);
console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate successful.");
}
......@@ -292,15 +292,21 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
## VibrateEffect<sup>9+</sup>
| 类型 | 说明 |
| ------------------------------- | ------------------------------ |
| [VibrateTime](#vibratetime) | 按照指定持续时间触发马达振动。 |
| [VibratePreset](#vibratepreset) | 按照预置振动类型触发马达振动。 |
马达振动效果。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 类型 | 说明 |
| -------------------------------- | ------------------------------ |
| [VibrateTime](#vibratetime9) | 按照指定持续时间触发马达振动。 |
| [VibratePreset](#vibratepreset9) | 按照预置振动类型触发马达振动。 |
## VibrateTime<sup>9+</sup>
马达振动时长。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------------ |
| type | "time" | 按照指定持续时间触发马达振动。 |
......@@ -310,6 +316,8 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
马达预置振动类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | -------- | ------------------------------ |
| type | "preset" | 按照预置振动效果触发马达振动。 |
......@@ -320,6 +328,8 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
马达振动属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| ----- | ------ | -------------- |
| id | 0 | 振动器id。 |
......@@ -329,6 +339,8 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
振动使用场景。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 类型 | 说明 |
| ---------------- | ------ | ------------------------------ |
| unknown | string | 没有明确使用场景，最低优先级。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或