THEOplayerConfiguration
@objc
public class THEOplayerConfiguration : NSObject, Encodable
The configuration for a THEOplayer instance.
-
Whether the chromeless player is used.
Remark
By default the player uses thechromefull
version with control buttons etc.Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var chromeless: Bool { get }
-
Whether the logic to expose date ranges parsed from HLS manifests is enabled.
Declaration
Swift
public private(set) var hlsDateRange: Bool? { get }
-
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 pre-integrated Verizon Media services that can be used with the player.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var verizonMedia: VerizonMediaConfiguration? { 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 }
-
The picture in picture configuration of the player.
Declaration
Swift
public private(set) var pip: PiPConfiguration? { get }
-
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 list of paths of optional css files to be loaded.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var cssPaths: [String] { get }
-
The list of paths of optional javascript files to be loaded.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var jsPaths: [String] { get }
-
The list of paths to javascript files which are loaded before the player is constructed.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var jsPathsPre: [String] { get }
-
Whether the default THEOplayer styling file is enabled.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var defaultCSS: Bool { get }
-
Whether picture in pitcture is enabled for this player.
Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release.") public private(set) var pictureInPicture: Bool { get }
-
The list of pre-integrated analytics services of the player.
Remark
For all possibilities, seeAnalyticsIntegration
.Declaration
Swift
@available(*, deprecated, message: "This property will be removed with the next major release. Analytics will be moved to separate modules in the form of connectors. For more info check: https://github.com/THEOplayer/iOS-Connector") public private(set) var analytics: [AnalyticsDescription] { 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 }
-
The unique identifier of the player.
Declaration
Swift
public private(set) var uid: Int? { get }
-
init(chromeless:
defaultCSS: cssPaths: jsPaths: jsPathsPre: analytics: pip: ads: ui: cast: hlsDateRange: license: licenseUrl: verizonMedia: network: ) 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( chromeless: Bool = false, defaultCSS: Bool = true, cssPaths: [String] = [], jsPaths: [String] = [], jsPathsPre: [String] = [], analytics: [AnalyticsDescription] = [], pip: PiPConfiguration? = nil, ads: AdsConfiguration? = nil, ui: UIConfiguration? = nil, cast: CastConfiguration? = nil, hlsDateRange: Bool? = nil, license: String? = nil, licenseUrl: String? = nil, verizonMedia: VerizonMediaConfiguration? = nil, network: NetworkConfiguration? = nil )
Parameters
chromeless
Whether the chromeless player, without UI, is used, defaults to false.
defaultCSS
Whether the default THEOplayer css is used, defaults to true.
cssPaths
An array of string paths of custom CSS files, defaults to an empty array. (e.g. from yourBundle.path(forResource:ofType:))
jsPaths
An array of string paths of custom JS files, defaults to an empty array. (e.g. from yourBundle.path(forResource:ofType:))
jsPathsPre
The paths to javascript files which are loaded before the player is constructed, defaults to an empty array.
analytics
The configurations for pre-integrated analytics services, defaults to an empty array.
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.
verizonMedia
The configuration for the Verizon Media services, defaults to nil.
license
the license for the player, defaults to nil.
- licenseUrl: the url to fetch 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.") @objc convenience public override init()
-
:nodoc
Declaration
Swift
public func encode(to encoder: Encoder) throws