-
-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
61d0e57
commit 20eeaf2
Showing
21 changed files
with
268 additions
and
328 deletions.
There are no files selected for viewing
37 changes: 15 additions & 22 deletions
37
.../3.api/1.sub-actions/streamlabs-desktop/filters/set-state-of-a-random-filter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,20 @@ | ||
--- | ||
title: Set State of a Random Filter | ||
description: Set the state of a filter randomly selected from a given scene or source | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsSource | ||
- name: State | ||
type: Select | ||
required: true | ||
description: | | ||
Set the state for the random filter | ||
- `Visible`: Set the filter state to visible | ||
- `Hidden`: Set the filter state to hidden | ||
- `Toggle`: Toggle the filter state between visible and hidden | ||
variables: [] | ||
csharpMethods: | ||
- SlobsSetRandomSceneFilterState | ||
- SlobsSetRandomSourceFilterState | ||
- SlobsSetRandomFilterState | ||
--- | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Source` | ||
Select the source from this dropdown list, you can also manually enter a source name. | ||
|
||
- Type: `String` | ||
|
||
### `State` | ||
Set the state for the random filter | ||
|
||
- `Visible`: Set the filter state to visible | ||
- `Hidden`: Set the filter state to hidden | ||
- `Toggle`: Toggle the filter state between visible and hidden |
18 changes: 5 additions & 13 deletions
18
streamerbot/3.api/1.sub-actions/streamlabs-desktop/groups/hide-groups-sources.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,11 @@ | ||
--- | ||
title: Hide Group's Sources | ||
description: Hide all the sources from a group | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsGroup | ||
variables: [] | ||
csharpMethods: | ||
- SlobsHideGroupsSources | ||
--- | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Group` | ||
Select the group from this dropdown list, you can also manually enter a group name. | ||
|
||
- Type: `String` |
29 changes: 11 additions & 18 deletions
29
....api/1.sub-actions/streamlabs-desktop/groups/set-random-group-source-visible.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,11 @@ | ||
# Set Random Group Source Visible | ||
Set a random source from a group visible | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Group` | ||
Select the group from this dropdown list, you can also manually enter a group name. | ||
|
||
- Type: `String` | ||
|
||
## C# Usage | ||
:csharp-method{name=SlobsSetRandomGroupSourceVisible} | ||
--- | ||
title: Set Random Group Source Visible | ||
description: Set a random source from a group visible | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsGroup | ||
variables: [] | ||
csharpMethods: | ||
- SlobsSetRandomGroupSourceVisible | ||
--- |
22 changes: 11 additions & 11 deletions
22
streamerbot/3.api/1.sub-actions/streamlabs-desktop/recording.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
--- | ||
title: Recording | ||
description: Change your current recording status | ||
parameters: | ||
- name: SlobsConnection | ||
- name: State | ||
type: Select | ||
description: | | ||
Select the desired recording state | ||
- `Start`: Start recording | ||
- `Stop`: Stop recording | ||
- `Pause`: Pause recording | ||
- `Resume`: Resume recording | ||
variables: [] | ||
csharpMethods: | ||
- SlobsStopRecording | ||
- SlobsStartRecording | ||
- SlobsPauseRecording | ||
- SlobsResumeRecording | ||
--- | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `State` | ||
Choose the recording state | ||
|
||
- `Start`: Start your recording | ||
- `Stop`: Stop your recording | ||
- `Pause`: Pause your recording | ||
- `Resume`: Resume your recording |
28 changes: 13 additions & 15 deletions
28
streamerbot/3.api/1.sub-actions/streamlabs-desktop/scenes/get-current-scene.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,13 @@ | ||
# Get Current Scene | ||
Get the current scene | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
## Variables | ||
:variables-description | ||
|
||
Name | Description | ||
----:|:------------ | ||
`currentScene` | Name of the active scene at the time of execution | ||
|
||
## C# Usage | ||
:csharp-method{name=SlobsGetCurrentScene} | ||
--- | ||
title: Get Current Scene | ||
description: Get the current scene from Streamlabs Desktop | ||
parameters: | ||
- name: SlobsConnection | ||
variables: | ||
- name: currentScene | ||
description: Name of the active scene | ||
type: string | ||
value: My Scene | ||
csharpMethods: | ||
- SlobsGetCurrentScene | ||
--- |
23 changes: 10 additions & 13 deletions
23
streamerbot/3.api/1.sub-actions/streamlabs-desktop/scenes/set-active-scene.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,10 @@ | ||
# Set Active Scene | ||
Change the current scene | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
## C# Usage | ||
:csharp-method{name=SlobsSetScene} | ||
--- | ||
title: Set Active Scene | ||
description: Change the current scene in Streamlabs Desktop | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
variables: [] | ||
csharpMethods: | ||
- SlobsSetScene | ||
--- |
42 changes: 19 additions & 23 deletions
42
...amerbot/3.api/1.sub-actions/streamlabs-desktop/scenes/set-scene-filter-state.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,20 @@ | ||
# Set Scene Filter State | ||
Sets the visibility state of a scene filter. | ||
--- | ||
title: Set Scene Filter State | ||
description: Update the visibility of a filter for a given scene | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsFilter | ||
- name: State | ||
type: Select | ||
required: true | ||
description: | | ||
Select the new state for the selected filter | ||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Filter` | ||
Select the filter from this dropdown list, you can also manually enter a filter name. | ||
|
||
- Type: `String` | ||
|
||
### `State` | ||
Select which state you want to set | ||
- `Visible`: Sets the filter state on your scene to Visible | ||
- `Hidden`: Sets the filter state on your scene to Hidden | ||
- `Toggle`: Toggles the filter state on your scene between Visible and Hidden | ||
|
||
## C# Usage | ||
:csharp-method{name=SlobsSetSceneFilterState} | ||
- `Visible`: Sets the filter state on your scene to Visible | ||
- `Hidden`: Sets the filter state on your scene to Hidden | ||
- `Toggle`: Toggles the filter state on your scene between Visible and Hidden | ||
variables: [] | ||
csharpMethods: | ||
- SlobsSetFilterState | ||
--- |
44 changes: 19 additions & 25 deletions
44
streamerbot/3.api/1.sub-actions/streamlabs-desktop/sources/flip-source.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,19 @@ | ||
# Flip Source | ||
Flip a source horizontally, vertically or both | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Source` | ||
Select the source from this dropdown list, you can also manually enter a source name. | ||
|
||
- Type: `String` | ||
|
||
### `Mode` | ||
Select on which side you want to flip the source | ||
|
||
- `Horizontal`: Flip the source horizontally | ||
- `Vertical`: Flip the source vertically | ||
- `Both`: Flip the source horizontally and vertically | ||
|
||
## C# Usage | ||
:csharp-method | ||
--- | ||
title: Flip Source | ||
description: Flip a source horizontally, vertically, or both | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsSource | ||
- name: Mode | ||
type: Select | ||
required: true | ||
description: | | ||
Choose how to flip the selected source | ||
- `Horizontal`: Flip the source horizontally | ||
- `Vertical`: Flip the source vertically | ||
- `Both`: Flip the source horizontally and vertically | ||
variables: [] | ||
csharpMethods: [] | ||
--- |
28 changes: 10 additions & 18 deletions
28
streamerbot/3.api/1.sub-actions/streamlabs-desktop/sources/hide-sources-filters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,10 @@ | ||
# Hide Source's Filters | ||
Hide all the filters from a source | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Source` | ||
Select the source from this dropdown list, you can also manually enter a source name. | ||
|
||
- Type: `String` | ||
|
||
## C# Usage | ||
:csharp-method | ||
--- | ||
title: Hide Source's Filters | ||
description: Hide all filters from a given source | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsSource | ||
variables: [] | ||
csharpMethods: [] | ||
--- |
54 changes: 25 additions & 29 deletions
54
streamerbot/3.api/1.sub-actions/streamlabs-desktop/sources/rotate-source.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,25 @@ | ||
# Rotate Source | ||
Rotate a source | ||
|
||
## Parameters | ||
:parameter{name=SlobsConnection} | ||
|
||
### `Scene` | ||
Select the scene from this dropdown list, you can also manually enter a scene name. | ||
|
||
- Type: `String` | ||
|
||
### `Source` | ||
Select the source from this dropdown list, you can also manually enter a source name. | ||
|
||
- Type: `String` | ||
|
||
### `Alignment` | ||
This shows the current alignment. | ||
|
||
### `Rotation` | ||
By default, this is an `Absolute` angle with 0 being normal rotation, valid range -360 -> +360, however as transform is instant values outside -180 -> +180 will be visually the same. Negative values rotate the source counter-clockwise. | ||
|
||
- Type: `Number` | ||
|
||
### `Additive` | ||
This option will make the rotation relative to its current transform rather than overwriting | ||
|
||
## C# Usage | ||
:csharp-method | ||
--- | ||
title: Hide Source's Filters | ||
description: Hide all filters from a given source | ||
parameters: | ||
- name: SlobsConnection | ||
- name: SlobsScene | ||
- name: SlobsSource | ||
- name: Alignment | ||
description: | | ||
Shows the current alignment | ||
- name: Rotation | ||
type: Number | ||
default: 0 | ||
description: | | ||
By default, this is an `Absolute` angle with 0 being normal rotation, valid range `-360`{lang=cs} to `+360`{lang=cs}, | ||
Negative values will rotate the source counter-clockwise. | ||
- name: Additive | ||
type: Toggle | ||
default: false | ||
description: | | ||
This option will make the rotation relative to its current alignment, rather than overwriting | ||
variables: [] | ||
csharpMethods: [] | ||
--- |
Oops, something went wrong.