com.jwplayer.pub.api.media.playlists

Class PlaylistItem.Builder

java.lang.Object

com.jwplayer.pub.api.media.playlists.PlaylistItem.Builder

Enclosing class:

PlaylistItem

public static class PlaylistItem.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(PlaylistItem src)

Method Summary

Modifier and Type	Method and Description
PlaylistItem.Builder	adSchedule(java.util.List<AdBreak> adSchedule)
PlaylistItem	build()
PlaylistItem.Builder	description(java.lang.String description)
PlaylistItem.Builder	duration(int durationInSeconds)
PlaylistItem.Builder	externalMetadata(java.util.List<ExternalMetadata> externalMetadata)
PlaylistItem.Builder	feedId(java.lang.String feedId)
PlaylistItem.Builder	file(java.lang.String file)
PlaylistItem.Builder	httpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)
PlaylistItem.Builder	imaDaiSettings(ImaDaiSettings imaDaiSettings)
PlaylistItem.Builder	image(java.lang.String image)
PlaylistItem.Builder	mediaDrmCallback(MediaDrmCallback callback)
PlaylistItem.Builder	mediaId(java.lang.String mediaId)
PlaylistItem.Builder	recommendations(java.lang.String recommendations)
PlaylistItem.Builder	sources(java.util.List<MediaSource> sources)
PlaylistItem.Builder	startTime(double startTime)
PlaylistItem.Builder	title(java.lang.String title)
PlaylistItem.Builder	tracks(java.util.List<Caption> tracks)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Builder

public Builder(PlaylistItem src)

Method Detail

title

public PlaylistItem.Builder title(java.lang.String title)

Parameters:

title - Title of the item. This is displayed inside of the player prior to playback, as well as in the visual playlist. This can be hidden with the PlayerConfig.setDisplayTitle() option.

description

public PlaylistItem.Builder description(java.lang.String description)

Parameters:

description - Short description of the item. It is displayed below the title. This can be hidden with the PlayerConfig.setDisplayDescription() option.

file

public PlaylistItem.Builder file(java.lang.String file)

Parameters:

file - The media file for this playlist item.

image

public PlaylistItem.Builder image(java.lang.String image)

Parameters:

image - Poster image URL. Displayed before and after playback.

mediaId

public PlaylistItem.Builder mediaId(java.lang.String mediaId)

Parameters:

mediaId - Unique identifier of this item. Used by advertising, analytics and discovery services.

feedId

public PlaylistItem.Builder feedId(java.lang.String feedId)

Parameters:

feedId - Unique identifier of this item. Used by Related/Recommendation services.

recommendations

public PlaylistItem.Builder recommendations(java.lang.String recommendations)

Parameters:

recommendations - URL to a feed that contains related items for a particular playlist item.

sources

public PlaylistItem.Builder sources(java.util.List<MediaSource> sources)

Parameters:

sources - Used for quality toggling and alternate sources.

tracks

public PlaylistItem.Builder tracks(java.util.List<Caption> tracks)

Parameters:

tracks - Include captions, chapters, and thumbnails for media.

adSchedule

public PlaylistItem.Builder adSchedule(java.util.List<AdBreak> adSchedule)

Parameters:

adSchedule - Schedule advertising for a specific media file.

mediaDrmCallback

public PlaylistItem.Builder mediaDrmCallback(MediaDrmCallback callback)

Parameters:

callback - DRM callback instance -- used for Widevine DRM.

imaDaiSettings

public PlaylistItem.Builder imaDaiSettings(ImaDaiSettings imaDaiSettings)

externalMetadata

public PlaylistItem.Builder externalMetadata(java.util.List<ExternalMetadata> externalMetadata)

httpHeaders

public PlaylistItem.Builder httpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)

Parameters:

httpHeaders - HTTP Headers to include with requests for this media file.

startTime

public PlaylistItem.Builder startTime(double startTime)

Parameters:

startTime - value that defines the start time for playlist items

duration

public PlaylistItem.Builder duration(int durationInSeconds)

Parameters:

durationInSeconds - value used to display the duration of the video

build

public PlaylistItem build()