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

Browse Source
This commit is contained in:
Travis CI 2017-10-27 08:21:09 +00:00
parent 7ab3e38da7
commit e88a60fa50
2 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/generated/comments.json
View File

@ -3070,14 +3070,14 @@
"description": "Start streaming.\nWill return an `error` if streaming is already active.", "description": "Start streaming.\nWill return an `error` if streaming is already active.",
"param": [ "param": [
"{Object (optional)} `stream` Special stream configuration.", "{Object (optional)} `stream` Special stream configuration.",
"{String (optional)} `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.", "{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.",
"{Object (optional)} `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.", "{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.",
"{Object (optional)} `settings` Settings for the stream.", "{Object (optional)} `stream.settings` Settings for the stream.",
"{String (optional)} `settings.server` The publish URL.", "{String (optional)} `stream.settings.server` The publish URL.",
"{String (optional)} `settings.key` The publish key of the stream.", "{String (optional)} `stream.settings.key` The publish key of the stream.",
"{boolean (optional)} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.", "{boolean (optional)} `stream.settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `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.username` If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`.",
"{String (optional)} `settings.password` If authentication is enabled, the password 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", "api": "requests",
"name": "StartStreaming", "name": "StartStreaming",
@ -3091,42 +3091,42 @@
}, },
{ {
"type": "String (optional)", "type": "String (optional)",
"name": "type", "name": "stream.type",
"description": "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." "description": "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."
}, },
{ {
"type": "Object (optional)", "type": "Object (optional)",
"name": "metadata", "name": "stream.metadata",
"description": "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." "description": "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."
}, },
{ {
"type": "Object (optional)", "type": "Object (optional)",
"name": "settings", "name": "stream.settings",
"description": "Settings for the stream." "description": "Settings for the stream."
}, },
{ {
"type": "String (optional)", "type": "String (optional)",
"name": "settings.server", "name": "stream.settings.server",
"description": "The publish URL." "description": "The publish URL."
}, },
{ {
"type": "String (optional)", "type": "String (optional)",
"name": "settings.key", "name": "stream.settings.key",
"description": "The publish key of the stream." "description": "The publish key of the stream."
}, },
{ {
"type": "boolean (optional)", "type": "boolean (optional)",
"name": "settings.use-auth", "name": "stream.settings.use-auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server." "description": "Indicates whether authentication should be used when connecting to the streaming server."
}, },
{ {
"type": "String (optional)", "type": "String (optional)",
"name": "settings.username", "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)", "type": "String (optional)",
"name": "settings.password", "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`."
} }
], ],

16
docs/generated/protocol.md
View File

@ -1268,14 +1268,14 @@ Will return an `error` if streaming is already active.
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `stream` | _Object (optional)_ | Special stream configuration. | | `stream` | _Object (optional)_ | Special stream configuration. |
| `type` | _String (optional)_ | 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. | | `stream.type` | _String (optional)_ | 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. |
| `metadata` | _Object (optional)_ | 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. | | `stream.metadata` | _Object (optional)_ | 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. |
| `settings` | _Object (optional)_ | Settings for the stream. | | `stream.settings` | _Object (optional)_ | Settings for the stream. |
| `settings.server` | _String (optional)_ | The publish URL. | | `stream.settings.server` | _String (optional)_ | The publish URL. |
| `settings.key` | _String (optional)_ | The publish key of the stream. | | `stream.settings.key` | _String (optional)_ | The publish key of the stream. |
| `settings.use-auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. | | `stream.settings.use-auth` | _boolean (optional)_ | Indicates whether authentication should be used when connecting to the streaming server. |
| `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.username` | _String (optional)_ | If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`. |
| `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.password` | _String (optional)_ | If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`. |
**Response Items:** **Response Items:**