Upload alternate images

Associate multiple image variations that enable you to showcase a media item in any location


👍


This is a beta offering.

By using this documentation, you are agreeing to abide by the terms of the JWP Beta Program Agreement


Each uploaded media item in your JWP account has a thumbnail image associated with it. This image is shown as a preview in the player until content playback begins.

This thumbnail image also can be used to promote the media item. However, you might need variations of this thumbnail to increase viewer engagement and to accommodate specific platform requirements:

  • Using an image with an overlay of text
  • Showcasing a media item on a Roku device with a 9:13 aspect ratio image and on web with a 16:9 aspect ratio image

To accommodate scenarios such as these, you can upload and label multiple alternate thumbnails to your JWP dashboard.

📘

JWP removes all sensitive metadata when an image is uploaded to protect privacy and ensure user security. Image capture tools can add sensitive metadata (known as EXIF) to images, including GPS location of the picture, time of day, and the camera used.



Standards

A custom static preview file should adhere to the following standards.

Standard Information
Accepted file formats
  • .jpg
  • .png
  • .webp
Number of active images 20 maximum per video
File size limit ≤ 50 MB
File resolution Highest available resolution


Upload alternate images

🔑

If you are a developer or have developer resources, you can use the Management API to upload alternate images.

Use the following steps to upload alternate images to a media item:

  1. From your Media Library, click the name of a video. The detail page for the video appears.
  2. In the Additional Images section, click Manage Images. The Additional Images popup window appears.
  3. Click Add an Image.
  4. Click Choose File to choose and upload a high-resolution, custom image file.

    📘

    When a request for an image is made to the JWP Delivery API, the image is dynamically resized. As a result, it is best to use high-resolution images for your alternate images.

  5. In the Create Label textbox, type a unique label for the uploaded image. This label can only contain letters, numbers, underscores, and dashes. The label is used to identify the correct image to display.
  6. Click Create Label to apply the label to the image. The label will appear in the Selected Image Label section.

    💡

    If you have existing labels associated with your account, you can click on a label name from the Available Image Label box to apply to the uploaded image.

  7. Click Save.


Alternate Images in the Web App

The Web App uses predefined labels, which you can use to customize the user experience. To add an alternate image to the JWP Web App, follow these steps:

  1. Upload an alternate image (steps 1-4).

  2. In the Create Label textbox, enter a Web App-supported label for the uploaded image. This label is used to identify the correct image to display.

    📘

    The Web App’s logic contains an image fallback pattern, allowing app partners to minimize loading time. If no image exists for the requested label, the Web App will use the standard thumbnail (poster) image.

    By default, the JWP Web App has three predefined image labels. Please note that JWP app partners may support different labels. Contact your partner representative to upload alternate images on their app.

    LabelDescription
    cardShelf image of a media item seen in the Web App’s library



    NOTE: Shelf images in the Web App default to a 16:9 aspect ratio. Follow these steps to customize card size:
    1. From the Playlists page, select a playlist. The playlist settings appear.

    2. On the Playlist Metadata tab, under Custom Parameters, add a custom parameter for cardImageAspectRatio with your desired aspect ratio as the value. The Web App supports the following aspect ratios: 2:1, 5:3, 4:3, 1:1, 9:13, 2:3, and 9:16.

    3. Click Save.
    backgroundPoster image of a media item seen upon selecting the media

    channel_logo_logoStreaming logo of live channel seen in the EPG

  3. Click Create Label to apply the label to the image. The label will appear in the Selected Image Label section.

    💡

    If you have existing labels associated with your account, you can click on a label name from the Available Image Label box to apply to the uploaded image.

  4. Click Save.