diff --git a/streamerbot/2.guide/06.integrations/streamfog.md b/streamerbot/2.guide/06.integrations/streamfog.md index 486c14cf..963a64ab 100644 --- a/streamerbot/2.guide/06.integrations/streamfog.md +++ b/streamerbot/2.guide/06.integrations/streamfog.md @@ -4,6 +4,7 @@ description: Integrate Streamer.bot with StreamFog navigation.icon: null version: 1.0.5 logo: /img/icons/streamfog.png +badge: New --- Integrate Streamer.bot with [StreamFog](https://streamfog.com){target=\_blank} @@ -45,4 +46,4 @@ StreamFog is now connected to Streamer.bot! ## Usage -:read-more{to="/api/sub-actions/integrations/streamfog"} \ No newline at end of file +:read-more{to="/api/sub-actions/integrations/streamfog"} diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/add-application-to-channel.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/add-application-to-channel.md new file mode 100644 index 00000000..65f87f04 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/add-application-to-channel.md @@ -0,0 +1,10 @@ +--- +title: Add Application to Channel +description: Add an application to a specific audio channel +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Mix to add to the audio channel +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/adjust-channel-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/adjust-channel-volume.md new file mode 100644 index 00000000..ff38524e --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/adjust-channel-volume.md @@ -0,0 +1,18 @@ +--- +title: Adjust Channel Volume +description: Adjust the volume of an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Desired mix of the channel you want to affect + - name: Volume Delta + type: Number + description: Will add/subtract from the current volume + default: +5 +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/get-channel-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/get-channel-information.md new file mode 100644 index 00000000..12b785d5 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/get-channel-information.md @@ -0,0 +1,71 @@ +--- +title: Get Channel Information +description: Retrieve information about an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to obtain the current information for +variables: + - name: waveLinkChannelId + type: string + description: Identifier of the channel ID + value: PCM_OUT_00_V_00_SD1 + - name: waveLinkChannelName + type: string + description: Name of the channel + value: System + - name: waveLinkChannelVolume + type: number + description: Current volume level of the channel + value: 1 + - name: waveLinkChannelMuted + type: bool + description: Indicates if the channel is muted + value: false + - name: waveLinkChannelLevel + type: number + description: Current volume level of the channel + value: 1 + - name: waveLinkChannelEffectsCount + type: number + description: Current number of effects applied to the channel + value: 0 + - name: waveLinkChannelMixesCount + type: number + description: Current number of mixes the channel is part of + value: 2 + - name: waveLinkChannelMix.0.id + type: string + description: ID of the first mix the channel is part of + value: PCM_IN_01_V_00_SD1 + - name: waveLinkChannelMix.0.name + type: string + description: Name of the first mix the channel is part of + value: Testing Name Mix + - name: waveLinkChannelMix.0.level + type: number + description: Volume level of the first mix the channel is part of + value: 1 + - name: waveLinkChannelMix.0.muted + type: bool + description: Indicates if the first mix the channel is part of is muted + value: false + - name: waveLinkChannelMix.1.id + type: string + description: ID of the second mix the channel is part of + value: PCM_IN_01_V_02_SD2 + - name: waveLinkChannelMix.1.name + type: string + description: Name of the second mix the channel is part of + value: Stream Mix + - name: waveLinkChannelMix.1.level + type: number + description: Volume level of the second mix the channel is part of + value: 1 + - name: waveLinkChannelMix.1.muted + type: bool + description: Indicates if the second mix the channel is part of is muted + value: false +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/mute-channel.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/mute-channel.md new file mode 100644 index 00000000..630ff18f --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/mute-channel.md @@ -0,0 +1,17 @@ +--- +title: Mute Channel +description: Mute a specific audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: State + type: Select + required: true + description: | + Mute State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-effect-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-effect-state.md new file mode 100644 index 00000000..cd5a03f6 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-effect-state.md @@ -0,0 +1,21 @@ +--- +title: Set Channel Effect State +description: Set the state of a specific effect within an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Effect + type: Select + required: true + description: Effect which should be applied to the audio channel + - name: State + type: Select + required: true + description: | + Effect State + Options: `Disabled`, `Enabled`, `Toggle` + default: Disabled +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-mix-mute.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-mix-mute.md new file mode 100644 index 00000000..2b7b6ecc --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-mix-mute.md @@ -0,0 +1,21 @@ +--- +title: Set Channel Mix Mute +description: Mute a specific mix within an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Mix which should be affected + - name: State + type: Select + required: true + description: | + Mute State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-volume.md new file mode 100644 index 00000000..7cf899a4 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/channels/set-channel-volume.md @@ -0,0 +1,19 @@ +--- +title: Set Channel Volume +description: Set the output volume of an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Audio input mix you want to affect + - name: Volume + type: Number + required: true + description: Volume of the audio input mix + default: 100 +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/get-input-device-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/get-input-device-information.md new file mode 100644 index 00000000..54b1c539 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/get-input-device-information.md @@ -0,0 +1,63 @@ +--- +title: Get Input Device Information +description: Retrieve information about an audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to obtain the current information for +variables: + - name: waveLinkInputDeviceId + type: string + description: Identifier of the input device + value: '{0.0.1.00000000}.{96e65e84-0aaf-4b18-8f69-3da2d478b3d4}' + - name: waveLinkInputDeviceName + type: string + description: Name of the input device + value: Microphone (2- Realtek USB2.0 Audio) + - name: waveLinkInputDeviceType + type: string + description: Type of the input device + value: thirdParty + - name: waveLinkInputDeviceGain + type: number + description: Current gain level of the input device + value: 0.5541552 + - name: waveLinkInputDeviceMuted + type: bool + description: Indicates if the input device is muted + value: false + - name: waveLinkInputDeviceMicPcMix + type: number + description: Current microphone/PC mix level of the input device + value: 0 + - name: waveLinkInputDeviceClipGuard + type: bool + description: Indicates if the input device has clip guard enabled + value: false + - name: waveLinkInputDeviceLowCutFilter + type: bool + description: Indicates if the input device has low cut filter enabled + value: false + - name: waveLinkInputDeviceChannelCount + type: number + description: Number of channels of the input device + value: 0 + - name: waveLinkInputChannelId + type: string + description: Identifier of the input channel + value: + - name: waveLinkInputChannelName + type: string + description: Name of the input channel + value: + - name: waveLinkInputChannelVolume + type: number + description: Current volume level of the channel + value: 0 + - name: waveLinkInputChannelMuted + type: bool + description: Indicates if the input channel is muted + value: false +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/mute-input-device.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/mute-input-device.md new file mode 100644 index 00000000..b6580491 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/mute-input-device.md @@ -0,0 +1,17 @@ +--- +title: Mute Input Device +description: Mute a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-clipguard-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-clipguard-state.md new file mode 100644 index 00000000..a671455d --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-clipguard-state.md @@ -0,0 +1,17 @@ +--- +title: Set Input Clipguard State +description: Sets the clipguard state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain-lock-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain-lock-state.md new file mode 100644 index 00000000..ff79efd4 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain-lock-state.md @@ -0,0 +1,17 @@ +--- +title: Set Input Gain Lock State +description: Sets the gain lock state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain.md new file mode 100644 index 00000000..dc9f24c0 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-gain.md @@ -0,0 +1,17 @@ +--- +title: Set Input Gain +description: Sets the gain of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: Gain + type: number + required: true + description: | + Gain + Range: `0` to `1` db + default: Enabled +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-low-cut-filter.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-low-cut-filter.md new file mode 100644 index 00000000..34cda478 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/inputs/set-input-low-cut-filter.md @@ -0,0 +1,17 @@ +--- +title: Set Input Low Cut Filter +description: Sets the low cut filter state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/adjust-mix-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/adjust-mix-volume.md new file mode 100644 index 00000000..117f496c --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/adjust-mix-volume.md @@ -0,0 +1,14 @@ +--- +title: Adjust Mix Volume +description: Adjust the volume of an audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to affect + - name: Volume Delta + type: Number + description: Will add/subtract from the current volume + default: +5 +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/get-mix-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/get-mix-information.md new file mode 100644 index 00000000..496b6d50 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/get-mix-information.md @@ -0,0 +1,27 @@ +--- +title: Get Mix Information +description: Retrieve information about an audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to obtain the current information for +variables: + - name: waveLinkMixId + type: string + description: Identifier of the mix ID + value: PCM_IN_01_V_04_SD3 + - name: waveLinkMixName + type: string + description: Name of the mix + value: Chat Mix + - name: waveLinkMixVolume + type: number + description: Current volume level of the mix + value: 1 + - name: waveLinkMixMuted + type: bool + description: Indicates if the mix is muted + value: false +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/set-mix-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/set-mix-volume.md new file mode 100644 index 00000000..58b7d891 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/mixes/set-mix-volume.md @@ -0,0 +1,17 @@ +--- +title: Set Mix Volume +description: Sets the volume of a specific audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to affect + - name: Volume + type: number + required: true + description: | + Gain + Range: `0` to `100` db + default: 100 +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/add-output-to-device-mix.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/add-output-to-device-mix.md new file mode 100644 index 00000000..a9be56e7 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/add-output-to-device-mix.md @@ -0,0 +1,14 @@ +--- +title: Add Output Device to Mix +description: Adds an output device to a specific audio mix +version: 1.1.0 +parameters: + - name: Output Device + type: Select + required: true + description: Audio output device you want to add to the mix + - name: Mix + type: Select + required: true + description: Audio mix you want to add the output device to +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/get-selected-output-device.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/get-selected-output-device.md new file mode 100644 index 00000000..a5d4b65a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/get-selected-output-device.md @@ -0,0 +1,18 @@ +--- +title: Get Selected Output Device +description: Retrieve information about the currently selected audio output device +version: 1.1.0 +variables: + - name: waveLinkOutputDeviceId + type: string + description: Identifier of the output device + value: '{0.0.0.00000000}.{51228b0e-d9af-4c0f-a03c-934a19a8cb23}' + - name: waveLinkOutputDeviceName + type: string + description: Name of the output device + value: SPDIF Interface (2- Realtek USB2.0 Audio) + - name: waveLinkOutputId + type: string + description: Identifier of the output device + value: '{0.0.0.00000000}.{51228b0e-d9af-4c0f-a03c-934a19a8cb23}' +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-monitored-mix.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-monitored-mix.md new file mode 100644 index 00000000..a12ad1c6 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-monitored-mix.md @@ -0,0 +1,10 @@ +--- +title: Set Monitored Mix +description: Sets the mix to monitor +version: 1.1.0 +parameters: + - name: Monitored Mix + type: Select + required: true + description: Audio mix you want to affect +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-output-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-output-volume.md new file mode 100644 index 00000000..61b9da54 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3.x/outputs/set-output-volume.md @@ -0,0 +1,17 @@ +--- +title: Set Output Volume +description: Sets the volume of a specific audio output +version: 1.1.0 +parameters: + - name: Output Device + type: Select + required: true + description: Audio output device you want to affect + - name: Volume + type: number + required: true + description: | + Gain + Range: `0` to `100` + default: 100 +--- diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/add-application-to-channel.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/add-application-to-channel.md new file mode 100644 index 00000000..d7119257 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/add-application-to-channel.md @@ -0,0 +1,11 @@ +--- +title: Add Application to Channel +description: Add an application to a specific audio channel +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Mix to add to the audio channel +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/adjust-channel-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/adjust-channel-volume.md new file mode 100644 index 00000000..c73f3a39 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/adjust-channel-volume.md @@ -0,0 +1,19 @@ +--- +title: Adjust Channel Volume +description: Adjust the volume of an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Desired mix of the channel you want to affect + - name: Volume Delta + type: Number + description: Will add/subtract from the current volume + default: +5 +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/get-channel-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/get-channel-information.md new file mode 100644 index 00000000..c25b7667 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/get-channel-information.md @@ -0,0 +1,72 @@ +--- +title: Get Channel Information +description: Retrieve information about an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to obtain the current information for +variables: + - name: waveLinkChannelId + type: string + description: Identifier of the channel ID + value: PCM_OUT_00_V_00_SD1 + - name: waveLinkChannelName + type: string + description: Name of the channel + value: System + - name: waveLinkChannelVolume + type: number + description: Current volume level of the channel + value: 1 + - name: waveLinkChannelMuted + type: bool + description: Indicates if the channel is muted + value: false + - name: waveLinkChannelLevel + type: number + description: Current volume level of the channel + value: 1 + - name: waveLinkChannelEffectsCount + type: number + description: Current number of effects applied to the channel + value: 0 + - name: waveLinkChannelMixesCount + type: number + description: Current number of mixes the channel is part of + value: 2 + - name: waveLinkChannelMix.0.id + type: string + description: ID of the first mix the channel is part of + value: PCM_IN_01_V_00_SD1 + - name: waveLinkChannelMix.0.name + type: string + description: Name of the first mix the channel is part of + value: Testing Name Mix + - name: waveLinkChannelMix.0.level + type: number + description: Volume level of the first mix the channel is part of + value: 1 + - name: waveLinkChannelMix.0.muted + type: bool + description: Indicates if the first mix the channel is part of is muted + value: false + - name: waveLinkChannelMix.1.id + type: string + description: ID of the second mix the channel is part of + value: PCM_IN_01_V_02_SD2 + - name: waveLinkChannelMix.1.name + type: string + description: Name of the second mix the channel is part of + value: Stream Mix + - name: waveLinkChannelMix.1.level + type: number + description: Volume level of the second mix the channel is part of + value: 1 + - name: waveLinkChannelMix.1.muted + type: bool + description: Indicates if the second mix the channel is part of is muted + value: false +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/mute-channel.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/mute-channel.md new file mode 100644 index 00000000..f735669a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/mute-channel.md @@ -0,0 +1,18 @@ +--- +title: Mute Channel +description: Mute a specific audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: State + type: Select + required: true + description: | + Mute State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-effect-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-effect-state.md new file mode 100644 index 00000000..ac14eb2a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-effect-state.md @@ -0,0 +1,22 @@ +--- +title: Set Channel Effect State +description: Set the state of a specific effect within an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Effect + type: Select + required: true + description: Effect which should be applied to the audio channel + - name: State + type: Select + required: true + description: | + Effect State + Options: `Disabled`, `Enabled`, `Toggle` + default: Disabled +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-mix-mute.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-mix-mute.md new file mode 100644 index 00000000..5174bd63 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-mix-mute.md @@ -0,0 +1,22 @@ +--- +title: Set Channel Mix Mute +description: Mute a specific mix within an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Mix which should be affected + - name: State + type: Select + required: true + description: | + Mute State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-volume.md new file mode 100644 index 00000000..23424050 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/channels/set-channel-volume.md @@ -0,0 +1,20 @@ +--- +title: Set Channel Volume +description: Set the output volume of an audio channel +version: 1.1.0 +parameters: + - name: Channel + type: Select + required: true + description: Audio channel you want to affect + - name: Mix + type: Select + required: true + description: Audio input mix you want to affect + - name: Volume + type: Number + required: true + description: Volume of the audio input mix + default: 100 +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/get-input-device-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/get-input-device-information.md new file mode 100644 index 00000000..a308145a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/get-input-device-information.md @@ -0,0 +1,64 @@ +--- +title: Get Input Device Information +description: Retrieve information about an audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to obtain the current information for +variables: + - name: waveLinkInputDeviceId + type: string + description: Identifier of the input device + value: "{0.0.1.00000000}.{96e65e84-0aaf-4b18-8f69-3da2d478b3d4}" + - name: waveLinkInputDeviceName + type: string + description: Name of the input device + value: Microphone (2- Realtek USB2.0 Audio) + - name: waveLinkInputDeviceType + type: string + description: Type of the input device + value: thirdParty + - name: waveLinkInputDeviceGain + type: number + description: Current gain level of the input device + value: 0.5541552 + - name: waveLinkInputDeviceMuted + type: bool + description: Indicates if the input device is muted + value: false + - name: waveLinkInputDeviceMicPcMix + type: number + description: Current microphone/PC mix level of the input device + value: 0 + - name: waveLinkInputDeviceClipGuard + type: bool + description: Indicates if the input device has clip guard enabled + value: false + - name: waveLinkInputDeviceLowCutFilter + type: bool + description: Indicates if the input device has low cut filter enabled + value: false + - name: waveLinkInputDeviceChannelCount + type: number + description: Number of channels of the input device + value: 0 + - name: waveLinkInputChannelId + type: string + description: Identifier of the input channel + value: + - name: waveLinkInputChannelName + type: string + description: Name of the input channel + value: + - name: waveLinkInputChannelVolume + type: number + description: Current volume level of the channel + value: 0 + - name: waveLinkInputChannelMuted + type: bool + description: Indicates if the input channel is muted + value: false +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/mute-input-device.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/mute-input-device.md new file mode 100644 index 00000000..27cee760 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/mute-input-device.md @@ -0,0 +1,18 @@ +--- +title: Mute Input Device +description: Mute a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Muted`, `Not Muted`, `Toggle` + default: Muted +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-clipguard-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-clipguard-state.md new file mode 100644 index 00000000..7e681c5a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-clipguard-state.md @@ -0,0 +1,18 @@ +--- +title: Set Input Clipguard State +description: Sets the clipguard state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain-lock-state.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain-lock-state.md new file mode 100644 index 00000000..35217c92 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain-lock-state.md @@ -0,0 +1,18 @@ +--- +title: Set Input Gain Lock State +description: Sets the gain lock state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain.md new file mode 100644 index 00000000..d6136d6e --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-gain.md @@ -0,0 +1,17 @@ +--- +title: Set Input Gain +description: Sets the gain of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: Gain + type: number + required: true + description: | + Gain + Range: `0` to `1` db + default: Enabled +--- \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-low-cut-filter.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-low-cut-filter.md new file mode 100644 index 00000000..24b26e7a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-input-low-cut-filter.md @@ -0,0 +1,18 @@ +--- +title: Set Input Low Cut Filter +description: Sets the low cut filter state of a specific audio input device +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: State + type: Select + required: true + description: | + State + Options: `Enabled`, `Disabled`, `Toggle` + default: Enabled +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-mic-pc-balance.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-mic-pc-balance.md new file mode 100644 index 00000000..91dcfcf8 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/inputs/set-mic-pc-balance.md @@ -0,0 +1,17 @@ +--- +title: Set Mic/PC Balance +description: Sets the balance between the microphone and PC audio input +version: 1.1.0 +parameters: + - name: Input Device + type: Select + required: true + description: Audio input device you want to affect + - name: Mic/PC Mix + type: number + required: true + description: | + Mic/PC Mix + Range: `0` to `100` + default: 100 +--- \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/adjust-mix-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/adjust-mix-volume.md new file mode 100644 index 00000000..25fdf373 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/adjust-mix-volume.md @@ -0,0 +1,15 @@ +--- +title: Adjust Mix Volume +description: Adjust the volume of an audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to affect + - name: Volume Delta + type: Number + description: Will add/subtract from the current volume + default: +5 +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/get-mix-information.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/get-mix-information.md new file mode 100644 index 00000000..37a04380 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/get-mix-information.md @@ -0,0 +1,28 @@ +--- +title: Get Mix Information +description: Retrieve information about an audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to obtain the current information for +variables: + - name: waveLinkMixId + type: string + description: Identifier of the mix ID + value: PCM_IN_01_V_04_SD3 + - name: waveLinkMixName + type: string + description: Name of the mix + value: Chat Mix + - name: waveLinkMixVolume + type: number + description: Current volume level of the mix + value: 1 + - name: waveLinkMixMuted + type: bool + description: Indicates if the mix is muted + value: false +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/set-mix-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/set-mix-volume.md new file mode 100644 index 00000000..7c08451d --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/mixes/set-mix-volume.md @@ -0,0 +1,17 @@ +--- +title: Set Mix Volume +description: Sets the volume of a specific audio mix +version: 1.1.0 +parameters: + - name: Mix + type: Select + required: true + description: Audio mix you want to affect + - name: Volume + type: number + required: true + description: | + Gain + Range: `0` to `100` db + default: 100 +--- \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/add-output-to-device-mix.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/add-output-to-device-mix.md new file mode 100644 index 00000000..13cc53ce --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/add-output-to-device-mix.md @@ -0,0 +1,15 @@ +--- +title: Add Output Device to Mix +description: Adds an output device to a specific audio mix +version: 1.1.0 +parameters: + - name: Output Device + type: Select + required: true + description: Audio output device you want to add to the mix + - name: Mix + type: Select + required: true + description: Audio mix you want to add the output device to +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/get-selected-output-device.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/get-selected-output-device.md new file mode 100644 index 00000000..cb804284 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/get-selected-output-device.md @@ -0,0 +1,19 @@ +--- +title: Get Selected Output Device +description: Retrieve information about the currently selected audio output device +version: 1.1.0 +variables: + - name: waveLinkOutputDeviceId + type: string + description: Identifier of the output device + value: "{0.0.0.00000000}.{51228b0e-d9af-4c0f-a03c-934a19a8cb23}" + - name: waveLinkOutputDeviceName + type: string + description: Name of the output device + value: SPDIF Interface (2- Realtek USB2.0 Audio) + - name: waveLinkOutputId + type: string + description: Identifier of the output device + value: "{0.0.0.00000000}.{51228b0e-d9af-4c0f-a03c-934a19a8cb23}" +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-monitored-mix.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-monitored-mix.md new file mode 100644 index 00000000..7d3f89b6 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-monitored-mix.md @@ -0,0 +1,11 @@ +--- +title: Set Monitored Mix +description: Sets the mix to monitor +version: 1.1.0 +parameters: + - name: Monitored Mix + type: Select + required: true + description: Audio mix you want to affect +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-output-volume.md b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-output-volume.md new file mode 100644 index 00000000..19c220f9 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/elgato/wave-link-3/outputs/set-output-volume.md @@ -0,0 +1,18 @@ +--- +title: Set Output Volume +description: Sets the volume of a specific audio output +version: 1.1.0 +parameters: + - name: Output Device + type: Select + required: true + description: Audio output device you want to affect + - name: Volume + type: number + required: true + description: | + Gain + Range: `0` to `100` + default: 100 +--- +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/.navigation.yml b/streamerbot/3.api/1.sub-actions/integrations/streamfog/.navigation.yml new file mode 100644 index 00000000..7e339ccf --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/.navigation.yml @@ -0,0 +1,8 @@ +title: Streamfog +icon: IconStreamfog +version: 1.0.7 +aside.level: 4 +category.title: Streamfog Sub-Actions +category.icon: IconStreamfog +navigation.title: Streamfog +navigation.description: Control Streamfog with Streamer.bot \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background-by-name.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background-by-name.md new file mode 100644 index 00000000..6add7824 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background-by-name.md @@ -0,0 +1,7 @@ +--- +title: Play Video Background by Name +description: Play Video Background by Name +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background.md new file mode 100644 index 00000000..b1f1ca4a --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/backgrounds/play-video-background.md @@ -0,0 +1,7 @@ +--- +title: Play Video Background +description: Play Video Background +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens-by-name.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens-by-name.md new file mode 100644 index 00000000..44963461 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens-by-name.md @@ -0,0 +1,7 @@ +--- +title: Activate Lens by Name +description: Activates the Selected Lens by name in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens.md new file mode 100644 index 00000000..e4f60b92 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/activate-lens.md @@ -0,0 +1,7 @@ +--- +title: Activate Lens +description: Activates the Selected Lens in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/deactivate-lens.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/deactivate-lens.md new file mode 100644 index 00000000..3a74695e --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/lenses/deactivate-lens.md @@ -0,0 +1,7 @@ +--- +title: Deactivate Lens +description: Deactivate the current lens in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit-by-name.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit-by-name.md new file mode 100644 index 00000000..6d774f94 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit-by-name.md @@ -0,0 +1,7 @@ +--- +title: Activate Outfit by Name +description: Activates the Selected Outfit by name in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit.md new file mode 100644 index 00000000..75579062 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/activate-outfit.md @@ -0,0 +1,7 @@ +--- +title: Activate Outfit +description: Activates the Selected Outfit in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/deactivate-outfit.md b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/deactivate-outfit.md new file mode 100644 index 00000000..078d9de3 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/integrations/streamfog/outfits/deactivate-outfit.md @@ -0,0 +1,7 @@ +--- +title: Deactivate Outfit +description: Deactivates the Selected Outfit in Streamfog +version: 1.0.7 +--- + +:wip \ No newline at end of file diff --git a/streamerbot/3.api/1.sub-actions/integrations/vtube-studio/assets/borkbork.txt b/streamerbot/3.api/1.sub-actions/integrations/vtube-studio/assets/borkbork.txt deleted file mode 100644 index 8b137891..00000000 --- a/streamerbot/3.api/1.sub-actions/integrations/vtube-studio/assets/borkbork.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/streamerbot/3.api/1.sub-actions/streamfog/.navigation.yml b/streamerbot/3.api/1.sub-actions/streamfog/.navigation.yml new file mode 100644 index 00000000..258c9350 --- /dev/null +++ b/streamerbot/3.api/1.sub-actions/streamfog/.navigation.yml @@ -0,0 +1,7 @@ +title: StreamFog +icon: IconStreamFog +aside.level: 3 +category.title: StreamFog Sub-Actions +category.icon: IconStreamFog +navigation.title: StreamFog +navigation.description: Integrate with StreamFog \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/integrations/throne/.navigation.yml b/streamerbot/3.api/2.triggers/integrations/throne/.navigation.yml new file mode 100644 index 00000000..a4fb2771 --- /dev/null +++ b/streamerbot/3.api/2.triggers/integrations/throne/.navigation.yml @@ -0,0 +1,7 @@ +title: Throne +icon: IconThrone +aside.level: 4 +category.title: Throne Triggers +category.icon: IconThrone +navigation.title: Throne +navigation.description: Donation events from Throne \ No newline at end of file diff --git a/streamerbot/3.api/2.triggers/twitch/chat/modiversary.md b/streamerbot/3.api/2.triggers/twitch/chat/modiversary.md new file mode 100644 index 00000000..05a2938b --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/chat/modiversary.md @@ -0,0 +1,13 @@ +--- +title: Modiversary +description: Trigger for a Twitch Modiversary +version: 1.0.7 +parameters: + - name: Range + import: common/range +variables: [] +commonVariables: + - TwitchBroadcaster + - TwitchChat + - TwitchUser +--- diff --git a/streamerbot/3.api/2.triggers/twitch/shared-chat/modiversary.md b/streamerbot/3.api/2.triggers/twitch/shared-chat/modiversary.md new file mode 100644 index 00000000..364a5d02 --- /dev/null +++ b/streamerbot/3.api/2.triggers/twitch/shared-chat/modiversary.md @@ -0,0 +1,14 @@ +--- +title: Shared Modiversary +description: Trigger for a Shared Twitch Modiversary +version: 1.0.7 +parameters: + - name: Range + import: common/range +variables: [] +commonVariables: + - TwitchBroadcaster + - TwitchChat + - TwitchUser + - TwitchSharedChatSource +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/core/parse.md b/streamerbot/3.api/3.csharp/3.methods/core/parse.md new file mode 100644 index 00000000..5b0bdc65 --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/core/parse.md @@ -0,0 +1,35 @@ +--- +name: Parse +title: Parse +description: Parse a string and replace variables using the provided arguments. +version: 1.0.7 +example: | + using System; + using System.Collections.Generic; + + public class CPHInline + { + public bool Execute() + { + //create a dictionary of arguments to be used for parsing + var args = new Dictionary + { + ["userName"] = "MustachedManiac", + ["userId"] = 123456789, + ["isModerator"] = true, + ["points"] = 1500 + }; + + //parse the string and replace the variables with the provided arguments + string result = CPH.Parse( + "User: %userName% | ID: %userId% | Moderator: %isModerator% | Points: %points%", + args + ); + + //log the result to see the parsed string with replaced variables + CPH.LogInfo(result); + + return true; + } + } +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/kick/kick-delete-chat-message.md b/streamerbot/3.api/3.csharp/3.methods/kick/kick-delete-chat-message.md new file mode 100644 index 00000000..584594e9 --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/kick/kick-delete-chat-message.md @@ -0,0 +1,21 @@ +--- +name: KickDeleteChatMessage +title: KickDeleteChatMessage +description: Deletes the selected chat message (by message ID) from the Kick stream +version: 1.0.7 +example: | + using System; + public class CPHInline + { + public bool Execute() + { + // get the current messaged ID from the Kick chat message + CPH.TryGetArg("messageId", out string messageId); + + // delete the associated Kick chat message + CPH.KickDeleteChatMessage(messageId); + + return true; + } + } +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-active-monitoring-suspicious-status.md b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-active-monitoring-suspicious-status.md new file mode 100644 index 00000000..d4ce8a3f --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-active-monitoring-suspicious-status.md @@ -0,0 +1,6 @@ +--- +name: TwitchAddActiveMonitoringSuspiciousStatus +title: TwitchAddActiveMonitoringSuspiciousStatus +description: Adds selected user to the Twitch active monitoring suspicious status list +version: 1.0.7 +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-restricted-suspicious-status.md b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-restricted-suspicious-status.md new file mode 100644 index 00000000..9881720c --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-add-restricted-suspicious-status.md @@ -0,0 +1,6 @@ +--- +name: TwitchAddRestrictedSuspiciousStatus +title: TwitchAddRestrictedSuspiciousStatus +description: Adds selected user to the Twitch restricted suspicious status list +version: 1.0.7 +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-remove-suspicious-status.md b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-remove-suspicious-status.md new file mode 100644 index 00000000..6fe3544d --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/twitch/moderation/twitch-remove-suspicious-status.md @@ -0,0 +1,6 @@ +--- +name: TwitchRemoveSuspiciousStatus +title: TwitchRemoveSuspiciousStatus +description: Removes selected user from the Twitch suspicious status list +version: 1.0.7 +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-mods.md b/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-mods.md new file mode 100644 index 00000000..659c0b52 --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-mods.md @@ -0,0 +1,26 @@ +--- +name: TwitchGetMods +title: TwitchGetMods +description: Get a list of all users currently assigned as moderators in the broadcaster's Twitch channel. +version: 1.0.7 +example: | + using System; + using System.Collections.Generic; + + public class CPHInline + { + public bool Execute() + { + //get the list of Mods for the channel + List mods = CPH.TwitchGetMods(); + + //iterate through the list and log the username and user id of each Moderator + foreach (TwitchUserInfo mod in mods) + { + CPH.LogInfo($"Moderator: {mod.UserName} ({mod.UserId})"); + } + + return true; + } + } +--- diff --git a/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-vips.md b/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-vips.md new file mode 100644 index 00000000..83afea68 --- /dev/null +++ b/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-vips.md @@ -0,0 +1,26 @@ +--- +name: TwitchGetVips +title: TwitchGetVips +description: Get a list of all users currently assigned as VIPs in the broadcaster's Twitch channel. +version: 1.0.7 +example: | + using System; + using System.Collections.Generic; + + public class CPHInline + { + public bool Execute() + { + //get the list of VIPS for the channel + List vips = CPH.TwitchGetVips(); + + //iterate through the list and log the username and user id of each VIP + foreach (TwitchUserInfo vip in vips) + { + CPH.LogInfo($"VIP: {vip.UserName} ({vip.UserId})"); + } + + return true; + } + } +---