PictureInPicture Protocol Reference


                    
                    
                    currentCorner

The current PictureInPictureCorner the PiP view is displayed in.

Precondition

The presentation mode of the player must be PresentationMode.pictureInPicture.

Swift

var currentCorner: PictureInPictureCorner? { get }


                    
                    
                    configure(movable:defaultCorner:scale:visibility:margin:)

Configures the picture-in-picture (PiP) view.

Swift

func configure(movable: Bool?, defaultCorner: PictureInPictureCorner?, scale: Float?, visibility: Double?, margin: THEOMargins?)

`movable`	Indicates wheter or not the PiP view is movable.
`defaultCorner`	Indicates the default corner at which the PiP view will appear when entering PiP mode.
`scale`	Indicates the scale of the PiP view, defaults to 0.33.
`visibility`	The maximum percentage of the original player position that should be visible to enable picture-in-picture automatically, from 0 to 1. If not configured, picture-in-picture can only be turned on by setting `presentationMode` to `pictureInPicture`.
`margin`	The `THEOMargins` value indicating the distance between the PiP view and the screen.


                    
                    
                    nativePictureInPictureDelegate

The protocol that defines the methods to respond to Picture in Picture events.

Remark

For more informations check https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate. Only supported when PiPConfiguration.nativePictureInPicture is set to true.

Note

For additional methods, the delegate can conform to type AVPictureInPictureControllerDelegateExtended.

Swift

@available(iOS 14.0, tvOS 14.0, *)
var nativePictureInPictureDelegate: AVPictureInPictureControllerDelegate? { get set }


                    
                    
                    configure(configuration:)

Sets the picture-in-picture configuration dynamically.

Swift

func configure(configuration: PiPConfiguration)


                                configuration

The PipConfiguration object which describes the configuration of the picture-in-picture feature.


                    
                    
                    configure(movable:defaultCorner:scale:)

Extension method

Configures the picture-in-picture (PiP) view

Swift

func configure(movable: Bool?, defaultCorner: PictureInPictureCorner?, scale: Float?)

`movable`	Indicates whether the PiP view is movable.
`defaultCorner`	Indicates the default corner at which the PiP view will appear when entering PiP mode.
`scale`	Indicates the scale of the PiP view, defaults to 0.33.


                    
                    
                    configure(movable:defaultCorner:scale:visibility:)

Extension method

Configures the picture-in-picture (PiP) view.

Swift

func configure(movable: Bool?, defaultCorner: PictureInPictureCorner?, scale: Float?, visibility: Double?)

`movable`	Indicates whether the PiP view is movable.
`defaultCorner`	Indicates the default corner at which the PiP view will appear when entering PiP mode.
`scale`	Indicates the scale of the PiP view, defaults to 0.33.
`visibility`	The maximum percentage of the original player position that should be visible to enable picture-in-picture automatically, from 0 to 1. If not configured, picture-in-picture can only be turned on by setting `presentationMode` to `pictureInPicture`.


                    
                    
                    configure(movable:defaultCorner:scale:margin:)

Extension method

Configures the picture-in-picture (PiP) view.

Swift

func configure(movable: Bool?, defaultCorner: PictureInPictureCorner?, scale: Float?, margin: THEOMargins?)

`movable`	Indicates whether the PiP view is movable.
`defaultCorner`	Indicates the default corner at which the PiP view will appear when entering PiP mode.
`scale`	Indicates the scale of the PiP view, defaults to 0.33.
`margin`	The `THEOMargins` value indicating the distance between the PiP view and the screen.