Package com.jwplayer.pub.api.media.playlists

Class PlaylistItem

  • All Implemented Interfaces:
    android.os.Parcelable
    public class PlaylistItem
extends java.lang.Object
implements android.os.Parcelable
    An item in a Playlist.

    • Field Detail

      • mTitle

        public final java.lang.String mTitle

      • mDescription

        public final java.lang.String mDescription

      • mFile

        public final java.lang.String mFile

      • mImage

        public java.lang.String mImage

      • mMediaId

        public final java.lang.String mMediaId

      • mFeedId

        public final java.lang.String mFeedId

      • mRecommendations

        public final java.lang.String mRecommendations

      • mSources

        public final java.util.List<MediaSource> mSources

      • mTracks

        public final java.util.List<Caption> mTracks

      • mAdSchedule

        public final java.util.List<AdBreak> mAdSchedule

      • mStartTime

        public final java.lang.Double mStartTime

      • mDuration

        public final java.lang.Integer mDuration

      • mSkippableTimeRanges

        public final java.util.List<SkippableTimeRange> mSkippableTimeRanges

      • mHttpHeaders

        @Nullable
public final java.util.Map<java.lang.String,​java.lang.String> mHttpHeaders
        HTTP Headers that should be used when requesting this playlist item

      • mDrmConfig

        public final DrmConfig mDrmConfig

      • mExternalMetadata

        public final java.util.List<ExternalMetadata> mExternalMetadata
        A list of external metadata in the video the user wishes to receive a meta event

      • CREATOR

        public static final android.os.Parcelable.Creator<PlaylistItem> CREATOR

    • Method Detail

      • setImage

        public void setImage​(java.lang.String image)

      • 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.

      • getFeedId

        @Nullable
public java.lang.String getFeedId()
        Returns:
        Unique identifier of this item. Used by related/recommendation services.

      • getRecommendations

        @Nullable
public java.lang.String getRecommendations()
        Returns:
        URL to a feed that contains related items for a particular playlist item.

      • getStartTime

        @Nullable
public java.lang.Double getStartTime()
        Returns:
        URL to a feed that contains related items for a particular playlist item.

      • getDuration

        @Nullable
public java.lang.Integer getDuration()
        Returns:
        the display duration for the item set in seconds

      • 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.

      • getDrmConfig

        public DrmConfig getDrmConfig()
        Returns:
        DRM config

      • getHttpHeaders

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getHttpHeaders()
        Returns:
        HTTP Headers to include with requests for this media file.

      • getImaDaiSettings

        @Nullable
public ImaDaiSettings getImaDaiSettings()
        Returns:
        The IMA DAI settings for this playlist item

      • getExternalMetadata

        @Nullable
public java.util.List<ExternalMetadata> getExternalMetadata()
        Returns:
        The External Metadata for this playlist Item

      • getSkippableTimeRanges

        @Nullable
public java.util.List<SkippableTimeRange> getSkippableTimeRanges()
        Returns:
        The list of skippable time ranges for the playlist Item

      • describeContents

        public int describeContents()
        Specified by:
        describeContents in interface android.os.Parcelable

      • writeToParcel

        public void writeToParcel​(android.os.Parcel dest,
                          int flags)
        Specified by:
        writeToParcel in interface android.os.Parcelable