Skip to main content
Version: 21 Aug 2024

MLInputCustomHaptics

A structure containing information about the Buzz command and/or pre-defined pattern to be played. A custom haptics pattern can be played by combining Buzz haptic command and/or a pre-defined pattern, this structure will hold info of a pattern to be added to the custom haptics array.

Public Methods

MLInputCustomHaptics

public MLInputCustomHaptics(
in Buzz buzzHaptics
)

Parameters

TypeNameDescription
in BuzzbuzzHapticsA structure containing information about the Buzz command to be played.

MLInputCustomHaptics

public MLInputCustomHaptics(
in PreDefined preDefinedPatternHaptics,
uint durationMs
)

Parameters

TypeNameDescription
in PreDefinedpreDefinedPatternHapticsA structure containing information about the Pre-Defined pattern to be played.
uintdurationMs

Public Attributes

Buzz

Potential buzz pattern to use.


public readonly MLInputBuzzCommand Buzz;

TypeDescription
readonly MLInputBuzzCommandA structure containing information about the Buzz command to be played.

DurationMs

Duration of the pattern in millisecond (ms) This field will set the time for which a pattern is played: -If the inherited duration of a pre-defined pattern is greater, then it will be cut short and the next pattern will start playing. -If the inherited duration of a pre-defined pattern is smaller, then it will not repeat itself and will wait for the #duration to complete before starting to play the next pattern. -Buzz command's duration will supersede the #duration. Above caveat is true in case buzz command'


public readonly uint DurationMs;


PreDefined

Potential predefined pattern to use.


public readonly MLInputPreDefinedPattern PreDefined;

TypeDescription
readonly MLInputPreDefinedPatternA structure containing information about the Pre-Defined pattern to be played.

Type

Type of the pattern to be set.


public readonly Type Type;

TypeDescription
readonly TypeCustom haptics pattern types.