From e88a60fa50b3adbb6f2b6a03116dd30346a56b81 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Fri, 27 Oct 2017 08:21:09 +0000 Subject: [PATCH] docs(travis): Update protocol.md - 7ab3e38 [skip ci] --- docs/generated/comments.json | 32 ++++++++++++++++---------------- docs/generated/protocol.md | 16 ++++++++-------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 50e73c00..a83fe7e6 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -3070,14 +3070,14 @@ "description": "Start streaming.\nWill return an `error` if streaming is already active.", "param": [ "{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.", - "{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)} `settings` Settings for the stream.", - "{String (optional)} `settings.server` The publish URL.", - "{String (optional)} `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.", - "{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)} `settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`." + "{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)} `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)} `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`." ], "api": "requests", "name": "StartStreaming", @@ -3091,42 +3091,42 @@ }, { "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." }, { "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." }, { "type": "Object (optional)", - "name": "settings", + "name": "stream.settings", "description": "Settings for the stream." }, { "type": "String (optional)", - "name": "settings.server", + "name": "stream.settings.server", "description": "The publish URL." }, { "type": "String (optional)", - "name": "settings.key", + "name": "stream.settings.key", "description": "The publish key of the stream." }, { "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." }, { "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`." }, { "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`." } ], diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 0ad8d114..307a3501 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1268,14 +1268,14 @@ Will return an `error` if streaming is already active. | Name | Type | Description | | ---- | :---: | ------------| | `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. | -| `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. | -| `settings.server` | _String (optional)_ | The publish URL. | -| `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. | -| `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.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.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.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`. | **Response Items:**