Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(travis): Update protocol.md - 27245cc [skip ci]

Browse Source
This commit is contained in:
Travis CI 2020-03-05 09:24:10 +00:00
parent 27245cca1a
commit 0eaef1ac3b
2 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/generated/comments.json
View File

@ -7540,9 +7540,9 @@
"{Object (optional)} `stream.settings` Settings for the stream.",
"{String (optional)} `stream.settings.server` The publish URL.",
"{String (optional)} `stream.settings.key` The publish key of the stream.",
"{boolean (optional)} `stream.settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`.",
"{String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`."
"{boolean (optional)} `stream.settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use_auth` is not set to `true`.",
"{String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use_auth` is not set to `true`."
],
"api": "requests",
"name": "StartStreaming",
@ -7581,18 +7581,18 @@
},
{
"type": "boolean (optional)",
"name": "stream.settings.use-auth",
"name": "stream.settings.use_auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
"type": "String (optional)",
"name": "stream.settings.username",
"description": "If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`."
"description": "If authentication is enabled, the username for the streaming server. Ignored if `use_auth` is not set to `true`."
},
{
"type": "String (optional)",
"name": "stream.settings.password",
"description": "If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`."
"description": "If authentication is enabled, the password for the streaming server. Ignored if `use_auth` is not set to `true`."
}
],
"names": [
@ -7662,7 +7662,7 @@
"{Object} `settings` The actual settings of the stream.",
"{String (optional)} `settings.server` The publish URL.",
"{String (optional)} `settings.key` The publish key.",
"{boolean (optional)} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{boolean (optional)} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `settings.username` The username for the streaming service.",
"{String (optional)} `settings.password` The password for the streaming service.",
"{boolean} `save` Persist the settings to disk."
@ -7694,7 +7694,7 @@
},
{
"type": "boolean (optional)",
"name": "settings.use-auth",
"name": "settings.use_auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
@ -7747,9 +7747,9 @@
"{Object} `settings` Stream settings object.",
"{String} `settings.server` The publish URL.",
"{String} `settings.key` The publish key of the stream.",
"{boolean} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`.",
"{String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`."
"{boolean} `settings.use_auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String} `settings.username` The username to use when accessing the streaming server. Only present if `use_auth` is `true`.",
"{String} `settings.password` The password to use when accessing the streaming server. Only present if `use_auth` is `true`."
],
"api": "requests",
"name": "GetStreamSettings",
@ -7778,18 +7778,18 @@
},
{
"type": "boolean",
"name": "settings.use-auth",
"name": "settings.use_auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
"type": "String",
"name": "settings.username",
"description": "The username to use when accessing the streaming server. Only present if `use-auth` is `true`."
"description": "The username to use when accessing the streaming server. Only present if `use_auth` is `true`."
},
{
"type": "String",
"name": "settings.password",
"description": "The password to use when accessing the streaming server. Only present if `use-auth` is `true`."
"description": "The password to use when accessing the streaming server. Only present if `use_auth` is `true`."
}
],
"names": [

14
docs/generated/protocol.md
View File

@ -2926,9 +2926,9 @@ Will return an `error` if streaming is already active.
| `stream.settings` | _Object (optional)_ | Settings for the stream. |
| `stream.settings.server` | _String (optional)_ | The publish URL. |
| `stream.settings.key` | _String (optional)_ | The publish key of the stream. |
| `stream.settings.use-auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `stream.settings.username` | _String (optional)_ | If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`. |
| `stream.settings.password` | _String (optional)_ | If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`. |
| `stream.settings.use_auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `stream.settings.username` | _String (optional)_ | If authentication is enabled, the username for the streaming server. Ignored if `use_auth` is not set to `true`. |
| `stream.settings.password` | _String (optional)_ | If authentication is enabled, the password for the streaming server. Ignored if `use_auth` is not set to `true`. |
**Response Items:**
@ -2970,7 +2970,7 @@ Sets one or more attributes of the current streaming server settings. Any option
| `settings` | _Object_ | The actual settings of the stream. |
| `settings.server` | _String (optional)_ | The publish URL. |
| `settings.key` | _String (optional)_ | The publish key. |
| `settings.use-auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `settings.use_auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `settings.username` | _String (optional)_ | The username for the streaming service. |
| `settings.password` | _String (optional)_ | The password for the streaming service. |
| `save` | _boolean_ | Persist the settings to disk. |
@ -3001,9 +3001,9 @@ _No specified parameters._
| `settings` | _Object_ | Stream settings object. |
| `settings.server` | _String_ | The publish URL. |
| `settings.key` | _String_ | The publish key of the stream. |
| `settings.use-auth` | _boolean_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `settings.username` | _String_ | The username to use when accessing the streaming server. Only present if `use-auth` is `true`. |
| `settings.password` | _String_ | The password to use when accessing the streaming server. Only present if `use-auth` is `true`. |
| `settings.use_auth` | _boolean_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `settings.username` | _String_ | The username to use when accessing the streaming server. Only present if `use_auth` is `true`. |
| `settings.password` | _String_ | The password to use when accessing the streaming server. Only present if `use_auth` is `true`. |
---