Receives data from OBS
Receives responses from the OBS WebSocket
The message data that has been received
Type | Required | Position | PipelineInput |
---|---|---|---|
[Object] |
false | named | true (ByValue) |
If set will wait for a response from the message and expand the results.
Type | Required | Position | PipelineInput |
---|---|---|---|
[Switch] |
false | named | false |
If set, will responsd to known events, like ‘hello’, and resend other events as PowerShell events
Type | Required | Position | PipelineInput | Aliases |
---|---|---|---|---|
[Switch] |
false | named | false | Resend |
The OBS websocket URL. If not provided, this will default to loopback on port 4455.
Type | Required | Position | PipelineInput | Aliases |
---|---|---|---|---|
[Uri] |
true | named | false | WebSocketURL |
A randomly generated password used to connect to OBS. You can see the websocket password in Tools -> obs-websocket settings -> show connect info
Type | Required | Position | PipelineInput | Aliases |
---|---|---|---|---|
[String] |
true | named | false | WebSocketPassword |
Receive-OBS [-MessageData <Object>] [-WaitForReponse] [<CommonParameters>]
Receive-OBS [-MessageData <Object>] [-SendEvent] -WebSocketURI <Uri> -WebSocketToken <String> [<CommonParameters>]