obs-powershell

Send-OBSTriggerMediaInputAction

Synopsis

Send-OBSTriggerMediaInputAction : TriggerMediaInputAction


Description

Triggers an action on a media input.

Send-OBSTriggerMediaInputAction calls the OBS WebSocket with a request of type TriggerMediaInputAction.



Parameters

InputName

Name of the media input

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

MediaAction

Identifier of the ObsMediaInputAction enum

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

Send-OBSTriggerMediaInputAction [-InputName] <String> [-MediaAction] <String> [-PassThru] [-NoResponse] [<CommonParameters>]