obs-powershell

Get-OBSMediaInputStatus

Synopsis

Get-OBSMediaInputStatus : GetMediaInputStatus


Description

Gets the status of a media input.

Media States:

Get-OBSMediaInputStatus calls the OBS WebSocket with a request of type GetMediaInputStatus.



Parameters

InputName

Name of the media input

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-OBSMediaInputStatus [-InputName] <String> [-PassThru] [-NoResponse] [<CommonParameters>]