Skip to main content

overwolf.logitech.led.pulseSingleKey

Overwolf APIs / overwolf / overwolf / logitech / led / pulseSingleKey

function pulseSingleKey(
keyName: KeyboardNames,
startRedPercentage: number,
startGreenPercentage: number,
startBluePercentage: number,
finishRedPercentage: number,
finishGreenPercentage: number,
finishBluePercentage: number,
milliSecondsDuration: number,
isInfinite: boolean,
callback: CallbackFunction<Result>,
): void;

Pulses a single key.

Parameters

ParameterTypeDescription
keyNameKeyboardNamesThe key name. For a list of key names see
startRedPercentagenumber>Red start percentage (0 - 100)
startGreenPercentagenumberGreen start percentage (0 - 100)
startBluePercentagenumberBlue start percentage (0 - 100)
finishRedPercentagenumberRed finish percentage (0 - 100)
finishGreenPercentagenumberGreen finish percentage (0 - 100)
finishBluePercentagenumberBlue finish percentage (0 - 100)
milliSecondsDurationnumberThe duration to pulse in milliseconds.
isInfinitebooleanStates whether the effect is infinite or not.
callbackCallbackFunction<Result>A callback with the result of the request.

Returns

void