diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 9c6e9cb9..50e73c00 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -3960,7 +3960,7 @@ "{boolean} `save` Persist the settings to disk." ], "api": "requests", - "name": "SetStreamingSettings", + "name": "SetStreamSettings", "category": "settings", "since": "4.1.0", "params": [ @@ -4008,7 +4008,7 @@ "names": [ { "name": "", - "description": "SetStreamingSettings" + "description": "SetStreamSettings" } ], "categories": [ @@ -4025,7 +4025,7 @@ ], "heading": { "level": 2, - "text": "SetStreamingSettings" + "text": "SetStreamSettings" }, "lead": "", "type": "class", @@ -4035,8 +4035,8 @@ "subheads": [], "description": "Get the current streaming server settings.", "return": [ - "{String} `type` The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'.", - "{Object} `settings` Setings of the stream.", + "{String} `type` The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.", + "{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 audentication should be used when connecting to the streaming server.", @@ -4051,12 +4051,12 @@ { "type": "String", "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", "name": "settings", - "description": "Setings of the stream." + "description": "Stream settings object." }, { "type": "String", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 4ab4896a..0ad8d114 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -147,7 +147,7 @@ auth_response = base64_encode(auth_response_hash) + [GetCurrentProfile](#getcurrentprofile) + [ListProfiles](#listprofiles) * [Settings](#settings) - + [SetStreamingSettings](#setstreamingsettings) + + [SetStreamSettings](#setstreamsettings) + [GetStreamSettings](#getstreamsettings) + [SaveStreamSettings](#savestreamsettings) * [Studio Mode](#studio-mode-1) @@ -1665,7 +1665,7 @@ _No specified parameters._ ## Settings -### SetStreamingSettings +### SetStreamSettings - Added in v4.1.0 @@ -1705,8 +1705,8 @@ _No specified parameters._ | Name | Type | Description | | ---- | :---: | ------------| -| `type` | _String_ | The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'. | -| `settings` | _Object_ | Setings of the stream. | +| `type` | _String_ | The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'. | +| `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 audentication should be used when connecting to the streaming server. |