Signature
Interface TimelineKeyboardOptionsProperties
| Name | Signature | Description |
|---|---|---|
bindings? | bindings?: false | Partial<Record<TimelineKeyboardCommand, typeOperator>> | Custom command bindings. Passing `false` disables all shortcut handling. |
commandHandlers? | commandHandlers?: Partial<Record<TimelineKeyboardCommand, TimelineKeyboardCommandHandler>> | Replaces individual command implementations, such as media-aware playback. |
disabled? | disabled?: boolean | Disables keyboard handling while preserving returned scope props. |
frameRate? | frameRate?: TimecodeFrameRate | Sequence frame rate used for exact frame stepping. |
frameStepCount? | frameStepCount?: number | Number of frames moved by step commands. Defaults to `1`. |
label? | label?: string | Accessible label for the default scope props. |
onCommandError? | (error: Error, command: TimelineKeyboardCommand): void | Receives unexpected thrown/rejected errors. Defaults to browser error reporting. |
onCommandResult? | (command: TimelineKeyboardCommand, result: TimelineKeyboardCommandResult): void | Receives a command's settled status after a keyboard shortcut invokes it. |
platform? | platform?: TimelineKeyboardPlatform | Platform used for platform-specific preset bindings. Defaults to the current browser platform. |
preset? | preset?: TimelineKeyboardPreset | Preset used when `bindings` is not supplied. Defaults to `professionalEditor`. |
preventDefault? | preventDefault?: boolean | Prevents browser defaults after a shortcut is claimed. Defaults to `true`. |
stopPropagation? | stopPropagation?: boolean | Stops propagation after a shortcut is claimed. Defaults to `false`. |
zoomStepRatio? | zoomStepRatio?: number | Multiplicative zoom step used by zoom commands. Defaults to `1.2`. |