Classes

The following classes are available globally.

  • JWAdBreak is an object providing info for an ad break in a video, played using JWPlayer. Single AdBreak or a set of multiple AdBreak should be fed to the JWAdConfig’s schedule array

    See more

    Declaration

    Objective-C

    @interface JWAdBreak : NSObject
  • JWAdCompanion is provided to expose the ad companion properties when available.

    See more

    Declaration

    Objective-C

    @interface JWAdCompanion : NSObject
  • An object providing information about the way ads are handled by the player. Describes adMessage, skipMessage, skipText and skipOffset.

    Note

    In the current implementation, an adConfig object can be added to config and propagates to all adBreaks.
    See more

    Declaration

    Objective-C

    @interface JWAdConfig : NSObject
  • Base class for various ad event classes. Exposes specific information based on the derived class.

    See more

    Declaration

    Objective-C

    @interface JWAdEvent : NSObject
  • JWAdRules playback rules for the scheduled ads.

    See more

    Declaration

    Objective-C

    @interface JWAdRules : NSObject
  • An object containing the necessary information required to create a custom control bar button.

    Note

    Buttons are added to the control bar using the JWPlayerController’s addButton method.

    See

    JWPlayerController
    See more

    Declaration

    Objective-C

    @interface JWButton : NSObject
  • Configuration object used to customize the captions. Must be set to the JWConfig object used to create the JWPlayerController.

    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

    Declaration

    Objective-C

    @interface JWCaptionStyling : NSObject
  • Controller for enabling casting using the JWPlayerController.

    See more

    Declaration

    Objective-C

    @interface JWCastController : NSObject
  • A class that encapsulates a casting device and holds its identifiers and attributes.

    See more

    Declaration

    Objective-C

    @interface JWCastingDevice : NSObject
  • Configuration object used to create JW Player instance.

    See more

    Declaration

    Objective-C

    @interface JWConfig : NSObject
  • JWControlbarStyling allows customization of the playback controls of the player.

    See more

    Declaration

    Objective-C

    @interface JWControlbarStyling : NSObject
  • JWEvent is the base class for all events emitted by the player.

    Declaration

    Objective-C

    @interface JWEvent : NSObject
  • Deprecated

    Use JWFriendlyAdObstructions class instead

    A class that exposes experimental functionality. Some of these APIs are not yet officially supported by standards and will be modified when the industry establishes a norm. At that point these APIs will be deprecated and will subsequently be removed or replaced by the industry’s standard.

    See more

    Declaration

    Objective-C

    
    @interface JWExperimentalAPI : NSObject
  • Metadata that can be passed externally, to supplement the encoded metadata of the underlying media asset. @discussion surfaced via the JWPlayerDelegate’s onMeta call when playback position reaches the position specified in the startTime property, or by seeking to position in between startTime and endTime.

    See

    JWPlayerDelegate
    See more

    Declaration

    Objective-C

    @interface JWExternalMetadata : NSObject
  • Configuration settings for freewheel ads.

    See more

    Declaration

    Objective-C

    @interface JWFreewheelConfig : NSObject
  • This interface allows to register views considered as friendly obstructions.

    Note

    Applicable to the Google IMA ad client only.

    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:

       1. Pause
    
       2. Play
    
       3. Fullscreen
    
       4. Cast/AirPlay
    
       5. Collapse
    
       6. Progress/Seek
    
       7. Other playback relevant actions
    

    You must NOT register:

    • Watermarks

    • Pop ups

    • Dialogs

    • Non-transient buttons

    • Other obscuring views

    For more information, see Open Measurement in the IMA SDK

    See more

    Declaration

    Objective-C

    @interface JWFriendlyAdObstructions : NSObject
  • Configuration settings for Google IMA DAI.

    See more

    Declaration

    Objective-C

    @interface JWGoogimaDaiConfig : NSObject
  • Configures a clickable watermark that is overlayed on the video.

    See more

    Declaration

    Objective-C

    @interface JWLogo : NSObject
  • JWMenuStyling allows customization of the menu of the player control.

    See more

    Declaration

    Objective-C

    @interface JWMenusStyling : NSObject
  • Undocumented

    Declaration

    Objective-C

    @interface JWPlayerError : NSError
    
    @end
  • An object providing info about playlist items.

    See more

    Declaration

    Objective-C

    @interface JWPlaylistItem : NSObject
  • An object providing information about the way related videos are handled by the player.

    See more

    Declaration

    Objective-C

    @interface JWRelatedConfig : NSObject
  • JWRelatedEvent is the base class of all events generated by the recommendations engine.

    Declaration

    Objective-C

    @interface JWRelatedEvent : NSObject
  • JWSkinStyling enables the customization of the player’s UI skin.

    See more

    Declaration

    Objective-C

    @interface JWSkinStyling : NSObject
  • An object providing info about quality levels of a video.

    See more

    Declaration

    Objective-C

    @interface JWSource : NSObject
  • JWTimesliderStyling allows customizaiton of the slider of the playback control.

    See more

    Declaration

    Objective-C

    @interface JWTimesliderStyling : NSObject
  • JWTooltipsStyling allows customization of the tooltip of the playback control.

    See more

    Declaration

    Objective-C

    @interface JWTooltipsStyling : NSObject
  • An object providing info about captions or thumbnails. Supports DFXP (TTML), SRT, WebVTT formats.

    See more

    Declaration

    Objective-C

    @interface JWTrack : NSObject
  • A class that encapsulates JW Player and provides control over the playback as well as holds the state of the player and notifies about status updates.

    See more

    Declaration

    Objective-C

    @interface JWPlayerController : NSObject