Skip to content

Commit 69252d2

Browse files
StartAutomatingStartAutomating
authored andcommitted
Hide-OBS: Fixing parameter signature (re #67)
1 parent 74b6316 commit 69252d2

1 file changed

Lines changed: 96 additions & 0 deletions

File tree

docs/Hide-OBS.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
Hide-OBS
2+
--------
3+
4+
5+
6+
7+
### Synopsis
8+
Hide OBS
9+
10+
11+
12+
---
13+
14+
15+
### Description
16+
17+
Hides items in OBS
18+
19+
20+
21+
---
22+
23+
24+
### Related Links
25+
* [Set-OBSSceneItemEnabled](Set-OBSSceneItemEnabled.md)
26+
27+
28+
29+
30+
31+
---
32+
33+
34+
### Examples
35+
#### EXAMPLE 1
36+
```PowerShell
37+
Hide-OBS -SourceName "foo"
38+
```
39+
40+
41+
42+
---
43+
44+
45+
### Parameters
46+
#### **ItemName**
47+
48+
The name of the item we want to Hide
49+
50+
51+
52+
53+
54+
55+
|Type |Required|Position|PipelineInput |Aliases |
56+
|----------|--------|--------|---------------------|------------------------|
57+
|`[Object]`|true |1 |true (ByPropertyName)|SourceName<br/>InputName|
58+
59+
60+
61+
#### **SceneName**
62+
63+
The name of the scene. If not provided, the current program scene will be used.
64+
65+
66+
67+
68+
69+
70+
|Type |Required|Position|PipelineInput |
71+
|----------|--------|--------|---------------------|
72+
|`[String]`|false |2 |true (ByPropertyName)|
73+
74+
75+
76+
#### **WhatIf**
77+
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
78+
-WhatIf is used to see what would happen, or return operations without executing them
79+
#### **Confirm**
80+
-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
81+
-Confirm is used to -Confirm each operation.
82+
83+
If you pass ```-Confirm:$false``` you will not be prompted.
84+
85+
86+
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
87+
88+
89+
90+
---
91+
92+
93+
### Syntax
94+
```PowerShell
95+
Hide-OBS [-ItemName] <Object> [[-SceneName] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
96+
```

0 commit comments

Comments
 (0)