obs-powershell

Set-OBSSourceFilterEnabled

Synopsis

Set-OBSSourceFilterEnabled : SetSourceFilterEnabled


Description

Sets the enable state of a source filter.

Set-OBSSourceFilterEnabled calls the OBS WebSocket with a request of type SetSourceFilterEnabled.



Parameters

SourceName

Name of the source the filter is on

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

FilterName

Name of the filter

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

FilterEnabled

New enable state of the filter

Type Required Position PipelineInput
[Switch] true named 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-OBSSourceFilterEnabled [-SourceName] <String> [-FilterName] <String> -FilterEnabled [-PassThru] [-NoResponse] [<CommonParameters>]