Run
1.0
Start / Run Application
Action
This action allows you to start or run an application on your desktop computer
filepath
The path of the file you want to start. This needs to be an executable. This action should not be used to run shortcuts or other non-executable files.
arguments
The arguments to pass to the file you want to start. Some applications allow you to add arguments to the path that will start the application with additional information. Leave empty if you do not need it.
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:
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.
Note: Some complex combinations of argument may not work. If this happens, best to start the application using a batch file and use the execute-batch-file-action instead.
2.2
Open File
Action
This action allows you to start any file. This will ask the OS to open or start the file.
File path
The path of the file to open.
Note: Your OS is asked to open the file. This will fail if the OS does not know how to handle the file. It also means that your OS will use the default selected application for the specific file extension. If you want to open it in a different application you need to use the Run Application action instead and use the arguments if that specific application supports this functionality.
1.3
Open Folder
Action
This action allows you to open a folder in your OS explorer.
Path
The path of the folder you want to be opened.
1.0
Run Batch Script
Action
This action allows you to execute Batch scripts.
Execution Type
option how to execute the batch file. Normally the action is started in the background and Touch Portal continues with the next action. If you need the action to wait for execution, choose the wait option. In some case you do not want to have the batch execution on the background, use the open option to let the command prompt execution of the batch file appear.
Script File Path
the path referencing the batch file
Arguments
arguments/parameters to add to the path when running the batch file
1.7
Run Powershell Script
Action
This action allows you to run a PowerShell script file
File
the reference to the PowerShell script file
Params
the parameters to pass on to the 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)
Note: If you have spaces in the full path of the powershell script and it does not run, you need to add a ` (Grave Accent) as an escape character for the space. So place it on each space in the path and keep 1 space size after the grave accent. This will allow spaces in Powershell.
Note: Touch Portal tells the OS that the origin of the script is the working directory of the file. If your script uses relative paths, you need to take account for this. If parts of the script are not working, ensure you use full paths to files and such.
3.0
Run Apple Script
Action
This action allows you to execute an Apple script
Script
the Apple script you want to execute
[ Link ]
4.2
Run Windows Apps
Action
This action allows you to run a Windows (UWP) Apps, steam games, epic games, gog games and other apps
Type
the type of app (Windows Apps, Steam Games, Epic Games, GOG Games and other Apps)
App
the app or game to launch
[ Link ]
Note: Touch Portal will query for available information from the system and from the services. When services change their functionality so may Touch Portal no longer be able to retrieve the list of games and applications to start. When this happens, check the logs and report to the Touch Portal dev. Application can always be started using shortcuts and application paths in this case.
3.1
Execute Script
Action
This action allows you to execute a script.
Run Option
Option for executing the script. (Run, Run visibly or Run and Wait for execution).
filepath
The path of the script file you want to execute. (.sh on Linux)
arguments
The arguments to pass to the script you want to execute. Leave empty if you do not need it.
Note: Some complex combinations of argument may not work. If this happens, best to start it using a second script (sh) file to have all arguments set up properly.
Nav
1.0
Go To Page
Action
This action allows you to navigate to the selected Page.
Page
The Page to navigate to
Note: This action does not stop executing the rest of the flow. The page will be changed so actions that refer to page specific functionality might not act incorrectly.
4.0
Go To Page On Device
- Multiple Devices Upgrade RequiredAction
This action allows you to navigate to the selected Page on a specific device.
Page
The Page to navigate to
Device reference
The device you want to send the page to, either the multiple devices upgrade id
1.0
Open Url
Action
This action allows you to open an URL in your standard browser.
Url
the url to open. This needs to be a full correctly formatted url otherwise the standard browser may not be able to open it correctly.
[ Link ]
4.0
When A Page Is Changed
- Pro Upgrade RequiredEvent
This event is triggered when a Page is changed on your device.
Page
the Page that would trigger this action. Use an asterix if you want to catch all Page changes.
[ Link ]
Note: This will only work if you have the Pro Upgrade.
Input Keyboard
2.2
Low Level Key Press
Action
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.
Keys
The key or key combination that is pressed down in order and then released in reversed order.
Time
The time between the last key pressed down and the first key being released
Keyboard Layout
the keyboard layout to use. This allows for country and language specific keys.
Note: Both Touch Portal and the application you want to control with Key Presses need to be in the same Sandbox on Windows. Either both run in Admin mode or both in User mode.
1.0
Virtual Key Press
Action
This action allows you to do virtual key presses. Virtual key presses are software simulated key presses requested to the OS.
Keys
the key or key combination that is pressed down in order and then released in reversed order.
Time
the time between the last key pressed down and the first key being released
Note: Virtual keys can be blocked by the application (or game) you want to use it for. Use the Low Level Key presses instead.
Note: Both Touch Portal and the application you want to control with Key Presses need to be in the same Sandbox on Windows. Either both run in Admin mode or both in User mode.
Note: Virtual Key Presses do not have country specific keys and follow the international keyboards. If you want to use key presses with for example a German keyboard layout, you should use the Low Level Key Presses action instead.
2.2
Hold Key Press
Action
This action allows you to keep pressing a key or a combination of keys while execution other actions during that pressing down.
Keys
the keys that will be pressed down in order and release at the end in reversed order.
Keyboard Layout
the keyboard layout to use. This allows for country and language specific keys.
1.0
Write Text
Action
This action allows you to write text.
Text
The text that will be written when the action is executed.
Note: This action copies the given text to the clipboard and will then do a general Paste action to apply the text.
Input Mouse
2.1
Mouse Click
Action
This action allows you to click with the mouse on a specific location
Method
Default means it uses virtual software simulation. Low Level means it uses mouse clicks injected at the lowest layer of the OS to simulate a mouse click.
Click Type
The mouse button to use for the click
Duration
The time in milliseconds to keep pressing the mouse button down before releasing it.
Location
The location on the screen where you want to click. Multiple screens resolutions are added to the main screen to have the location on another screen.
Use the mouse position
If this is checked it means it will use the location of where the mouse currently is when the action is executed. The action will not move the mouse.
Note: You can press the 'm'-key to get the location of the mouse at that time. Be sure that the popup window is the active window when you press the key as otherwise it will not get the location.
4.0
Move Mouse
Action
This action allows you to move the mouse to a specific location on your screen(s)
x
the x value of the location
y
the y value of the location
Method
Relative will move the mouse away from the current mouse position with the given x and y values, Absolute will move the mouse to the given location on screen.
[ Link ]
4.1
Drag Mouse
Action
This action allows you to drag the mouse from and to specific locations on your screen(s)
start x
the x value of the drag location start
start y
the y value of the drag location start
end x
the x value of the drag location end
end y
the y value of the drag location end
Method
Relative will drag the mouse away from the current mouse position with the given x and y drag end values, Absolute will drag the mouse from and to the given locations on screen.
speed
the speed of the drag process in milliseconds, 0 will be instant.
[ Link ]
Utility Touch Portal Functions
4.0
Restart Touch Portal
Action
With this action you can restart Touch Portal.
Note: When executing this action, actions that follow this might not be executed or might not be fully executed. Use this action as the last in the flow of actions.
2.3
Switch Event On / Off
- Pro Upgrade RequiredAction
This action allows you to turn global Event on and off.
Option
The state to put the event in.
Event
The event to change the state of.
[ Link ]
4.0
On Touch Portal Initialized
- Pro Upgrade RequiredEvent
This event is triggered when Touch Portal is initialized.
Note: This will only trigger if the mobile device is running Touch Portal and has been previously connected to the desktop application. This will only work if you have the Pro Upgrade.
4.0
Toggle Plugin Action
Action
This action allows you to start or stop plugins using actions
Option
Start or Stop a plugin
Plugin
The plugin to start of stop
[ Link ]
Utility Clipboard
4.0
Clipboard Content To Value
Action
With this action you store the current contents of the systems clipboard to a Value.
Value
The value that is used to store the contents of the default clipboard.
[ Link ]
Note: This action will grab the string contents of the clipboard.
2.2
Copy File To Clipboard
Action
With this action you store the specified file in the clipboard
File
The file that is used to store in clipboard.
[ Link ]
2.2
Copy Image To Clipboard
Action
With this action you store the specified image in the clipboard
Image
The image that is used to store in clipboard.
[ Link ]
4.0
Set Clipboard Content
Action
With this action you can copy text to the clipboard.
Body
The multiline enabled text you want to copy to the clipboard
[ Link ]
Note: This action copies the given text to the default clipboard.
Utility System And Applications
3.0
Activate Application (foreground)
Action
This action allows you to bring an application on your computer to the foreground (activate)
Token
part of the full process.
[ Link ]
Note: To get an overview of all current running processes to determine what the token is you need to use to activate the specific application check out the Page Navigation options as it has a button to show all currently running processes. Use this list to determine what token (part of the process path) you need to use.
3.0
Close Application
Action
This action allows you to close an application on your computer.
Type
A soft close will send a close request to the process. It depends on the application how it handles this. Usually it will normally close the application and ask you to save whatever is not saved yet. Forced Close means the process is killed instantly no matter the state. It will not follow the normal close procedure.
Token
part of the full process.
[ Link ]
Note: To get an overview of all current running processes to determine what the token is you need to use to activate the specific application check out the Page Navigation options as it has a button to show all currently running processes. Use this list to determine what token (part of the process path) you need to use.
Logic
1.0
Wait For (timer)
Action
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.
Value
The time value
Unit
The unit of time to use with the value.
System
The default system uses less resources but is less precise. The Experimental system uses more resources but it more precise.
Note: The default system can show spikes of longer wait times when the system is very busy and all system resources are used near 100%. If this happens, use the experimental system.
3.0
Logic If Statement Extended
Action
This logic action allows you to run actions based on specific criteria.
State
the state you want to use to compare with
Comparator
the type of comparator you want the state to compare the value with. Depending on the type of state you will be presented with different options.
Value
the value to compare the state with
Combinator
this option allows you to string multiple lines of criteria together
Note: When using the combinator Touch Portal will evaluate the situation line by line. This means that it takes the previous result and the compares that with the new compare line. So if you have 3 lines, first it will check the first, then it will check the second and uses the combinator to get a result. For the third line it uses the combinator between that line and the previous result.
1.10
Logic If Statement
Action
This logic action allows you to run actions based on specific criteria.
State
the state you want to use to compare with
Comparator
the type of comparator you want the state to compare the value with
Value
the value to compare the state with
[ Link ]
Note: The IF statement logic action is superceeded by the IF statement (advanced). This IF statement will keep working but will not get updates. The new advanced IF statement will be kept up to date.
1.10
Logic Else
Action
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.
2.2
If File Statement
Action
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.
File
The file to use in this logic statement.
Comparator
Options on how you want to compare the file.
Text
The text to compare the file with. If the option 'exists' is chosen, this option will not appear.
Note: This action expects the file to be in UTF-8 encoding.
2.1
Logic Repeat X Times
Action
This logic action allows you to create a repeating loop that will execute the flow of actions within its context x amount of times
Counter
the amount of times it should repeat executing the flow of actions within its context.
Note: The maximum number allowed is 2147470000
2.3
Execute Flow
Action
This action allows you to execute a predefined Flow.
Flow
the Flow object to execute
2.2
Stop Executing Actions In Current Flow
Action
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.
Note: If you use this action in a Flow object, it will stop that Flow object and will continue the flow of actions from which the Flow object has been called.
2.1
Dynamic Text Updater
Event
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.
Text
the text to update the button with
[ Link ]
Value
2.1
Set Value To / Change Value To
- Pro Upgrade RequiredAction
This action allows you to change what the Value.
Value Object
The Value Object to change
value
the new value the Value Object should hold.
2.3
Get Url Content And Store In Value
- Pro Upgrade RequiredAction
This action allows you to retrieve the contents from an URL and store it into the specified Value
url
the url to get the contents from
Value Object
The Value Object to store the url contents into.
[ Link ]
2.1
When Value Changes
- Pro Upgrade RequiredEvent
This event allows you to trigger on when a Value changes.
Value
the Value to listen for a change
Param
the comparator for the Value change
Param
the token for the comparator
[ Guide ]
Note: To listen for every change of the specific Value, use the 'does not change to' and use a token which will never happen. This will make the event trigger always for that Value.
2.1
When Plugin Value Changes
- Pro Upgrade RequiredEvent
This event allows you to trigger on when a Plugin State changes.
Value
the plugin state to listen for a change
Param
the comparator for the plugin state change
Param
the token for the comparator
Note: To listen for every change of the specific plugin state, use the 'does not change to' and use a token which will never happen. This will make the event trigger always for that plugin state.
Button State
1.8
Set Button State
Action
This action allows you to set the button state to either On or Off
state
the state to set the button to
Note: The button state is a predefined state for a button which can only be On and Off. If you need more or different states, use Values.
2.0
Set Other Button State
Action
This action allows you to set the state of a button with the given id to On or Off.
State
the state to set the button to, can be On or Off
Id
The id of the button to set the state of
2.0
Toggle Button State
Action
This action allows you to toggle the button state to either on or off. This action will switch from the current state.
Note: The button state on and off is a built in state for a button. If you need more options, use Values.
1.8
When Button State Changes
Event
This event allows you to act on the event that is triggered when the state of the button changes.
OnOff
the state of the button the event should trigger on.
Value Text Manipulation
4.0
Set Value Capitalization
- Pro Upgrade RequiredAction
This action allows you to capitalize the text Value.
Value
The Value to capitalize
Option
The option for capitalisation
[ Link ]
2.3
Replace (regex) In Value
- Pro Upgrade RequiredAction
This action allows you to replace a given part of the Value Object with another value.
Token (regex)
The regex token to search for in the Value
Replacement
The replacement to replace the regex token with in the Value
Value
The Value object to store the results in
[ Link ]
Note: If you want to add newlines to the Value, you can use {tpnewline} which are replaced by the systems newline character combination when used in this action.
4.0
Get Subtext
- Pro Upgrade RequiredAction
This action allows you to get part of a text Value
Value
The value to store the results in
Text
The text to get the part of
Range start
index of the start of the sub text
Range end
index of the end of the sub text
[ Link ]
4.0
Get Length Of Value
- Pro Upgrade RequiredAction
This action allows you to get the length of a given text and store it into a Value.
Value
The Value to store the length of the given text in.
Text
The text to get the length of.
[ Link ]
4.0
Trim Value
- Pro Upgrade RequiredAction
This action allows you to trim the text Value
Value
The Value to trim
[ Link ]
4.0
Split Value And Get N-th
- Pro Upgrade RequiredAction
This action allows you to split a text with a delimiter and get the nth item from the split text.
Value
The Value to store the results in
n-th
The index of the item to get from the split collection
Text
The text to split
Delimiter
the character or text to split the text with.
[ Link ]
Note: The n-th index is zero based. This means the first item in the collection is 0.
Note: The delimiter works using regex, therefor you need to escape special characeters like <([{\^-=$!|]})?*+.> with escape character \ otherwise they are handled as the function they represent in regex
4.0
Get Index Of
- Pro Upgrade RequiredAction
This action allows you to get the index of a given character or text from a text
Value
the Value to store the results in
Token
the character or text to get the index of
Text
the Text to search for the token
[ Link ]
Note: This will save the index if found or it will save -1 in the Value if the token is not found.
Note: The index is zero based.
4.0
Get Occurrence Count
- Pro Upgrade RequiredAction
This action allows you to count occurences of text in a text and store it into a Value
Value
the Value to store the results in
Token
the character or text to get the occurence count of
Text
the Text to search for the token
[ Link ]
Value Number Manipulation
2.2
Increment Value
- Pro Upgrade RequiredAction
This action allows you to increment a Value with a given number.
Value
the Value Object to increment.
increment
the increment, this can be a negative number to effectively decrement a Value.
[ Link ]
Note: This action can only increment with whole number, decimal numbers are not allowed.
2.2
Randomize Value
- Pro Upgrade RequiredAction
This action allows you to generate a random (whole) number and store it in a Value
Value
details
start of range
The start of the range from which a random number should be generated. This range start number is included in the random generation.
end of range
The end of the range from which a random number should be generated. This range start number is included in the random generation.
4.0
Round Value Number
- Pro Upgrade RequiredAction
This action allows you to round the number stored in a Value.
Value
the Value to round
Decimals
the amount of decimals to keep (or add) when rounding the number.
[ Link ]
Note: Internally Touch Portal works with a period (.) in a number to divide the whole number with the decimal part. This action will switch all commas for periods to ensure the function works when used with a wrong format.
2.3
Value Calculations
- Pro Upgrade RequiredAction
This action allows you to do standard calculations with numbers.
Value
the Value to store the result in.
Left Side
the left side of the formula.
Operator
the operator
Right Side
the right side of the formula
Note: Using this actions on text Value will add the text and remove the text but the multiply, the divide and the modulo do nothing with Text values.
File Input Output
3.0.11
Create File
Action
This action allows you to create a file. If the specified file already exists on disc then this action will fail silently.
File
The file you want to create.
2.2
Write To File
Action
This action allows you to write content to a file. The file is cleared of contents before writing.
File
The file to write to
Text
The contents written to the given file
Note: This will write the file using UTF-8 encoding.
2.2
Append To File
Action
This action allows you to append text to the given file
File
The file you want to append to
Text
The text you want to append
Note: This expects the file to be in UTF-8 encoding and will be saved as such as well after appending.
2.2
Delete File
Action
This action allows you to delete a file. If the file does not exist this action will fail silently.
File
The file you want to delete.
Note: The action expects that Touch Portal has the rights to delete files from the disc. If the OS prevents this or the file is locked, this action will fail. Cloud synced file may not be deleted properly by this action, read the manual of the cloud syncing software to see the requirements to correctly delete the given file.
2.2
File To Value
- Pro Upgrade RequiredAction
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.
File
The file you want the contents of
Value
The Value you want to store into
3.0.11
Get Line Count From File
Action
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.
File
The file to get the line count from.
Value
The Value to store the line count into.
Note: This expects the file to be in UTF-8 encoding.
3.0.11
Get Line From File
Action
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.
Line Number
The number of the line in the file.
File
The text file from which the line is retrieved.
Value
The Value into which the retrieved line is set.
Note: This expects the file to be in UTF-8 encoding.
4.0
Remove Lines From File
Action
This action allows you to remove lines from a text file.
Line Start
The start line number of the line range you want to remove
Line End
The end line number of the line range you want to remove
File
The file from which you want to remove the lines.
Note: This action expects the file to be in UTF-8 encoding and will also save the file back with UTF-8 encoding.
2.3
Url Result To File
Action
This action allows you to get the result of a endpoint (url) and store it into a file
Url
The url.
File
The file to store the endpoints content in.
Note: This uses UTF-8 encoding for the file.
Note: The contents can be altered based on newlines and OS specifics
2.2
When A File Changes
Event
This events can be set up to listen when the contents of a file changed.
File
The file set up to listen for changes.
Note: Wildcards and codes cannot be used in the file field because file listeners are not dynamic and are set when loaded and are directly connected to the specified file.
Http
1.10
Http Get
Action
This action allows you to do a GET call to a given endpoint.
Url
The endpoint you want to send the GET call to.
Authorization header
This optional parameter can be used to add Authorization Headers if the call requires this. Leave empty if you do not want to add authorization headers.
Content-Type header
This optional parameter can be used to add content-type headers. Leave empty if you do not want to add content-type headers.
[ Link ]
Note: The GET call is done with no additional headers except a default user-agent being 'TouchPortal'.
1.10
Http Post
Action
This action allows you to do a POST call to a given endpoint.
Url
The endpoint you want to send the POST call to
Data
The data you want to send as POST data. This data will be send as a UTF-8 encoded string. The format depends on the endpoint and Touch Portal does not prepare the data for you. You need to prepare the data so that it will be accepted by the endpoint.
Authorization header
This optional parameter can be used to add Authorization Headers if the call requires this. Leave empty if you do not want to add authorization headers.
Content-Type header
This optional parameter can be used to add content-type headers. Leave empty if you do not want to add content-type headers.
Optional Custom header 1
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 2
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 3
This optional parameter can be used to add an additional header with a custom key and value.
[ Link ]
Note: The POST call is done with no additional headers. If you do not specify a 'user-agent' in the custom headers, the default 'TouchPortal' will be added as a user-agent.
2.1
Http Put
Action
This action allows you to do a PUT call to a given endpoint.
Url
The endpoint you want to send the PUT call to
Data
The data you want to send as PUT data. This data will be send as a UTF-8 encoded string. The format depends on the endpoint and Touch Portal does not prepare the data for you. You need to prepare the data so that it will be accepted by the endpoint.
Authorization header
This optional parameter can be used to add Authorization Headers if the call requires this. Leave empty if you do not want to add authorization headers.
Content-Type header
This optional parameter can be used to add content-type headers. Leave empty if you do not want to add content-type headers.
Optional Custom header 1
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 2
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 3
This optional parameter can be used to add an additional header with a custom key and value.
[ Link ]
Note: The PUT call is done with no additional headers. If you do not specify a 'user-agent' in the custom headers, the default 'TouchPortal' will be added as a user-agent.
4.0
Http Patch
Action
This action allows you to do a PATCH call to a given endpoint.
Url
The endpoint you want to send the PATCH call to
Data
The data you want to send as PATCH data. This data will be send as a UTF-8 encoded string. The format depends on the endpoint and Touch Portal does not prepare the data for you. You need to prepare the data so that it will be accepted by the endpoint.
Authorization header
This optional parameter can be used to add Authorization Headers if the call requires this. Leave empty if you do not want to add authorization headers.
Content-Type header
This optional parameter can be used to add content-type headers. Leave empty if you do not want to add content-type headers.
Optional Custom header 1
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 2
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 3
This optional parameter can be used to add an additional header with a custom key and value.
[ Link ]
Note: The PATCH call is done with no additional headers. If you do not specify a 'user-agent' in the custom headers, the default 'TouchPortal' will be added as a user-agent.
4.0
Http Delete
Action
This action allows you to do a DELETE call to a given endpoint.
Url
The endpoint you want to send the DELETE call to
Data
The data you want to send as DELETE data. This data will be send as a UTF-8 encoded string. The format depends on the endpoint and Touch Portal does not prepare the data for you. You need to prepare the data so that it will be accepted by the endpoint.
Authorization header
This optional parameter can be used to add Authorization Headers if the call requires this. Leave empty if you do not want to add authorization headers.
Content-Type header
This optional parameter can be used to add content-type headers. Leave empty if you do not want to add content-type headers.
Optional Custom header 1
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 2
This optional parameter can be used to add an additional header with a custom key and value.
Optional Custom header 3
This optional parameter can be used to add an additional header with a custom key and value.
[ Link ]
Note: The DELETE call is done with no additional headers. If you do not specify a 'user-agent' in the custom headers, the default 'TouchPortal' will be added as a user-agent.
Note: The http DELETE protocol data body has been a debate of whether it should be possible but the protocol allows it and while most clients and server ignore the body, some might not. Be sure to query the documentation of the end point you are trying to reach on how it handles the DELETE calls.
Visuals
1.0
Change Button Visuals
Action
This action allows you to change the visuals of a button
+
This button allows you to select what attribute you want to change of the button.
4.0
Restore Buttons Original Visuals
Action
This action allows you to restore parts of the original button visuals setup.
Options
the parts of the original button visuals you want to restore.
[ Link ]
2.2
Change Visuals By Plug-in State
- Pro Upgrade RequiredAction
This action allows you to change the background color, the text color or the icon from a plugin state.
Option
the background color, the text color or the icon option
Param
the plugin state to use to update the chosen option.
[ Link ]
2.1
Comment
Action
This action allows you to add comments in your flow of actions. This comment action does not execute anything.
Comment
the text you want add as a comment in the flow.
4.0
Url To Button Icon
Action
With this action you can load an url image and set that image as the icon.
Url
A properly encoding url pointing to an PNG.
[ Link ]
Note: This action can only use PNG images.
4.0
Change Page Background Image
Action
This action allows you to change the image of the Page.
Image
the file of the image to
[ Link ]
Note: Pages background images can be quite big in memory. This means transferring the image from desktop to device can have a delayed if they are not yet cached. Loading big images can also result in out of memory crashes on older devices. If any issues, please make the image smaller.
2.3
Change Graphics Upgrade Settings
- Graphics Upgrades RequiredAction
This action allows you to change the Graphics Upgrade settings for the button
Graphics Upgrade
the details of the graphics upgrade can be set the same as when you set it through the button editor screen.
[ Link ]
Note: To remove graphics upgrades settings, add this action and use 'No Upgrade'
2.3
Change Page Graphics Upgrade Setting
- Graphics Upgrades RequiredAction
This action allows you to change the graphics upgrade settings for a Page.
Graphics Upgrade
the settings the same as when you set the graphics upgrade for a Page in the Page editor.
[ Link ]
4.0
Keep Button Icon The Same As External File
Event
This event will keep track of the image file pointed to. Whenever the file is changed, it will update the icon of the button.
File
A full path pointing to the image file to keep track of and update the icon with.
Note: This action can only use JPG and PNG images.
Media
3.1
Play Audio File Advanced
Action
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.
File
The file to play. This can be an wav or mp3 file.
Output
The output you want the file to be played on.
Volume
The volume to play the audio file at.
Id
An optional id to give to this audio file. This can be used in the 'Stop Playing all Audio with Id'-action.
Fade in time
The time it takes to fade in the song to the given volume. 0 if no fade in wanted.
Fade curve
The curve used to fade in the time. This will not be used if the fade in time is 0.
[ Link ]
Note: Not all mp3 formats are supported. If the mp3 does not play, we suggest to re-encode it using free online services. These services usually use the most mainstream mp3 encoding.
1.0
Play Audio File
Action
This action allows you to play an audio file (wav and mp3) over the general audio output.
File
The file to play. This can be an wav or mp3 file.
Volume
The volume to play the audio file at.
[ Link ]
Note: Not all mp3 formats are supported. If the mp3 does not play, we suggest to re-encode it using free online services. These services usually use the most mainstream mp3 encoding.
1.0
Stop All Playing Audio
Action
This action will stop all audio played by Touch Portal.
[ Link ]
Note: This will only stop audio started by the audio actions of Touch Portal. It will not stop audio from plugins or external audio applications.
4.0
Stop Audio With Id
Action
This action allows you to stop specific audio which was started by the advance audio play action and was started with a given id
Id
The id of the audio to stop. This will stop all audio files with the same id.
[ Link ]
1.0
Media Toggle Play / Pause
Action
This action allows you to play, resume or pause a track on the current audio application active on the OS.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
4.2
Set Volume Audio With Id
Action
This action allows you to set the volume of an audio file played by Touch Portal with the given ID.
Id
The id of the audio to stop. This will stop all audio files with the same id.
Volume
The volume of the file. Keep in mind that this is relative to the audio level of the device this is played on.
[ Link ]
4.2
Stop And Fade Audio With Id
Action
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
Id
The id of the audio to stop and fade. This will stop and fade all audio files with the same id.
Time
The duration of the fade in milliseconds
Curve
The curve to use for the fade.
[ Link ]
1.0
Media Stop
Action
This action allows you to stop a track on the current audio application active on the OS.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
1.0
Media Next Track
Action
This action allows you to go to the next track on the current audio application active on the OS.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
1.0
Media Previous Track
Action
This action allows you to go to the previous track on the current audio application active on the OS.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
1.0
Volume Up
Action
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.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
1.0
Volume Down
Action
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.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
1.0
Volume Mute
Action
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.
[ Link ]
Note: This system uses virtual media keys send to the OS. Not all application may support this. The OS settings can interfere with the functionality.
Note: Some application may catch all media key actions. Browsers such as Google can be set up like this. When this is set, it means no other applications will ever receive the media key actions.
3.0
Set Volume Of The Default Windows Audio Source
Action
This action allows you to set the volume of the default windows audio source (both input as output)
Output Type
Default output or input audio source to set the volume of.
Change
The volume in percentage.
[ Link ]
3.0
Set Volume Of The Default Windows Audio Source
Connector
This action allows you to set the volume of the default windows audio source (both input as output)
Output Type
Default output or input audio source to set the volume of.
Change
The volume in percentage.
[ Link ]
2.3
Set Volume Of Windows Audio Source
Action
This action allows you to set the volume of a given windows audio source (both input as output)
Output Type
Output or Input. Changing this will show the output or input device available on Windows.
Source
The Windows audio source you want to change the volume of
Change
The volume in percentage.
[ Link ]
Note: Touch Portal links this action to the unique ID of the windows audio source. After Windows updates and other situations internal ids can change and Touch Portal cannot link anymore. When this happens you need to relink the audio source to ensure it is linked to the new id.
2.3
Set Volume Of Windows Audio Source
Connector
This action allows you to set the volume of a given windows audio source (both input as output)
Output Type
Output or Input. Changing this will show the output or input device available on Windows.
Source
The Windows audio source you want to change the volume of
Change
The volume in percentage.
[ Link ]
Note: Touch Portal links this action to the unique ID of the windows audio source. After Windows updates and other situations internal ids can change and Touch Portal cannot link anymore. When this happens you need to relink the audio source to ensure it is linked to the new id.
2.3
Increase / Decrease Volume Windows Audio Source
Action
This action allows you to increase or decrease the specific Windows audio source.
Output Type
Output or Input. Changing this will show the output or input device available on Windows.
Source
The Windows audio source you want to change the volume of
Change
The change in percentage.
[ Link ]
Note: Touch Portal links this action to the unique ID of the windows audio source. After Windows updates and other situations internal ids can change and Touch Portal cannot link anymore. When this happens you need to relink the audio source to ensure it is linked to the new id.
2.3
Toggle Mute State Of Windows Audio Source
Action
This action allows you to toggle, set or unset the mute state of a given windows audio source.
Mute Action
Toggle, mute or unmute the current mute state of the give windows audio source.
Source Type
The input or output devices to show in the list of selectable sources.
Sources
The source to select.
[ Link ]
3.0
Set Volume Of Current Output On Macos
Action
This action allows you to set the volume of the current selected speaker (output) on MacOS
Volume
The volume to set the output to
[ Link ]
3.0
Set Volume Of Current Output On Macos
Connector
This action allows you to set the volume of the current selected speaker (output) on MacOS
Volume
The volume to set the output to
[ Link ]
3.0
Set Volume Of Current Microphone On Macos
Action
This action allows you to set the volume of the current selected microphone (input) on MacOS
Volume
The volume to set the mic to
[ Link ]
3.0
Set Volume Of Current Microphone On Macos
Connector
This action allows you to set the volume of the current selected microphone (input) on MacOS
Volume
The volume to set the mic to
[ Link ]
1.0
When Volume Specific Audio Device Changes
Event
This event allows you to act on volume changes of specific audio devices
Type
output or input device selection
Param
the actual device to select
Comparator
how you want to compare the new volume
Value
the value you want to compare the new volume to
3.0
When Windows Default Audio Device Mute State Changes
Event
This event will listen to the mute state of the current Windows audio source
Source Type
The input or output devices to listen for.
Mute State
The state to listen for
[ Link ]
3.0
When Windows Audio Source Mute State Changes
Event
This event will listen to the mute state of the given Windows audio source
Source Type
The input or output devices to show in the list of selectable sources.
Sources
The source to select.
Mute State
The state to listen for
[ Link ]
Obs
1.6
Set Streaming State
Action
This action allows you to set the state of streaming, in other words start and stop a stream.
Option
to either start or stop the stream
2.1
Set Recording State
Action
This action allows you to set the state of recording within OBS.
Option
the options to set the state to
[ Link ]
2.1
Set Profile
Action
This action allows you to change the current OBS Profile
Profile
the profile to set
Note: The OBS Websocket API will only load scene collections that are part of the current profile.
2.1
Set Scene Collection
Action
This action allows you to activate a scene collection.
Scene Collection
the scene collection to activate
[ Link ]
Note: Scenes and Sources within Touch Portal are loaded from the active scene collection, this means that inactive scene collections are not loaded and therefor also not their scenes and sources.
1.10
Set Preview Scene
Action
This action allows you to set the Preview scene
Scene
the scene to set as preview scene
[ Link ]
2.2
Set Scene Filter
Action
This action allows you to turn on or off a filter on a scene.
Scene
The scene with the specific filter
Filter
The filter to turn on or off
State
The state to turn the filter to
[ Link ]
1.6
Set Source Visibility
Action
This action allows you to change the visibility of a source
Option
toggle the visibility or set it to hide or show
Scene
the scene the source belongs to
Source
the source to handle
[ Link ]
2.1
Set Source Filter Visibility
Action
This action allows you to turn a source filter on or off
Source
the source that has the filter
Filter
the filter to set
State
the state to set the filter to
[ Link ]
4.0
Set Source Image
Action
This action allows you to set the image of an image source
Source
The source to set the image for
Image
The path to the image to set
[ Link ]
4.0
Set Source Text
Action
With this action you can set a text of a text source directly. This can only be applied to a Text Source.
Source
The text source that you want to set with the given text.
Text
The text you want the source to be set to.
[ Link ]
Note: When using this action Touch Portal will turn of the link to a file in the source in OBS.
Note: This action is only available from websocket version 5.0 and higher
4.0
Set Source Video
Action
This action allows you to set a video on a video source
Source
the source to set the video on
Video
the path to the video file to set on the source
[ Link ]
4.0
Set Source Browser Url
Action
This action allows you to set the url of a browser url.
Source
the source to set the url on
Url
the url to set
[ Link ]
Note: This will not automatically reload the browser source. You need to use the Refresh Browser action to make the source refresh.
4.0
Refresh Browser Source
Action
This action allows you to refresh a browser source
Source
the source to refresh
[ Link ]
1.6
Set Volume
Action
This action allows you to set the volume of a scene specific source.
Scene
The scene containing the source
Source
The source to change the volume of
Volume
the actual volume in percentages
[ Link ]
1.6
Set Source Mute State
Action
This action allows you to mute or unmute an audio source
State
the mute state to set
Source
the source to set the state to
[ Link ]
3.0
Set Volume Source
Action
This action allows you to set the volume of a specific source.
Source
The source to change the volume of
Volume
the actual volume in percentages
[ Link ]
Note: This version of the set Volume action allows you to set the volume of non-scene sources.
1.6
Increase Source Volume
Action
This action allows you to increase the volume in respect to the current volume
Source
The source to increase the volume of
Percentage
The percentage of volume to increase
[ Link ]
1.6
Decrease Source Volume
Action
This action allows you to decrease the volume in respect to the current volume
Source
The source to decrease the volume of
Percentage
The percentage of volume to decrease
[ Link ]
2.3
Media Source Play / Pause
Action
This action allows you to play and pause a media source
Action
play or pause
Media Source
the media source to play or pause
[ Link ]
Note: Play does not mean it will restart the media source. To play the media source from the start be sure to use the Media Source restart action.
2.3
Media Source Restart
Action
This action allows you to restart a media source
Media Source
the media source to restart
[ Link ]
2.3
Media Source Stop
Action
This action allows you to stop a media source
Media Source
the media source to stop
[ Link ]
2.3
Media Source Next
Action
This action allows you to go to the next media source
Media Source
the media source to go to
[ Link ]
2.3
Media Source Previous
Action
This action allows you to go to the previous media source
Media Source
the media source to go to
[ Link ]
1.9
Set Studio Mode State
Action
This action allows you to change the Studio Mode state
Option
Enable, disable or toggle the studio mode
[ Link ]
2.1
Set Current Transition
Action
This action allows you to set the current transition
Transition
the transition to set as current
[ Link ]
3.2
Set Current Transition Duration
Action
This action sets the current transition duration in milliseconds.
Duration
the duration in milliseconds
[ Link ]
Note: Valid duration is an integer in range 50-20000 representing the milliseconds
4.0
Obs Raw Request
Action
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.
Request Type
Read the OBS Websocket documentation for all available request types.
Request Id
An id which is returned in the resulting message. With this ID you can keep track of the send message and the received request. Touch Portal will prefix this id with 'tpc_'.
Request Data
The data in JSON format. Touch Portal will parse the text and build a JSON object with it. If it fails this action will not be executed. Ensure the JSON is properly formatted.
[ Link ]
Note: Link to the OBS Websocket v5 documentation: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md
2.3
Screenshot To File
Action
This action allows you to take a screenshot of a scene or source
Source
the source or scene you want to take a screenshot of
Format
currently only BMP and PNG are supported
Quality
the quality of the resulting image, the lower the quality the lower the file size.
File
path to a file to store the image in.
[ Link ]
1.9
Set Replay Buffer State
Action
This action allows you to start, stop, toggle or save the replay buffer
Options
the options
[ Link ]
4.0
Toggle Virtual Cam
Action
This action allows you to toggle the Virtual Cam
Option
Start, Stop or Toggle
[ Link ]
1.0
On Recording State
Event
This event allows you to listen for changes in the recording state
Comparator
how to compare the new state
State
the new state
1.0
On Streaming State
Event
This event allows you to listen for changes in the streaming state
Comparator
how to compare the new state
State
the new state
1.0
On Scene Selected
Event
This event allows you to listen for when the active scene changes
Comparator
how to compare the new state
Scene
the new active scene
1.0
On Previous Scene Selected
Event
This event allows you to listen for when the previous active scene changes
Comparator
how to compare the new state
Scene
the new previous active scene
1.9
On Source Visibility Change
Event
This event allows you to listen for source visibility changes
Source
the source to listen for
State
the state to trigger on
[ Link ]
2.2
On Scene Filter Visibility Change
Event
This event allows you to listen for scene filters visibility changes
Source
the source to listen for
State
the state to trigger on
[ Link ]
2.1
On Source Mute State
Event
This event allows you to listen for audio source mute changes
Source
the source to listen for
State
the state to trigger on
[ Link ]
2.2
On Source Filter Visibility Change
Event
This event allows you to listen for source filter changes
Source
the source to listen for
Filter
the filter to listen for
State
the state to trigger on
[ Link ]
1.0
On Replay Buffer Status Change
Event
This event allows you to listen for when the replay buffer state changes
State
the new replay buffer state
1.0
On Virtual Cam State Change
Event
This event allows you to listen for when the virtual cam state changes
State
the new virtual cam state
2.2
Scene Output To Icon Event
Event
This event allows you to show a scene visually on a button.
Scene
The scene to render on the button
Framerate
The framerate of rendering
Quality
The quality of the output
Note: This feature has a big impact on the connectivity. The best is to keep the framerate update at or above 1 frame per second. To high and other actions may be delayed by it. This all depends on the device, the network and the desktop computer.
4.0
On Preview Scene Selected
Event
This event allows you to listen for when the active preview scene changes
Comparator
how to compare the new state
Scene
the new active scene
4.0
When Studio Mode Changes
Event
This event allows you to listen for when the studio mode changes
State
On or Off
[ Link ]
4.0
When Custom Request Result Are Returned
Event
This event allows you to listen to the result of a Custom Request by ID
id
the id to check for of the Custom Request you made
[ Link ]
Note: This event will have the result information stored in the local states.
4.1
When Profile Is Changed
Event
This event allows you to listen for profile changes in OBS.
Comparator
how to compare the new profile
Profile
the new active profile
[ Link ]
Note: If you have both the normal websocket and the appcompat websocket active, this will cause disconnects of the websoket itself. To fix this uninstall the app compat websocket plugin in OBS.
Twitch
1.10
Send Chat Message
Action
This action allows you to send a message to your channel.
Message
the message to send
[ Link ]
3.0
Send Chat Message To Channel
Action
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.
Channel
the channel to send to
Message
the message to send
[ Link ]
Note: This action requires a few criteria to have been met such as that you need to be a mod in the channel. If the action does not check the Touch Portal logs to see why.
3.1
Send Whisper
Action
This action allows you to send a whisper to a user.
User ID Type
the type of id of the user you want to use. The name or the id.
User ID
the actual id in regards to the Type. If using the name, Ensure to use the login name.
Message
The whisper message to send to the user
[ Link ]
Note: The User ID type 'name' will first do a lookup of the user to get the id.
3.1.11
Announcement
Action
This action allows you to do announcements in Twitch
Message
The message of the announcement.
Announcement Color
the type of announcement message
[ Link ]
3.1.11
Shout Out
Action
This action allows you to do a shout out to a specific user
User ID Type
the type of id of the user you want to use. The name or the id.
User ID
the actual id in regards to the Type. If using the name, Ensure to use the login name.
[ Link ]
1.9
Start Advertisement
Action
This action allows you to
Ad Time
The lenght of the advertisement you want start.
[ Link ]
3.1.11
Start / Stop Raid
Action
This action allows you to start or stop a raid
Action
Start or stop the raid
User ID Type
the type of id of the user you want to use. The name or the id.
User ID
the actual id in regards to the Type. If using the name, Ensure to use the login name.
[ Link ]
Note: If this action is not executed, check the Touch Portal logs as the reason should be present in the logs.
1.9
Set Marker
Action
This action allows you to set a marker
Marker Name
the name of the marker
[ Link ]
Note: Markers cannot be added when your are not live (1), if VOD is not enabled (2), if the stream is a premiere (3) or when the stream is a rerun (4).
Note: The marker is created through the system, this means it is not created through the web interface and the feedback from that interface will not be present.
4.0
Channel Info To Value
Action
This action allows you to get channel information and store it in a Value
Data
The data to retrieve; Channel Title, Channel Game Title, Channel Game Id or Channel Tags
Value
the value to store the information in
[ Link ]
4.2
Streamers Channel Info To Value
Action
This action allows you to get channel information from any channel and store it in a Value
Data
The data to retrieve; Channel Title, Channel Game Title, Channel Game Id or Channel Tags
Login name
the login name of the twitch user / channel
Value
the value to store the information in
[ Link ]
2.2
Set Stream Category
Action
This action allows you to set the stream category
Category
the category name
[ Link ]
2.1
Set Stream Title
Action
This action allows you to set the stream title
Stream Title
the title of the stream
[ Link ]
3.1.11
Shield Mode
Action
This action allows you to disable or enable shieldmode
Action
Enable or Disable
User ID Type
the type of id of the user you want to use. The name, the id or yourself. When chosing yourself the third option will not show.
User ID (optional)
the actual id in regards to the Type. If using the name, Ensure to use the login name.
[ Link ]
3.1.11
Start / Cancel Timeout User
Action
This action allows you to set a timeout for a user
Action
start of cancel the timout
User ID Type
the type of id of the user you want to use. The name, the id or yourself.
User ID (optional)
the actual id in regards to the Type. If using the name, Ensure to use the login name.
Duration
The time of the timeout
Reason
the reason for the timeout
[ Link ]
4.0
Streamer Profile Pic Url To Value
- Pro Upgrade RequiredAction
This action allows you to retrieve the url of the streamers icon or offline image.
Action
Profile image or Offline image
User Name
The users loginname to get the images from
Value
the Value to store the url in
[ Link ]
3.1.11
Switch Mod Status Of User
Action
This action allows you to mod or unmod a specific user
Action
Mod or Unmod
User ID Type
the type of id of the user you want to use. The name or the id.
User ID (optional)
the actual id in regards to the Type. If using the name, Ensure to use the login name.
[ Link ]
1.9
Switch Slow Chat
Action
This action allows you to set the slow chat functionality
Time
The slow chat time or off
[ Link ]
3.1.11
Switch Unique Chat
Action
This action allows you to set the unique chat functionality
State
On or Off
[ Link ]
3.1.11
Switch Vip Status Of User
Action
This action allows you to set the VIP status of a user
State
VIP or UNVIP
User ID Type
the type of id of the user you want to use. The name or the id.
User ID
the actual id in regards to the Type. If using the name, Ensure to use the login name.
[ Link ]
1.9
Switch Emote Only Chat
Action
This action allows you to set the emote only chat functionality
State
On or Off
[ Link ]
1.9
Switch Followers Only Chat
Action
This action allows you to set the followers only chat functionality
State
On or Off
[ Link ]
1.9
Switch Subscribers Only Chat
Action
This action allows you to set the subscribers only chat functionality
State
On or Off
[ Link ]
3.1.11
Ban / Unban User
Action
This action allows you to ban or unban a user
Action
Ban or Unban
User ID Type
the type of id of the user you want to use. The name or the id.
User ID
the actual id in regards to the Type. If using the name, Ensure to use the login name.
Reason
the reason you want to specify for the banishment or the unbanishment.
[ Link ]
2.2
On New Subscriber
Event
This event allows you to listen for new subscribers.
Type
Only listen for the selected types of subscriptions
Tier
Only listen for the selected tiers of subscriptions
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.
[ Link ]
2.3
On Channel Point Redemption
Event
This event allows you to listen for channel points redemption.
Id
The id the of the channel point award. The id is the same as the name given in the Twitch interface to the channel point award. To create a Catch-All, use a * as the id.
[ Link ]
2.2
On Chat Message Event
Event
This event allows you to listen for incoming chat messages
Type
Select the types of chatters you want to trigger on
Comparator
the condition to meet to trigger
Text
the text to use with the comparator
2.2
On Receiving Bits
Event
This event allows you to listen for received bits between amounts
Start
the start of the range of bits received.
End
the end of the range of bits received.
[ Link ]
Note: This event listens for bits in between the two values specified. This means the numbers entered are not part of the range. If you want the event to trigger for when you receive 1 or 2 bits, use 0 to 3 as the range. It will then trigger for all numbers between 0 and 3, which are 1 and 2.
2.2
On Host
Event
This event allows you to listen for when another user starts to host your stream
[ Link ]
2.2
On Raid
Event
This event allows you to listen for when another user starts to raid your stream
[ Link ]
4.0
When Slow Mode Changes
Event
This event will listen to the slow chat being active or not
State
On or Off
[ Link ]
4.0
When Unique Mode Changes
Event
This event will listen to the unique chat being active or not
State
On or Off
[ Link ]
3.1.11
When Followers Only Chat Changes
Event
This event will listen to the followers only chat being active or not
State
On or Off
[ Link ]
4.0
When Emotes Only Chat Changes
Event
This event will listen to the emotes only chat being active or not
State
On or Off
[ Link ]
3.0
On New Whisper
Event
This event will listen for new whispers
Name
The username of the user that you received a whisper from
[ Link ]
3.0
On Gift Sub Bomb
Event
This event allows you to listen for gift sub bombs
Tier
The tiers to listen to
Start range
The start of the range of subs gifted
End range
The end of the range of subs gifted
[ Link ]
4.1
On User Ban Or Unban
Event
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.
[ Link ]
4.1
On Ad Break Start
Event
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
[ Link ]
4.1
When Channel Info Updates
Event
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.
[ Link ]
4.1
When Twitch Charity Campaign Starts / Progresses / Ends
Event
This event allows you to listen for Charity Campaign events.
Event Trigger
whether this event should trigger on the start, end or when there is progress.
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
[ Link ]
Note: Twitch does not guarantee that the begin message is sent before the initial progress message. Keep this in mind when using these events for complex setups.
4.1
When A Donation Is Made
Event
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
[ Link ]
4.1
When A Poll Begins / Progresses / Ends
Event
This event allows you to listen for Twitch Poll events.
Event Trigger
whether this event should trigger on the start, end or when there is progress.
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.
[ Link ]
4.1
When Hype Train Starts / Progresses / Ends
Event
This event allows you to listen for hypetrain events.
Event Trigger
whether this event should trigger on the start, end or when there is progress.
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.
[ Link ]
Note: Twitch does not guarantee that the begin message is sent before the initial progress message. Keep this in mind when using these events for complex setups.
4.1
When Twitch Goal Starts / Progresses / Ends
Event
This event allows you to listen for Goal events.
Event Trigger
whether this event should trigger on the start, end or when there is progress.
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.
[ Link ]
Note: Twitch does not guarantee that the begin message is sent before the initial progress message. Keep this in mind when using these events for complex setups.
4.1
When Twitch Prediction Starts / Progresses / Ends
Event
This event allows you to listen for Prediction events.
Event Trigger
whether this event should trigger on the start, end, when it locks or when there is progress.
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.
[ Link ]
Note: Twitch does not guarantee that the begin message is sent before the initial progress message. Keep this in mind when using these events for complex setups.
4.1
On Shout Out Received
Event
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.
[ Link ]
4.1
On Subscription End
Event
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.
[ Link ]
Streamlabs Desktop
1.6
Set Scene
Action
This action allows you to change the current scene
Scene
the scene to activate
[ Link ]
3.1
Set Scene Collection
Action
This action allows you to set the scene collection
Scene Collection
The scene collection to be set as active
[ Link ]
1.6
Source Visibility Toggle
Action
This action allows you to change the visibility of a source
Action
Hide, Show or toggle the visibility of the specified source
Scene
the scene that holds the source
Source
the source to handle
[ Link ]
2.1
Set Streaming State
Action
This action allows you to start and stop streaming
Action
Start, Stop or Toggle the streaming state
[ Link ]
2.1
Set Recording State
Action
This action allows you to start and stop recording
Action
Start, Stop or Toggle the recording state
[ Link ]
2.1
Replay Buffer
Action
This action allows you to start, stop and save a replay buffer
Action
Start, Stop or Save
[ Link ]
2.1
Set Studio Mode
Action
This action allows you to enable or disable Studio Mode
Action
Enable or Disable
[ Link ]
2.3
Execute Studio Mode Transition
Action
This action allows you to execute the Studio Mode transition.
Action
Enable or Disable
[ Link ]
1.6
Mute Volume
Action
This action allows you to mute and unmute an audio source
Action
Mute or Unmute
[ Link ]
1.8
When Scene Changes
Event
This event allows you to listen for scene changes
Comparator
the comparator
Scene
The scene to compare the new active scene with
[ Link ]
3.1
When Scene Collection Changes
Event
This event allows you to listen to scene collection changes
Comparator
how to compare with the new active scene collection
Scene Collection
the scene collection to compare and listen for
[ Link ]
1.6
When Source Visibility Changes
Event
This event allows you to listen to scene collection changes
Scene
The scene which holds the source
Source
the source to set the state of
State
the state of the visibility of the source
2.1
When Streaming State Changes
Event
This event allows you to listen to streaming state changes
Comparator
how to compare with the new streaming state
State
the streaming state to listen and compare to
2.1
When Recording State Changes
Event
This event allows you to listen to recording state changes
Comparator
how to compare with the new recording state
State
the recording state to listen and compare to
Xsplit
1.6
Toggle Source Visibility
Action
This action allows you to toggle the visibility of a source
Scene
the scene which contains the source
Source
the source to change the visibility of
[ Link ]
1.6
Set Recording
Action
This action allows you to change the recording state
Action
action for the recording state
[ Link ]
1.6
Set Streaming
Action
This action allows you to change the streaming state
Action
action for the recording state
Service
The streaming service to use
[ Link ]
1.6
Toggle Mute Volume Mic
Action
This action allows you to toggle the mute state of the main mic volume
[ Link ]
1.6
Toggle Mute Volume Speaker
Action
This action allows you to toggle the mute state of the main volume
[ Link ]
3.0
Set Volume Default Speaker
Action
This action allows you to change the volume of the main speaker
Volume
the volume of the main speaker
[ Link ]
3.0
Set Volume Default Mic
Action
This action allows you to change the volume of the main mic
Volume
the volume of the main mic
[ Link ]
3.0
Set Silence Detection
Action
This action allows you to turn on and off the silence detection
Action
Turn on or off the silence detection
[ Link ]
3.0
Set Noise Suppression
Action
This action allows you to turn on and off the noise suppression
Action
Turn on or off the noise suppression
[ Link ]
1.6
When Recording State Changes
Event
This event allows you to listen to changes in the recording state
Comparator
compare the new state with the give state
State
the state to compare with
1.6
When Scene Changes
Event
This event allows you to listen to scene changes
Comparator
compare the new state with the give state
Scene
the scene to compare the new active scene with
Photoshop
3.0
Bring Photoshop To The Front
Action
This action allows you to bring the Photoshop window to the front
[ Link ]
3.0
Set Tool
Action
This action allows you to select a tool in Photoshop
Tool
the Tool to set as the active tool in Photoshop
[ Link ]
3.0
Cycle Current Tools Group
Action
This action allows you to cycle through the tools in the current selected group of tools.
[ Link ]
3.0
Set Main Working Color
Action
This action allows you to set the main working color in Photoshop.
Type
Choose between the background color or the foreground color
Color
the actual color to set
[ Link ]
Note: Touch Portal executes scripts through the remote control system of Photoshop, this means that if you want to change both colors it will execute the script twice with a given delay. If you want to set both the background and the foreground color at once, use the set-both-working-colors action instead.
3.0
Set Both Main Working Colors
Action
With this action you set both colors in one go.
Foreground Color
The color to be set as the foreground color in Photoshop
Background Color
The color to be set as the background color in Photoshop
[ Link ]
Note: This action has better performance in comparison with using two separate actions for changing both the foreground and the background colors.
3.0
Set Visibility Current Layer
Action
With this action you can set the visibility to show or hide. You can also toggle the state.
Action
Show, Hide or Toggle the visibility of the layer
[ Link ]
3.0
Lock / Unlock Current Layer
Action
With this action you can lock and unlock the current layer
Action
Lock or Unlock the layer
[ Link ]
3.0
Set Opacity Current Layer
Action
With this action you can set the opacity of the current layer
Opacity
The percentage of the opacity
[ Link ]
3.0
Set Fill Current Layer
Action
With this action you can set the fill of the current layer
Fill
The percentage of the fill
[ Link ]
3.0
Set Blendmode Current Layer
Action
With this action you can set the blendmode of the current layer
Blendmode
The blendmode to set for the current layer.
[ Link ]
3.0
Set Text Content Current Layer
Action
With this action you can set the text of the current selected Text layer
Text
The text to set on the current selected Text Layer
[ Link ]
3.0
Set Current Brush Radius (smart)
Action
With this action you can set the radius of the currently selected Brush
Radius
The radius of the selected Brush should be set to.
[ Link ]
3.0
Set Current Brush Hardness (smart)
Action
With this action you can set the hardness of the currently selected brush
Radius
The hardness of the selected Brush should be set to.
[ Link ]
3.0
Resize Image
Action
With this action you can change the image size of the image.
Width
The new width of the image
Height
The new height of the image
[ Link ]
3.0
Resize Canvas
Action
With this action you can change the canvas size of the image.
Width
The new width of the image
Height
The new height of the image
Anchor
The anchor point from which you want to resize the canvas.
[ Link ]
4.0
Trim Image
Action
This allows you to trim the image on four sides by removing the transparent colums or rows.
Top
Option to include the top of the image for trimming.
YesNo
Right
Option to include the right of the image for trimming.
YesNo
Bottom
Option to include the bottom of the image for trimming.
YesNo
Left
Option to include the left of the image for trimming.
YesNo
Note: Trimming is done with only full rows or columns of fully transparent visible pixels. If hidden layers have non-transparent pixels they will be cut from the image.
4.0
Execute Custom Photoshop Script
Action
This action allows you to write your own script and execute it within Photoshop
Script
the script to be passed to Photoshop to execute
[ Link ]
Note: Documentation for Photoshop scripting can be found here: https://helpx.adobe.com/photoshop/using/scripting.html
3.0
When
Event
This events allows you to listen to when the tool is changed
Comparator
how to compare the new selected tool against the given tool
Tool
The tool to compare the new selected tool with using the comparator
[ Link ]
3.0
When Current Tool Radius Changes
Event
This events allows you to listen to when the radius is changed
Comparator
how to compare the new selected radius against the given radius
Tool
The radius to compare the new selected radius with using the comparator
[ Link ]
3.0
When Current Tool Hardness Changes
Event
This events allows you to listen to when the hardness of a brush is changed
Comparator
how to compare the new selected hardness against the given hardness
Tool
The hardness to compare the new selected hardness with using the comparator
[ Link ]
3.0
When Current Layer Visibility Changes
Event
This events allows you to listen to when the current layer becomes visible or hidden
State
The visibility of the layer to check for.
VisibleHidden
[ Link ]
3.0
When Current Layer Locked State Changes
Event
This events allows you to listen to when the current layer becomes locked or unlocked
State
The locked state of the layer to check for.
LockedNot Locked
[ Link ]
Hue
2.1
Turn On / Off
Action
This action allows you to turn on and off lights, zones and rooms
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
State
the state to set the entity to.
2.1
Set Color
Action
This action allows you to set the color of lights, zones and rooms
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Color
the color to set the entity to.
2.3
Set Color
Action
This action allows you to set the brightness of lights, zones and rooms
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Brightness
the brightness to set the entity to.
2.1
Change Brightness
Action
This action allows you to change the brightness of lights, zones and rooms from relative to the current value
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Brightness
the brightness increase or decrease
2.3
Set Color Temperature
Action
This action allows you to change the color temperature of lights, zones and rooms
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Color Temperature
the color temprature value
2.3
Change Color Temperature
Action
This action allows you to change the color temperature of lights, zones and rooms relative to the current value
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Color Temperature
the color temprature value increase or decrease
2.3.2
Set Scene
Action
This action allows you to set the scene for rooms or zones
Bridge
The bridge that has the entity set up
Entity Type
The entity type; room or zone
Entity Name
The entity name/id
Scene
the scene to set
2.1
Set Special Effect
Action
This action allows you to start a special effect for lights, rooms or zones
Bridge
The bridge that has the entity set up
Entity Type
The entity type; light, room or zone
Entity Name
The entity name/id
Effect
the special effect to set
