Skip to main content
Version: 21 Aug 2024

MLInputBuzzCommand

Module: Input

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

#include <ml_input.h>

Public Attributes

TypeName
uint32_tversion
uint16_tstart_hz
uint16_tend_hz
uint32_tduration_ms
uint8_tamp

Detailed Description

struct MLInputBuzzCommand;

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

When playing haptic buzz command, needed information is stored in this structure.

API Level:

  • 20

Public Attributes Documentation

version

uint32_t version;

Version of this structure.


start_hz

uint16_t start_hz;

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


end_hz

uint16_t end_hz;

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


duration_ms

uint32_t duration_ms;

Duration of the buzz command in milliseconds (ms).


amp

uint8_t amp;

Amplitude of the buzz command, as a percentage (1 - 100).