Begin Modifier Command

Begins running the modifier command given by the command id. This has a similar effect as holding the hotkey associated with that command.

Syntax

store.dispatch({ type: "BEGIN_MODIFIER_COMMAND", payload: command, meta: { ignorable: true } });

Parameters

command

The modifier command to start executing. This command will not stop until an END_MODIFIER_COMMAND action with the same id is called or a user input triggers the end of the command. A full list of available command ids and their default hotkeys can be found here.

Examples

Starts fast-forwarding playback through the modifier hotkey.

store.dispatch({
  type: "BEGIN_MODIFIER_COMMAND",
  payload: "modifiers.fastForward",
  meta: { ignorable: true }
});