Skip to content

TIME UNTIL...

XtoMHA96 edited this page Oct 28, 2023 · 5 revisions

Main Options

These are the primary options for this browser source in the main window:

Cdowntime

Here's what these options do:

  • 👁️ -> This option opens a preview window of the browser source.
  • 📄 -> This option copies the URL that you should configure in OBS to capture the browser source.
  • ⚙️ -> This option opens a window displaying all the configurable source options. Further down, you can see each of these options detailed.
  • 🗑️ -> This option deletes the source and all of its saved configurations.

Control from the Browser

Control-Cdowntime

This new window has the following options:

  • Two control buttons -> Start/Pause and Reset that pause, resume, and reset the timer.
  • A row to add time -> A row of buttons with predefined times to add to the timer.
  • An editor for the end date and time -> An editor for setting the date and time when the browser source's timer will end.
  • An editor for the timezone of the date and time -> An editor for the reference date and time for the browser source's timer.
  • A row to subtract time -> A row of buttons with predefined times to subtract from the timer.
  • A message editor -> An editor for the message that will appear when the timer expires. If not defined, it will display the time at 0 in the selected format.
  • A format selector* -> The ability to change the format in which the timer is displayed in the browser source. Please note the following meanings:
    • TT -> It will display the total sum of this unit of time.
    • (TT:) or (tt:) -> It will only display if that unit of time is different from zero.
    • tt -> The unit of time as defined in the standard format.
    • .000 -> It will display milliseconds at the end.
  • A font selector -> The option to change the font of the timer text in the browser source.
  • A numeric control -> The ability to adjust the text size of the timer in the browser source.
  • Three buttons to modify the format -> The ability to modify the format of the text in the browser source.
  • Three alignment buttons -> The ability to modify the alignment of the text in the browser source.
  • A color selector -> The ability to change the color of the text in the browser source. You can select a color or use its hexadecimal code.

*You can suggest more time formats by making a request at: Feature Request

Control via WebSockets Sending

Several WebSockets are available for use with StreamDeck or similar applications. In these URLs, you need to replace {PORT}, which is the connection port defined in the code (by default, it's set to 5001).

Following the examples provided on this Wiki page, we'll use cdowntime01. However, you can modify the URL for other sources if needed.

  • localhost:{PORT}/cdowntime01/control&addtime={ttxx} -> Adds time to the timer.

  • localhost:{PORT}/cdowntime01/control&subtime={ttxx} -> Subtracts time from the timer.

    • {ttxx} should be replaced with the desired time and its unit for addition or subtraction. Available time units include:
      • y -> year
      • mh -> month
      • w -> week
      • d -> day
      • h -> hour
      • m -> minute
      • s -> second
      • ms -> millisecond

    For example:

    localhost:{PORT}/cdowntime01/control&addtime=1m

    localhost:{PORT}/cdowntime01/control&subtime=60s

Clone this wiki locally