From 8a52f86912394de0542ae4066e79ef3146993610 Mon Sep 17 00:00:00 2001 From: WarmUpTill Date: Wed, 16 Aug 2023 20:41:56 +0200 Subject: [PATCH] Created Hotkey (markdown) --- Hotkey.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Hotkey.md diff --git a/Hotkey.md b/Hotkey.md new file mode 100644 index 0000000..1b8c01b --- /dev/null +++ b/Hotkey.md @@ -0,0 +1,39 @@ +## Hotkey condition + +The hotkey condition allows you to perform a set of actions depending on if a hotkey is pressed. + +![HotkeyCondition](https://github.com/WarmUpTill/SceneSwitcher/assets/19472752/c4b64e47-26b6-46b2-873a-bbdf69919b3b) + +You can specify the name of the hotkey at (1). +If multiple hotkey conditions use the same name they will be triggered by the same key bind. + +The key combination to trigger the hotkey must be configured in the OBS settings window in the "Hotkeys" section. +You can filter by the name you have configured at (1) to make finding the hotkey easier. + +![HotkeySettings](https://github.com/WarmUpTill/SceneSwitcher/assets/19472752/fb7fae62-81b0-45ae-8a7b-2b1ff97880bb) + +Note that this condition type also supports [duration modifiers](Macro-duration-modifiers), in case you want to check how long a hotkey was pressed for. + +## Hotkey action + +The hotkey action allows you to ... + * trigger any functionality, which can be triggered by OBS hotkeys. (1) + * simulate key presses. (2) + +![HotkeyAction](https://github.com/WarmUpTill/SceneSwitcher/assets/19472752/76398613-428c-4531-aad6-e85dbb9ec273) + +### Triggering OBS hotkeys + +Note that it is not required, that a key is bound to the given hotkey functionality. +This can be useful to trigger functionality which is not directly accessible to the Advanced scene switcher. + +For example, this can be used to trigger functionality provided by other plugins, like starting the vertical recording for the "OBS Aitum Vertical plugin": + +![HotkeyAction](https://github.com/WarmUpTill/SceneSwitcher/assets/19472752/bad4d8df-f8ec-4004-8c9a-f44dbbc658e9) + +### Simulating key presses + +This option can be useful if you want to interact with entirely different programs, which offer interaction via hotkeys. +You can select which key and which modifier keys shall be pressed and for how long. + +Note that on some platforms the simulated key presses can only be sent to OBS itself.