Session Timer
The Session Timer Provides either a single or multi-sector timer.
This is a 1st party module designed to be used with the Session Timer user interface component when creating Interfaces.
This module is ideal for creating timers for fitness venues, escape rooms, interactive installations and more. It does not require an network patch.
Think of a sector as a set length of time within a session:
i.e. if we use a fitness session as an example, a 5-minute sector called "warm-up" at the start of the session, the second sector would be called "exercise" for 20 minutes, and a sector created for the last 5 minutes called "cool down".
We can automate the session by setting auto-continue to ON or allow the instructor to manually advance the session by setting it to OFF. To stop the timer at the maximum duration, set Allow Overrun to OFF.
Multiple sectors can be set to run back to back or manually advanced by an end user through a Ctrl Player Interface using the Global Timer Interface component or Sector Timer Interface Component.
| Module Rating | |
|---|---|
| Quality of API | N/A |
| Implementation | 3/3 |
| Status | Complete |
See the Modules Overview article for more information about how Module Ratings are calculated.
Module Settings
Settings for this module can be accessed using the pencil icon on the module created within the nodes view.
Multiple Running Sectors
Define if the module can support multiple sectors counting in parallel, or if only one can be run at a time within a session.
Sectors
Define each sector by giving it a:
- Name - An identifier for each sector.
- Duration - Define the length of each section.
- Auto Continue - If set to yes, the module will automatically start the next sector as soon as the previous one has completed.
- Allow Overrun - If set to Yes, the module will continue to cant past the time defined for the sector.
Options
Upon receiving an Input, the Session Timer is triggered, if sucessful, the Triggered outlet will send data. If unsucessful, or the data entered within the block's fields is invalid, the Error outlet sends data.
| Endpoint | Option 1 | Option 2 | Notes |
|---|---|---|---|
| Start | Sector [String] | Offset String | When triggered, the Sector begins counting. An offset can be applied. |
| Pause | Sector [String] | - | Pause the Sector. |
| Stop | Sector [String] | - | Stop the Sector. |
| Reset | Sector [String] | - | Reset the time in the Sector. |
| Next | Sector [String] | - | Jump to trigger the next Sector. |
| Set Duration | Sector [String] | Duration String | Set the duration of a given sector to allow a user to modify it. |
Events react to changes in the Session Timer. Upon the Target state defined in the block being matched, the Triggered outlet will send data.
| Event | Option1 | Notes |
|---|---|---|
| Did Global State | - | Sends a trigger upon any change taking place. |
| Time Changed | Sector [String] | Sends a trigger if the time within the target Sector is changed. |
| State Change | Sector [String] | Sends a trigger if the state in the target Sector changes. |
| Did Complete | Sector [String] | Sends a trigger once the time defined in the sector elapses. |
| Did Overrun | Sector [String] | Sends a trigger if the time defined within the sector overuns. |