Skip to content

Latest commit

 

History

History
94 lines (35 loc) · 1.87 KB

Set-OBSCurrentSceneCollection.md

File metadata and controls

94 lines (35 loc) · 1.87 KB

Set-OBSCurrentSceneCollection

Synopsis

Set-OBSCurrentSceneCollection : SetCurrentSceneCollection


Description

Switches to a scene collection.

Note: This will block until the collection has finished changing.

Set-OBSCurrentSceneCollection calls the OBS WebSocket with a request of type SetCurrentSceneCollection.


Related Links


Parameters

SceneCollectionName

Name of the scene collection to switch to

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-OBSCurrentSceneCollection [-SceneCollectionName] <String> [-PassThru] [-NoResponse] [<CommonParameters>]