Skip to content

Commit 6241d53

Browse files
author
James Brundage
committed
feat: Shader Commands now Prefer a ShaderFile ( Fixes #163 )
2 parents b4128d0 + 419142b commit 6241d53

File tree

3 files changed

+528
-0
lines changed

3 files changed

+528
-0
lines changed

‎docs/Add-OBSSoundCloudSource.md

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Set-OBSSoundCloudSource
2+
-----------------------
3+
4+
### Synopsis
5+
Sets a Sound Cloud Source
6+
7+
---
8+
9+
### Description
10+
11+
Adds or changes a Sound Cloud source OBS.
12+
Sound Cloud Sources are Browser Sources that display a [SoundCloud Player Widget](https://developers.soundcloud.com/docs/api/html5-widget).
13+
14+
---
15+
16+
### Examples
17+
> EXAMPLE 1
18+
19+
```PowerShell
20+
Set-obssoundCloudSource -Uri https://soundcloud.com/outertone/sets/new-earth
21+
```
22+
23+
---
24+
25+
### Parameters
26+
#### **Uri**
27+
The uri to display. This must point to a SoundCloud URL.
28+
29+
|Type |Required|Position|PipelineInput |Aliases |
30+
|-------|--------|--------|---------------------|---------------------------------------|
31+
|`[Uri]`|false |1 |true (ByPropertyName)|Url<br/>SoundCloudUri<br/>SoundCloudUrl|
32+
33+
#### **NoAutoPlay**
34+
If set, will not autoplay.
35+
36+
|Type |Required|Position|PipelineInput |
37+
|----------|--------|--------|---------------------|
38+
|`[Switch]`|false |named |true (ByPropertyName)|
39+
40+
#### **NoArtwork**
41+
If set, will not display album artwork.
42+
43+
|Type |Required|Position|PipelineInput |
44+
|----------|--------|--------|---------------------|
45+
|`[Switch]`|false |named |true (ByPropertyName)|
46+
47+
#### **NoPlayCount**
48+
If set, will not display play count.
49+
50+
|Type |Required|Position|PipelineInput |
51+
|----------|--------|--------|---------------------|
52+
|`[Switch]`|false |named |true (ByPropertyName)|
53+
54+
#### **NoUploaderInfo**
55+
If set, will not display uploader info.
56+
57+
|Type |Required|Position|PipelineInput |
58+
|----------|--------|--------|---------------------|
59+
|`[Switch]`|false |named |true (ByPropertyName)|
60+
61+
#### **TrackNumber**
62+
If provided, will start playing at a given track number.
63+
64+
|Type |Required|Position|PipelineInput |
65+
|---------|--------|--------|---------------------|
66+
|`[Int32]`|false |2 |true (ByPropertyName)|
67+
68+
#### **ShowShare**
69+
If set, will show a share link.
70+
71+
|Type |Required|Position|PipelineInput |
72+
|----------|--------|--------|---------------------|
73+
|`[Switch]`|false |named |true (ByPropertyName)|
74+
75+
#### **ShowDownload**
76+
If set, will show a download link.
77+
78+
|Type |Required|Position|PipelineInput |
79+
|----------|--------|--------|---------------------|
80+
|`[Switch]`|false |named |true (ByPropertyName)|
81+
82+
#### **ShowBuy**
83+
If set, will show a buy link.
84+
85+
|Type |Required|Position|PipelineInput |
86+
|----------|--------|--------|---------------------|
87+
|`[Switch]`|false |named |true (ByPropertyName)|
88+
89+
#### **Color**
90+
The color used for the SoundCloud audio bars and buttons.
91+
92+
|Type |Required|Position|PipelineInput |
93+
|----------|--------|--------|---------------------|
94+
|`[String]`|false |3 |true (ByPropertyName)|
95+
96+
#### **Width**
97+
The width of the browser source.
98+
If none is provided, this will be the output width of the video settings.
99+
100+
|Type |Required|Position|PipelineInput |
101+
|---------|--------|--------|---------------------|
102+
|`[Int32]`|false |4 |true (ByPropertyName)|
103+
104+
#### **Height**
105+
The width of the browser source.
106+
If none is provided, this will be the output height of the video settings.
107+
108+
|Type |Required|Position|PipelineInput |
109+
|---------|--------|--------|---------------------|
110+
|`[Int32]`|false |5 |true (ByPropertyName)|
111+
112+
#### **CSS**
113+
The css style used to render the browser page.
114+
115+
|Type |Required|Position|PipelineInput |
116+
|----------|--------|--------|---------------------|
117+
|`[String]`|false |6 |true (ByPropertyName)|
118+
119+
#### **ShutdownWhenHidden**
120+
If set, the browser source will shutdown when it is hidden
121+
122+
|Type |Required|Position|PipelineInput |
123+
|----------|--------|--------|---------------------|
124+
|`[Switch]`|false |named |true (ByPropertyName)|
125+
126+
#### **RestartWhenActived**
127+
If set, the browser source will restart when it is activated.
128+
129+
|Type |Required|Position|PipelineInput |
130+
|----------|--------|--------|---------------------|
131+
|`[Switch]`|false |named |true (ByPropertyName)|
132+
133+
#### **RerouteAudio**
134+
If set, audio from the browser source will be rerouted into OBS.
135+
136+
|Type |Required|Position|PipelineInput |
137+
|----------|--------|--------|---------------------|
138+
|`[Switch]`|false |named |true (ByPropertyName)|
139+
140+
#### **FramesPerSecond**
141+
If provided, the browser source will render at a custom frame rate.
142+
143+
|Type |Required|Position|PipelineInput |Aliases|
144+
|---------|--------|--------|---------------------|-------|
145+
|`[Int32]`|false |7 |true (ByPropertyName)|FPS |
146+
147+
#### **Scene**
148+
The name of the scene.
149+
If no scene name is provided, the current program scene will be used.
150+
151+
|Type |Required|Position|PipelineInput |
152+
|----------|--------|--------|---------------------|
153+
|`[String]`|false |8 |true (ByPropertyName)|
154+
155+
#### **Name**
156+
The name of the input.
157+
If no name is provided, the last segment of the URI or file path will be the input name.
158+
159+
|Type |Required|Position|PipelineInput |Aliases |
160+
|----------|--------|--------|---------------------|------------------------|
161+
|`[String]`|false |9 |true (ByPropertyName)|InputName<br/>SourceName|
162+
163+
#### **Force**
164+
If set, will check if the source exists in the scene before creating it and removing any existing sources found.
165+
If not set, you will get an error if a source with the same name exists.
166+
167+
|Type |Required|Position|PipelineInput |
168+
|----------|--------|--------|---------------------|
169+
|`[Switch]`|false |named |true (ByPropertyName)|
170+
171+
---
172+
173+
### Syntax
174+
```PowerShell
175+
Set-OBSSoundCloudSource [[-Uri] <Uri>] [-NoAutoPlay] [-NoArtwork] [-NoPlayCount] [-NoUploaderInfo] [[-TrackNumber] <Int32>] [-ShowShare] [-ShowDownload] [-ShowBuy] [[-Color] <String>] [[-Width] <Int32>] [[-Height] <Int32>] [[-CSS] <String>] [-ShutdownWhenHidden] [-RestartWhenActived] [-RerouteAudio] [[-FramesPerSecond] <Int32>] [[-Scene] <String>] [[-Name] <String>] [-Force] [<CommonParameters>]
176+
```

‎docs/Get-OBSSoundCloudSource.md

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Set-OBSSoundCloudSource
2+
-----------------------
3+
4+
### Synopsis
5+
Sets a Sound Cloud Source
6+
7+
---
8+
9+
### Description
10+
11+
Adds or changes a Sound Cloud source OBS.
12+
Sound Cloud Sources are Browser Sources that display a [SoundCloud Player Widget](https://developers.soundcloud.com/docs/api/html5-widget).
13+
14+
---
15+
16+
### Examples
17+
> EXAMPLE 1
18+
19+
```PowerShell
20+
Set-obssoundCloudSource -Uri https://soundcloud.com/outertone/sets/new-earth
21+
```
22+
23+
---
24+
25+
### Parameters
26+
#### **Uri**
27+
The uri to display. This must point to a SoundCloud URL.
28+
29+
|Type |Required|Position|PipelineInput |Aliases |
30+
|-------|--------|--------|---------------------|---------------------------------------|
31+
|`[Uri]`|false |1 |true (ByPropertyName)|Url<br/>SoundCloudUri<br/>SoundCloudUrl|
32+
33+
#### **NoAutoPlay**
34+
If set, will not autoplay.
35+
36+
|Type |Required|Position|PipelineInput |
37+
|----------|--------|--------|---------------------|
38+
|`[Switch]`|false |named |true (ByPropertyName)|
39+
40+
#### **NoArtwork**
41+
If set, will not display album artwork.
42+
43+
|Type |Required|Position|PipelineInput |
44+
|----------|--------|--------|---------------------|
45+
|`[Switch]`|false |named |true (ByPropertyName)|
46+
47+
#### **NoPlayCount**
48+
If set, will not display play count.
49+
50+
|Type |Required|Position|PipelineInput |
51+
|----------|--------|--------|---------------------|
52+
|`[Switch]`|false |named |true (ByPropertyName)|
53+
54+
#### **NoUploaderInfo**
55+
If set, will not display uploader info.
56+
57+
|Type |Required|Position|PipelineInput |
58+
|----------|--------|--------|---------------------|
59+
|`[Switch]`|false |named |true (ByPropertyName)|
60+
61+
#### **TrackNumber**
62+
If provided, will start playing at a given track number.
63+
64+
|Type |Required|Position|PipelineInput |
65+
|---------|--------|--------|---------------------|
66+
|`[Int32]`|false |2 |true (ByPropertyName)|
67+
68+
#### **ShowShare**
69+
If set, will show a share link.
70+
71+
|Type |Required|Position|PipelineInput |
72+
|----------|--------|--------|---------------------|
73+
|`[Switch]`|false |named |true (ByPropertyName)|
74+
75+
#### **ShowDownload**
76+
If set, will show a download link.
77+
78+
|Type |Required|Position|PipelineInput |
79+
|----------|--------|--------|---------------------|
80+
|`[Switch]`|false |named |true (ByPropertyName)|
81+
82+
#### **ShowBuy**
83+
If set, will show a buy link.
84+
85+
|Type |Required|Position|PipelineInput |
86+
|----------|--------|--------|---------------------|
87+
|`[Switch]`|false |named |true (ByPropertyName)|
88+
89+
#### **Color**
90+
The color used for the SoundCloud audio bars and buttons.
91+
92+
|Type |Required|Position|PipelineInput |
93+
|----------|--------|--------|---------------------|
94+
|`[String]`|false |3 |true (ByPropertyName)|
95+
96+
#### **Width**
97+
The width of the browser source.
98+
If none is provided, this will be the output width of the video settings.
99+
100+
|Type |Required|Position|PipelineInput |
101+
|---------|--------|--------|---------------------|
102+
|`[Int32]`|false |4 |true (ByPropertyName)|
103+
104+
#### **Height**
105+
The width of the browser source.
106+
If none is provided, this will be the output height of the video settings.
107+
108+
|Type |Required|Position|PipelineInput |
109+
|---------|--------|--------|---------------------|
110+
|`[Int32]`|false |5 |true (ByPropertyName)|
111+
112+
#### **CSS**
113+
The css style used to render the browser page.
114+
115+
|Type |Required|Position|PipelineInput |
116+
|----------|--------|--------|---------------------|
117+
|`[String]`|false |6 |true (ByPropertyName)|
118+
119+
#### **ShutdownWhenHidden**
120+
If set, the browser source will shutdown when it is hidden
121+
122+
|Type |Required|Position|PipelineInput |
123+
|----------|--------|--------|---------------------|
124+
|`[Switch]`|false |named |true (ByPropertyName)|
125+
126+
#### **RestartWhenActived**
127+
If set, the browser source will restart when it is activated.
128+
129+
|Type |Required|Position|PipelineInput |
130+
|----------|--------|--------|---------------------|
131+
|`[Switch]`|false |named |true (ByPropertyName)|
132+
133+
#### **RerouteAudio**
134+
If set, audio from the browser source will be rerouted into OBS.
135+
136+
|Type |Required|Position|PipelineInput |
137+
|----------|--------|--------|---------------------|
138+
|`[Switch]`|false |named |true (ByPropertyName)|
139+
140+
#### **FramesPerSecond**
141+
If provided, the browser source will render at a custom frame rate.
142+
143+
|Type |Required|Position|PipelineInput |Aliases|
144+
|---------|--------|--------|---------------------|-------|
145+
|`[Int32]`|false |7 |true (ByPropertyName)|FPS |
146+
147+
#### **Scene**
148+
The name of the scene.
149+
If no scene name is provided, the current program scene will be used.
150+
151+
|Type |Required|Position|PipelineInput |
152+
|----------|--------|--------|---------------------|
153+
|`[String]`|false |8 |true (ByPropertyName)|
154+
155+
#### **Name**
156+
The name of the input.
157+
If no name is provided, the last segment of the URI or file path will be the input name.
158+
159+
|Type |Required|Position|PipelineInput |Aliases |
160+
|----------|--------|--------|---------------------|------------------------|
161+
|`[String]`|false |9 |true (ByPropertyName)|InputName<br/>SourceName|
162+
163+
#### **Force**
164+
If set, will check if the source exists in the scene before creating it and removing any existing sources found.
165+
If not set, you will get an error if a source with the same name exists.
166+
167+
|Type |Required|Position|PipelineInput |
168+
|----------|--------|--------|---------------------|
169+
|`[Switch]`|false |named |true (ByPropertyName)|
170+
171+
---
172+
173+
### Syntax
174+
```PowerShell
175+
Set-OBSSoundCloudSource [[-Uri] <Uri>] [-NoAutoPlay] [-NoArtwork] [-NoPlayCount] [-NoUploaderInfo] [[-TrackNumber] <Int32>] [-ShowShare] [-ShowDownload] [-ShowBuy] [[-Color] <String>] [[-Width] <Int32>] [[-Height] <Int32>] [[-CSS] <String>] [-ShutdownWhenHidden] [-RestartWhenActived] [-RerouteAudio] [[-FramesPerSecond] <Int32>] [[-Scene] <String>] [[-Name] <String>] [-Force] [<CommonParameters>]
176+
```

0 commit comments

Comments
 (0)