Skip to content

Latest commit

 

History

History
363 lines (352 loc) · 42.8 KB

obs-powershell-commands.md

File metadata and controls

363 lines (352 loc) · 42.8 KB

obs-powershell-commands

obs-powershell exports 339 commands (169 functions and 170 aliases)

A good number of these commands directly correspond to an obs-websocket message. For a complete list, see obs-powershell-websocket-commands.

Functions

Name Synopsis
Add-OBSInput Add-OBSInput : CreateInput
Add-OBSProfile Add-OBSProfile : CreateProfile
Add-OBSScene Add-OBSScene : CreateScene
Add-OBSSceneCollection Add-OBSSceneCollection : CreateSceneCollection
Add-OBSSceneItem Add-OBSSceneItem : CreateSceneItem
Add-OBSSourceFilter Add-OBSSourceFilter : CreateSourceFilter
Clear-OBSScene Clears a Scene in OBS
Connect-OBS Connects to Open Broadcast Studio
Copy-OBSSceneItem Copy-OBSSceneItem : DuplicateSceneItem
Disconnect-OBS Disconnects OBS
Get-OBS Gets OBS
Get-OBSCurrentPreviewScene Get-OBSCurrentPreviewScene : GetCurrentPreviewScene
Get-OBSCurrentProgramScene Get-OBSCurrentProgramScene : GetCurrentProgramScene
Get-OBSCurrentSceneTransition Get-OBSCurrentSceneTransition : GetCurrentSceneTransition
Get-OBSCurrentSceneTransitionCursor Get-OBSCurrentSceneTransitionCursor : GetCurrentSceneTransitionCursor
Get-OBSEffect Gets OBS Effects
Get-OBSGroup Get-OBSGroup : GetGroupList
Get-OBSGroupSceneItem Get-OBSGroupSceneItem : GetGroupSceneItemList
Get-OBSHotkey Get-OBSHotkey : GetHotkeyList
Get-OBSInput Get-OBSInput : GetInputList
Get-OBSInputAudioBalance Get-OBSInputAudioBalance : GetInputAudioBalance
Get-OBSInputAudioMonitorType Get-OBSInputAudioMonitorType : GetInputAudioMonitorType
Get-OBSInputAudioSyncOffset Get-OBSInputAudioSyncOffset : GetInputAudioSyncOffset
Get-OBSInputAudioTracks Get-OBSInputAudioTracks : GetInputAudioTracks
Get-OBSInputDefaultSettings Get-OBSInputDefaultSettings : GetInputDefaultSettings
Get-OBSInputKind Get-OBSInputKind : GetInputKindList
Get-OBSInputMute Get-OBSInputMute : GetInputMute
Get-OBSInputPropertiesListPropertyItems Get-OBSInputPropertiesListPropertyItems : GetInputPropertiesListPropertyItems
Get-OBSInputSettings Get-OBSInputSettings : GetInputSettings
Get-OBSInputVolume Get-OBSInputVolume : GetInputVolume
Get-OBSLastReplayBufferReplay Get-OBSLastReplayBufferReplay : GetLastReplayBufferReplay
Get-OBSMediaInputStatus Get-OBSMediaInputStatus : GetMediaInputStatus
Get-OBSMonitor Get-OBSMonitor : GetMonitorList
Get-OBSOutput Get-OBSOutput : GetOutputList
Get-OBSOutputSettings Get-OBSOutputSettings : GetOutputSettings
Get-OBSOutputStatus Get-OBSOutputStatus : GetOutputStatus
Get-OBSPersistentData Get-OBSPersistentData : GetPersistentData
Get-OBSProfile Get-OBSProfile : GetProfileList
Get-OBSProfileParameter Get-OBSProfileParameter : GetProfileParameter
Get-OBSRecordDirectory Get-OBSRecordDirectory : GetRecordDirectory
Get-OBSRecordStatus Get-OBSRecordStatus : GetRecordStatus
Get-OBSReplayBufferStatus Get-OBSReplayBufferStatus : GetReplayBufferStatus
Get-OBSScene Get-OBSScene : GetSceneList
Get-OBSSceneCollection Get-OBSSceneCollection : GetSceneCollectionList
Get-OBSSceneItem Get-OBSSceneItem : GetSceneItemList
Get-OBSSceneItemBlendMode Get-OBSSceneItemBlendMode : GetSceneItemBlendMode
Get-OBSSceneItemEnabled Get-OBSSceneItemEnabled : GetSceneItemEnabled
Get-OBSSceneItemId Get-OBSSceneItemId : GetSceneItemId
Get-OBSSceneItemIndex Get-OBSSceneItemIndex : GetSceneItemIndex
Get-OBSSceneItemLocked Get-OBSSceneItemLocked : GetSceneItemLocked
Get-OBSSceneItemTransform Get-OBSSceneItemTransform : GetSceneItemTransform
Get-OBSSceneSceneTransitionOverride Get-OBSSceneSceneTransitionOverride : GetSceneSceneTransitionOverride
Get-OBSSceneTransition Get-OBSSceneTransition : GetSceneTransitionList
Get-OBSSourceActive Get-OBSSourceActive : GetSourceActive
Get-OBSSourceFilter Get-OBSSourceFilter : GetSourceFilter
Get-OBSSourceFilterDefaultSettings Get-OBSSourceFilterDefaultSettings : GetSourceFilterDefaultSettings
Get-OBSSourceFilterList Get-OBSSourceFilterList : GetSourceFilterList
Get-OBSSourceScreenshot Get-OBSSourceScreenshot : GetSourceScreenshot
Get-OBSSpecialInputs Get-OBSSpecialInputs : GetSpecialInputs
Get-OBSStats Get-OBSStats : GetStats
Get-OBSStreamServiceSettings Get-OBSStreamServiceSettings : GetStreamServiceSettings
Get-OBSStreamStatus Get-OBSStreamStatus : GetStreamStatus
Get-OBSStudioModeEnabled Get-OBSStudioModeEnabled : GetStudioModeEnabled
Get-OBSTransitionKind Get-OBSTransitionKind : GetTransitionKindList
Get-OBSVersion Get-OBSVersion : GetVersion
Get-OBSVideoSettings Get-OBSVideoSettings : GetVideoSettings
Get-OBSVirtualCamStatus Get-OBSVirtualCamStatus : GetVirtualCamStatus
Hide-OBS Hide OBS
Import-OBSEffect Imports Effects
Open-OBSInputFiltersDialog Open-OBSInputFiltersDialog : OpenInputFiltersDialog
Open-OBSInputInteractDialog Open-OBSInputInteractDialog : OpenInputInteractDialog
Open-OBSInputPropertiesDialog Open-OBSInputPropertiesDialog : OpenInputPropertiesDialog
Open-OBSSourceProjector Open-OBSSourceProjector : OpenSourceProjector
Open-OBSVideoMixProjector Open-OBSVideoMixProjector : OpenVideoMixProjector
Receive-OBS Receives data from OBS
Remove-OBS Remove OBS
Remove-OBSEffect Removes OBS Effects
Remove-OBSInput Remove-OBSInput : RemoveInput
Remove-OBSProfile Remove-OBSProfile : RemoveProfile
Remove-OBSScene Remove-OBSScene : RemoveScene
Remove-OBSSceneItem Remove-OBSSceneItem : RemoveSceneItem
Remove-OBSSourceFilter Remove-OBSSourceFilter : RemoveSourceFilter
Resume-OBSRecord Resume-OBSRecord : ResumeRecord
Save-OBSReplayBuffer Save-OBSReplayBuffer : SaveReplayBuffer
Save-OBSSourceScreenshot Save-OBSSourceScreenshot : SaveSourceScreenshot
Send-OBS Sends messages to the OBS websocket.
Send-OBSCallVendorRequest Send-OBSCallVendorRequest : CallVendorRequest
Send-OBSCustomEvent Send-OBSCustomEvent : BroadcastCustomEvent
Send-OBSOffsetMediaInputCursor Send-OBSOffsetMediaInputCursor : OffsetMediaInputCursor
Send-OBSPauseRecord Send-OBSPauseRecord : PauseRecord
Send-OBSPressInputPropertiesButton Send-OBSPressInputPropertiesButton : PressInputPropertiesButton
Send-OBSSleep Send-OBSSleep : Sleep
Send-OBSStreamCaption Send-OBSStreamCaption : SendStreamCaption
Send-OBSTriggerHotkeyByKeySequence Send-OBSTriggerHotkeyByKeySequence : TriggerHotkeyByKeySequence
Send-OBSTriggerHotkeyByName Send-OBSTriggerHotkeyByName : TriggerHotkeyByName
Send-OBSTriggerMediaInputAction Send-OBSTriggerMediaInputAction : TriggerMediaInputAction
Send-OBSTriggerStudioModeTransition Send-OBSTriggerStudioModeTransition : TriggerStudioModeTransition
Set-OBS3DFilter Sets an OBS 3D Filter.
Set-OBSAudioOutputSource Adds or sets an audio output source
Set-OBSBrowserSource Sets a browser source
Set-OBSColorFilter Sets a color filter
Set-OBSColorSource Adds a color source
Set-OBSCurrentPreviewScene Set-OBSCurrentPreviewScene : SetCurrentPreviewScene
Set-OBSCurrentProfile Set-OBSCurrentProfile : SetCurrentProfile
Set-OBSCurrentProgramScene Set-OBSCurrentProgramScene : SetCurrentProgramScene
Set-OBSCurrentSceneCollection Set-OBSCurrentSceneCollection : SetCurrentSceneCollection
Set-OBSCurrentSceneTransition Set-OBSCurrentSceneTransition : SetCurrentSceneTransition
Set-OBSCurrentSceneTransitionDuration Set-OBSCurrentSceneTransitionDuration : SetCurrentSceneTransitionDuration
Set-OBSCurrentSceneTransitionSettings Set-OBSCurrentSceneTransitionSettings : SetCurrentSceneTransitionSettings
Set-OBSDisplaySource Adds a display source
Set-OBSEqualizerFilter Sets a Equalizer filter.
Set-OBSGainFilter Sets a Gain filter.
Set-OBSInputAudioBalance Set-OBSInputAudioBalance : SetInputAudioBalance
Set-OBSInputAudioMonitorType Set-OBSInputAudioMonitorType : SetInputAudioMonitorType
Set-OBSInputAudioSyncOffset Set-OBSInputAudioSyncOffset : SetInputAudioSyncOffset
Set-OBSInputAudioTracks Set-OBSInputAudioTracks : SetInputAudioTracks
Set-OBSInputMute Set-OBSInputMute : SetInputMute
Set-OBSInputName Set-OBSInputName : SetInputName
Set-OBSInputSettings Set-OBSInputSettings : SetInputSettings
Set-OBSInputVolume Set-OBSInputVolume : SetInputVolume
Set-OBSMediaInputCursor Set-OBSMediaInputCursor : SetMediaInputCursor
Set-OBSMediaSource Adds a media source
Set-OBSOutputSettings Set-OBSOutputSettings : SetOutputSettings
Set-OBSPersistentData Set-OBSPersistentData : SetPersistentData
Set-OBSProfileParameter Set-OBSProfileParameter : SetProfileParameter
Set-OBSRecordDirectory Set-OBSRecordDirectory : SetRecordDirectory
Set-OBSRenderDelayFilter Sets a RenderDelay filter.
Set-OBSScaleFilter Sets a Scale filter.
Set-OBSSceneItemBlendMode Set-OBSSceneItemBlendMode : SetSceneItemBlendMode
Set-OBSSceneItemEnabled Set-OBSSceneItemEnabled : SetSceneItemEnabled
Set-OBSSceneItemIndex Set-OBSSceneItemIndex : SetSceneItemIndex
Set-OBSSceneItemLocked Set-OBSSceneItemLocked : SetSceneItemLocked
Set-OBSSceneItemTransform Set-OBSSceneItemTransform : SetSceneItemTransform
Set-OBSSceneName Set-OBSSceneName : SetSceneName
Set-OBSSceneSceneTransitionOverride Set-OBSSceneSceneTransitionOverride : SetSceneSceneTransitionOverride
Set-OBSScrollFilter Sets a scroll filter.
Set-OBSShaderFilter Sets a Shader filter.
Set-OBSSharpnessFilter Sets a Sharpness filter.
Set-OBSSourceFilterEnabled Set-OBSSourceFilterEnabled : SetSourceFilterEnabled
Set-OBSSourceFilterIndex Set-OBSSourceFilterIndex : SetSourceFilterIndex
Set-OBSSourceFilterName Set-OBSSourceFilterName : SetSourceFilterName
Set-OBSSourceFilterSettings Set-OBSSourceFilterSettings : SetSourceFilterSettings
Set-OBSStreamServiceSettings Set-OBSStreamServiceSettings : SetStreamServiceSettings
Set-OBSStudioModeEnabled Set-OBSStudioModeEnabled : SetStudioModeEnabled
Set-OBSTBarPosition Set-OBSTBarPosition : SetTBarPosition
Set-OBSVideoSettings Set-OBSVideoSettings : SetVideoSettings
Set-OBSVLCSource Adds a VLC playlist source
Set-OBSWindowSource Adds or sets a window capture source
Show-OBS Shows content in OBS
Start-OBSEffect Starts obs-powershell effects.
Start-OBSOutput Start-OBSOutput : StartOutput
Start-OBSRecord Start-OBSRecord : StartRecord
Start-OBSReplayBuffer Start-OBSReplayBuffer : StartReplayBuffer
Start-OBSStream Start-OBSStream : StartStream
Start-OBSVirtualCam Start-OBSVirtualCam : StartVirtualCam
Stop-OBSEffect Stops obs-powershell effects.
Stop-OBSOutput Stop-OBSOutput : StopOutput
Stop-OBSRecord Stop-OBSRecord : StopRecord
Stop-OBSReplayBuffer Stop-OBSReplayBuffer : StopReplayBuffer
Stop-OBSStream Stop-OBSStream : StopStream
Stop-OBSVirtualCam Stop-OBSVirtualCam : StopVirtualCam
Switch-OBSInputMute Switch-OBSInputMute : ToggleInputMute
Switch-OBSOutput Switch-OBSOutput : ToggleOutput
Switch-OBSRecord Switch-OBSRecord : ToggleRecord
Switch-OBSRecordPause Switch-OBSRecordPause : ToggleRecordPause
Switch-OBSReplayBuffer Switch-OBSReplayBuffer : ToggleReplayBuffer
Switch-OBSStream Switch-OBSStream : ToggleStream
Switch-OBSVirtualCam Switch-OBSVirtualCam : ToggleVirtualCam
Watch-OBS Watches OBS

Aliases

Name ResolvedCommand
Add-OBSInput
Add-OBSProfile
Add-OBSScene
Add-OBSSceneCollection
Add-OBSSceneItem
Add-OBSSourceFilter
Clear-OBSScene
Connect-OBS
Copy-OBSSceneItem
Disconnect-OBS
Get-OBS
Get-OBSCurrentPreviewScene
Get-OBSCurrentProgramScene
Get-OBSCurrentSceneTransition
Get-OBSCurrentSceneTransitionCursor
Get-OBSEffect
Get-OBSGroup
Get-OBSGroupSceneItem
Get-OBSHotkey
Get-OBSInput
Get-OBSInputAudioBalance
Get-OBSInputAudioMonitorType
Get-OBSInputAudioSyncOffset
Get-OBSInputAudioTracks
Get-OBSInputDefaultSettings
Get-OBSInputKind
Get-OBSInputMute
Get-OBSInputPropertiesListPropertyItems
Get-OBSInputSettings
Get-OBSInputVolume
Get-OBSLastReplayBufferReplay
Get-OBSMediaInputStatus
Get-OBSMonitor
Get-OBSOutput
Get-OBSOutputSettings
Get-OBSOutputStatus
Get-OBSPersistentData
Get-OBSProfile
Get-OBSProfileParameter
Get-OBSRecordDirectory
Get-OBSRecordStatus
Get-OBSReplayBufferStatus
Get-OBSScene
Get-OBSSceneCollection
Get-OBSSceneItem
Get-OBSSceneItemBlendMode
Get-OBSSceneItemEnabled
Get-OBSSceneItemId
Get-OBSSceneItemIndex
Get-OBSSceneItemLocked
Get-OBSSceneItemTransform
Get-OBSSceneSceneTransitionOverride
Get-OBSSceneTransition
Get-OBSSourceActive
Get-OBSSourceFilter
Get-OBSSourceFilterDefaultSettings
Get-OBSSourceFilterList
Get-OBSSourceScreenshot
Get-OBSSpecialInputs
Get-OBSStats
Get-OBSStreamServiceSettings
Get-OBSStreamStatus
Get-OBSStudioModeEnabled
Get-OBSTransitionKind
Get-OBSVersion
Get-OBSVideoSettings
Get-OBSVirtualCamStatus
Hide-OBS
Import-OBSEffect
Open-OBSInputFiltersDialog
Open-OBSInputInteractDialog
Open-OBSInputPropertiesDialog
Open-OBSSourceProjector
Open-OBSVideoMixProjector
Receive-OBS
Remove-OBS
Remove-OBSEffect
Remove-OBSInput
Remove-OBSProfile
Remove-OBSScene
Remove-OBSSceneItem
Remove-OBSSourceFilter
Resume-OBSRecord
Save-OBSReplayBuffer
Save-OBSSourceScreenshot
Send-OBS
Send-OBSCallVendorRequest
Send-OBSCustomEvent
Send-OBSOffsetMediaInputCursor
Send-OBSPauseRecord
Send-OBSPressInputPropertiesButton
Send-OBSSleep
Send-OBSStreamCaption
Send-OBSTriggerHotkeyByKeySequence
Send-OBSTriggerHotkeyByName
Send-OBSTriggerMediaInputAction
Send-OBSTriggerStudioModeTransition
Set-OBS3DFilter
Set-OBSAudioOutputSource
Set-OBSBrowserSource
Set-OBSColorFilter
Set-OBSColorSource
Set-OBSCurrentPreviewScene
Set-OBSCurrentProfile
Set-OBSCurrentProgramScene
Set-OBSCurrentSceneCollection
Set-OBSCurrentSceneTransition
Set-OBSCurrentSceneTransitionDuration
Set-OBSCurrentSceneTransitionSettings
Set-OBSDisplaySource
Set-OBSEqualizerFilter
Set-OBSGainFilter
Set-OBSInputAudioBalance
Set-OBSInputAudioMonitorType
Set-OBSInputAudioSyncOffset
Set-OBSInputAudioTracks
Set-OBSInputMute
Set-OBSInputName
Set-OBSInputSettings
Set-OBSInputVolume
Set-OBSMediaInputCursor
Set-OBSMediaSource
Set-OBSOutputSettings
Set-OBSPersistentData
Set-OBSProfileParameter
Set-OBSRecordDirectory
Set-OBSRenderDelayFilter
Set-OBSScaleFilter
Set-OBSSceneItemBlendMode
Set-OBSSceneItemEnabled
Set-OBSSceneItemIndex
Set-OBSSceneItemLocked
Set-OBSSceneItemTransform
Set-OBSSceneName
Set-OBSSceneSceneTransitionOverride
Set-OBSScrollFilter
Set-OBSShaderFilter
Set-OBSSharpnessFilter
Set-OBSSourceFilterEnabled
Set-OBSSourceFilterIndex
Set-OBSSourceFilterName
Set-OBSSourceFilterSettings
Set-OBSStreamServiceSettings
Set-OBSStudioModeEnabled
Set-OBSTBarPosition
Set-OBSVideoSettings
Set-OBSVLCSource
Set-OBSWindowSource
Show-OBS
Start-OBSEffect
Start-OBSOutput
Start-OBSRecord
Start-OBSReplayBuffer
Start-OBSStream
Start-OBSVirtualCam
Stop-OBSEffect
Stop-OBSOutput
Stop-OBSRecord
Stop-OBSReplayBuffer
Stop-OBSStream
Stop-OBSVirtualCam
Switch-OBSInputMute
Switch-OBSOutput
Switch-OBSRecord
Switch-OBSRecordPause
Switch-OBSReplayBuffer
Switch-OBSStream
Switch-OBSVirtualCam
Watch-OBS