From 60dbcc1b66bf8047df2ff17691cbd9d4a0d9210b Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Fri, 18 Nov 2022 06:20:26 +0000 Subject: [PATCH] docs(ci): Update generated docs - 8cabe24 [skip ci] --- docs/generated/protocol.json | 17 +++++++++++++++++ docs/generated/protocol.md | 21 +++++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 22ed73d0..0186eaef 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -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.", "eventType": "VendorEvent", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index cda7bf00..4a619505 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1364,6 +1364,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event. - [MediaInputActionTriggered](#mediainputactiontriggered) - [Ui Events](#ui-events) - [StudioModeStateChanged](#studiomodestatechanged) + - [ScreenshotSaved](#screenshotsaved) ## General Events @@ -2285,6 +2286,26 @@ Studio mode has been enabled or 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 Table of Contents