mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
Requests/Events: Use Note:
for all notes
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaah my ocdddddddddddddddddddddddddddddddddddddd
This commit is contained in:
@ -1024,7 +1024,7 @@ void WSEvents::OnTransitionBegin(void* param, calldata_t* data) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A transition (other than "cut") has ended.
|
* A transition (other than "cut") has ended.
|
||||||
* Please note that the `from-scene` field is not available in TransitionEnd.
|
* Note: The `from-scene` field is not available in TransitionEnd.
|
||||||
*
|
*
|
||||||
* @return {String} `name` Transition name.
|
* @return {String} `name` Transition name.
|
||||||
* @return {String} `type` Transition type.
|
* @return {String} `type` Transition type.
|
||||||
|
@ -137,7 +137,7 @@ RpcResponse WSRequestHandler::ResumeRecording(const RpcRequest& request) {
|
|||||||
* In the current profile, sets the recording folder of the Simple and Advanced
|
* In the current profile, sets the recording folder of the Simple and Advanced
|
||||||
* output modes to the specified value.
|
* output modes to the specified value.
|
||||||
*
|
*
|
||||||
* Please note: if `SetRecordingFolder` is called while a recording is
|
* Note: If `SetRecordingFolder` is called while a recording is
|
||||||
* in progress, the change won't be applied immediately and will be
|
* in progress, the change won't be applied immediately and will be
|
||||||
* effective on the next recording.
|
* effective on the next recording.
|
||||||
*
|
*
|
||||||
|
@ -1726,7 +1726,7 @@ RpcResponse WSRequestHandler::GetSourceDefaultSettings(const RpcRequest& request
|
|||||||
* Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is
|
* Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is
|
||||||
* preserved if only one of these two parameters is specified.
|
* preserved if only one of these two parameters is specified.
|
||||||
*
|
*
|
||||||
* @param {String (optional)} `sourceName` Source name. Note that, since scenes are also sources, you can also provide a scene name. If not provided, the currently active scene is used.
|
* @param {String (optional)} `sourceName` Source name. Note: Since scenes are also sources, you can also provide a scene name. If not provided, the currently active scene is used.
|
||||||
* @param {String (optional)} `embedPictureFormat` Format of the Data URI encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other value supported by Qt's Image module)
|
* @param {String (optional)} `embedPictureFormat` Format of the Data URI encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other value supported by Qt's Image module)
|
||||||
* @param {String (optional)} `saveToFilePath` Full file path (file extension included) where the captured image is to be saved. Can be in a format different from `pictureFormat`. Can be a relative path.
|
* @param {String (optional)} `saveToFilePath` Full file path (file extension included) where the captured image is to be saved. Can be in a format different from `pictureFormat`. Can be a relative path.
|
||||||
* @param {String (optional)} `fileFormat` Format to save the image file as (one of the values provided in the `supported-image-export-formats` response field of `GetVersion`). If not specified, tries to guess based on file extension.
|
* @param {String (optional)} `fileFormat` Format to save the image file as (one of the values provided in the `supported-image-export-formats` response field of `GetVersion`). If not specified, tries to guess based on file extension.
|
||||||
|
@ -62,7 +62,7 @@ RpcResponse WSRequestHandler::StartStopStreaming(const RpcRequest& request) {
|
|||||||
* Start streaming.
|
* Start streaming.
|
||||||
* Will return an `error` if streaming is already active.
|
* Will return an `error` if streaming is already active.
|
||||||
*
|
*
|
||||||
* @param {Object (optional)} `stream` Special stream configuration. Please note: these won't be saved to OBS' configuration.
|
* @param {Object (optional)} `stream` Special stream configuration. Note: these won't be saved to OBS' configuration.
|
||||||
* @param {String (optional)} `stream.type` If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.
|
* @param {String (optional)} `stream.type` If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.
|
||||||
* @param {Object (optional)} `stream.metadata` Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.
|
* @param {Object (optional)} `stream.metadata` Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.
|
||||||
* @param {Object (optional)} `stream.settings` Settings for the stream.
|
* @param {Object (optional)} `stream.settings` Settings for the stream.
|
||||||
|
Reference in New Issue
Block a user