Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.17 KB

Send-OBSTriggerHotkeyByName.md

File metadata and controls

59 lines (40 loc) · 2.17 KB

Send-OBSTriggerHotkeyByName

Synopsis

Send-OBSTriggerHotkeyByName : TriggerHotkeyByName


Description

Triggers a hotkey using its name. See GetHotkeyList.

Note: Hotkey functionality in obs-websocket comes as-is, and we do not guarantee support if things are broken. In 9/10 usages of hotkey requests, there exists a better, more reliable method via other requests.

Send-OBSTriggerHotkeyByName calls the OBS WebSocket with a request of type TriggerHotkeyByName.


Related Links


Parameters

HotkeyName

Name of the hotkey to trigger

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

ContextName

Name of context of the hotkey to trigger

Type Required Position PipelineInput
[String] false 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-OBSTriggerHotkeyByName [-HotkeyName] <String> [[-ContextName] <String>] [-PassThru] [-NoResponse] [<CommonParameters>]