mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
parent
9f72852588
commit
9722ed3df4
@ -5670,6 +5670,23 @@
|
|||||||
"valueDescription": "Vendor-provided event data. {} if event does not provide any data"
|
"valueDescription": "Vendor-provided event data. {} if event does not provide any data"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Custom event emitted by `BroadcastCustomEvent`.",
|
||||||
|
"eventType": "CustomEvent",
|
||||||
|
"eventSubscription": "General",
|
||||||
|
"complexity": 1,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "general",
|
||||||
|
"dataFields": [
|
||||||
|
{
|
||||||
|
"valueName": "eventData",
|
||||||
|
"valueType": "Object",
|
||||||
|
"valueDescription": "Custom event data"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
@ -1304,6 +1304,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event.
|
|||||||
- [General Events](#general-events)
|
- [General Events](#general-events)
|
||||||
- [ExitStarted](#exitstarted)
|
- [ExitStarted](#exitstarted)
|
||||||
- [VendorEvent](#vendorevent)
|
- [VendorEvent](#vendorevent)
|
||||||
|
- [CustomEvent](#customevent)
|
||||||
- [Config Events](#config-events)
|
- [Config Events](#config-events)
|
||||||
- [CurrentSceneCollectionChanging](#currentscenecollectionchanging)
|
- [CurrentSceneCollectionChanging](#currentscenecollectionchanging)
|
||||||
- [CurrentSceneCollectionChanged](#currentscenecollectionchanged)
|
- [CurrentSceneCollectionChanged](#currentscenecollectionchanged)
|
||||||
@ -1395,6 +1396,22 @@ If a plugin or script implements vendor requests or events, documentation is exp
|
|||||||
| eventType | String | Vendor-provided event typedef |
|
| eventType | String | Vendor-provided event typedef |
|
||||||
| eventData | Object | Vendor-provided event data. {} if event does not provide any data |
|
| eventData | Object | Vendor-provided event data. {} if event does not provide any data |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### CustomEvent
|
||||||
|
|
||||||
|
Custom event emitted by `BroadcastCustomEvent`.
|
||||||
|
|
||||||
|
- Complexity Rating: `1/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Data Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| eventData | Object | Custom event data |
|
||||||
|
|
||||||
## Config Events
|
## Config Events
|
||||||
|
|
||||||
### CurrentSceneCollectionChanging
|
### CurrentSceneCollectionChanging
|
||||||
|
@ -102,6 +102,20 @@ RequestResult RequestHandler::GetStats(const Request &)
|
|||||||
return RequestResult::Success(responseData);
|
return RequestResult::Success(responseData);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom event emitted by `BroadcastCustomEvent`.
|
||||||
|
*
|
||||||
|
* @dataField eventData | Object | Custom event data
|
||||||
|
*
|
||||||
|
* @eventType CustomEvent
|
||||||
|
* @eventSubscription General
|
||||||
|
* @complexity 1
|
||||||
|
* @rpcVersion -1
|
||||||
|
* @initialVersion 5.0.0
|
||||||
|
* @category general
|
||||||
|
* @api events
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.
|
* Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user