语言

VibrationEffect.Builder 类

定义

用于通过对各种触觉元素进行排序来组合触觉效果的生成器。

[Android.Runtime.Register("android/os/VibrationEffect$Builder", ApiSince=37, DoNotGenerateAcw=true)]
public sealed class VibrationEffect.Builder : Java.Lang.Object
[<Android.Runtime.Register("android/os/VibrationEffect$Builder", ApiSince=37, DoNotGenerateAcw=true)>]
type VibrationEffect.Builder = class
    inherit Object
继承
VibrationEffect.Builder
特性

注解

用于通过对各种触觉元素进行排序来组合触觉效果的生成器。

此 API 是 VibrationEffect.Composition 的首选替代方法,用于创建复杂的振动效果。 它允许在时间线中的特定点计划多个元素,从而更灵活地创建触觉模式。

使用此生成器可以添加信封、预设和现有 VibrationEffects(作为事件),以创建复杂的波形。 每个元素都使用指定的 startTimeMillis 添加。 请注意,不建议在此处使用旧版 VibrationEffects。

此外,可以使用 setRepeatingEffect(long,VibrationEffect,long)设置重复部分。 设置重复效果后,无法再将触觉元素添加到合成中。

回退支持:如果设备不支持请求的触觉元素,此生成器创建的振动将提供回退支持。

请注意,即使将回退效果添加到此生成器中,也不会为波形符EnvelopeBuilder 创建的信封效果提供回退支持。 对于此类效果,如果设备不支持 PWLE 效果或请求的频率,则不会播放振动。

有关触觉实现的背景以及 OEM 如何支持这些效果的更多详细信息,请参阅 Android 触觉实现指南。

计时和对齐方式:startTimeMillis 是从正在生成的合成开始的时间(以毫秒为单位)。 元素必须按开始时间的递增顺序添加。

该框架在播放期间提供最佳计时支持。 如果达到下一个事件的指定开始时间时,上一个事件仍在播放,框架将自动将下一个事件转移到下一个最早的槽位。 这可以保证不会删除触觉反馈,事件不会在实际播放中重叠(它们将按顺序播放)。

但是,这种自动移位可能会引入计时偏移。 为了确保实际播放计时与指定的时间线保持一致,生成器在生成时会尽最大努力地进行验证,以帮助避免将元素安排在一起太近。 此验证使用某些元素(如信封)的已知持续时间或设备依赖元素(如预设)的最小持续时间(1 毫秒)。 如果在生成时检测到潜在的重叠,则会引发 IllegalArgumentException。

由于某些元素的实际持续时间仅在物理设备上的运行时完全已知,因此开发人员在对具有可变持续时间的元素进行排序时仍应注意,以确保设计和实际播放时间之间的最佳对齐方式。

Android 参考。android.os.VibrationEffect.Builder

本页的某些部分是根据 Android 开放源代码项目创建和共享的工作进行的修改,并根据 Creative Commons 2.5 属性许可证中所述的术语使用。

构造函数

名称 说明
VibrationEffect.Builder()

创建一个空生成器以撰写新的 VibrationEffect。

VibrationEffect.Builder(VibrationEffect)

创建使用现有 VibrationEffect 的副本初始化的生成器。

属性

名称 说明
Class

返回此 Object的运行时类。

(继承自 Object)
Handle

基础 Android 实例的句柄。

(继承自 Object)
JniIdentityHashCode

获取互操作运行时分配给此Java对等的标识哈希代码。

(继承自 Object)
JniManagedPeerState

获取运行时上次分配的状态标志。

(继承自 JavaObject)
JniPeerMembers

获取用于访问此Java绑定成员的 JNI 元数据。

PeerReference

获取此Java对等方的 JNI 对象引用。

(继承自 Object)
ThresholdClass

此 API 支持 Mono for Android 基础结构,不打算直接从代码使用。

(继承自 Object)
ThresholdType

此 API 支持 Mono for Android 基础结构,不打算直接从代码使用。

(继承自 Object)

方法

名称 说明
AddEnvelope(Int64, VibrationEffect+Envelope)

向合成添加触觉信封。

AddEvents(Int64, IList<VibrationEffect.Event>)

将现有事件的列表添加到合成中。

AddPreset(Int64, VibrationEffect+Preset)

将预定义触觉预设添加到合成中。

Build()

生成组合的 VibrationEffect。

Clone()

创建并返回此对象的副本。

(继承自 Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

将此对等方的构造委托给运行时的值管理器。

(继承自 JavaObject)
Dispose()

释放此Java对等方持有的资源。

(继承自 Object)
Dispose(Boolean)

释放此Java对等方持有的资源。

(继承自 Object)
DisposeUnlessReferenced()

要求值管理器释放此对等方,除非其映射保留此相同的托管实例。

(继承自 JavaObject)
Equals(Object)

测试另一个托管对等方是否引用同一Java对象。

(继承自 JavaObject)
Equals(Object)

指示其他对象是否“等于”此对象。

(继承自 Object)
GetHashCode()

返回对象的哈希代码值。

(继承自 Object)
JavaFinalize()
已过时.

当垃圾回收确定不再引用该对象时,由对象上的垃圾回收器调用。

(继承自 Object)
Notify()

唤醒正在等待此对象的监视器的单个线程。

(继承自 Object)
NotifyAll()

唤醒正在等待此对象的监视器的所有线程。

(继承自 Object)
SetHandle(IntPtr, JniHandleOwnership)

设置 Handle 属性。

(继承自 Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

在不创建 JNI 引用副本的情况下,将引用值存储在控制块中。

(继承自 JavaObject)
SetRepeatingEffect(Int64, VibrationEffect, Int64)

向合成添加重复触觉效果。

ToArray<T>()

从此Java数组包装器创建托管数组。

(继承自 Object)
ToString()

返回对象的字符串表示形式。

(继承自 Object)
UnregisterFromRuntime()

从互操作运行时取消注册此Java对等。

(继承自 Object)
Wait()

导致当前线程等待,直到它被唤醒,通常是通过 通知 或 中断。

(继承自 Object)
Wait(Int64, Int32)

使当前线程等待直到唤醒,通常是通过 通知 或 中断,或直到经过一定数量的实时。

(继承自 Object)
Wait(Int64)

使当前线程等待直到唤醒,通常是通过 通知 或 中断,或直到经过一定数量的实时。

(继承自 Object)

显式接口实现

名称 说明
IJavaPeerable.Disposed()

将此对等方标记为已释放,并将disposing调用Dispose设置为 true.

(继承自 JavaObject)
IJavaPeerable.Finalized()

将此对等方标记为已释放,并将disposing调用Dispose设置为 false.

(继承自 JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

获取此对等方使用的本机控制块指针。

(继承自 JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

存储运行时提供的标识哈希代码。

(继承自 JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

替换存储的托管对等状态标志。

(继承自 JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

更新对等引用,并在引用无效时释放已释放的对等方控制块。

(继承自 JavaObject)

扩展方法

名称 说明
GetJniTypeName(IJavaPeerable)

获取实例 self类型的 JNI 名称。

JavaAs<TResult>(IJavaPeerable)

尝试强制self键入TResult,检查强制是否在Java端有效。

JavaCast<TResult>(IJavaObject)

执行 Android 运行时检查的类型转换。

JavaCast<TResult>(IJavaObject)

重复使用兼容的托管对等,或获取请求类型的包装器。

TryJavaCast<TResult>(IJavaPeerable, TResult)

尝试强制self键入TResult,检查强制是否在Java端有效。

适用于