Skip to main content
Version: 20 Mar 2024

Buzz

A structure containing information about the Buzz command to be played.

Inherits from:
IHapticsCommand

Public Methods​

Buzz Create​

public static Buzz Create(
    ushort startHz,
    ushort endHz,
    uint durationMs,
    byte amplitude
)

Parameters

TypeNameDescription
ushortstartHz
ushortendHz
uintdurationMs
byteamplitude

MLResult StartHaptics​

public MLResult StartHaptics()

Reimplements: StartHaptics

Public Attributes​

Amplitude​

amplitude of the buzz command, as a percentage (0 - 100). 


public readonly byte Amplitude;

DurationMs​

Duration of the buzz command in milliseconds (ms). 


public readonly uint DurationMs;

EndHz​

End frequency of the buzz command (0 - 1250). 


public readonly ushort EndHz;

StartHz​

Start frequency of the buzz command (0 - 1250). 


public readonly ushort StartHz;