Skip to content

Overlay Widgets

Jump to bottom
Matthew Olivo edited this page Aug 2, 2019 · 13 revisions

Overlay Widgets

The Overlay Widgets feature allows you to show static content on your overlay that can be updated as time goes on. Normally, Overlay items only show for a brief period of time and then disappear. With Overlay Widgets, you're able to show certain content constantly on your stream and add all new features for your users to take advantage of.

Widgets are refreshed every X many seconds based on the number you have set in the bottom of the page, though there are some widgets that specifically refresh on their own time schedules and can not be changed from that.

Overlay Widget Example

When adding a widget, you assign both a name and overlay to show the widget on. You can also optionally prevent the widget from auto-refreshing. Some of the more basic widgets will look exactly as they do with Overlay Actions (EX: Text, Image, Video, etc).

The more advanced widgets allow you a large degree of freedom to customize them based on your skill level. You can use the pre-defined options to change things like the sizing, font, colors, & animations used. If you're more advanced, you can also customize how the widget is shown directly by changing the HTML for it. You can change it design to your hearts content and also use any Special Identifiers you want inside of the HTML.

Overlay Widget Types

When creating a new widget, you need to select the type of widget that is shown. Below is a list of all the different types of widgets that are available:

  • Chat Messages - Shows the last X many chat messages from your channel. Chat messages are added as they occur.

  • Event List - Shows the last X many events that have occurred in your channel. Events are added as they occur.

  • Game Queue - Shows a block of text. Events are added as they occur.

  • Goal/Progress Bar - Shows a progress bar for a specified goal. Progress is updated as events occur or on user-defined refresh Interval.

  • HTML - Shows HTML code directly on the overlay. Refreshes based on user-defined Refresh Interval.

  • Image - Shows an image. Refreshes based on user-defined Refresh Interval.

  • Leaderboard - Shows the top X users in a specified category. Leaderboard positions are updated as events occur or on user-defined refresh interval

  • Stream Clip Playback - Shows the video & audio footage of a Stream Clip when it is taken.

  • Song Requests - Show the top X songs currently in the song request queue. Song requests are added as they occur.

  • Spark Crystal - Shows the current progress on the channel's spark crystal patronage. Progress is updated as spark patronage occurs.

  • Stream Boss - Shows a user from your channel as a "boss" that can be damaged by performing actions in your channel until they are defeated and a new boss is selected. Damage is added as it occurs. The Stream Boss Special Identifiers can be used in parallel with this overlay widget.

  • Text - Shows a block of text. Refreshes based on user-defined Refresh Interval.

  • Ticker Tape - Shows a scrolling list of text of the last X many users that caused a specified event to occur. Users are added to the list as the event occurs.

  • Timer - Shows a timer that counts down while it is visible. Hiding the timer resets the amount.

  • Timer Train - Shows a timer that counts down and can be increased by performing certain actions in your channel. It is only shown when total time exceeds the Minimum Seconds To Show value. Time updates as events occur.

  • Video - Shows a video. Refreshes based on user-defined Refresh Interval.

  • Web Page - Shows a web page. Refreshes based on user-defined Refresh Interval.

  • YouTube - Shows a YouTube video. Refreshes based on user-defined Refresh Interval.

Clone this wiki locally