PiPConfiguration

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

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

  • Whether the presentation mode should be retained on source changes. Defaults to false.

    Remark

    When using native Picture in Picture (when nativePictureInPicture = true), then this property will only work if the new source is not nil, and the source will be preloaded.

    Declaration

    Swift

    @objc
public let retainPresentationModeOnSourceChange: Bool

  • Disables seekability while in native Picture in Picture mode. This can be useful when playing advertisements for instance. Defaults to false.

    Remark

    This only works in Native Picture in Picture. (when nativePictureInPicture = true) This has a minimum requirement of iOS/tvOS 14.0 and does not work on simulators.

    Since

    v5.0.1

    Declaration

    Swift

    @objc
public let requiresLinearPlayback: Bool

  • Enable the Native Picture in Picture. Defaults to false.

    Remark

    This has a minimum requirement of iOS 14.0 and does not work on simulators.

    Since

    v2.85.2

    Declaration

    Swift

    @objc
public let nativePictureInPicture: Bool

  • Native Picture in Picture starts automatically when the player is embedded inline and the app transitions to the background. Defaults to false.

    Remark

    This only works in Native Picture in Picture. (when nativePictureInPicture = true) This has a minimum requirement of iOS 14.2 and does not work on simulators.

    Since

    v3.5.0

    Declaration

    Swift

    @objc
public let canStartPictureInPictureAutomaticallyFromInline: Bool