IVibratorInterface

概述

Vibrator模块向上层服务提供统一的接口。

上层服务开发人员可根据Vibrator模块提供的统一接口，用于控制马达执行单次或周期性振动。

Since:

3.2

Version:

1.1

相关模块:

Vibrator

汇总

Public 成员函数

成员函数说明

EnableVibratorModulation()

IVibratorInterface::EnableVibratorModulation ([in] unsigned int duration, [in] int intensity, [in] int frequency )

描述：

根据传入的振动效果启动马达。

参数:

返回:

如果操作成功，则返回0。

如果不支持振动周期设置，则返回-1。

如果不支持振幅设置，则返回-2。

如果不支持频率设置，则返回-3。

GetVibratorInfo()

IVibratorInterface::GetVibratorInfo ([out] struct HdfVibratorInfo[] vibratorInfo)

描述：

获取有关系统中支持设置振幅和频率的所有马达信息。

参数:

返回:

如果操作成功，则返回0。

如果操作失败，则返回负值。

Start()

IVibratorInterface::Start ([in] String effectType)

描述：

控制马达以预置效果执行周期性振动。

单次振动与周期振动相互排斥。在执行周期性振动之前，需退出单次振动。

参数:

返回:

如果操作成功，则返回0。

如果操作失败，则返回负值。

StartOnce()

IVibratorInterface::StartOnce ([in] unsigned int duration)

描述：

控制马达以执行给定持续时间的单次振动。

单次振动与周期振动相互排斥。在执行单次振动之前，需退出周期性振动。

参数:

返回:

如果操作成功，则返回0。

如果操作失败，则返回负值。

Stop()

IVibratorInterface::Stop ([in] enum HdfVibratorMode mode)

描述：

停止马达振动。

马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。

参数:

返回:

如果操作成功，则返回0。

如果操作失败，则返回负值。