Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

requesthandler: Add note about as-is status of hotkey requests

Browse Source 
Too much trouble for too little gain. Please stop using these requests.
This commit is contained in:
tt2468 2024-01-18 16:05:24 -08:00
parent b806a0cfb1
commit b53527cba8
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/requesthandler/RequestHandler_General.cpp
View File

@ -211,12 +211,14 @@ RequestResult RequestHandler::CallVendorRequest(const Request &request)
}
/**
* Gets an array of all hotkey names in OBS
* Gets an array of all hotkey names in OBS.
*
* Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
*
* @responseField hotkeys | Array<String> | Array of hotkey names
*
* @requestType GetHotkeyList
* @complexity 3
* @complexity 4
* @rpcVersion -1
* @initialVersion 5.0.0
* @category general
@ -230,13 +232,15 @@ RequestResult RequestHandler::GetHotkeyList(const Request &)
}
/**
* Triggers a hotkey using its name. See `GetHotkeyList`
* Triggers a hotkey using its name. See `GetHotkeyList`.
*
* Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
*
* @requestField hotkeyName | String | Name of the hotkey to trigger
* @requestField ?contextName | String | Name of context of the hotkey to trigger
*
* @requestType TriggerHotkeyByName
* @complexity 3
* @complexity 4
* @rpcVersion -1
* @initialVersion 5.0.0
* @category general
@ -269,6 +273,8 @@ RequestResult RequestHandler::TriggerHotkeyByName(const Request &request)
/**
* Triggers a hotkey using a sequence of keys.
*
* Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.
*
* @requestField ?keyId | String | The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h | Not pressed
* @requestField ?keyModifiers | Object | Object containing key modifiers to apply | Ignored
* @requestField ?keyModifiers.shift | Boolean | Press Shift | Not pressed