Skip to main content

14 docs tagged with "overlays"

View All Tags

Alerts

This overlay/dock is used to display multiplatform alerts to viewers. These alerts can have custom messages, images, and sounds.

Chat

This overlay/dock is used to display a multiplatform chat, either for the spectators or for the streamer.

Concepts

Our tools are structured around different concepts for which it is important to have an overview before going into details.

CSS framework

We provide a CSS framework intended to help you in the development of overlays and docks as well as the application of themes on these. Below you will find all the variables and classes exposed, grouped by category.

Develop a theme

Once you become familiar with the concept of theme, you will probably want to develop your own. This page therefore serves as a quick "tutorial" so that you can master the main blocks constituting the creation of a theme applicable to overlays and/or docks.

Develop an overlay

Once you become familiar with the concept of overlay, you will probably want to develop your own. This page therefore serves as a quick "tutorial" so that you can master the main blocks constituting the creation of an overlay capable of receiving and emitting events but also using the OBS JavaScript API.

Featured

This overlay, intended to be integrated into your OBS installation in the form of a browser source, goes hand in hand with the dock of our Chat overlay and allows you to highlight the chat messages of your choice on your stream. For example, during a frequently asked questions (FAQ) or an interview, your viewers will be able to more easily identify the topic being discussed.

Hosting

After developing your own adapters, overlays and themes it is necessary that those are hosted and served over HTTPS for use in our system. Adapters and overlays are HTML pages that can be displayed in iframes, themes are simple CSS files; their hosting is therefore standard in the Web development world.

JavaScript framework

We provide a JavaScript framework intended to help you in the development of adapters, overlays and docks. Below you will find all the exposed constants, functions and classes, grouped by category.

OBS

The best free software for streaming and recording videos.

Overlays

Overlays, such as described previously, are distributed as HTML pages served over HTTPS. They are displayed using our wrapper and use our JavaScript and CSS frameworks to receive (observe) and send (emit) events as well as use the OBS JavaScript API.

Polls

This overlay/dock is used to display and administer multiplatform surveys.

Themes

Our dock and each overlay can be presented differently from their default styles thanks to the theme feature. It simply is a matter of writing CSS code, based on our CSS framework, and using the theme parameter provided for this purpose. There are two ways to configure this parameter to apply the theme of your choice.

Wrapper

Our wrapper, such as described previously, is distributed in the form of an HTML page present at the following address: