Run
![](https://www.touch-portal.com/docs/images/icon-run.png)
Start / Run Application
![](https://www.touch-portal.com/docs/images/action-start-run-application.png)
This action allows you to start or run an application on your desktop computer
Special Case: Launching Steam Games
Launching Steam games is not possible directly using this Action. To launch a Steam game you need to use the steam id and use the Open URL action instead from the Navigation category like this:
![](https://www.touch-portal.com/blog/images/example_start_steam_game.png)
Special Case: Launching Epic Games
Launching Epic games is not possible in the normal way just like Steam games. To launch an Epic game you need to do similar steps as with the steam option. First you need to open the properties of the normal shortcut on your desktop to that game. It will hold an url that you need to copy and use on an Open URL action instead from the Navigation category.
Special Case: Windows Apps
Windows apps are a special type of application. They are different from normal executables. Touch Portal has no trouble opening such applications but finding them can be difficult. Here is how you run windows Apps with Touch Portal:
- Open a file explorer
- Enter this value: shell:AppsFolder
- This will open the applications folder.
- Pick the application you want to start
- Right mouse click and choose "Create Shortcut"
- Now use this shortcut in the Run shortcut action
What to do when the application is not launched?
Some applications will not start up using this action. To be able to start such an application, create a shortcut to the application and use the Run-a-shortcut-action instead and point it to your created shortcut.
![](https://www.touch-portal.com/docs/images/icon-run.png)
Open File
![](https://www.touch-portal.com/docs/images/action-open-file.png)
This action allows you to start any file. This will ask the OS to open or start the file.
![](https://www.touch-portal.com/docs/images/icon-run.png)
Open Folder
![](https://www.touch-portal.com/docs/images/action-open-folder.png)
This action allows you to open a folder in your OS explorer.
![](https://www.touch-portal.com/docs/images/icon-run.png)
Run Batch Script
![](https://www.touch-portal.com/docs/images/action-run-batch-file.png)
This action allows you to execute Batch scripts.
![](https://www.touch-portal.com/docs/images/icon-run.png)
Run Powershell Script
![](https://www.touch-portal.com/docs/images/action-run-powershell-file.png)
This action allows you to run a PowerShell script file
Open Windows Restrictions
Touch Portal requires that the execution policies of Powershell are unrestricted. By default Windows sets it on restricted so we need to change that. Do the following:
- Open a Command Prompt in Windows (cmd.exe)
- Type "Powershell" and press enter.
- Powershell is now started. When in Powershell run the following two commands
- Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass -Force;
- Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;
- These two options allow you to run any script (unrestricted) and will not prompt a message with the question whether it is safe to run your selected script (bypass)
![](https://www.touch-portal.com/docs/images/icon-run.png)
Run Apple Script
This action allows you to execute an Apple script
![](https://www.touch-portal.com/docs/images/icon-run.png)
Run Windows Apps
![](https://www.touch-portal.com/docs/images/action-run-apps-and-games.png)
This action allows you to run a Windows (UWP) Apps, steam games, epic games, gog games and other apps
![](https://www.touch-portal.com/docs/images/icon-run.png)
Execute Script
This action allows you to execute a script.
Nav
![](https://www.touch-portal.com/docs/images/icon-nav.png)
Go To Page
![](https://www.touch-portal.com/docs/images/action-nav-goto-page.png)
This action allows you to navigate to the selected Page.
![](https://www.touch-portal.com/docs/images/icon-nav.png)
Go To Page On Device
- Multiple Devices Upgrade RequiredThis action allows you to navigate to the selected Page on a specific device.
![](https://www.touch-portal.com/docs/images/icon-nav.png)
Open Url
![](https://www.touch-portal.com/docs/images/action-nav-open-url.png)
This action allows you to open an URL in your standard browser.
![](https://www.touch-portal.com/docs/images/icon-nav.png)
When A Page Is Changed
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/event-nav-when-page-changes.png)
This event is triggered when a Page is changed on your device.
Input Keyboard
![](https://www.touch-portal.com/docs/images/icon-input_keyboard.png)
Low Level Key Press
![](https://www.touch-portal.com/docs/images/action-input-keyboard-low-level-key-presses.png)
This action allows you to do low level key presses. While still software driven key presses they are triggered on a lower level in the OS than the virtual key presses. Low Level Key presses can be used with keyboards from different countries to do language specific key presses as well.
![](https://www.touch-portal.com/docs/images/icon-input_keyboard.png)
Virtual Key Press
![](https://www.touch-portal.com/docs/images/action-input-keyboard-virtual-key-presses.png)
This action allows you to do virtual key presses. Virtual key presses are software simulated key presses requested to the OS.
![](https://www.touch-portal.com/docs/images/icon-input_keyboard.png)
Hold Key Press
![](https://www.touch-portal.com/docs/images/action-input-keyboard-low-level-hold.png)
This action allows you to keep pressing a key or a combination of keys while execution other actions during that pressing down.
![](https://www.touch-portal.com/docs/images/icon-input_keyboard.png)
Write Text
![](https://www.touch-portal.com/docs/images/action-input-keyboard-write-text.png)
This action allows you to write text.
Input Mouse
![](https://www.touch-portal.com/docs/images/icon-input_mouse.png)
Mouse Click
![](https://www.touch-portal.com/docs/images/action-input-mouse-click.png)
This action allows you to click with the mouse on a specific location
![](https://www.touch-portal.com/docs/images/icon-input_mouse.png)
Move Mouse
![](https://www.touch-portal.com/docs/images/action-input-mouse-move.png)
This action allows you to move the mouse to a specific location on your screen(s)
![](https://www.touch-portal.com/docs/images/icon-input_mouse.png)
Drag Mouse
![](https://www.touch-portal.com/docs/images/action-input-mouse-drag.png)
This action allows you to drag the mouse from and to specific locations on your screen(s)
Utility Touch Portal Functions
![](https://www.touch-portal.com/images/black_logo256.png)
Restart Touch Portal
![](https://www.touch-portal.com/blog/images/v32-utility-restart-tp-01.png)
With this action you can restart Touch Portal.
![](https://www.touch-portal.com/images/black_logo256.png)
Switch Event On / Off
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-utility-switch-events-on-off.png)
This action allows you to turn global Event on and off.
![](https://www.touch-portal.com/images/black_logo256.png)
On Touch Portal Initialized
- Pro Upgrade Required![](https://www.touch-portal.com/blog/images/v32-utility-on-application-load-event.png)
This event is triggered when Touch Portal is initialized.
![](https://www.touch-portal.com/images/black_logo256.png)
Toggle Plugin Action
This action allows you to start or stop plugins using actions
Utility Clipboard
![](https://www.touch-portal.com/docs/images/icon-clipboard.png)
Clipboard Content To Value
![](https://www.touch-portal.com/blog/images/v32-utility-clipboard-to-value.png)
With this action you store the current contents of the systems clipboard to a Value.
![](https://www.touch-portal.com/docs/images/icon-clipboard.png)
Copy File To Clipboard
![](https://www.touch-portal.com/docs/images/action-utility-file_to_clipboard.png)
With this action you store the specified file in the clipboard
![](https://www.touch-portal.com/docs/images/icon-clipboard.png)
Copy Image To Clipboard
![](https://www.touch-portal.com/docs/images/action-utility-image_to_clipboard.png)
With this action you store the specified image in the clipboard
![](https://www.touch-portal.com/docs/images/icon-clipboard.png)
Set Clipboard Content
![](https://www.touch-portal.com/blog/images/v32-utility-set-clipboard-content-01.png)
With this action you can copy text to the clipboard.
Utility System And Applications
![](https://www.touch-portal.com/docs/images/icon-systemapp.png)
Activate Application (foreground)
![](https://www.touch-portal.com/docs/images/action-utility-activate-application.png)
This action allows you to bring an application on your computer to the foreground (activate)
![](https://www.touch-portal.com/docs/images/icon-systemapp.png)
Close Application
![](https://www.touch-portal.com/docs/images/action-utility-close-application.png)
This action allows you to close an application on your computer.
Logic
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Wait For (timer)
![](https://www.touch-portal.com/docs/images/action-logic-timer.png)
This action allows you to add a time to wait. This will pause the execution of the flow of actions until the timer has finished.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Logic If Statement Extended
![](https://www.touch-portal.com/docs/images/action-logic-advanced-if-statement.png)
This logic action allows you to run actions based on specific criteria.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Logic If Statement
![](https://www.touch-portal.com/docs/images/action-logic-if-statement.png)
This logic action allows you to run actions based on specific criteria.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Logic Else
This action can be used together with logic IF actions to create the flow of actions to do when the IF does not meet the criteria.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
If File Statement
![](https://www.touch-portal.com/docs/images/action-logic-if-file.png)
This action allows you to add logic based on the specified file. This allows you to check if a given file exists, has content that equals or if it contains a given text. If it meets the criteria this If File statement will continue with executing actions within the scope of this If Statement. If not it will continue with the actions after the scope of this IF File Statement. If the file cannot be accessed it will not meet the criteria and will act accordingly.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Logic Repeat X Times
![](https://www.touch-portal.com/docs/images/action-logic-repeat.png)
This logic action allows you to create a repeating loop that will execute the flow of actions within its context x amount of times
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Execute Flow
![](https://www.touch-portal.com/docs/images/action-logic-execute-flow.png)
This action allows you to execute a predefined Flow.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Stop Executing Actions In Current Flow
This action allows you to stop the current flow of actions to be stopped. All actions after this will be dropped and not executed. Every collection of actions (On Press, On Event etc.) within Touch Portal is seen as a flow. The Flow object is also a flow of actions.
![](https://www.touch-portal.com/docs/images/icon-logic.png)
Dynamic Text Updater
![](https://www.touch-portal.com/docs/images/event-logic-dynamic-text-updater.png)
This event will update the button text each 500ms with the given text. If using Dynamic Text Variables, they will be evaluated each iteration and should always show the up to date value.
Value
![](https://www.touch-portal.com/images/black_logo256.png)
Set Value To / Change Value To
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-set-value.png)
This action allows you to change what the Value.
![](https://www.touch-portal.com/images/black_logo256.png)
Get Url Content And Store In Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-store-url-content-in-value.png)
This action allows you to retrieve the contents from an URL and store it into the specified Value
![](https://www.touch-portal.com/images/black_logo256.png)
When Value Changes
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/event-states-when-value-changes.png)
This event allows you to trigger on when a Value changes.
![](https://www.touch-portal.com/images/black_logo256.png)
When Plugin Value Changes
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/event-states-when-plugin-state-changes.png)
This event allows you to trigger on when a Plugin State changes.
Button State
![](https://www.touch-portal.com/images/black_logo256.png)
Set Button State
![](https://www.touch-portal.com/docs/images/action-states-set-button-state.png)
This action allows you to set the button state to either On or Off
![](https://www.touch-portal.com/images/black_logo256.png)
Set Other Button State
![](https://www.touch-portal.com/docs/images/action-states-set-other-button-state.png)
This action allows you to set the state of a button with the given id to On or Off.
![](https://www.touch-portal.com/images/black_logo256.png)
Toggle Button State
This action allows you to toggle the button state to either on or off. This action will switch from the current state.
![](https://www.touch-portal.com/images/black_logo256.png)
When Button State Changes
![](https://www.touch-portal.com/docs/images/event-states-when-button-state-changes.png)
This event allows you to act on the event that is triggered when the state of the button changes.
Value Text Manipulation
![](https://www.touch-portal.com/images/black_logo256.png)
Set Value Capitalization
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-capitalization.png)
This action allows you to capitalize the text Value.
![](https://www.touch-portal.com/images/black_logo256.png)
Replace (regex) In Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-replace.png)
This action allows you to replace a given part of the Value Object with another value.
![](https://www.touch-portal.com/images/black_logo256.png)
Get Subtext
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-subtext.png)
This action allows you to get part of a text Value
![](https://www.touch-portal.com/images/black_logo256.png)
Get Length Of Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-get-length.png)
This action allows you to get the length of a given text and store it into a Value.
![](https://www.touch-portal.com/images/black_logo256.png)
Trim Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-trim.png)
This action allows you to trim the text Value
![](https://www.touch-portal.com/images/black_logo256.png)
Split Value And Get N-th
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-split-and-get-nth.png)
This action allows you to split a text with a delimiter and get the nth item from the split text.
![](https://www.touch-portal.com/images/black_logo256.png)
Get Index Of
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-text-get-index-of.png)
This action allows you to get the index of a given character or text from a text
![](https://www.touch-portal.com/images/black_logo256.png)
Get Occurrence Count
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/values-get-occurences-count.png)
This action allows you to count occurences of text in a text and store it into a Value
Value Number Manipulation
![](https://www.touch-portal.com/images/black_logo256.png)
Advanced Value Calculations
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-number-advanced-calculation.png)
This action allows you to do advanced calculations with numbers.
Available Calculation methods
The list below shows all calculation operators and functions available:
- Plus operator - The usual + operator is used. For example 6 + 9
- Subtraction operator - The usual - operator is used. For example 9 - 6
- Multiplication operator - The usual * operator is used. For example 9 * 6
- Division operator - The usual / operator is used. For example 9 / 3
- Modulus operator - The % operator is used. An alternative is the mod operator. For example 5 mod 2 gives 1 and is equivalent to 5 % 2
- Random - Use tp.random() to generate a random number.
- Power - Use tp.pow(10,2) to calculate 10 raised to the power of 2 which is 100
- Absolute - Use tp.abs(-15) to get the absolute value, in this example 15.
- Square Root - Use tp.sqrt(16) to get the square root of a number, in this example 4.
- Exp - Use tp.exp(4). e raised to the power of a number. e is the base of the natural system of logarithms (approximately 2.718282).
- Log - Use tp.log(5) to get the natural logarithm of 5 in this example.
- Log10 - Use tp.log10(5) to get the base 10 logarithm of a 5 in this example.
- Sine Function - Use tp.sin(5) to get the sine of 5 in this example.
- Cosine Function - Use tp.cos(5) to get the cosine of 5 in this example.
- Tangent Function - Use tp.tan(5) to get the tangent of 5 in this example.
- Inverse Sine Function - Use tp.asin(5) to get the inverse sine of 5 in this example.
- Inverse Cosine Function - Use tp.acos(5) to get the inverse cosine of 5 in this example.
- Inverse Tangent Function - Use tp.atan(5) to get the inverse tangent of 5 in this example.
- Hyperbolic Sine Function - Use tp.sinh(5) to get the hyperbolic sine of 5 in this example.
- Hyperbolic Cosine Function - Use tp.cosh(5) to get the hyperbolic cosine of 5 in this example.
- Hyperbolic Tangent Function - Use tp.tanh(5) to get the hyperbolic tangent of 5 in this example.
![](https://www.touch-portal.com/images/black_logo256.png)
Increment Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-number-increment.png)
This action allows you to increment a Value with a given number.
![](https://www.touch-portal.com/images/black_logo256.png)
Randomize Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-number-random.png)
This action allows you to generate a random (whole) number and store it in a Value
![](https://www.touch-portal.com/images/black_logo256.png)
Round Value Number
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-number-round.png)
This action allows you to round the number stored in a Value.
![](https://www.touch-portal.com/images/black_logo256.png)
Value Calculations
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-states-number-calculate.png)
This action allows you to do standard calculations with numbers.
File Input Output
![](https://www.touch-portal.com/docs/images/icon-file.png)
Create File
![](https://www.touch-portal.com/docs/images/action-fileio-create-file.png)
This action allows you to create a file. If the specified file already exists on disc then this action will fail silently.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Write To File
![](https://www.touch-portal.com/docs/images/action-fileio-write-file.png)
This action allows you to write content to a file. The file is cleared of contents before writing.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Append To File
![](https://www.touch-portal.com/docs/images/action-fileio-append-file.png)
This action allows you to append text to the given file
![](https://www.touch-portal.com/docs/images/icon-file.png)
Delete File
![](https://www.touch-portal.com/docs/images/action-fileio-delete-file.png)
This action allows you to delete a file. If the file does not exist this action will fail silently.
![](https://www.touch-portal.com/docs/images/icon-file.png)
File To Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-fileio-file-contents-to-value.png)
This action allows you to store the contents of a file into a Value. If the file does not exist nothing will happen. If the file cannot be read, nothing will happen.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Get Line Count From File
![](https://www.touch-portal.com/docs/images/action-fileio-line-count-to-value.png)
This action allows you to the line count from a text file. If the file does not exist nothing will happen. If for some reason the file cannot be read nothing will happen.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Get Line From File
![](https://www.touch-portal.com/docs/images/action-fileio-get-line-to-value.png)
This action allows you to get a specified line from a text File. If the file does not exist nothing happens. If the given line number is not a number nothing happens. If the file has less lines than the line number given, the last line is used.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Remove Lines From File
![](https://www.touch-portal.com/blog/images/v32-utility-remove-lines-from-file.png)
This action allows you to remove lines from a text file.
![](https://www.touch-portal.com/docs/images/icon-file.png)
Url Result To File
![](https://www.touch-portal.com/docs/images/action-fileio-url-to-file.png)
This action allows you to get the result of a endpoint (url) and store it into a file
![](https://www.touch-portal.com/docs/images/icon-file.png)
When A File Changes
![](https://www.touch-portal.com/docs/images/event-fileio-when-file-changes.png)
This events can be set up to listen when the contents of a file changed.
Http
![](https://www.touch-portal.com/docs/images/icon-http.png)
Http Get
This action allows you to do a GET call to a given endpoint.
![](https://www.touch-portal.com/docs/images/icon-http.png)
Http Post
This action allows you to do a POST call to a given endpoint.
![](https://www.touch-portal.com/docs/images/icon-http.png)
Http Put
This action allows you to do a PUT call to a given endpoint.
![](https://www.touch-portal.com/docs/images/icon-http.png)
Http Patch
This action allows you to do a PATCH call to a given endpoint.
![](https://www.touch-portal.com/docs/images/icon-http.png)
Http Delete
This action allows you to do a DELETE call to a given endpoint.
Visuals
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Change Button Visuals
![](https://www.touch-portal.com/docs/images/action-visuals-change-button.png)
This action allows you to change the visuals of a button
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Restore Buttons Original Visuals
This action allows you to restore parts of the original button visuals setup.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Change Visuals By Plug-in State
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-visuals-change-plugin-state.png)
This action allows you to change the background color, the text color or the icon from a plugin state.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Comment
![](https://www.touch-portal.com/docs/images/action-comment.png)
This action allows you to add comments in your flow of actions. This comment action does not execute anything.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Url To Button Icon
![](https://www.touch-portal.com/blog/images/v32-visuals-url-to-icon-action.png)
With this action you can load an url image and set that image as the icon.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Change Page Background Image
![](https://www.touch-portal.com/docs/images/action-visuals-page-background-image.png)
This action allows you to change the image of the Page.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Change Graphics Upgrade Settings
- Graphics Upgrades RequiredThis action allows you to change the Graphics Upgrade settings for the button
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Change Page Graphics Upgrade Setting
- Graphics Upgrades RequiredThis action allows you to change the graphics upgrade settings for a Page.
![](https://www.touch-portal.com/docs/images/icon-visuals.png)
Keep Button Icon The Same As External File
![](https://www.touch-portal.com/blog/images/v32-visuals-keep-icon-same-as-image.png)
This event will keep track of the image file pointed to. Whenever the file is changed, it will update the icon of the button.
Media
![](https://www.touch-portal.com/docs/images/icon-media.png)
Play Audio File Advanced
![](https://www.touch-portal.com/docs/images/action-media-play-audio-advanced.png)
This action allows you to play an audio files (wav and mp3) over a chosen audio output. The fade in components are available from version 4.2 of Touch Portal.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Play Audio File
![](https://www.touch-portal.com/docs/images/action-media-play-audio-normal.png)
This action allows you to play an audio file (wav and mp3) over the general audio output.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Stop All Playing Audio
This action will stop all audio played by Touch Portal.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Stop Audio With Id
![](https://www.touch-portal.com/docs/images/action-media-stop-audio-by-id.png)
This action allows you to stop specific audio which was started by the advance audio play action and was started with a given id
![](https://www.touch-portal.com/docs/images/icon-media.png)
Media Toggle Play / Pause
This action allows you to play, resume or pause a track on the current audio application active on the OS.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Audio With Id
![](https://www.touch-portal.com/docs/images/action-media-set-audio-sound-volume.png)
This action allows you to set the volume of an audio file played by Touch Portal with the given ID.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Stop And Fade Audio With Id
![](https://www.touch-portal.com/docs/images/action-media-stop-and-fade.png)
This action allows you to stop and fade out a specific audio which was started by the advance audio play action and was started with a given id
![](https://www.touch-portal.com/docs/images/icon-media.png)
Media Stop
This action allows you to stop a track on the current audio application active on the OS.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Media Next Track
This action allows you to go to the next track on the current audio application active on the OS.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Media Previous Track
This action allows you to go to the previous track on the current audio application active on the OS.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Volume Up
This action allows you to get the volume 1 percent up on the current active media application on your OS, when no application is listening then this will change the volume of the OS itself.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Volume Down
This action allows you to get the volume 1 percent down on the current active media application on your OS, when no application is listening then this will change the volume of the OS itself.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Volume Mute
This action allows you to mute the volume on the current active media application on your OS, when no application is listening then this will change the volume of the OS itself.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of The Default Windows Audio Source
This action allows you to set the volume of the default windows audio source (both input as output)
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of The Default Windows Audio Source
This action allows you to set the volume of the default windows audio source (both input as output)
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Windows Audio Source
This action allows you to set the volume of a given windows audio source (both input as output)
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Windows Audio Source
This action allows you to set the volume of a given windows audio source (both input as output)
![](https://www.touch-portal.com/docs/images/icon-media.png)
Increase / Decrease Volume Windows Audio Source
This action allows you to increase or decrease the specific Windows audio source.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Toggle Mute State Of Windows Audio Source
This action allows you to toggle, set or unset the mute state of a given windows audio source.
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Current Output On Macos
This action allows you to set the volume of the current selected speaker (output) on MacOS
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Current Output On Macos
This action allows you to set the volume of the current selected speaker (output) on MacOS
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Current Microphone On Macos
This action allows you to set the volume of the current selected microphone (input) on MacOS
![](https://www.touch-portal.com/docs/images/icon-media.png)
Set Volume Of Current Microphone On Macos
This action allows you to set the volume of the current selected microphone (input) on MacOS
![](https://www.touch-portal.com/docs/images/icon-media.png)
When Volume Specific Audio Device Changes
![](https://www.touch-portal.com/docs/images/event-media-when-audio-device-volume-changes.png)
This event allows you to act on volume changes of specific audio devices
![](https://www.touch-portal.com/docs/images/icon-media.png)
When Windows Default Audio Device Mute State Changes
This event will listen to the mute state of the current Windows audio source
![](https://www.touch-portal.com/docs/images/icon-media.png)
When Windows Audio Source Mute State Changes
This event will listen to the mute state of the given Windows audio source
Obs
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Streaming State
![](https://www.touch-portal.com/docs/images/action-obs-set-streaming-state.png)
This action allows you to set the state of streaming, in other words start and stop a stream.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Recording State
![](https://www.touch-portal.com/docs/images/action-obs-set-recording-state.png)
This action allows you to set the state of recording within OBS.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Profile
![](https://www.touch-portal.com/docs/images/action-obs-set-profile.png)
This action allows you to change the current OBS Profile
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Scene Collection
![](https://www.touch-portal.com/docs/images/action-obs-set-scene-collection.png)
This action allows you to activate a scene collection.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Preview Scene
![](https://www.touch-portal.com/docs/images/action-obs-set-preview.png)
This action allows you to set the Preview scene
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Scene Filter
![](https://www.touch-portal.com/docs/images/action-obs-scene-filter.png)
This action allows you to turn on or off a filter on a scene.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Visibility
![](https://www.touch-portal.com/docs/images/action-obs-set-source-visibility.png)
This action allows you to change the visibility of a source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Filter Visibility
![](https://www.touch-portal.com/docs/images/action-obs-set-source-filter-visibility.png)
This action allows you to turn a source filter on or off
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Image
![](https://www.touch-portal.com/docs/images/action-obs-set-source-image.png)
This action allows you to set the image of an image source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Text
![](https://www.touch-portal.com/blog/images/v32-obs-set-source-text-action-01.png)
With this action you can set a text of a text source directly. This can only be applied to a Text Source.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Video
![](https://www.touch-portal.com/docs/images/action-obs-set-source-video.png)
This action allows you to set a video on a video source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Browser Url
![](https://www.touch-portal.com/docs/images/action-obs-set-source-url.png)
This action allows you to set the url of a browser url.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Refresh Browser Source
![](https://www.touch-portal.com/docs/images/action-obs-refresh-browser-source.png)
This action allows you to refresh a browser source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Volume
![](https://www.touch-portal.com/docs/images/action-obs-set-source-volume.png)
This action allows you to set the volume of a scene specific source.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Source Mute State
![](https://www.touch-portal.com/docs/images/action-obs-source-mute.png)
This action allows you to mute or unmute an audio source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Volume Source
![](https://www.touch-portal.com/docs/images/action-obs-set-source-volume-non-scene.png)
This action allows you to set the volume of a specific source.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Increase Source Volume
![](https://www.touch-portal.com/docs/images/action-obs-source-volume-increase.png)
This action allows you to increase the volume in respect to the current volume
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Decrease Source Volume
![](https://www.touch-portal.com/docs/images/action-obs-source-volume-decrease.png)
This action allows you to decrease the volume in respect to the current volume
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Media Source Play / Pause
![](https://www.touch-portal.com/docs/images/action-obs-media-source-playpause.png)
This action allows you to play and pause a media source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Media Source Restart
![](https://www.touch-portal.com/docs/images/action-obs-media-source-restart.png)
This action allows you to restart a media source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Media Source Stop
![](https://www.touch-portal.com/docs/images/action-obs-media-source-stop.png)
This action allows you to stop a media source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Media Source Next
![](https://www.touch-portal.com/docs/images/action-obs-media-source-next.png)
This action allows you to go to the next media source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Media Source Previous
![](https://www.touch-portal.com/docs/images/action-obs-media-source-prev.png)
This action allows you to go to the previous media source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Studio Mode State
![](https://www.touch-portal.com/docs/images/action-obs-set-studio-mode.png)
This action allows you to change the Studio Mode state
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Current Transition
![](https://www.touch-portal.com/docs/images/action-obs-set-current-transition.png)
This action allows you to set the current transition
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Current Transition Duration
![](https://www.touch-portal.com/docs/images/action-obs-set-transition-duration.png)
This action sets the current transition duration in milliseconds.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Obs Raw Request
![](https://www.touch-portal.com/docs/images/action-obs-raw-request.png)
This action allows you to make custom requests to the OBS Websocket v5+. This allows you to do additional requests that are not (yet) implemented directly in Touch Portal.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Screenshot To File
![](https://www.touch-portal.com/docs/images/action-obs-take-screenshot.png)
This action allows you to take a screenshot of a scene or source
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Set Replay Buffer State
![](https://www.touch-portal.com/docs/images/action-obs-replay-buffer.png)
This action allows you to start, stop, toggle or save the replay buffer
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Toggle Virtual Cam
![](https://www.touch-portal.com/docs/images/action-obs-toggle-virtual-cam.png)
This action allows you to toggle the Virtual Cam
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Recording State
![](https://www.touch-portal.com/docs/images/event-obs-when-recording-state-changes.png)
This event allows you to listen for changes in the recording state
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Streaming State
![](https://www.touch-portal.com/docs/images/event-obs-when-stream-state-changes.png)
This event allows you to listen for changes in the streaming state
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Scene Selected
![](https://www.touch-portal.com/docs/images/event-obs-when-scen-changes.png)
This event allows you to listen for when the active scene changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Previous Scene Selected
![](https://www.touch-portal.com/docs/images/event-obs-when-scene-changes.png)
This event allows you to listen for when the previous active scene changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Source Visibility Change
![](https://www.touch-portal.com/docs/images/event-obs-when-source-changes.png)
This event allows you to listen for source visibility changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Scene Filter Visibility Change
![](https://www.touch-portal.com/docs/images/event-obs-when-scene-filter-changes.png)
This event allows you to listen for scene filters visibility changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Source Mute State
![](https://www.touch-portal.com/docs/images/event-obs-when-source-mutes.png)
This event allows you to listen for audio source mute changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Source Filter Visibility Change
![](https://www.touch-portal.com/docs/images/event-obs-when-source-filter-visibility-changes.png)
This event allows you to listen for source filter changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Replay Buffer Status Change
![](https://www.touch-portal.com/docs/images/event-obs-when-replay-buffer-state.png)
This event allows you to listen for when the replay buffer state changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Virtual Cam State Change
![](https://www.touch-portal.com/docs/images/event-obs-when-virtual-cam-state-changes.png)
This event allows you to listen for when the virtual cam state changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
Scene Output To Icon Event
![](https://www.touch-portal.com/docs/images/event-obs-scene-to-icon.png)
This event allows you to show a scene visually on a button.
![](https://www.touch-portal.com/docs/images/icon_obs.png)
On Preview Scene Selected
![](https://www.touch-portal.com/docs/images/event-obs-when-preview-scene-changes.png)
This event allows you to listen for when the active preview scene changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
When Studio Mode Changes
![](https://www.touch-portal.com/docs/images/event-obs-when-studio-mode-changes.png)
This event allows you to listen for when the studio mode changes
![](https://www.touch-portal.com/docs/images/icon_obs.png)
When Custom Request Result Are Returned
![](https://www.touch-portal.com/docs/images/event-obs-raw-request-result.png)
This event allows you to listen to the result of a Custom Request by ID
![](https://www.touch-portal.com/docs/images/icon_obs.png)
When Profile Is Changed
![](https://www.touch-portal.com/docs/images/event-obs-when-profile-changed.png)
This event allows you to listen for profile changes in OBS.
Twitch
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Send Chat Message
![](https://www.touch-portal.com/docs/images/action-twitch-send-message.png)
This action allows you to send a message to your channel.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Send Chat Message To Channel
![](https://www.touch-portal.com/docs/images/action-twitch-send-message-to-channel.png)
This action allows you to send a message to a specific channel. You need to be a mod in that channel to be able to send messages in that channel.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Send Whisper
![](https://www.touch-portal.com/docs/images/action-twitch-send-whisper.png)
This action allows you to send a whisper to a user.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Announcement
![](https://www.touch-portal.com/docs/images/action-twitch-announcement.png)
This action allows you to do announcements in Twitch
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Shout Out
![](https://www.touch-portal.com/docs/images/action-twitch-shoutout.png)
This action allows you to do a shout out to a specific user
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Start Advertisement
![](https://www.touch-portal.com/docs/images/action-twitch-start-advertisement.png)
This action allows you to
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Start / Stop Raid
![](https://www.touch-portal.com/docs/images/action-twitch-start-stop-raid.png)
This action allows you to start or stop a raid
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Set Marker
![](https://www.touch-portal.com/docs/images/action-twitch-set-marker.png)
This action allows you to set a marker
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Channel Info To Value
![](https://www.touch-portal.com/docs/images/action-twitch-channel-info-to-value.png)
This action allows you to get channel information and store it in a Value
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Streamers Channel Info To Value
![](https://www.touch-portal.com/docs/images/action-twitch-get-streamer-channel-info.png)
This action allows you to get channel information from any channel and store it in a Value
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Set Stream Category
![](https://www.touch-portal.com/docs/images/action-twitch-set-stream-category.png)
This action allows you to set the stream category
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Set Stream Title
![](https://www.touch-portal.com/docs/images/action-twitch-set-stream-title.png)
This action allows you to set the stream title
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Shield Mode
![](https://www.touch-portal.com/docs/images/action-twitch-shieldmode.png)
This action allows you to disable or enable shieldmode
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Start / Cancel Timeout User
![](https://www.touch-portal.com/docs/images/action-twitch-set-timeout.png)
This action allows you to set a timeout for a user
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Streamer Profile Pic Url To Value
- Pro Upgrade Required![](https://www.touch-portal.com/docs/images/action-twitch-get-url-streamer-icon-to-value.png)
This action allows you to retrieve the url of the streamers icon or offline image.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Mod Status Of User
![](https://www.touch-portal.com/docs/images/action-twitch-mod-unmod-status.png)
This action allows you to mod or unmod a specific user
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Slow Chat
![](https://www.touch-portal.com/docs/images/action-twitch-slow-chat.png)
This action allows you to set the slow chat functionality
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Unique Chat
![](https://www.touch-portal.com/docs/images/action-twitch-switch-unique-chat.png)
This action allows you to set the unique chat functionality
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Vip Status Of User
![](https://www.touch-portal.com/docs/images/action-twitch-switch-vip-status.png)
This action allows you to set the VIP status of a user
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Emote Only Chat
![](https://www.touch-portal.com/docs/images/action-twitch-emote-only-chat.png)
This action allows you to set the emote only chat functionality
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Followers Only Chat
![](https://www.touch-portal.com/docs/images/action-twitch-followers-only-chat.png)
This action allows you to set the followers only chat functionality
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Switch Subscribers Only Chat
![](https://www.touch-portal.com/docs/images/action-twitch-subscribers-only-chat.png)
This action allows you to set the subscribers only chat functionality
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
Ban / Unban User
![](https://www.touch-portal.com/docs/images/action-twitch-ban-unban-user.png)
This action allows you to ban or unban a user
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On New Subscriber
![](https://www.touch-portal.com/docs/images/event-twitch-new-subscriber.png)
This event allows you to listen for new subscribers.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Subscription Type - This is the type of subscription, this can be Sub (1), ReSub (2), Gift (3), Anonymous Gift (4), ReGift (5) and Anonymous ReGift (6). In some cases this value will be the number representation of the type within Touch Portal.
- Subscription Gifter Display Name - This is the display name of the user that has gifted the subscription. For anonymouse gifts, this will be "Anonymous" and for non-gift subs and resub it will be the same as the recipient.
- Subscription Gifter Login Name - This is the login name of the user that has gifted the subscription. For anonymous gifts, this will be empty or Twitch API specific. Touch Portal will not interpreted or change this value and is passed along to the event as it is been given from the Twitch API. For subs and resubs this will be the same as the recipient.
- Subscription Recipient Display Name - The display name of the user that receives the subscription.
- Subscription Recipient Login Name - The login name of the user that receives the subscription.
- Subscription Months (raw Data Field) - This field represents the cumulative number of months the gifter has giften in the channel. This is a raw data field passed along unaltered from the Twitch API.
- Subscription Multi Month Duration (raw Data Field) - Number of months gifted as part of a single, multi-month gift OR number of months purchased as part of a multi-month subscription. This is a raw data field passed along unaltered from the Twitch API.
- Subscription Cumulative Months (raw Data Field) - Cumulative number of tenure months of the subscription. This is a raw data field passed along unaltered from the Twitch API.
- Subscription Message - The body of the user-entered resub message. Depending on the type of message, the message body contains different fields. If none is specified this state will be an empty text.
- Subscription is Gifts - This represents whether or not this events subscription is a gift or not. The value will be 1 if it is, 0 if it is not.
- Subscription Sub Plan Name (raw Data Field) - Channel Specific Subscription Plan Name. This is a raw data field passed along unaltered from the Twitch API.
- Subscription Sub Plan Code - Subscription Plan ID, values: Prime, 1000, 2000, 3000 (According to Twitch Documentation) but the Prime version can also be represented as 1.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Channel Point Redemption
![](https://www.touch-portal.com/docs/images/event-twitch-channel-point-redemption.png)
This event allows you to listen for channel points redemption.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Chat Message Event
![](https://www.touch-portal.com/docs/images/event-twitch-chat-message.png)
This event allows you to listen for incoming chat messages
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Receiving Bits
![](https://www.touch-portal.com/docs/images/event-twitch-receiving-bits.png)
This event allows you to listen for received bits between amounts
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Host
This event allows you to listen for when another user starts to host your stream
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Raid
This event allows you to listen for when another user starts to raid your stream
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Slow Mode Changes
![](https://www.touch-portal.com/docs/images/event-twitch-on-slow-mode.png)
This event will listen to the slow chat being active or not
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Unique Mode Changes
![](https://www.touch-portal.com/docs/images/event-twitch-unique-chat-state.png)
This event will listen to the unique chat being active or not
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Followers Only Chat Changes
![](https://www.touch-portal.com/docs/images/event-twitch-followers-only-chat.png)
This event will listen to the followers only chat being active or not
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Emotes Only Chat Changes
![](https://www.touch-portal.com/docs/images/event-twitch-emotes-only-chat.png)
This event will listen to the emotes only chat being active or not
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On New Whisper
![](https://www.touch-portal.com/docs/images/event-twitch-new-whisper.png)
This event will listen for new whispers
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Gift Sub Bomb
![](https://www.touch-portal.com/docs/images/event-twitch-gift-sub-bomb.png)
This event allows you to listen for gift sub bombs
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On User Ban Or Unban
![](https://www.touch-portal.com/docs/images/event-twitch-on-ban-unban-event.png)
This event allows you to listen for timeouts, bans and unbans on your channel. Use the below listed local states to control for what and how you want the event to act.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Issuer User ID - The user ID of the user that issued the ban or unban.
- Issuer User Login name - The user login name of the user that issued the ban or unban.
- Issuer User Name - The user display name of the user that issued the ban or unban.
- (Un)Banned User ID - The user ID of the user that is timed out, banned or unbanned.
- (Un)Banned User Login name - The user login name of the user that is timed out, banned or unbanned.
- (Un)Banned User Display Name - The user display name of the user that is timed out, banned or unbanned.
- Ban Reason - The reason as given by the issuer of the ban (or timeout). This local state is not available for the Unban event.
- Banned at - The UTC date and time (in RFC3339 format) of when the user was banned or put in a timeout. This is a string representation and not a time or data object. This local state is not available for the Unban event.
- Ends at - The UTC date and time (in RFC3339 format) of when the timeout ends. Is empty if the user was banned instead of put in a timeout. This is a string representation and not a time or data object. This local state is not available for the Unban event.
- Is Ban Permanent - Indicates whether the ban is permanent (1) or a timeout (0). If 1, Ends At will be empty.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Ad Break Start
![](https://www.touch-portal.com/docs/images/event-ad-break-start.png)
This event allows you to listen for when a user runs a midroll commercial break, either manually or automatically via ads manager.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Ad Break Requester User ID - The ID of the user that requested the ad. For automatic ads, this will be the ID of the broadcaster
- Ad Break Requester User Login - The login of the user that requested the ad.
- Ad Break Requester User Name - The display name of the user that requested the ad.
- Ad Break Time Stamp - The UTC timestamp of when the ad break began, in RFC3339 format. Note that there is potential delay between this event, when the streamer requested the ad break, and when the viewers will see ads. This is a string representation and not a time or data object.
- Ad Break Duration - Length in seconds of the mid-roll ad break requested.
- Ad Break Is Started Automatic - Indicates if the ad was automatically scheduled via Ads Manager
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Channel Info Updates
![](https://www.touch-portal.com/docs/images/event-twitch-channel-info-changes.png)
This event allows you to listen for channel info changes.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Title - The channel's stream title.
- Language - The channel's broadcast language.
- Category Id - The channel's category ID.
- Category Name - The channel's category name.
- Classification Labels - String of content classification label IDs currently applied on the Channel separated by commas.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Twitch Charity Campaign Starts / Progresses / Ends
![](https://www.touch-portal.com/docs/images/event-charity-campaign-states.png)
This event allows you to listen for Charity Campaign events.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Name - The charity's name.
- Description - A description of the charity.
- Logo - A URL to an image of the charity's logo. The image's type is PNG and its size is 100px by 100px.
- Website - A URL to the charity's website.
- Started At - The UTC timestamp (in RFC3339 format) of when the broadcaster started the campaign. This is a string and not a time or date object. This value will only be filled with the started state.
- Stopped At - The UTC timestamp (in RFC3339 format) of when the broadcaster stopped the campaign. This is a string and not a time or date object. This value will only be filled with the stopped state.
- Current Amount Value - The value of the current amount. This is a decimal number.
- Current Amount Pretty - The value of the current amount. This is a string containing the currency as well, example 100.00 USD or 250.00 EUR
- Target Amount Value - The value of the target amount. This is a decimal number.
- Target Amount Pretty - The value of the target amount. This is a string containing the currency as well, example 100.00 USD or 250.00 EUR
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When A Donation Is Made
![](https://www.touch-portal.com/docs/images/event-twitch-donation.png)
This event allows you to listen for donations made.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Donation Charity Campaign Name - The charity's name.
- Donation Charity Campaign Description - A description of the charity.
- Donation Charity Campaign Logo - A URL to an image of the charity's logo. The image's type is PNG and its size is 100px by 100px.
- Donation Charity Campaign Website - A URL to the charity's website.
- Donator User Id - An ID that identifies the user that donated to the campaign.
- Donator User Login Name - The user's login name.
- Donator User Display Name - The user's display name.
- Donation Amount Value - The amount donated. This is a decimal number.
- Donation Amount Pretty - The donation amount formatted. This is a string containing the currency as well, examples 100.00 USD or 250.00 EUR
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When A Poll Begins / Progresses / Ends
![](https://www.touch-portal.com/docs/images/event-twitch-poll.png)
This event allows you to listen for Twitch Poll events.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- ID - ID of the poll.
- Title - Question displayed for the poll.
- Started At - The time the poll started. This is a String representation, not a time or date object.
- Ends At - The time the poll will end. This is a String representation, not a time or date object.
- Choice Count - The number of choices in this poll.
- Bits Voting Available - Whether bits voting is enabled (1) or not (0).
- Bits Required per Vote - The amount of bits that represent one vote.
- Channel Points Voting Available - Whether Channel Points voting is enabled (1) or not (0).
- Channel Points Required per Vote - The amount of Channel Points that represent one vote.
-
Choices Collection -
This is the collection of choices within this poll. This is a special local state and
requires you to select what part of the choice data structure you want to use. When
you are not using the visual tags system within Touch Portal you need to construct this
value manually. An example is $local2{TwitchPollChoices{[0].title}} where the
important parts to understand are within the double brackets. This first tells which
choice from the choice collection you want to use ([0]), which in this case tells to
use the zero index of the collection which is the first item. Then the second part of the
code is the attribute you want to use from that object. In this case we want the title,
which combined is [0].title.
all options are:
id ID for the choice. title Text displayed for the choice. bits_votes Currently Not used by Twitch; will be set to 0. channel_points_votes Number of votes received via Channel Points. votes Total number of votes received for the choice across all methods of voting.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Hype Train Starts / Progresses / Ends
![](https://www.touch-portal.com/docs/images/event-twitch-hype-train.png)
This event allows you to listen for hypetrain events.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Total - Total points contributed to the Hype Train.
- Progress - The number of points contributed to the Hype Train at the current level.
- Goal - The number of points required to reach the next level.
- Level - The starting level of the Hype Train.
- Started At - The time when the Hype Train started. This is a textual representation of the time, it is not a time or date object.
- Expires At - The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level. This is a textual representation of the time, it is not a time or date object.
-
Last Contributor -
The most recent contribution. This is a comma separated string in the format
, , , , . Check out the Twitch API documentation for more information about these structures and data fields. - Top Contributions (raw) - The contributors with the most points contributed. This is the string representation of the raw JSON object received from Twitch. We suggest to use a JSON parsing plugin to get the data from this string. Check out the Twitch API documentation for more information about these structures and data fields.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Twitch Goal Starts / Progresses / Ends
![](https://www.touch-portal.com/docs/images/event-twitch-goals.png)
This event allows you to listen for Goal events.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
-
Goal Type -
The type of goal. Possible values (from Twitch API Documentation) are:
follow The goal is to increase followers. subscription The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions. subscription_count The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions. new_subscription The goal is to increase subscriptions. This type shows only the net increase in tier points associated with the subscriptions (it does not account for users that unsubscribed since the goal started). new_subscription_count The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started). - Goal Description - A description of the goal, if specified, otherwise empty. The description may contain a maximum of 40 characters.
- Goal is Achieved - A value that indicates whether the broadcaster achieved their goal. Is 1 if the goal was achieved; otherwise, 0. This field is only available for the event when the Goal ends.
- Goal Target Amount - The goal's target value.
- Goal Current Amount - The goal's current value.
- Goal Started At - The UTC timestamp in RFC 3339 format, which indicates when the broadcaster created the goal. This is a String representation and not a date or time object.
- Goal Ended At - The UTC timestamp in RFC 3339 format, which indicates when the broadcaster ended the goal. This is a String representation and not a date or time object. This field is only available for the event when the Goal ends.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
When Twitch Prediction Starts / Progresses / Ends
![](https://www.touch-portal.com/docs/images/event-twitch-prediction.png)
This event allows you to listen for Prediction events.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Prediction Id - Channel Points Prediction ID.
- Prediction Title - Title for the Channel Points Prediction.
- Prediction Started At - The time the Channel Points Prediction started. This is a String representation, not a time or date object.
- Prediction Locks At - The time the Channel Points Prediction will automatically lock. This is a String representation, not a time or date object. Not available in the Lock Event.
- Prediction Locked At - The time the Channel Points Prediction was locked. This is a String representation, not a time or date object. Only available in the Lock event
- Prediction Outcome Count - The amount of outcomes in the outcome collection.
-
Predictions Outcome Collection -
The outcomes collection contains an object that describes each outcome and, if applicable,
the number of users who selected that outcome and the number of Channel Points for that outcome.
This is a special local state and
requires you to select what part of the outcome data structure you want to use. When
you are not using the visual tags system within Touch Portal you need to construct this
value manually. An example is $local2{TwitchPredictionOutcomes{[0].title}} where the
important parts to understand are within the double brackets. This first tells which
outcome from the outcomes collection you want to use ([0]), which in this case tells to
use the zero index of the collection which is the first item. Then the second part of the
code is the attribute you want to use from that object. In this case we want the title,
which combined is [0].title.
all options are:
id The outcome ID. title The outcome title. color The color for the outcome. Valid values are pink and blue. users The number of users who used Channel Points on this outcome. channel_points The total number of Channel Points used on this outcome.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Shout Out Received
![](https://www.touch-portal.com/docs/images/event-twitch-shout-out.png)
This event allows you to listen for when get a Shout Out.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- Shout Out by User Id - The User ID that identifies the broadcaster that sent the Shoutout.
- Shout Out by User Login - The User Login Name that identifies the broadcaster that sent the Shoutout.
- Shout Out by User Name - The User Name that identifies the broadcaster that sent the Shoutout.
- Shout Out Viewer Count - The number of users that were watching the shout-out-by-broadcaster's stream at the time of the Shoutout.
- Shout Out Started at - The UTC timestamp (in RFC3339 format) of when the moderator sent the Shoutout. This is a String representation and not a date or time object.
![](https://www.touch-portal.com/docs/images/icon-twitch.png)
On Subscription End
![](https://www.touch-portal.com/docs/images/event-twitch-subscription-end.png)
This event allows you to listen for when a user stops being a subscriber to your channel.
Local States descriptions
The local states listed below are being passed along with the event when the event is triggered. They can be used to act on the specifics of the triggered event.
- End Subscription User Id - The user ID for the user whose subscription ended.
- End Subscription User Login - The user login name for the user whose subscription ended.
- End Subscription User Name - The user display name for the user whose subscription ended.
- End Subscription Tier - The tier of the subscription that ended. Valid values are 1000, 2000, and 3000.
- End Subscription Was Gifted - Whether the subscription was a gift.
Streamlabs Desktop
![](https://www.touch-portal.com/images/black_logo256.png)
Set Scene
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-scene.png)
This action allows you to change the current scene
![](https://www.touch-portal.com/images/black_logo256.png)
Set Scene Collection
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-scene-collection.png)
This action allows you to set the scene collection
![](https://www.touch-portal.com/images/black_logo256.png)
Source Visibility Toggle
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-source.png)
This action allows you to change the visibility of a source
![](https://www.touch-portal.com/images/black_logo256.png)
Set Streaming State
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-streaming.png)
This action allows you to start and stop streaming
![](https://www.touch-portal.com/images/black_logo256.png)
Set Recording State
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-recording.png)
This action allows you to start and stop recording
![](https://www.touch-portal.com/images/black_logo256.png)
Replay Buffer
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-replay-buffer.png)
This action allows you to start, stop and save a replay buffer
![](https://www.touch-portal.com/images/black_logo256.png)
Set Studio Mode
![](https://www.touch-portal.com/docs/images/action-sldesktop-set-studio-mode.png)
This action allows you to enable or disable Studio Mode
![](https://www.touch-portal.com/images/black_logo256.png)
Execute Studio Mode Transition
This action allows you to execute the Studio Mode transition.
![](https://www.touch-portal.com/images/black_logo256.png)
Mute Volume
![](https://www.touch-portal.com/docs/images/action-sldesktop-mute-volume.png)
This action allows you to mute and unmute an audio source
![](https://www.touch-portal.com/images/black_logo256.png)
When Scene Changes
![](https://www.touch-portal.com/docs/images/event-sld-on-scene-event.png)
This event allows you to listen for scene changes
![](https://www.touch-portal.com/images/black_logo256.png)
When Scene Collection Changes
![](https://www.touch-portal.com/docs/images/event-sld-on-scene-collection-event.png)
This event allows you to listen to scene collection changes
![](https://www.touch-portal.com/images/black_logo256.png)
When Source Visibility Changes
This event allows you to listen to scene collection changes
![](https://www.touch-portal.com/images/black_logo256.png)
When Streaming State Changes
![](https://www.touch-portal.com/docs/images/event-sld-on-streaming-state.png)
This event allows you to listen to streaming state changes
![](https://www.touch-portal.com/images/black_logo256.png)
When Recording State Changes
![](https://www.touch-portal.com/docs/images/event-sld-on-recording-state.png)
This event allows you to listen to recording state changes
Xsplit
![](https://www.touch-portal.com/images/black_logo256.png)
Toggle Source Visibility
![](https://www.touch-portal.com/docs/images/action-xsplit-set-source.png)
This action allows you to toggle the visibility of a source
![](https://www.touch-portal.com/images/black_logo256.png)
Set Recording
![](https://www.touch-portal.com/docs/images/action-xsplit-set-recording.png)
This action allows you to change the recording state
![](https://www.touch-portal.com/images/black_logo256.png)
Set Streaming
![](https://www.touch-portal.com/docs/images/action-xsplit-set-streaming.png)
This action allows you to change the streaming state
![](https://www.touch-portal.com/images/black_logo256.png)
Toggle Mute Volume Mic
This action allows you to toggle the mute state of the main mic volume
![](https://www.touch-portal.com/images/black_logo256.png)
Toggle Mute Volume Speaker
This action allows you to toggle the mute state of the main volume
![](https://www.touch-portal.com/images/black_logo256.png)
Set Volume Default Speaker
![](https://www.touch-portal.com/docs/images/action-xsplit-set-volume-main-speaker.png)
This action allows you to change the volume of the main speaker
![](https://www.touch-portal.com/images/black_logo256.png)
Set Volume Default Mic
![](https://www.touch-portal.com/docs/images/action-xsplit-set-volume-main-mic.png)
This action allows you to change the volume of the main mic
![](https://www.touch-portal.com/images/black_logo256.png)
Set Silence Detection
![](https://www.touch-portal.com/docs/images/action-xsplit-set-silence-detection.png)
This action allows you to turn on and off the silence detection
![](https://www.touch-portal.com/images/black_logo256.png)
Set Noise Suppression
![](https://www.touch-portal.com/docs/images/action-xsplit-set-noise-suppression.png)
This action allows you to turn on and off the noise suppression
![](https://www.touch-portal.com/images/black_logo256.png)
When Recording State Changes
![](https://www.touch-portal.com/docs/images/event-xsplit-when-recording-state-changes.png)
This event allows you to listen to changes in the recording state
![](https://www.touch-portal.com/images/black_logo256.png)
When Scene Changes
![](https://www.touch-portal.com/docs/images/event-xsplit-when-scene-changes.png)
This event allows you to listen to scene changes
Photoshop
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Bring Photoshop To The Front
This action allows you to bring the Photoshop window to the front
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Tool
![](https://www.touch-portal.com/docs/images/action-photoshop-set-tool.png)
This action allows you to select a tool in Photoshop
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Cycle Current Tools Group
This action allows you to cycle through the tools in the current selected group of tools.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Main Working Color
![](https://www.touch-portal.com/docs/images/action-photoshop-set-main-working-color.png)
This action allows you to set the main working color in Photoshop.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Both Main Working Colors
![](https://www.touch-portal.com/docs/images/action-photoshop-set-both-main-working-colors.png)
With this action you set both colors in one go.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Visibility Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-set-visibility.png)
With this action you can set the visibility to show or hide. You can also toggle the state.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Lock / Unlock Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-lock-unlock-layer.png)
With this action you can lock and unlock the current layer
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Opacity Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-set-opacity.png)
With this action you can set the opacity of the current layer
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Fill Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-set-fill.png)
With this action you can set the fill of the current layer
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Blendmode Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-set-blendmode-layer.png)
With this action you can set the blendmode of the current layer
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Text Content Current Layer
![](https://www.touch-portal.com/docs/images/action-photoshop-set-text-on-text-layer.png)
With this action you can set the text of the current selected Text layer
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Current Brush Radius (smart)
![](https://www.touch-portal.com/docs/images/action-photoshop-set-brush-radius.png)
With this action you can set the radius of the currently selected Brush
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Set Current Brush Hardness (smart)
![](https://www.touch-portal.com/docs/images/action-photoshop-set-brush-hardness.png)
With this action you can set the hardness of the currently selected brush
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Resize Image
![](https://www.touch-portal.com/docs/images/action-photoshop-set-image-size.png)
With this action you can change the image size of the image.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Resize Canvas
![](https://www.touch-portal.com/docs/images/action-photoshop-set-canvas-size.png)
With this action you can change the canvas size of the image.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Trim Image
![](https://www.touch-portal.com/docs/images/action-photoshop-trim-image.png)
This allows you to trim the image on four sides by removing the transparent colums or rows.
![](https://www.touch-portal.com/docs/images/icon-ps.png)
Execute Custom Photoshop Script
![](https://www.touch-portal.com/docs/images/action-photoshop-execute-custom-script.png)
This action allows you to write your own script and execute it within Photoshop
![](https://www.touch-portal.com/docs/images/icon-ps.png)
When
![](https://www.touch-portal.com/docs/images/event-photoshop-when-tool-changed.png)
This events allows you to listen to when the tool is changed
![](https://www.touch-portal.com/docs/images/icon-ps.png)
When Current Tool Radius Changes
![](https://www.touch-portal.com/docs/images/event-photoshop-when-brush-radius-changes.png)
This events allows you to listen to when the radius is changed
![](https://www.touch-portal.com/docs/images/icon-ps.png)
When Current Tool Hardness Changes
![](https://www.touch-portal.com/docs/images/event-photoshop-when-brush-hardness-changes.png)
This events allows you to listen to when the hardness of a brush is changed
![](https://www.touch-portal.com/docs/images/icon-ps.png)
When Current Layer Visibility Changes
![](https://www.touch-portal.com/docs/images/event-photoshop-when-layer-visibility-changes.png)
This events allows you to listen to when the current layer becomes visible or hidden
![](https://www.touch-portal.com/docs/images/icon-ps.png)
When Current Layer Locked State Changes
![](https://www.touch-portal.com/docs/images/event-photoshop-when-locked-state-changes.png)
This events allows you to listen to when the current layer becomes locked or unlocked
Hue
![](https://www.touch-portal.com/images/black_logo256.png)
Turn On / Off
![](https://www.touch-portal.com/docs/images/action-hue-turn-lights-on-off.png)
This action allows you to turn on and off lights, zones and rooms
![](https://www.touch-portal.com/images/black_logo256.png)
Set Color
![](https://www.touch-portal.com/docs/images/action-hue-set-color.png)
This action allows you to set the color of lights, zones and rooms
![](https://www.touch-portal.com/images/black_logo256.png)
Set Color
![](https://www.touch-portal.com/docs/images/action-hue-set-brightness.png)
This action allows you to set the brightness of lights, zones and rooms
![](https://www.touch-portal.com/images/black_logo256.png)
Change Brightness
![](https://www.touch-portal.com/docs/images/action-hue-change-brightness.png)
This action allows you to change the brightness of lights, zones and rooms from relative to the current value
![](https://www.touch-portal.com/images/black_logo256.png)
Set Color Temperature
![](https://www.touch-portal.com/docs/images/action-hue-set-color-temp.png)
This action allows you to change the color temperature of lights, zones and rooms
![](https://www.touch-portal.com/images/black_logo256.png)
Change Color Temperature
![](https://www.touch-portal.com/docs/images/action-hue-change-color-temp.png)
This action allows you to change the color temperature of lights, zones and rooms relative to the current value
![](https://www.touch-portal.com/images/black_logo256.png)
Set Scene
![](https://www.touch-portal.com/docs/images/action-hue-set-scene.png)
This action allows you to set the scene for rooms or zones
![](https://www.touch-portal.com/images/black_logo256.png)
Set Special Effect
![](https://www.touch-portal.com/docs/images/action-hue-set-special-effect.png)
This action allows you to start a special effect for lights, rooms or zones
![](https://www.touch-portal.com/images/black_logo256.png)
Set Alert
![](https://www.touch-portal.com/docs/images/action-hue-set-alert.png)
This action allows you to start an alert for lights, rooms or zones
![](https://www.touch-portal.com/images/black_logo256.png)
Restore Light Source State From Value
![](https://www.touch-portal.com/docs/images/action-hue-restore-lights-from-value.png)
This action allows you to restore a source (light, room or zone) from a stored Hue State
![](https://www.touch-portal.com/images/black_logo256.png)
Store The Current Light Source State Into A Value
![](https://www.touch-portal.com/docs/images/action-hue-store-light-state-into-value.png)