obs-powershell

Set-OBSStreamServiceSettings

Synopsis

Set-OBSStreamServiceSettings : SetStreamServiceSettings


Description

Sets the current stream service settings (stream destination).

Note: Simple RTMP settings can be set with type rtmp_custom and the settings fields server and key.

Set-OBSStreamServiceSettings calls the OBS WebSocket with a request of type SetStreamServiceSettings.



Parameters

StreamServiceType

Type of stream service to apply. Example: rtmp_common or rtmp_custom

Type Required Position PipelineInput
[String] true 1 true (ByPropertyName)

StreamServiceSettings

Settings to apply to the service

Type Required Position PipelineInput
[PSObject] true 2 true (ByPropertyName)

PassThru

If set, will return the information that would otherwise be sent to OBS.

Type Required Position PipelineInput Aliases
[Switch] false named true (ByPropertyName) OutputRequest
OutputInput

NoResponse

If set, will not attempt to receive a response from OBS. This can increase performance, and also silently ignore critical errors

Type Required Position PipelineInput Aliases
[Switch] false named true (ByPropertyName) NoReceive
IgnoreResponse
IgnoreReceive
DoNotReceiveResponse

Syntax

Set-OBSStreamServiceSettings [-StreamServiceType] <String> [-StreamServiceSettings] <PSObject> [-PassThru] [-NoResponse] [<CommonParameters>]