com.longtailvideo.jwplayer.media.playlists

Class PlaylistItem

java.lang.Object

com.longtailvideo.jwplayer.media.playlists.PlaylistItem

All Implemented Interfaces:

com.longtailvideo.jwplayer.utils.Jsonable

public class PlaylistItem
extends java.lang.Object
implements com.longtailvideo.jwplayer.utils.Jsonable

An item in a Playlist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaylistItem.Builder

Constructor Summary

Constructors

Constructor and Description
PlaylistItem()
PlaylistItem(PlaylistItem src)
PlaylistItem(java.lang.String file)
PlaylistItem(java.lang.String title, java.lang.String description, java.lang.String file, java.lang.String image, java.lang.String mediaId, java.util.List<MediaSource> sources, java.util.List<Caption> tracks, java.util.List<AdBreak> adSchedule, java.util.Map<java.lang.String,java.lang.String> httpHeaders, java.lang.String recommendations)

Method Summary

Modifier and Type	Method and Description
static java.util.List<PlaylistItem>	cloneList(java.util.List<PlaylistItem> src)
java.util.List<AdBreak>	getAdSchedule()
java.lang.String	getDescription()
java.lang.String	getFile()
java.util.Map<java.lang.String,java.lang.String>	getHttpHeaders()
java.lang.String	getImage()
MediaDrmCallback	getMediaDrmCallback()
java.lang.String	getMediaId()
java.lang.String	getRecommendations()
java.util.List<MediaSource>	getSources()
java.lang.String	getTitle()
java.util.List<Caption>	getTracks()
static java.util.List<PlaylistItem>	listFromJson(org.json.JSONArray json)
static java.util.List<PlaylistItem>	listFromJson(java.lang.String json)
static PlaylistItem	parseJson(org.json.JSONObject json)
static PlaylistItem	parseJson(java.lang.String json)
void	setAdSchedule(java.util.List<AdBreak> adSchedule)
void	setAdScheduleInternal(java.util.List<AdBreak> adSchedule)
void	setCaptions(java.util.List<Caption> tracks)
void	setDescription(java.lang.String description)
void	setFile(java.lang.String file)
void	setHttpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)
void	setImage(java.lang.String image)
void	setMediaDrmCallback(MediaDrmCallback callback)
void	setMediaId(java.lang.String mediaId)
void	setRecommendations(java.lang.String recommendations)
void	setSources(java.util.List<MediaSource> sources)
void	setTitle(java.lang.String title)
org.json.JSONObject	toJson()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaylistItem

public PlaylistItem(java.lang.String title,
                    java.lang.String description,
                    java.lang.String file,
                    java.lang.String image,
                    java.lang.String mediaId,
                    java.util.List<MediaSource> sources,
                    java.util.List<Caption> tracks,
                    java.util.List<AdBreak> adSchedule,
                    java.util.Map<java.lang.String,java.lang.String> httpHeaders,
                    java.lang.String recommendations)

PlaylistItem

public PlaylistItem(java.lang.String file)

PlaylistItem

public PlaylistItem(PlaylistItem src)

PlaylistItem

public PlaylistItem()

Method Detail

getTitle

@Nullable
public java.lang.String getTitle()

Returns:

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.

getDescription

@Nullable
public java.lang.String getDescription()

Returns:

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

getFile

public java.lang.String getFile()

Returns:

The media file for this playlist item.

getImage

@Nullable
public java.lang.String getImage()

Returns:

Poster image URL. Displayed before and after playback.

getMediaId

@Nullable
public java.lang.String getMediaId()

Returns:

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

getRecommendations

@Nullable
public java.lang.String getRecommendations()

Returns:

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

getSources

@NonNull
public java.util.List<MediaSource> getSources()

Returns:

Used for quality toggling and alternate sources.

getTracks

@NonNull
public java.util.List<Caption> getTracks()

Returns:

Include captions, chapters, and thumbnails for media.

getAdSchedule

public java.util.List<AdBreak> getAdSchedule()

Returns:

Schedule advertising for a specific media file.

getMediaDrmCallback

public MediaDrmCallback getMediaDrmCallback()

Returns:

DRM callback instance -- used for Widevine DRM.

getHttpHeaders

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getHttpHeaders()

Returns:

HTTP Headers to include with requests for this media file.

setTitle

public void setTitle(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.

setDescription

public void setDescription(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.

setFile

public void setFile(java.lang.String file)

Parameters:

file - The media file for this playlist item.

setImage

public void setImage(java.lang.String image)

Parameters:

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

setMediaId

public void setMediaId(java.lang.String mediaId)

Parameters:

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

setRecommendations

public void setRecommendations(java.lang.String recommendations)

Parameters:

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

setSources

public void setSources(java.util.List<MediaSource> sources)

Parameters:

sources - Used for quality toggling and alternate sources.

setCaptions

public void setCaptions(java.util.List<Caption> tracks)

Parameters:

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

setAdSchedule

public void setAdSchedule(java.util.List<AdBreak> adSchedule)

Parameters:

adSchedule - Schedule advertising for a specific media file.

setMediaDrmCallback

public void setMediaDrmCallback(MediaDrmCallback callback)

Parameters:

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

setHttpHeaders

public void setHttpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)

Parameters:

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

setAdScheduleInternal

public void setAdScheduleInternal(java.util.List<AdBreak> adSchedule)

parseJson

public static PlaylistItem parseJson(org.json.JSONObject json)
                              throws org.json.JSONException

Throws:

org.json.JSONException

parseJson

public static PlaylistItem parseJson(java.lang.String json)
                              throws org.json.JSONException

Throws:

org.json.JSONException

listFromJson

public static java.util.List<PlaylistItem> listFromJson(org.json.JSONArray json)

listFromJson

public static java.util.List<PlaylistItem> listFromJson(java.lang.String json)

toJson

public org.json.JSONObject toJson()

Specified by:

toJson in interface com.longtailvideo.jwplayer.utils.Jsonable

cloneList

public static java.util.List<PlaylistItem> cloneList(java.util.List<PlaylistItem> src)