Set up Recommendations (Android)

If you have hundreds of videos hosted on or registered with your account, Recommendations automates the generation of a playlist based on a seed video and provides you options to customize the appearance and behavior of that playlist.

Requirements

In addition to the general Android SDK requirements, the following items are required to implement Recommendations.

Configure the Recommendations display options

The following steps explain how to create the Recommendations overlay:

1. Create a recommendations playlist in your JWP dashboard.
2. After creating the recommendations playlist, on the DEVELOPER RESOURCES tab of the JWP dashboard, copy the JSON URL.
3. In your app, use Related.Config.Builder() to create and name a RelatedConfig object, for example, related.
4. Add the JSON URL (file). Be sure to change the value of the ?related_media_id= query to match the media ID of the playlistItem.file URL.
5. (Optional) Define autoPlayTimer. This creates a break between the playback of videos and enables the countdown overlay to appear. The default value is 10 (seconds).
6. (Optional) Define onComplete as RELATED_ON_COMPLETE_AUTOPLAY. This property helps to extend a user's viewing session.
7. (Optional) Use autoPlayMessage property to define the message that displays when the countdown overlay appears. We suggest using __title__ will begin in xx seconds.
   
   The countdown message appears above the title and description of the next video to play. The default message is Next up in xx. In the default message, xx represents the number of seconds remaining in the countdown as defined by autoPlayTimer.

8. Add related to config.

PlaylistItem playlistItem = new PlaylistItem.Builder()
    .file("https://cdn.jwplayer.com/manifests/{MEDIA_ID}.m3u8")
    .image("https://www.mydomain.com/poster.jpg")
    .title("Playlist-Item Title")
    .description("Some really great content")
    .build();


RelatedConfig related = new RelatedConfig.Builder()
    .file("https://cdn.jwplayer.com/v2/playlists/{RECOMMENDATIONS_ID}?related_media_id={MEDIA_ID}")
    .autoPlayTimer(10)
    .onComplete(RELATED_ON_COMPLETE_AUTOPLAY)
    .autoPlayMessage("__title__ will begin in xx seconds")
    .build();
List<PlaylistItem> playlist = new ArrayList<>();
playlist.add(playlistItem);
PlayerConfig config = new PlayerConfig.Builder()
    .playlist(playlist)
    .relatedConfig(related)
    .build();
mPlayer.setup(config);

Related Overly API Methods

Related Overlay Callbacks