Skip to content

Latest commit

 

History

History
109 lines (40 loc) · 1.94 KB

Remove-OBSSceneItem.md

File metadata and controls

109 lines (40 loc) · 1.94 KB

Remove-OBSSceneItem

Synopsis

Remove-OBSSceneItem : RemoveSceneItem


Description

Removes a scene item from a scene.

Scenes only

Remove-OBSSceneItem calls the OBS WebSocket with a request of type RemoveSceneItem.


Related Links


Parameters

SceneName

Name of the scene the item is in

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

SceneItemId

Numeric ID of the scene item

Type Required Position PipelineInput
[Double] true 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

Remove-OBSSceneItem [-SceneName] <String> [-SceneItemId] <Double> [-PassThru] [-NoResponse] [<CommonParameters>]