Send-OBSCustomEvent : BroadcastCustomEvent
Broadcasts a CustomEvent to all WebSocket clients. Receivers are clients which are identified and subscribed.
Send-OBSCustomEvent calls the OBS WebSocket with a request of type BroadcastCustomEvent.
Data payload to emit to all receivers
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[PSObject] |
true | 1 | true (ByPropertyName) |
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 |
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 |
Send-OBSCustomEvent [-EventData] <PSObject> [-PassThru] [-NoResponse] [<CommonParameters>]