docs(ci): Update protocol.md - 02c7a7f [skip ci]

This commit is contained in:
Azure CI 2020-09-30 22:22:57 +00:00
parent 02c7a7f7c7
commit 8a90051ab5
2 changed files with 161 additions and 0 deletions

View File

@ -4065,6 +4065,120 @@
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Executes hotkey routine, identified by hotkey unique name",
"param": "{String} `hotkeyName` Unique name of the hotkey, as defined when registering the hotkey (e.g. \"ReplayBuffer.Save\")",
"api": "requests",
"name": "TriggerHotkeyByName",
"category": "general",
"since": "unreleased",
"params": [
{
"type": "String",
"name": "hotkeyName",
"description": "Unique name of the hotkey, as defined when registering the hotkey (e.g. \"ReplayBuffer.Save\")"
}
],
"names": [
{
"name": "",
"description": "TriggerHotkeyByName"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "TriggerHotkeyByName"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Executes hotkey routine, identified by bound combination of keys. A single key combination might trigger multiple hotkey routines depending on user settings",
"param": [
"{String} `keyId` Main key identifier (e.g. `OBS_KEY_A` for key \"A\"). Available identifiers [here](https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h)",
"{Object (Optional)} `keyModifiers` Optional key modifiers object. False entries can be ommitted",
"{boolean} `keyModifiers.shift` Trigger Shift Key",
"{boolean} `keyModifiers.alt` Trigger Alt Key",
"{boolean} `keyModifiers.control` Trigger Control (Ctrl) Key",
"{boolean} `keyModifiers.command` Trigger Command Key (Mac)"
],
"api": "requests",
"name": "TriggerHotkeyByCombination",
"category": "general",
"since": "unreleased",
"params": [
{
"type": "String",
"name": "keyId",
"description": "Main key identifier (e.g. `OBS_KEY_A` for key \"A\"). Available identifiers [here](https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h)"
},
{
"type": "Object (Optional)",
"name": "keyModifiers",
"description": "Optional key modifiers object. False entries can be ommitted"
},
{
"type": "boolean",
"name": "keyModifiers.shift",
"description": "Trigger Shift Key"
},
{
"type": "boolean",
"name": "keyModifiers.alt",
"description": "Trigger Alt Key"
},
{
"type": "boolean",
"name": "keyModifiers.control",
"description": "Trigger Control (Ctrl) Key"
},
{
"type": "boolean",
"name": "keyModifiers.command",
"description": "Trigger Command Key (Mac)"
}
],
"names": [
{
"name": "",
"description": "TriggerHotkeyByCombination"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "TriggerHotkeyByCombination"
},
"lead": "",
"type": "class",
"examples": []
}
],
"media control": [

View File

@ -136,6 +136,8 @@ You can also refer to any of the client libraries listed on the [README](README.
+ [BroadcastCustomMessage](#broadcastcustommessage-1)
+ [GetVideoInfo](#getvideoinfo)
+ [OpenProjector](#openprojector)
+ [TriggerHotkeyByName](#triggerhotkeybyname)
+ [TriggerHotkeyByCombination](#triggerhotkeybycombination)
* [Media Control](#media-control)
+ [PlayPauseMedia](#playpausemedia)
+ [RestartMedia](#restartmedia)
@ -1649,6 +1651,51 @@ Open a projector window or create a projector on a monitor. Requires OBS v24.0.4
| `name` | _String (Optional)_ | Name of the source or scene to be displayed (ignored for other projector types). |
**Response Items:**
_No additional response items._
---
### TriggerHotkeyByName
- Unreleased
Executes hotkey routine, identified by hotkey unique name
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `hotkeyName` | _String_ | Unique name of the hotkey, as defined when registering the hotkey (e.g. "ReplayBuffer.Save") |
**Response Items:**
_No additional response items._
---
### TriggerHotkeyByCombination
- Unreleased
Executes hotkey routine, identified by bound combination of keys. A single key combination might trigger multiple hotkey routines depending on user settings
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `keyId` | _String_ | Main key identifier (e.g. `OBS_KEY_A` for key "A"). Available identifiers [here](https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h) |
| `keyModifiers` | _Object (Optional)_ | Optional key modifiers object. False entries can be ommitted |
| `keyModifiers.shift` | _boolean_ | Trigger Shift Key |
| `keyModifiers.alt` | _boolean_ | Trigger Alt Key |
| `keyModifiers.control` | _boolean_ | Trigger Control (Ctrl) Key |
| `keyModifiers.command` | _boolean_ | Trigger Command Key (Mac) |
**Response Items:**
_No additional response items._