Understanding global Events

Getting started with Touch Portal

This guide will help you understand the Events system of Touch Portal.

Global Events vs buttons On Event

The Events section in Touch Portal allows you to create events that are always triggered when Touch Portal is running. It does not matter on which page you are on your mobile device. This is different to the events that are part of a button. Those events should be used to act on events where your goal is to do something with that button. They will only trigger when the button is active on your mobile device.

Using Events

You can manage your Events from the main menu by clicking on the "Events" menu item and that will show you the above screen. When using it for the first time your screen will be empty of course but in this example we already have an Event.

Each event will be shown in a block (2) where all the details of this Event and other usefull information is shown. This block will also show you feedback when the Event is being triggered. This will help you with seeing whether or not an Event is actually triggered, is being blocked or when nothing happens.

You can pause an event by pressing on the pause button. It will turn grey to show you that the event will not listen to anything. You can also use special Touch Portal Actions to turn on and off Events in your buttons for dynamic usage of your setup. You can for example only turn on all your Twitch Events when you go Live and add that action to the Go Live button.

Let us create our first global Event by clicking on the "Add Event" button.(1)

A new Event

Name

This is the screen where you can setup an global Event. To identify and to be able to use the Event we need to give it a name (1).

Event

The second option (2) to set is which event you want to listen to. These events are the same events you could also add to the On Event section of a button. When you select an event, the visual representation will appear (5) where you can set up the event with the desired settins. In our case we want to listen to when the contents of the specific file changes.

Cooldown Time

For each event you can set a cooldown (3) period. When the event is triggered, the cooldown time is the time that is waited before the event will listen again to the event. So in our case we added a cooldown of 1000 milliseconds, which is 1 second. So if the file we specified is triggered again within a second after the first time it triggered, we discard that event due to the cooldown time of 1 second.

Queue Lane

You can assign a queue lane (4) to the Event. If an event is assigned to a queue lane it will be put in that specific queue and will execute the flow of actions only when it is its turn.

Lets say you have a Twitch Channel Points redemption event. If you do not use a queue and two users will redeem their channel points at the same time the event will trigger two times almost on the same moment. This can result in undesired effects. If the event is queued to lane 1 for example this won't be an issue anymore. In that case the event will be triggered and executed. The second redemption then is queued and will execute when the first has completed.

Having one big queue is not the most dynamic way of handling this kind of situations when you have a complex setup so we have added a few so you can choose yourself which events should be in the same queue. For example when you have one event for playing a sound and the other for showing a source animation or something. You might want to put them in their own queue lane as they do not interfere with each other.

Flow of Actions

For each event you have to specify a flow of actions (6) that are executed when the event occurs. As Events are not connected to a page or a button they cannot trigger page or button specific actions such as Change-Button-Visuals actions and other like that.


Back to Guide Overview