Requests: Add hotkeys press events #595
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a new request called `ProcessHotkeyByName` which calls the routine associated with a given hotkey. The hotkey is identified by the unique name set while registering it. Works with both OBS default hotkeys and hotkeys added by plugins/scripts.
Adds a new request called `ProcessHotkeyByCombination` which calls the routine associated with a given hotkey. The hotkey is identified by the combination of keys set by the user to trigger it. Multiple routines are called if the same combination is bound to different hotkeys.
tt2468
reviewed
Sep 30, 2020
Changes requests names to "TriggerHotkeyByName" and "TriggerHotkeyBySequence"
|
Thanks for the docs updates and the other fixes, I'll keep them in mind for future PRs We need to adjust the TriggerHotkeyBySequence/TriggerHotkeyByCombination name, we ended up using different stuff in our PRs. Feel free to update whatever you want |
tt2468
approved these changes
Sep 30, 2020
|
@tt2468 I guess you didn't see my message before merging. New docs refer to TriggerHotkeyByCombination but the request is actually called TriggerHotkeyBySequence. You need to change either of those, whichever you prefer. Sorry for all the mess :S |
|
I did read your message, but didn't understand it correctly. Oops |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds two new requests that allow triggering hotkeys callback functions over websocket. The hotkey can be defined either by its unique name (the one used during registration) or by specifing the combination of keys associated to trigger it. In the latter, if the same combination has been set for multiple hotkeys, all of them will be triggered.
Note: the requests are named
ProcessHotkeyand notPressHotkeybecause no "physical" pressing event is sent/triggered, rather just the underlying callback functions are called/processed. Please let me know if you'd rather name the requests differently.Motivation and Context
This PR was motivated by the need to trigger script functions remotely. The requests can be easily used to trigger custom hotkeys registered within a script, and of course they also work with the default OBS hotkeys.
Related feature requests: #427, #444, #180
How Has This Been Tested?
Tested OS(s): Windows 7 SP1, Windows 10 2004 (OBS 25.0.8)
The changes were tested by sending the requests via webpage using obs-websocket-js. For
ProcessHotkeyByNamerequest, both OBS default hotkeys and custom hotkeys (registered within scripts) were tested. ForProcessHotkeyByCombinationrequest, tests were done with multiple key combinations (with and without modifiers), and associated to a single or multiple hotkey routines.Types of changes
Checklist: