mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(travis): Update protocol.md - ac2ae90 [skip ci]
This commit is contained in:
Travis CI
parent
ac2ae90e8a
commit
b4857e2c79
@ -333,6 +333,135 @@
|
||||
},
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"typedef": "{Object} `Output`",
|
||||
"property": [
|
||||
"{String} `name` Output name",
|
||||
"{String} `type` Output type/kind",
|
||||
"{int} `width` Video output width",
|
||||
"{int} `height` Video output height",
|
||||
"{Object} `flags` Output flags",
|
||||
"{int} `flags.rawValue` Raw flags value",
|
||||
"{boolean} `flags.audio` Output uses audio",
|
||||
"{boolean} `flags.video` Output uses video",
|
||||
"{boolean} `flags.encoded` Output is encoded",
|
||||
"{boolean} `flags.multiTrack` Output uses several audio tracks",
|
||||
"{boolean} `flags.service` Output uses a service",
|
||||
"{Object} `settings` Output name",
|
||||
"{boolean} `active` Output status (active or not)",
|
||||
"{boolean} `reconnecting` Output reconnection status (reconnecting or not)",
|
||||
"{double} `congestion` Output congestion",
|
||||
"{int} `totalFrames` Number of frames sent",
|
||||
"{int} `droppedFrames` Number of frames dropped",
|
||||
"{int} `totalBytes` Total bytes sent"
|
||||
],
|
||||
"properties": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "name",
|
||||
"description": "Output name"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "type",
|
||||
"description": "Output type/kind"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "width",
|
||||
"description": "Video output width"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "height",
|
||||
"description": "Video output height"
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "flags",
|
||||
"description": "Output flags"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "flags.rawValue",
|
||||
"description": "Raw flags value"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "flags.audio",
|
||||
"description": "Output uses audio"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "flags.video",
|
||||
"description": "Output uses video"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "flags.encoded",
|
||||
"description": "Output is encoded"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "flags.multiTrack",
|
||||
"description": "Output uses several audio tracks"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "flags.service",
|
||||
"description": "Output uses a service"
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "settings",
|
||||
"description": "Output name"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "active",
|
||||
"description": "Output status (active or not)"
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"name": "reconnecting",
|
||||
"description": "Output reconnection status (reconnecting or not)"
|
||||
},
|
||||
{
|
||||
"type": "double",
|
||||
"name": "congestion",
|
||||
"description": "Output congestion"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "totalFrames",
|
||||
"description": "Number of frames sent"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "droppedFrames",
|
||||
"description": "Number of frames dropped"
|
||||
},
|
||||
{
|
||||
"type": "int",
|
||||
"name": "totalBytes",
|
||||
"description": "Total bytes sent"
|
||||
}
|
||||
],
|
||||
"typedefs": [
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "Output",
|
||||
"description": ""
|
||||
}
|
||||
],
|
||||
"name": "",
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": ""
|
||||
},
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"typedef": "{Object} `Scene`",
|
||||
@ -2941,6 +3070,188 @@
|
||||
"examples": []
|
||||
}
|
||||
],
|
||||
"outputs": [
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "List existing outputs",
|
||||
"return": "{Array<Output>} `outputs` Outputs list",
|
||||
"api": "requests",
|
||||
"name": "ListOutputs",
|
||||
"category": "outputs",
|
||||
"since": "4.7.0",
|
||||
"returns": [
|
||||
{
|
||||
"type": "Array<Output>",
|
||||
"name": "outputs",
|
||||
"description": "Outputs list"
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "ListOutputs"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "outputs"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "4.7.0"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "ListOutputs"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Get information about a single output",
|
||||
"param": "{String} `outputName` Output name",
|
||||
"return": "{Output} `outputInfo` Output info",
|
||||
"api": "requests",
|
||||
"name": "GetOutputInfo",
|
||||
"category": "outputs",
|
||||
"since": "4.7.0",
|
||||
"returns": [
|
||||
{
|
||||
"type": "Output",
|
||||
"name": "outputInfo",
|
||||
"description": "Output info"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "outputName",
|
||||
"description": "Output name"
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "GetOutputInfo"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "outputs"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "4.7.0"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "GetOutputInfo"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Start an output",
|
||||
"param": "{String} `outputName` Output name",
|
||||
"api": "requests",
|
||||
"name": "StartOutput",
|
||||
"category": "outputs",
|
||||
"since": "4.7.0",
|
||||
"params": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "outputName",
|
||||
"description": "Output name"
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "StartOutput"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "outputs"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "4.7.0"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "StartOutput"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Stop an output",
|
||||
"param": [
|
||||
"{String} `outputName` Output name",
|
||||
"{boolean (optional)} `force` Force stop (default: false)"
|
||||
],
|
||||
"api": "requests",
|
||||
"name": "StopOutput",
|
||||
"category": "outputs",
|
||||
"since": "4.7.0",
|
||||
"params": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "outputName",
|
||||
"description": "Output name"
|
||||
},
|
||||
{
|
||||
"type": "boolean (optional)",
|
||||
"name": "force",
|
||||
"description": "Force stop (default: false)"
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "StopOutput"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "outputs"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "4.7.0"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "StopOutput"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
}
|
||||
],
|
||||
"profiles": [
|
||||
{
|
||||
"subheads": [],
|
||||
|
||||
@ -46,6 +46,7 @@ auth_response = base64_encode(auth_response_hash)
|
||||
* [SceneItem](#sceneitem)
|
||||
* [SceneItemTransform](#sceneitemtransform)
|
||||
* [OBSStats](#obsstats)
|
||||
* [Output](#output)
|
||||
* [Scene](#scene)
|
||||
- [Events](#events)
|
||||
* [Scenes](#scenes)
|
||||
@ -112,6 +113,11 @@ auth_response = base64_encode(auth_response_hash)
|
||||
+ [GetFilenameFormatting](#getfilenameformatting)
|
||||
+ [GetStats](#getstats)
|
||||
+ [GetVideoInfo](#getvideoinfo)
|
||||
* [Outputs](#outputs)
|
||||
+ [ListOutputs](#listoutputs)
|
||||
+ [GetOutputInfo](#getoutputinfo)
|
||||
+ [StartOutput](#startoutput)
|
||||
+ [StopOutput](#stopoutput)
|
||||
* [Profiles](#profiles-1)
|
||||
+ [SetCurrentProfile](#setcurrentprofile)
|
||||
+ [GetCurrentProfile](#getcurrentprofile)
|
||||
@ -256,6 +262,27 @@ These are complex types, such as `Source` and `Scene`, which are used as argumen
|
||||
| `cpu-usage` | _double_ | Current CPU usage (percentage) |
|
||||
| `memory-usage` | _double_ | Current RAM usage (in megabytes) |
|
||||
| `free-disk-space` | _double_ | Free recording disk space (in megabytes) |
|
||||
## Output
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `name` | _String_ | Output name |
|
||||
| `type` | _String_ | Output type/kind |
|
||||
| `width` | _int_ | Video output width |
|
||||
| `height` | _int_ | Video output height |
|
||||
| `flags` | _Object_ | Output flags |
|
||||
| `flags.rawValue` | _int_ | Raw flags value |
|
||||
| `flags.audio` | _boolean_ | Output uses audio |
|
||||
| `flags.video` | _boolean_ | Output uses video |
|
||||
| `flags.encoded` | _boolean_ | Output is encoded |
|
||||
| `flags.multiTrack` | _boolean_ | Output uses several audio tracks |
|
||||
| `flags.service` | _boolean_ | Output uses a service |
|
||||
| `settings` | _Object_ | Output name |
|
||||
| `active` | _boolean_ | Output status (active or not) |
|
||||
| `reconnecting` | _boolean_ | Output reconnection status (reconnecting or not) |
|
||||
| `congestion` | _double_ | Output congestion |
|
||||
| `totalFrames` | _int_ | Number of frames sent |
|
||||
| `droppedFrames` | _int_ | Number of frames dropped |
|
||||
| `totalBytes` | _int_ | Total bytes sent |
|
||||
## Scene
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
@ -1214,6 +1241,92 @@ _No specified parameters._
|
||||
| `colorRange` | _String_ | Color range (full or partial) |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Outputs
|
||||
|
||||
### ListOutputs
|
||||
|
||||
|
||||
- Added in v4.7.0
|
||||
|
||||
List existing outputs
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
_No specified parameters._
|
||||
|
||||
**Response Items:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `outputs` | _Array<Output>_ | Outputs list |
|
||||
|
||||
|
||||
---
|
||||
|
||||
### GetOutputInfo
|
||||
|
||||
|
||||
- Added in v4.7.0
|
||||
|
||||
Get information about a single output
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `outputName` | _String_ | Output name |
|
||||
|
||||
|
||||
**Response Items:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `outputInfo` | _Output_ | Output info |
|
||||
|
||||
|
||||
---
|
||||
|
||||
### StartOutput
|
||||
|
||||
|
||||
- Added in v4.7.0
|
||||
|
||||
Start an output
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `outputName` | _String_ | Output name |
|
||||
|
||||
|
||||
**Response Items:**
|
||||
|
||||
_No additional response items._
|
||||
|
||||
---
|
||||
|
||||
### StopOutput
|
||||
|
||||
|
||||
- Added in v4.7.0
|
||||
|
||||
Stop an output
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `outputName` | _String_ | Output name |
|
||||
| `force` | _boolean (optional)_ | Force stop (default: false) |
|
||||
|
||||
|
||||
**Response Items:**
|
||||
|
||||
_No additional response items._
|
||||
|
||||
---
|
||||
|
||||
## Profiles
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user