HDOnTap

Player Overlay Options

Updated 2 min read

Overview

The Image Overlay is an image that is overlaid on your stream in the player window:

Live beach stream with an HDOnTap logo overlay marked by an arrow in the top-left corner

Prerequisites

Step-by-step instructions

1. Begin by logging in to the HDOnTap Portal and navigating to Streaming > Embed Configs:
Portal dashboard with the Streaming tile highlighted

Portal Streaming menu with Embed Configs highlighted

If you are creating a new embed config, see Customizing the Webcam Stream Embed. If you are editing an existing embed config, click the edit icon Edit icon for that config. In either case, set your Overlay preferences in the Overlay section:

Embed config with the Overlays tab highlighted

2. Choose your overlay settings:

Overlays image settings numbered one through six: Stream Overlay Image, Overlay Position, URL for Overlay, Is Responsive, Opacity and Overlay Stand-Off

3. Select the image you would like to use as your overlay from the Stream Overlay Image drop-down menu. For instructions on uploading images, see Uploading Images to the Portal.

4. Select the location of the overlay from the Overlay Position drop-down menu.

5. Enter the (optional) website address that you would like to link to the overlay image in the URL for Overlay field.
Note: This must begin with “http://” or “https://”.

6. If you would like your overlay to increase in size with the player size, toggle on the Is Responsive option. See below for more information on responsive settings.

7. Set the Opacity for the overlay (where 0 is invisible and 100 is completely opaque).

8. Set the (optional) Overlay Stand-Off (In %) to move the overlay image away from the edges of the player. By default, we recommend using no value in the overlay stand-off fields unless you need to reposition the overlay.

Responsive settings

Responsive settings with the Max Width and X-Size fields numbered one and two

  1. Set the Max Width (In Pixels) – this is the maximum width that the overlay will scale to.
  2. Set the X-Size (In %) – this is the percentage of the player width that the overlay will be until it reaches the Max Width. For example, “10” means that the overlay will be 10% of the width of the player.

Weather widget

Weather Widget settings including Enable Widget, Coordinates Source, Label, Fade After, Default Temp Units, Position and Background Opacity

  1. Click (optional) Enable Widget to turn the Weather Widget on or off.
  2. Select a Coordinates Source from the drop-down menu: use the device’s GPS (Global Positioning System) coordinates or enter custom GPS coordinates.
  3. Put your custom GPS Coordinates in this field if you have custom coordinates set as your source.
  4. Title the weather widget with the Label field. This turns on a title/header for the widget with the text in the right input field.
  5. Set a Fade After value, which sets the time before the weather widget fades.
  6. Default Temp Units will adjust the measurement units of the displayed temperature.
  7. Select a Position of the anchor for the widget from the drop-down menu. If a position is greyed out, it is already in use by the image overlay.
  8. Adjust the Background Opacity of the dark box behind the weather widget.

Still need help?

Contact the HDOnTap support team at [email protected] or submit a support request.