Other Classes

The following classes are available globally.

  • Describes the configuration of the Google Interactive Media Ads.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This class will be removed in future releases. Configuration for Google IMA is moved to `THEOplayerGoogleIMAIntegration`.")
@objc(THEOplayerGoogleIMAAdsConfiguration)
public class GoogleIMAAdsConfiguration : NSObject, Codable

  • An object to create or build GoogleIMAAdsConfigurations.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This class will be removed in future releases. Configuration for Google IMA is moved to `THEOplayerGoogleIMAIntegration`.")
@objc(THEOplayerGoogleIMAConfigurationBuilder)
public class GoogleIMAConfigurationBuilder : NSObject

  • An initializer for a custom Ad.

    Remark

    Experimental

    Declaration

    Swift

    @objc(THEOplayerAdInit)
public class AdInit : NSObject

  • An initializer for a custom AdBreak.

    Remark

    Experimental

    Declaration

    Swift

    @objc(THEOplayerAdBreakInit)
public class AdBreakInit : NSObject

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

    See more

    Declaration

    Swift

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

  • Thrown to indicate that the ad was skipped.

    See more

    Declaration

    Swift

    @objc(THEOplayerAdSkipEvent)
public class AdSkipEvent : AdEvent

  • Thrown to indicate that an ad was tapped.

    • ad : the Ad (either LinearAd or NonLinearAd)

    Declaration

    Swift

    @objc(THEOplayerAdTappedEvent)
public class AdTappedEvent : AdEvent

  • Thrown to indicate that an ad was added.

    • ad : the Ad (either LinearAd or NonLinearAd)

    Declaration

    Swift

    @objc(THEOplayerAddAdEvent)
public class AddAdEvent : AdEvent

  • Thrown to indicate that an ad was updated.

    • ad : the Ad (either LinearAd or NonLinearAd)

    Declaration

    Swift

    @objc(THEOplayerUpdateAdEvent)
public class UpdateAdEvent : AdEvent

  • Thrown to indicate that an adbreak has been added.

    • ad : the AdBreak

    Declaration

    Swift

    @objc(THEOplayerAddAdBreakEvent)
public class AddAdBreakEvent : AdBreakEvent

  • Thrown to indicate that an adbreak has been updated.

    • ad : the AdBreak

    Declaration

    Swift

    @objc(THEOplayerUpdateAdBreakEvent)
public class UpdateAdBreakEvent : AdBreakEvent

  • Thrown to indicate that an adbreak has been removed.

    • ad : the AdBreak

    Declaration

    Swift

    @objc(THEOplayerRemoveAdBreakEvent)
public class RemoveAdBreakEvent : AdBreakEvent

  • Thrown to indicate that an adbreak has changed.

    • ad : the AdBreak

    Declaration

    Swift

    @objc(THEOplayerAdBreakChangeEvent)
public class AdBreakChangeEvent : AdBreakEvent

  • Represents the base for all other player events.

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

  • Represents a network configuration.

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

    Declaration

    Swift

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

  • A builder class to help initialize a NetworkConfiguration instance.

    See more

    Declaration

    Swift

    @objc(THEOplayerNetworkConfigurationBuilder)
public class NetworkConfigurationBuilder : NSObject

  • Builder class for the THEOplayerConfiguration object.

    See more

    Declaration

    Swift

    @objc
public class THEOplayerConfigurationBuilder : NSObject

  • A set of configurations for different key systems.

    See more

    Declaration

    Swift

    @objc(THEOplayerKeySystemConfigurationCollection)
public final class KeySystemConfigurationCollection : NSObject
    extension KeySystemConfigurationCollection: Codable

  • A set of DRM parameters.

    See more

    Declaration

    Swift

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

  • 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

  • A builder to create CachingParametersTrackSelections.

    Since

    v5.0.0
    See more

    Declaration

    Swift

    @objc(THEOplayerCachingParametersTrackSelectionBuilder)
public class CachingParametersTrackSelectionBuilder : NSObject

  • The cast error.

    See more

    Declaration

    Swift

    @objc(THEOplayerCastError)
public class CastError_Objc : NSObject

  • Fired when the CachingTask.status changes to .error.

    See more

    Declaration

    Swift

    @objc(THEOplayerCachingTaskErrorStateChangeEvent)
public class CachingTaskErrorStateChangeEvent : CachingTaskStateChangeEvent

  • Fired when the CachingTask.status changes to .idle.

    See more

    Declaration

    Swift

    @objc(THEOplayerCachingTaskIdleStateChangeEvent)
public class CachingTaskIdleStateChangeEvent : CachingTaskStateChangeEvent