add hotkey section

This commit is contained in:
onyx-and-iris 2025-05-22 09:42:51 +01:00
parent b186685e2f
commit 48fab684a3

View File

@ -452,10 +452,45 @@ obsws-cli virtualcam toggle
obsws-cli virtualcam status
```
#### Hotkey
- list: List all hotkeys.
```console
obsws-cli hotkey list
```
- trigger: Trigger a hotkey by name.
```console
obsws-cli hotkey trigger OBSBasic.StartStreaming
obsws-cli hotkey trigger OBSBasic.StopStreaming
```
- trigger-sequence: Trigger a hotkey by sequence.
- flags:
*optional*
- --shift: Press shift.
- --ctrl: Press control.
- --alt: Press alt.
- --cmd: Press command (mac).
- args: <key_id>
- Check [obs-hotkeys.h][obs-keyids] for a full list of OBS key ids.
```console
obsws-cli hotkey trigger-sequence OBS_KEY_F1 --ctrl
obsws-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
```
## License
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
[obs-studio]: https://obsproject.com/
[obs-studio]: https://obsproject.com/
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h