THEOplayerConfiguration

@objc
public class THEOplayerConfiguration : NSObject, Encodable

The configuration for a THEOplayer instance.

  • Whether the logic to expose date ranges parsed from HLS manifests is enabled.

    Declaration

    Swift

    public private(set) var hlsDateRange: Bool? { get }
  • ads

    The Advertisement configuration of the player.

    Declaration

    Swift

    @available(*, deprecated, message: "This property will be removed with the next major release.")
public private(set) var ads: AdsConfiguration? { get }

  • The license for the player.

    Declaration

    Swift

    public private(set) var license: String? { get }

  • The url to fetch the license for the player.

    Declaration

    Swift

    public private(set) var licenseUrl: String? { get }
  • pip

    The picture in picture configuration of the player.

    Declaration

    Swift

    public private(set) var pip: PiPConfiguration? { get }
  • ui

    The UI configuration of the player.

    Declaration

    Swift

    @available(*, deprecated, message: "This property will be removed with the next major release.")
public private(set) var ui: UIConfiguration? { get }

  • The network configuration of the player.

    Declaration

    Swift

    public private(set) var network: NetworkConfiguration? { get }

  • The cast configuration of the player.

    Declaration

    Swift

    @available(*, deprecated, message: "This property will be removed in future releases. To configure this into GoogleCast, `CastConfiguration` can be passed to `GoogleCastIntegrationFactory.createIntegration`.")
public private(set) var cast: CastConfiguration? { get }
  • uid

    The unique identifier of the player.

    Declaration

    Swift

    public private(set) var uid: Int? { get }

  • Constructs a THEOplayerConfiguration.

    • licenseUrl: the url to fetch the license for the player, defaults to nil.
      • network: The additional network configuration, defaults to nil.

    Declaration

    Swift

    @available(*, deprecated, message: "This initializer will be removed in future releases. Use the builder `THEOplayerConfigurationBuilder` instead.")
public init(
    pip: PiPConfiguration? = nil,
    ads: AdsConfiguration? = nil,
    ui: UIConfiguration? = nil,
    cast: CastConfiguration? = nil,
    hlsDateRange: Bool? = nil,
    license: String? = nil,
    licenseUrl: String? = nil,
    network: NetworkConfiguration? = nil
    )

    Parameters

    pip

    The configuration for picture-in-picture.
    ads

    The additional advertisement configuration, defaults to nil.
    ui

    The additional UI configuration, defaults to nil.
    cast

    The additional cast configuration, defaults to nil.
    hlsDateRange

    Whether the logic to expose date ranges parsed from HLS manifests is enabled, defaults to nil.
    license

    the license for the player, defaults to nil.

  • Constructs a THEOplayerConfiguration.

    Declaration

    Swift

    @available(*, deprecated, message: "This initializer will be removed in future releases. Use the builder `THEOplayerConfigurationBuilder` instead.")
convenience public override init()

  • :nodoc

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws