# @ohos.vibrator (振动)

vibrator 模块提供控制马达振动的能力，如通过接口控制马达启动马达振动，停止马达振动等。

说明：

本模块首批接口从 API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

# 导入模块

import vibrator from "@ohos.vibrator";

# vibrator.vibrate

vibrate(duration: number): Promise<void>

按照指定持续时间触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
duration	number	是	马达振动时长, 单位 ms。

返回值：

类型	说明
Promise<void>	Promise 对象。无返回结果的 Promise 对象。

示例：

vibrator.vibrate(1000).then(
  () => {
    console.log("Promise returned to indicate a successful vibration.");
  },
  (error) => {
    console.log("error.code" + error.code + "error.message" + error.message);
  }
);

1
2
3
4
5
6
7
8

# vibrator.vibrate⁹⁺

vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise<void>

按照指定振动效果和振动属性触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
effect	VibrateEffect	是	马达振动效果。
attribute	VibrateAttribute	是	马达振动属性。

返回值：

类型	说明
Promise<void>	Promise 对象。无返回结果的 Promise 对象。

示例：

vibrator
  .vibrate(
    {
      type: "time",
      duration: 1000,
    },
    {
      id: 0,
      usage: "alarm",
    }
  )
  .then(() => {
    console.log("Promise returned to indicate a successful vibration");
  })
  .catch((error) => {
    console.log("error.code" + error.code + "error.message" + error.message);
  });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# vibrator.vibrate

vibrate(duration: number, callback?: AsyncCallback<void>): void

按照指定持续时间触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
duration	number	是	马达振动时长, 单位 ms。
callback	AsyncCallback<void>	否	回调函数。当马达振动成功，err 为 undefined，否则为错误对象。

示例：

vibrator.vibrate(1000, function (error) {
  if (error) {
    console.log("error.code" + error.code + "error.message" + error.message);
  } else {
    console.log("Callback returned to indicate a successful vibration.");
  }
});

1
2
3
4
5
6
7

# vibrator.vibrate

vibrate(effectId: EffectId): Promise<void>

按照预置振动效果触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
effectId	EffectId	是	预置的振动效果 ID。

返回值：

类型	说明
Promise<void>	Promise 对象。无返回结果的 Promise 对象。

示例：

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);
  }
);

1
2
3
4
5
6
7
8

# vibrator.vibrate

vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void

按照指定振动效果触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
effectId	EffectId	是	预置的振动效果 ID。
callback	AsyncCallback<void>	否	回调函数。当马达振动成功，err 为 undefined，否则为错误对象。

示例：

vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function (error) {
  if (error) {
    console.log("error.code" + error.code + "error.message" + error.message);
  } else {
    console.log("Callback returned to indicate a successful vibration.");
  }
});

1
2
3
4
5
6
7

# vibrator.vibrate⁹⁺

vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback<void>): void

按照指定振动效果和振动属性触发马达振动。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
effect	VibrateEffect	是	马达振动效果。
attribute	VibrateAttribute	是	马达振动属性。
callback	AsyncCallback<void>	是	回调函数。当马达振动成功，err 为 undefined，否则为错误对象。

示例：

vibrator.vibrate(
  {
    type: "time",
    duration: 1000,
  },
  {
    id: 0,
    usage: "alarm",
  },
  (error) => {
    if (error) {
      console.log(
        "vibrate fail, error.code:" +
          error.code +
          ",error.message:" +
          error.message
      );
    } else {
      console.log("Callback returned to indicate a successful vibration.");
    }
  }
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# vibrator.stop

stop(stopMode: VibratorStopMode): Promise<void>

按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
stopMode	VibratorStopMode	是	马达停止指定的振动模式。

返回值：

类型	说明
Promise<void>	Promise 对象。无返回结果的 Promise 对象。

示例：

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);
  }
);

1
2
3
4
5
6
7
8

# vibrator.stop

stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;

按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。

需要权限：ohos.permission.VIBRATE

系统能力：SystemCapability.Sensors.MiscDevice

参数：

参数名	类型	必填	说明
stopMode	VibratorStopMode	是	马达停止指定的振动模式。
callback	AsyncCallback<void>	否	回调函数。当马达停止振动成功，err 为 undefined，否则为错误对象。

示例：

vibrator.stop(
  vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET,
  function (error) {
    if (error) {
      console.log("error.code" + error.code + "error.message" + error.message);
    } else {
      console.log("Callback returned to indicate successful.");
    }
  }
);

1
2
3
4
5
6
7
8
9
10

# EffectId

马达振动效果的字符串。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	默认值	说明
EFFECT_CLOCK_TIMER	"haptic.clock.timer"	预置的振动效果 ID。

# VibratorStopMode

马达要停止指定的振动模式。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	默认值	说明
VIBRATOR_STOP_MODE_TIME	"time"	停止模式为 duration 模式的振动。即触发振动时参数类型为 number，参数本身为振动持续时间的触发方式。
VIBRATOR_STOP_MODE_PRESET	"preset"	停止模式为预置 EffectId 的振动。即触发振动时参数类型为 EffectId，参数本身为马达振动效果的字符串的触发方式。

# VibrateEffect⁹⁺

马达振动效果。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

类型	说明
VibrateTime	按照指定持续时间触发马达振动。
VibratePreset	按照预置振动类型触发马达振动。

# VibrateTime⁹⁺

马达振动时长。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	默认值	说明
type	"time"	按照指定持续时间触发马达振动。
duration	-	马达振动时长, 单位 ms。

# VibratePreset⁹⁺

马达预置振动类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	默认值	说明
type	"preset"	按照预置振动效果触发马达振动。
effectId	-	预置的振动效果 ID。
count	-	重复振动的次数。

# VibrateAttribute⁹⁺

马达振动属性。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	默认值	说明
id	0	振动器 id。
usage	-	马达振动场景。

# Usage⁹⁺

振动使用场景。

系统能力：以下各项对应的系统能力均为 SystemCapability.Sensors.MiscDevice

名称	类型	说明
unknown	string	没有明确使用场景，最低优先级。
alarm	string	用于警报振动的场景。
ring	string	用于铃声振动的场景。
notification	string	用于通知振动的场景。
communication	string	用于通信振动的场景。
touch	string	用于触摸振动的场景。
media	string	用于多媒体振动的场景。
physicalFeedback	string	用于物理反馈振动的场景。
simulateReality	string	用于模拟现实振动的场景。

# @ohos.vibrator (振动)

# 导入模块

# vibrator.vibrate

# vibrator.vibrate9+

# vibrator.vibrate

# vibrator.vibrate

# vibrator.vibrate

# vibrator.vibrate9+

# vibrator.stop

# vibrator.stop

# EffectId

# VibratorStopMode

# VibrateEffect9+

# VibrateTime9+

# VibratePreset9+

# VibrateAttribute9+

# Usage9+

# vibrator.vibrate⁹⁺

# vibrator.vibrate⁹⁺

# VibrateEffect⁹⁺

# VibrateTime⁹⁺

# VibratePreset⁹⁺

# VibrateAttribute⁹⁺

# Usage⁹⁺