obs-powershell

Set-OBSCurrentPreviewScene

Synopsis

Set-OBSCurrentPreviewScene : SetCurrentPreviewScene


Description

Sets the current preview scene.

Only available when studio mode is enabled.

Set-OBSCurrentPreviewScene calls the OBS WebSocket with a request of type SetCurrentPreviewScene.



Parameters

SceneName

Scene to set as the current preview scene

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

Set-OBSCurrentPreviewScene [-SceneName] <String> [-PassThru] [-NoResponse] [<CommonParameters>]