Other Classes Reference


                    
                    
                    AdInit

An initializer for a custom Ad.

Declaration

Swift

@objc(THEOplayerAdInit)
public class AdInit : NSObject


                    
                    
                    AdBreakInit

An initializer for a custom AdBreak.

Declaration

Swift

@objc(THEOplayerAdBreakInit)
public class AdBreakInit : NSObject


                    
                    
                    PiPConfiguration

Describes the configuration of the picture-in-picture feature.

Declaration

Swift

@objc(THEOplayerPiPConfiguration)
public class PiPConfiguration : NSObject, Codable


                    
                    
                    AdSkipEvent

Thrown to indicate that the ad was skipped.

Declaration

Swift

@objc(THEOplayerAdSkipEvent)
public class AdSkipEvent : AdEvent


                    
                    
                    AdTappedEvent

Thrown to indicate that an ad was tapped.

ad : the Ad (either LinearAd or NonLinearAd)

Declaration

Swift

@objc(THEOplayerAdTappedEvent)
public class AdTappedEvent : AdEvent


                    
                    
                    AdClickedEvent

Thrown to indicate that an ad was clicked. Most of the cases when user clicks on the “Learn More” button.

ad : the Ad (either LinearAd or NonLinearAd)

Declaration

Swift

@objc(THEOplayerAdClickedEvent)
public class AdClickedEvent : AdEvent


                    
                    
                    AddAdEvent

Thrown to indicate that an ad was added.

ad : the Ad (either LinearAd or NonLinearAd)

Declaration

Swift

@objc(THEOplayerAddAdEvent)
public class AddAdEvent : AdEvent


                    
                    
                    UpdateAdEvent

Thrown to indicate that an ad was updated.

ad : the Ad (either LinearAd or NonLinearAd)

Declaration

Swift

@objc(THEOplayerUpdateAdEvent)
public class UpdateAdEvent : AdEvent


                    
                    
                    AddAdBreakEvent

Thrown to indicate that an adbreak has been added.

ad : the AdBreak

Declaration

Swift

@objc(THEOplayerAddAdBreakEvent)
public class AddAdBreakEvent : AdBreakEvent


                    
                    
                    UpdateAdBreakEvent

Thrown to indicate that an adbreak has been updated.

ad : the AdBreak

Declaration

Swift

@objc(THEOplayerUpdateAdBreakEvent)
public class UpdateAdBreakEvent : AdBreakEvent


                    
                    
                    RemoveAdBreakEvent

Thrown to indicate that an adbreak has been removed.

ad : the AdBreak

Declaration

Swift

@objc(THEOplayerRemoveAdBreakEvent)
public class RemoveAdBreakEvent : AdBreakEvent


                    
                    
                    AdBreakChangeEvent

Thrown to indicate that an adbreak has changed.

ad : the AdBreak

Declaration

Swift

@objc(THEOplayerAdBreakChangeEvent)
public class AdBreakChangeEvent : AdBreakEvent


                    
                    
                    PlayerEvent

Represents the base for all other player events.

Declaration

Swift

@objc(THEOplayerPlayerEvent)
public class PlayerEvent : NSObject, EventProtocol


                    
                    
                    ActiveQualityChangedEvent

Fired when the media track’s active quality bandwidth changes.

Declaration

Swift

@objc(THEOplayerActiveQualityChangedEvent)
public class ActiveQualityChangedEvent : NSObject, EventProtocol


                    
                    
                    TrackUpdateEvent

Fired when one or more properties of a track have been updated.

Declaration

Swift

@objc(THEOplayerTrackUpdateEvent)
public class TrackUpdateEvent : NSObject, _TrackEventProtocol


                    
                    
                    NetworkConfiguration

Represents a network configuration.

- Remark: Use `NetworkConfigurationBuilder` to initialize an instance.

Declaration

Swift

@objc(THEOplayerNetworkConfiguration)
public class NetworkConfiguration : NSObject, Codable


                    
                    
                    NetworkConfigurationBuilder

A builder class to help initialize a NetworkConfiguration instance.

Declaration

Swift

@objc(THEOplayerNetworkConfigurationBuilder)
public class NetworkConfigurationBuilder : NSObject


                    
                    
                    THEOplayerConfigurationBuilder

Builder class for the THEOplayerConfiguration object.

Declaration

Swift

@objc
public class THEOplayerConfigurationBuilder : NSObject


                    
                    
                    KeySystemConfigurationCollection

A set of configurations for different key systems.

Declaration

Swift

@objc(THEOplayerKeySystemConfigurationCollection)
public final class KeySystemConfigurationCollection : NSObject

extension KeySystemConfigurationCollection: Codable


                    
                    
                    MultiplatformDRMConfiguration

A set of DRM parameters.

Declaration

Swift

@objc(THEOplayerMultiplatformDRMConfiguration)
public class MultiplatformDRMConfiguration : NSObject, DRMConfiguration

extension MultiplatformDRMConfiguration: DRMConfiguration_Objc


                    
                    
                    FullscreenViewController

The Fullscreen view controller class that presents the player when the PresentationMode is set to fullscreen. This class can be subclassed for customization, and the resulting type can be passed back to the player via the Fullscreen.viewControllerClass API. Additionally, it is possible to control when and how the view controller is presented via the Fullscreen.presentationDelegate API.

Remark

When subclassing and overriding UIViewController lifecycle methods such as viewDidLoad, the super methods must be called to maintain functionality.

Declaration

Swift

open class FullscreenViewController : UIViewController


                    
                    
                    CachingParametersTrackSelectionBuilder

A builder to create CachingParametersTrackSelections.

Since

v5.0.0

Declaration

Swift

@objc(THEOplayerCachingParametersTrackSelectionBuilder)
public class CachingParametersTrackSelectionBuilder : NSObject


                    
                    
                    CastError_Objc

The cast error.

Declaration

Swift

@objc(THEOplayerCastError)
public class CastError_Objc : NSObject


                    
                    
                    CachingTaskErrorStateChangeEvent

Fired when the CachingTask.status changes to .error.

Declaration

Swift

@objc(THEOplayerCachingTaskErrorStateChangeEvent)
public class CachingTaskErrorStateChangeEvent : CachingTaskStateChangeEvent


                    
                    
                    CachingTaskIdleStateChangeEvent

Fired when the CachingTask.status changes to .idle.

Declaration

Swift

@objc(THEOplayerCachingTaskIdleStateChangeEvent)
public class CachingTaskIdleStateChangeEvent : CachingTaskStateChangeEvent