obs-powershell

Get-OBSSourceActive

Synopsis

Get-OBSSourceActive : GetSourceActive


Description

Gets the active and show state of a source.

Compatible with inputs and scenes.

Get-OBSSourceActive calls the OBS WebSocket with a request of type GetSourceActive.



Parameters

SourceName

Name of the source to get the active state of

Type Required Position PipelineInput
[String] true 1 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

Get-OBSSourceActive [-SourceName] <String> [-PassThru] [-NoResponse] [<CommonParameters>]