mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 8cabe24
[skip ci]
This commit is contained in:
parent
8cabe24b77
commit
60dbcc1b66
@ -5644,6 +5644,23 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "A screenshot has been saved.\n\nNote: Triggered for the screenshot feature available in `Settings -> Hotkeys -> Screenshot Output` ONLY.\nApplications using `Get/SaveSourceScreenshot` should implement a `CustomEvent` if this kind of inter-client\ncommunication is desired.",
|
||||||
|
"eventType": "ScreenshotSaved",
|
||||||
|
"eventSubscription": "Ui",
|
||||||
|
"complexity": 2,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.1.0",
|
||||||
|
"category": "ui",
|
||||||
|
"dataFields": [
|
||||||
|
{
|
||||||
|
"valueName": "savedScreenshotPath",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Path of the saved image file"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "An event has been emitted from a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.",
|
"description": "An event has been emitted from a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.",
|
||||||
"eventType": "VendorEvent",
|
"eventType": "VendorEvent",
|
||||||
|
@ -1364,6 +1364,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event.
|
|||||||
- [MediaInputActionTriggered](#mediainputactiontriggered)
|
- [MediaInputActionTriggered](#mediainputactiontriggered)
|
||||||
- [Ui Events](#ui-events)
|
- [Ui Events](#ui-events)
|
||||||
- [StudioModeStateChanged](#studiomodestatechanged)
|
- [StudioModeStateChanged](#studiomodestatechanged)
|
||||||
|
- [ScreenshotSaved](#screenshotsaved)
|
||||||
|
|
||||||
## General Events
|
## General Events
|
||||||
|
|
||||||
@ -2285,6 +2286,26 @@ Studio mode has been enabled or disabled.
|
|||||||
| ---- | :---: | ----------- |
|
| ---- | :---: | ----------- |
|
||||||
| studioModeEnabled | Boolean | True == Enabled, False == Disabled |
|
| studioModeEnabled | Boolean | True == Enabled, False == Disabled |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ScreenshotSaved
|
||||||
|
|
||||||
|
A screenshot has been saved.
|
||||||
|
|
||||||
|
Note: Triggered for the screenshot feature available in `Settings -> Hotkeys -> Screenshot Output` ONLY.
|
||||||
|
Applications using `Get/SaveSourceScreenshot` should implement a `CustomEvent` if this kind of inter-client
|
||||||
|
communication is desired.
|
||||||
|
|
||||||
|
- Complexity Rating: `2/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.1.0
|
||||||
|
|
||||||
|
**Data Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| savedScreenshotPath | String | Path of the saved image file |
|
||||||
|
|
||||||
# Requests
|
# Requests
|
||||||
|
|
||||||
## Requests Table of Contents
|
## Requests Table of Contents
|
||||||
|
Loading…
Reference in New Issue
Block a user