HDOnTap

Snapshot Proxy Portal Feature

Updated 3 min read

Overview

The HDOnTap Snapshot Config Tool is a quick and easy way to generate images of your live stream that update automatically at a regular interval. These images can be branded with your logo or a live icon. Most often they are used as thumbnail images for your website that link to your live stream, as social sharing thumbnails or as a backdrop for a stream that does not autoplay.

Prerequisites

  • You must have your Portal login. Contact your Customer Administrator or HDOnTap Support if you need assistance with your Portal credentials.

Step-by-step instructions

1. Log in to the HDOnTap Portal and navigate to Streaming > Snapshot Configs:

Portal dashboard with the Streaming tile highlighted

Portal Streaming menu with Snapshot Configs highlighted

2. Click the plus button Plus button to add a new snapshot.

Fill out the Add New Snapshot Config form and click Save Changes when finished.
Add New Snapshot Config form

Note: AVMix (which combines separate audio and video streams) is set up by HDOnTap staff for now. If you would like AVMix for your account, contact support at 858.481.4096, Option 2. If AVMix is already enabled, select the appropriate radio button (“Use Stream” or “Use AVMix”) for the snapshot you are creating.

Stream ID
Select your desired stream from the drop-down menu.

Snapshot ID
This will auto-populate with the name of the stream. We recommend that you append this with “-[descriptor]” so that you can easily determine what the snapshot is for. For example: redtailhawk_hdontap-SDNEWS

Offline Image (optional)
This will replace the live snapshot if your stream is offline. You may choose No Poster, the HDOnTap “Stream Offline” image (recommended), or upload a custom image.
Note: You must have previously uploaded the custom image you wish to use. Learn how to upload images.

Overlay (optional)
An image that is displayed over the live stream snapshot.

Select the image you would like to use as your overlay from the Stream Overlay Image drop-down menu. Select the location of the overlay from the Overlay Position drop-down menu and set the Overlay Stand-Off X and Y values (the pixel distance from the top/bottom edge X and side edge Y of the player). Select Responsive Overlay to allow the overlay to resize based on the size of the snapshot.

Set the Opacity value for the overlay (0=invisible, 100=completely opaque).

Note: You must have previously uploaded any custom image you wish to use. Learn how to upload images. For your convenience, we have already uploaded a live bug: Live bug: white LIVE text on a red banner

Cache Interval
This controls how frequently (in seconds) your snapshot updates. For example: entering a cache interval of “60” would refresh the image every 60 seconds.

Default Snapshot Resolution
This is the size of your image. If you would like to change the size from the default of 640 pixels by 360 pixels, we recommend you use our Player Sizing Tool.

URL for Snapshot Image Link
This is the URL that the snapshot will link to in the output code. We recommend you use the URL of the page where your live stream is hosted.

Notes/Description (optional)
Add any relevant notes or information about your snapshot.

3. Click the Snapshot ID or URL Link icon to preview your snapshot:
Snapshot Configs list with a Snapshot ID highlighted and a Get Snapshot Proxy URL tooltip

Snapshot preview with the Static URL and Embed Code fields highlighted above a live snapshot
If you need to make any changes to your snapshot config, click Edit Config in the upper left-hand corner of the preview section, make changes, and click Save Changes when complete.

4. Copy either the Static URL or the Embed Code, then place it in the desired location on your site.
Static URL
This URL will display the snapshot as it is currently configured and will NOT update if the snapshot is edited in the Portal.

Embed Code
Paste this embed code on your website. Any updates made to this snapshot in the Portal (for example, changing the overlay) will update automatically on your site.
Note: If you wish to update the URL that the snapshot links to, that will need to be updated within your website’s code – it will not automatically update if you make changes after embedding the snapshot on your website.

Tip: You can click on the text or copy icon Copy icon of either the Static URL or the Embed Code to copy them automatically. Otherwise, copy by highlighting the text then pressing Ctrl+C (PC) or ⌘+C (Mac). Paste the code by pressing Ctrl+V (PC) or ⌘+V (Mac).

5. Editing your snapshots

If you need to make any changes to your snapshot, click the edit icon Edit icon, make any changes and click Save Changes when complete:

Snapshot Configs list with the Edit snapshot tooltip on the edit icon

6. Deleting your snapshots

Click the edit icon Edit icon and click Remove Snapshot:

Edit snapshot form with the Remove Snapshot button highlighted

Still need help?

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