Other Protocols Reference


                    
                    
                    AdBreak_Objc

An AdBreak is an object that represents a collection of ads that are scheduled at a certain time.

Declaration

Swift

@objc(THEOplayerAdBreak)
public protocol AdBreak_Objc


                    
                    
                    Ad_Objc

An Ad is an abstract object that represents a single ad, which is a creative in the VAST specification.

Remark

See LinearAd and NonLinearAd

Declaration

Swift

@objc(THEOplayerAd)
public protocol Ad_Objc


                    
                    
                    LinearAd_Objc

Represents a linear ad in the VAST specification. It extends the properties of the Ad object.

Declaration

Swift

@objc(THEOplayerLinearAd)
public protocol LinearAd_Objc : Ad_Objc


                    
                    
                    NonLinearAd_Objc

Represents a non-linear ad in the VAST specification. It extends the properties of the Ad object.

Declaration

Swift

@objc(THEOplayerNonLinearAd)
public protocol NonLinearAd_Objc : Ad_Objc


                    
                    
                    ScheduledAd_Objc

An ad that is scheduled to appear at a certain point.

Declaration

Swift

@objc(THEOplayerScheduledAd)
public protocol ScheduledAd_Objc


                    
                    
                    GoogleImaAd_Objc

A GoogleImaAd is a concrete implementation of an Ad which represents a Google IMA ad.

Declaration

Swift

@objc(THEOplayerGoogleImaAd)
public protocol GoogleImaAd_Objc : Ad_Objc


                    
                    
                    UniversalAdId

Represents the list of universal ad ID information of the selected creative for the ad.

Declaration

Swift

@objc(THEOplayerUniversalAdId)
public protocol UniversalAdId


                    
                    
                    Ads_Objc

The Ads object helps you configure and control ads within THEOplayer.

Declaration

Swift

@objc(THEOplayerAds)
public protocol Ads_Objc


                    
                    
                    GoogleDAI

Represents information regarding content with dynamically inserted advertisements.

Declaration

Swift

public protocol GoogleDAI


                    
                    
                    GoogleDAI_Objc

Represents information regarding content with dynamically inserted advertisements.

Declaration

Swift

@objc(THEOplayerGoogleDAI)
public protocol GoogleDAI_Objc


                    
                    
                    CompanionAd_Objc

Represents a companion ad which is displayed besides the player.

Remark

It doesn’t extend the properties of Ad.

Declaration

Swift

@objc(THEOplayerCompanionAd)
public protocol CompanionAd_Objc


                    
                    
                    ContentProtectionError_Objc

An error related to content protection.

Declaration

Swift

@objc(THEOplayerContentProtectionError)
public protocol ContentProtectionError_Objc : THEOError


                    
                    
                    ContentProtectionIntegrationFactory_Objc

Factory pattern to createContentProtectionIntegration.

Declaration

Swift

@objc(THEOplayerContentProtectionIntegrationFactory)
public protocol ContentProtectionIntegrationFactory_Objc


                    
                    
                    MediaTrackList_Objc

A MediaTrackList lists all available MediaTrack objects that the player can play. It contains MediaTrack objects, which are either AudioTracks or VideoTracks.

Declaration

Swift

@objc(THEOplayerMediaTrackList)
public protocol MediaTrackList_Objc


                    
                    
                    VideoTrackList_Objc

A VideoTrackList lists all available VideoTrack objects that the player can play.

Declaration

Swift

@objc(THEOplayerVideoTrackList)
public protocol VideoTrackList_Objc : MediaTrackList_Objc


                    
                    
                    AudioTrackList_Objc

An AudioTrackList lists all available AudioTrack objects that the player can play.

Declaration

Swift

@objc(THEOplayerAudioTrackList)
public protocol AudioTrackList_Objc : MediaTrackList_Objc


                    
                    
                    MediaTrack_Objc

A MediaTrack is an element that represents a single video or audio track that can be played by the player.

Declaration

Swift

@objc(THEOplayerMediaTrack)
public protocol MediaTrack_Objc : Track_Objc


                    
                    
                    VideoTrack_Objc

A VideoTrack object is an element that represents a single video track that can be played by the player.

Declaration

Swift

@objc(THEOplayerVideoTrack)
public protocol VideoTrack_Objc : MediaTrack_Objc


                    
                    
                    AudioTrack_Objc

An AudioTrack object is an element that represents a single audio track that can be played by the player.

Declaration

Swift

@objc(THEOplayerAudioTrack)
public protocol AudioTrack_Objc : MediaTrack_Objc


                    
                    
                    Network_Objc

The Network API.

Declaration

Swift

@objc(THEOplayerNetwork)
public protocol Network_Objc


                    
                    
                    PictureInPicture_Objc

Helps configure the settings when PresentationMode.pictureInPicture is active.

Declaration

Swift

@objc(THEOplayerPictureInPicture)
public protocol PictureInPicture_Objc


                    
                    
                    AVPictureInPictureControllerDelegateExtended

Extends AVPictureInPictureControllerDelegate to provide additional methods that get called when changes occur in AVPictureInPictureController.

Declaration

Swift

@available(iOS 14.0, tvOS 14.0, *)
@objc(THEOplayerAVPictureInPictureControllerDelegateExtended)
public protocol AVPictureInPictureControllerDelegateExtended : AVPictureInPictureControllerDelegate


                    
                    
                    TextTrackCue_Objc

A TextTrackCue object represents an individual cue and provides methods and properties to access the data and events to act on changes to cue state. Depending on the TextTrack’s type, a cue might have different properties.

Declaration

Swift

@objc(THEOplayerTextTrackCue)
public protocol TextTrackCue_Objc


                    
                    
                    WebVttCue_Objc

Web Video Text Tracks cue.

Remark

The content type is String.

Declaration

Swift

@objc(THEOplayerWebVttCue)
public protocol WebVttCue_Objc : TextTrackCue_Objc


                    
                    
                    Id3Cue_Objc

ID3 Text Track cue. Content type is [String:String].

Declaration

Swift

@objc(THEOplayerId3Cue)
public protocol Id3Cue_Objc : TextTrackCue_Objc


                    
                    
                    DateRangeCue_Objc

Represents the HLS date range cue which is a part of the metadata text track.

Declaration

Swift

@objc(THEOplayerDateRangeCue)
public protocol DateRangeCue_Objc : TextTrackCue_Objc


                    
                    
                    TextTrackList_Objc

A TextTrackList lists all available TextTrack objects that the player can display.

Declaration

Swift

@objc(THEOplayerTextTrackList)
public protocol TextTrackList_Objc


                    
                    
                    TextTrack_Objc

A TextTrack object is an element that represents a single text track that can be displayed in the player.

Declaration

Swift

@objc(THEOplayerTextTrack)
public protocol TextTrack_Objc : Track_Objc


                    
                    
                    Track_Objc

A track object.

Remark

Either a TextTrack or a MediaTrack.
A specific track type (e.g. TextTrack) will always be used.

Declaration

Swift

@objc(THEOplayerTrack)
public protocol Track_Objc


                    
                    
                    CueEventProtocol_Objc

The base TextTrackCue Event protocol.

Declaration

Swift

@objc(THEOplayerCueEventProtocol)
public protocol CueEventProtocol_Objc : EventProtocol


                    
                    
                    TextTrackCueEventProtocol_Objc

The base TextTrack cue Event protocol.

Declaration

Swift

@objc(THEOplayerTextTrackCueEventProtocol)
public protocol TextTrackCueEventProtocol_Objc : EventProtocol


                    
                    
                    TrackEventProtocol_Objc

The base Track Event protocol.

Declaration

Swift

@objc(THEOplayerTrackEventProtocol)
public protocol TrackEventProtocol_Objc : EventProtocol


                    
                    
                    EventDispatcherProtocol_Objc

Classes that comform to this protocol can add and remove event listeners.

Declaration

Swift

@objc(THEOplayerEventDispatcherProtocol)
public protocol EventDispatcherProtocol_Objc


                    
                    
                    DRMConfiguration_Objc

The DRMConfiguration object provides a set of DRM parameters for DRM streaming.

Declaration

Swift

@objc(THEOplayerDRMConfiguration)
public protocol DRMConfiguration_Objc


                    
                    
                    FairPlayDRMConfigurationProtocol_Objc

The FairPlay DRM configuration.

Declaration

Swift

@objc(THEOplayerFairPlayDRMConfigurationProtocol)
public protocol FairPlayDRMConfigurationProtocol_Objc : DRMConfiguration_Objc


                    
                    
                    WidevineDRMConfigurationProtocol_Objc

The Widevine DRM configuration.

Declaration

Swift

@objc(THEOplayerWidevineDRMConfigurationProtocol)
public protocol WidevineDRMConfigurationProtocol_Objc : DRMConfiguration_Objc


                    
                    
                    ManifestInterceptor

Manifest interceptor introduces the possibility to intercept/observe the manifest requests made by the player. (master and rendition (child) manifest)

It is a AVAssetResourceLoaderDelegate subclass and hooked into the AVURLAsset.resourceLoader of the player item.

Remark

Only works on online resources.

Since

v5.0.0

Declaration

Swift

public protocol ManifestInterceptor : AVAssetResourceLoaderDelegate


                    
                    
                    DeveloperSettings

Developer Settings API

This API provides access to developer settings, debugging tools and experimental features.

Remark

The experimental APIs can make their way into THEOplayer production APIs some day, but not guaranteed. Experimental APIs can be broken between minor or even between patch releases too. Relying on them in production systems can be dangerous.

Since

v5.0.0

Declaration

Swift

public protocol DeveloperSettings


                    
                    
                    InternalCastIntegration

Chromecast, also known as Google Cast, is a casting device designed by Google.

Declaration

Swift

public protocol InternalCastIntegration : InternalContentPlayerIntegration


                    
                    
                    Cache_Objc

The caching API allows to store a streaming source on the user’s device.

Declaration

Swift

@objc(THEOplayerCache)
public protocol Cache_Objc


                    
                    
                    CachingTask_Objc

Represents a caching task.

Declaration

Swift

@objc(THEOplayerCachingTask)
public protocol CachingTask_Objc


                    
                    
                    CachingTaskLicense_Objc

The caching task license controller which can be used to renew the license.

Declaration

Swift

@objc(THEOplayerCachingTaskLicense)
public protocol CachingTaskLicense_Objc


                    
                    
                    Airplay_Objc

The AirPlay API.

Declaration

Swift

@objc(THEOplayerAirplay)
public protocol Airplay_Objc


                    
                    
                    Cast_Objc

The Cast object helps you configure and control casting to external devices with THEOplayer.

Declaration

Swift

@objc(THEOplayerCast)
public protocol Cast_Objc


                    
                    
                    Chromecast_Objc

Chromecast, also known as Google Cast, is a casting device designed by Google.

Declaration

Swift

@objc(THEOplayerChromecast)
public protocol Chromecast_Objc


                    
                    
                    Fullscreen_Objc

The Fullscreen object helps you configure the settings of the fullscreen mode.

Declaration

Swift

@objc(THEOplayerFullscreen)
public protocol Fullscreen_Objc


                    
                    
                    FullscreenPresentationDelegate

The fullscreen delegate which allows control over the presentation of the fullscreen view controller.

Declaration

Swift

@objc(THEOplayerFullscreenPresentationDelegate)
public protocol FullscreenPresentationDelegate