Classes

An interface to expose information on an ad companion.

See more

@objc
public class JWAdCompanion : NSObject

A description of an ad event.

See more

@objc
public class JWAdEvent : NSObject

Ad impression information for an ad.

See more

@objcMembers
public class JWAdImpression : NSObject

A description of an ad impression from the JW Player Ad Client.

See more

@objcMembers
public class JWPlayerAdImpression : JWAdImpression

An offset into the content where an ad plays.

See more

@objc
public class JWAdOffset : NSObject

This class represents an obstruction that is marked as friendly for viewability measurement purposes.

See more

@objcMembers
public class JWFriendlyObstruction : NSObject

This class allows to register views considered as friendly obstructions.

Friendly obstructions are views such as video controls that are essential to the user’s experience but do not impact viewability. Once registered as such, these controls are excluded from ad viewability measurements. These controls must only be fully transparent overlays or small buttons. Any other non-control views must not be registered.

When ad viewability via the OMSDK is calculated, all views overlaying the media element are considered obstructions and reduce the viewability rate.

You may register:

• A transparent overlay used to capture user taps.
• Transient buttons such as:
  • Pause
  • Play
  • Fullscreen
  • Cast/AirPlay
  • Collapse
  • Progress/Seek
  • Other playback relevant actions

You must NOT register:

• Watermarks
• Pop ups
• Dialogs
• Non-transient buttons

• Other obscuring views

• Tag: FriendlyObstructionsContainer

See more

@objcMembers
public class JWFriendlyObstructionsContainer : NSObject

Defines time information.

See more

@objcMembers
public class JWTimeData : NSObject

Defines time range information.

See more

@objcMembers
public class JWTimeRange : NSObject

A JWCueTime can represent any accepted format of time in a cue.

See more

@objcMembers
public class JWCueTime : NSObject

Defines a point of interest in the content.

See more

@objcMembers
public class JWCue : NSObject, JWJSONEncodable

A custom error class.

See more

@objcMembers
public class JWError : NSError

A location or point in time where one or more ads may be scheduled for delivery.

See more

@objcMembers
public class JWAdBreak : NSObject

The builder for JWAdBreak.

See more

@objcMembers
public class JWAdBreakBuilder : NSObject, JWBuilder

Defines playback rules for the scheduled ads.

@objc
public class JWAdRules : NSObject

The builder for JWAdRules.

See more

@objcMembers
public class JWAdRulesBuilder : NSObject, JWBuilder

This class allows setting specific ad behavior for the JWPlayer ad client.

@objc
public class JWAdSettings : NSObject

The builder for JWAdSettings, object used to set behavior for JWPlayer ads.

See more

@objcMembers
public class JWAdSettingsBuilder : NSObject, JWBuilder

Used to build a JWAdvertisingConfig object to play ads using the JWPlayer client.

See more

@objcMembers
public class JWAdsAdvertisingConfigBuilder : NSObject, JWBuilder

Encompasses all configuration options for ad plugins.

See more

@objc
public class JWAdvertisingConfig : NSObject

Used to configure Google DAI streams based on the provided information.

See more

@objc
public class JWGoogleDAIStream : NSObject

The builder for JWGoogleDAIStream, object used to play ads using the DAI client.

See more

@objcMembers
public class JWGoogleDAIStreamBuilder : NSObject, JWBuilder

Used to build a JWAdvertisingConfig object to play ads using the IMA client.

See more

@objcMembers
public class JWImaAdvertisingConfigBuilder : NSObject, JWBuilder

Used to build a JWAdvertisingConfig object to play ads using the DAI client.

See more

@objcMembers
public class JWImaDaiAdvertisingConfigBuilder : NSObject, JWBuilder

The JWImaSettings class encompasses the Google IMA SDK settings.

@objc
public class JWImaSettings : NSObject

The builder for JWImaSettings, object used to configure the Google IMA SDK.

See more

@objcMembers
public class JWImaSettingsBuilder : NSObject, JWBuilder

This serves as the base class for configurations affecting advertisement analytics.

@objc
public class JWAdTrackerConfig : NSObject

An object describing the position, size, and behavior of a caption on the screen. In order to instantiate an instance of this class, use JWCaptionPositionBuilder.

See more

@objcMembers
public class JWCaptionPosition : NSObject

The builder for creating a JWCaptionPosition and verifying its properties.

See more

@objcMembers
public class JWCaptionPositionBuilder : NSObject, JWBuilder

Configuration object used to customize the captions. Styles specified using this structure will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

See more

@objcMembers
public class JWCaptionStyle : NSObject

The builder for JWCaptionStyle.

See more

@objcMembers
public class JWCaptionStyleBuilder : NSObject, JWBuilder

Provides information about a caption track.

See more

@objcMembers
public class JWCaptionTrack : JWMediaTrack

The builder for creating a JWMediaTrack used for captions.

See more

@objcMembers
public class JWCaptionTrackBuilder : NSObject, JWBuilder

Provides information about a chapter track.

See more

@objcMembers
public class JWChapterTrack : JWMediaTrack

The builder for creating a JWMediaTrack used for chapters.

See more

@objcMembers
public class JWChapterTrackBuilder : NSObject, JWBuilder

A settings object containing information regarding external playback.

See more

public class JWExternalPlaybackSettings : NSObject

A builder for creating instances of JWExternalPlaybackSettings.

See more

public class JWExternalPlaybackSettingsBuilder : NSObject, JWBuilder

This JSON parser helps to convert a json object into a JWPlayerConfiguration using the different configuration builders provided by JWPlayerKit.

See more

@objcMembers
final public class JWJSONParser : NSObject

Defines a logo which is overlayed on the player.

@objc
public class JWLogo : NSObject

The builder for JWLogo.

See more

@objcMembers
public class JWLogoBuilder : NSObject, JWBuilder

Represents a specific option for the presentation of media.

See more

@objcMembers
public class JWMediaSelectionOption : NSObject

Provides information about captions or thumbnails. Supports TTML (DFXP), SRT, and WebVTT formats.

See more

@objcMembers
public class JWMediaTrack : NSObject

Defines the style for the control bar on a player.

@objc
public class JWMenuStyle : NSObject

The builder for JWMenuStyle.

See more

@objcMembers
public class JWMenuStyleBuilder : NSObject, JWBuilder

Configuration object used to create a JWPlayer instance.

See more

@objc
public class JWPlayerConfiguration : NSObject

Used to build a JWPlayerConfiguration object to configure instance(s) of JWPlayer.

See more

@objcMembers
public class JWPlayerConfigurationBuilder : NSObject, JWBuilder

Defines a player item which contains the information about the media content.

See more

@objcMembers
public class JWPlayerItem : NSObject, JWJSONEncodable

The builder for JWPlayerItem, ensuring it is built correctly.

See more

@objcMembers
public class JWPlayerItemBuilder : NSObject, JWBuilder

A configuration object for handling related content loading and display.

@objc
public class JWRelatedContentConfiguration : NSObject

The builder for JWRelatedContentConfiguration.

See more

@objcMembers
public class JWRelatedContentConfigurationBuilder : NSObject, JWBuilder

Defines a time range in the video which should display a skip button, along with a destination in the video to seek to.

See more

@available(tvOS 14, *)
@available(iOS, unavailable)
@objcMembers
public class JWSkippableTimeRange : NSObject

The builder for creating a JWSkippableTimeRange object.

See more

@available(tvOS 14, *)
@available(iOS, unavailable)
@objcMembers
public class JWSkippableTimeRangeBuilder : NSObject, JWBuilder

The builder for creating a JWMediaTrack used for thumbnails.

See more

@objcMembers
public class JWThumbnailTrackBuilder : NSObject, JWBuilder

Defines the style for the control bar on a player.

@objc
public class JWTimeSliderStyle : NSObject

The builder for JWTimeSliderStyle.

See more

@objcMembers
public class JWTimeSliderStyleBuilder : NSObject, JWBuilder

Defines a video source which represents a visual quality level of the video.

See more

@objcMembers
public class JWVideoSource : NSObject

The builder for JWVideSource.

See more

@objcMembers
public class JWVideoSourceBuilder : NSObject, JWBuilder

A description of a video quality level.

See more

@objcMembers
public class JWVisualQualityLevel : NSObject

JWVisualQuality represents the quality of a video stream.

See more

@objcMembers
public class JWVisualQuality : NSObject

This loader is used to interface with FairPlay and decode streams for download.

See more

JWLockScreenManager allows setting the active JWPlayer that will be shown on the NowPlaying Controls.

• Background audio must be enabled.
• The audio session must be set to AVAudioSessionCategoryPlayback.

By default when using more than one player, the last player played will have priority on NowPlaying Controls.

See more

@objcMembers
public class JWLockScreenManager : NSObject

Access log metadata. Fires when a new access log entry has been added for the JWPlayerItem.

See more

@objcMembers
public class JWAccessLogMetadata : NSObject

Date range metadata. Fired when playback enters the section of an HLS stream tagged with #EXT-X-DATERANGE.

See more

@objcMembers
public class JWDateRangeMetadata : NSObject

Metadata that can be passed externally to supplement the encoded metadata of the underlying media asset.

See more

@objcMembers
public class JWExternalMetadata : NSObject

ID3 metadata. Fires when playback buffers a section of an HLS stream containing ID3 tags.

See more

@objcMembers
public class JWID3Metadata : NSObject

Media metadata. Fires when the initial metadata of content has loaded.

See more

@objcMembers
public class JWMediaMetadata : NSObject

Delegates that surface different types of metadata from the player.

See more

@objcMembers
public class JWMetadataDelegates : NSObject

Program-date-time metadata. Fires when playback enters the section of an HLS stream tagged with #EXT-X-PROGRAM-DATE-TIME.

See more

@objcMembers
public class JWProgramDateTimeMetadata : NSObject

JWPlayerKitLicense is a static interface into our SDK for accomplishing basic tasks outside of a JWPlayer instance.

See more

@objcMembers
public class JWPlayerKitLicense : NSObject

A structure describing settings for the ad interface.

@objc
public class JWAdInterfaceStyle : NSObject

The builder for the JWAdInterfaceStyle.

See more

@objcMembers
public class JWAdInterfaceStyleBuilder : NSObject, JWBuilder

Used to define the next up card’s style.

@objc
public class JWNextUpStyle : NSObject

Used to build a new JWNextUpStyle to configure the next up card.

See more

@objcMembers
public class JWNextUpStyleBuilder : NSObject, JWBuilder

This view controller creates a sleek, minimalist interface more consistent with a cinematic experience akin to what you would see for viewing movies and long media.

See more

@objcMembers
open class JWCinematicViewController: UIViewController,
                                      AVPictureInPictureControllerDelegate,
                                      JWAccessLogMetadataDelegate,
                                      JWAdDelegate,
                                      JWAirPlayDelegate,
                                      JWAVDelegate,
                                      JWDateRangeMetadataDelegate,
                                      JWExternalMetadataDelegate,
                                      JWID3MetadataDelegate,
                                      JWMediaMetadataDelegate,
                                      JWPlayerDelegate,
                                      JWPlayerStateDelegate,
                                      JWPlayerViewDelegate,
                                      JWProgramDateTimeMetadataDelegate,
                                      JWTimeEventListener,
                                      JWRelatedEventDelegate,
                                      JWChaptersDelegate

A view for displaying a player. It automatically handles enlarging the player to the size of this container view, and displaying the player.

See more

@objcMembers
public class JWPlayerView : UIView, JWPlayerViewProtocol, ViewabilityHandlerDelegate