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 - 70a8533 [skip ci]

Browse Source
This commit is contained in:
Travis CI 2017-10-16 11:13:41 +00:00
parent 70a8533f5e
commit 73302cb060
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/generated/comments.json
View File

@ -3960,7 +3960,7 @@
"{boolean} `save` Persist the settings to disk." "{boolean} `save` Persist the settings to disk."
], ],
"api": "requests", "api": "requests",
"name": "SetStreamingSettings", "name": "SetStreamSettings",
"category": "settings", "category": "settings",
"since": "4.1.0", "since": "4.1.0",
"params": [ "params": [
@ -4008,7 +4008,7 @@
"names": [ "names": [
{ {
"name": "", "name": "",
"description": "SetStreamingSettings" "description": "SetStreamSettings"
} }
], ],
"categories": [ "categories": [
@ -4025,7 +4025,7 @@
], ],
"heading": { "heading": {
"level": 2, "level": 2,
"text": "SetStreamingSettings" "text": "SetStreamSettings"
}, },
"lead": "", "lead": "",
"type": "class", "type": "class",
@ -4035,8 +4035,8 @@
"subheads": [], "subheads": [],
"description": "Get the current streaming server settings.", "description": "Get the current streaming server settings.",
"return": [ "return": [
"{String} `type` The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'.", "{String} `type` The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.",
"{Object} `settings` Setings of the stream.", "{Object} `settings` Stream settings object.",
"{String} `settings.server` The publish URL.", "{String} `settings.server` The publish URL.",
"{String} `settings.key` The publish key of the stream.", "{String} `settings.key` The publish key of the stream.",
"{boolean} `settings.use-auth` Indicates whether audentication should be used when connecting to the streaming server.", "{boolean} `settings.use-auth` Indicates whether audentication should be used when connecting to the streaming server.",
@ -4051,12 +4051,12 @@
{ {
"type": "String", "type": "String",
"name": "type", "name": "type",
"description": "The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'." "description": "The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'."
}, },
{ {
"type": "Object", "type": "Object",
"name": "settings", "name": "settings",
"description": "Setings of the stream." "description": "Stream settings object."
}, },
{ {
"type": "String", "type": "String",

8
docs/generated/protocol.md
View File

@ -147,7 +147,7 @@ auth_response = base64_encode(auth_response_hash)
+ [GetCurrentProfile](#getcurrentprofile) + [GetCurrentProfile](#getcurrentprofile)
+ [ListProfiles](#listprofiles) + [ListProfiles](#listprofiles)
* [Settings](#settings) * [Settings](#settings)
+ [SetStreamingSettings](#setstreamingsettings) + [SetStreamSettings](#setstreamsettings)
+ [GetStreamSettings](#getstreamsettings) + [GetStreamSettings](#getstreamsettings)
+ [SaveStreamSettings](#savestreamsettings) + [SaveStreamSettings](#savestreamsettings)
* [Studio Mode](#studio-mode-1) * [Studio Mode](#studio-mode-1)
@ -1665,7 +1665,7 @@ _No specified parameters._
## Settings ## Settings
### SetStreamingSettings ### SetStreamSettings
- Added in v4.1.0 - Added in v4.1.0
@ -1705,8 +1705,8 @@ _No specified parameters._
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `type` | _String_ | The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'. | | `type` | _String_ | The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'. |
| `settings` | _Object_ | Setings of the stream. | | `settings` | _Object_ | Stream settings object. |
| `settings.server` | _String_ | The publish URL. | | `settings.server` | _String_ | The publish URL. |
| `settings.key` | _String_ | The publish key of the stream. | | `settings.key` | _String_ | The publish key of the stream. |
| `settings.use-auth` | _boolean_ | Indicates whether audentication should be used when connecting to the streaming server. | | `settings.use-auth` | _boolean_ | Indicates whether audentication should be used when connecting to the streaming server. |