obs-powershell

Get-OBSOutputStatus

Synopsis

Get-OBSOutputStatus : GetOutputStatus


Description

Gets the status of an output.

Get-OBSOutputStatus calls the OBS WebSocket with a request of type GetOutputStatus.



Parameters

OutputName

Output name

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-OBSOutputStatus [-OutputName] <String> [-PassThru] [-NoResponse] [<CommonParameters>]