JWPlaylistItem

@interface JWPlaylistItem : NSObject

An object providing info about playlist items.

Accessing Playlist Item Attributes

  • An array of JWSource objects representing multiple quality levels of a video.

    See

    JWSource

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) NSArray<JWSource *> *sources;
  • Video URL to a single video file, to be played using JW Player.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *file;
  • URL to a poster image. The image is displayed before and after playback, and in the listbar. For audio-only media, the poster image stays visible during playback.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *image;
  • Title of the video.

    Note

    Shown in the listbar and in the play button container in the center of the screen before the video starts to play.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *title;
  • A dictionary containing asset initialization options.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        NSDictionary *assetOptions;
  • An array of JWAdBreak objects that proivide info about ad breaks.

    See

    JWAdBreak

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable)
        NSArray<JWAdBreak *> *adSchedule;
  • The JWGoogimaDaiConfig class stores the Google IMA DAI settings.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        JWGoogimaDaiConfig *googimaDaiSettings;
  • The JWFreewheelConfig class stores the Freewheel SDK settings. The settings defined here will apply only to ads associated with this playlist item.

    Note

    When setting a Freewheel config, config.advertising.adClient should be set to JWAdClientFreewheel, where config is an instance of JWConfig.

    Note

    if nil, fallsback to config.advertising.freewheel.

    Note

    Properties that are nil will fallback to the equivalent in config.advertising.freewheel. You may therefore use config.advertising.freewheel to define common settings.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        JWFreewheelConfig *freewheel;
  • An array of JWTrack objects providing captions for different languages or thumbnails images.

    See

    JWTrack

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) NSArray<JWTrack *> *tracks;
  • Short description of the item. It is displayed in the listbar.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *desc;
  • The playlist item’s Media ID.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *mediaId;
  • URL to a feed that contains related items for a particular playlist item.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable) NSString *recommendations;
  • Number of seconds from the start of a media asset when playback should begin.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) CGFloat startTime;
  • Array of metadata that can be passed externally to supplement the encoded metadata of the underlying media asset. @discussion Supersedes the externalMetada specified in the JWConfig, for this playlist item.

    Note

    Capped at 5 metadata instances; the instances in excess will be excluded.

    See

    JWExternalMetadata

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite, nullable)
        NSArray<JWExternalMetadata *> *externalMetadata;

Creating Playlist Item Object

  • Inits a JWPlaylistItem object with provided JWConfig.

    Declaration

    Objective-C

    + (nonnull instancetype)playlistItemWithConfig:(nonnull JWConfig *)config;

    Parameters

    config

    configuration object.