Interface PiPConfiguration

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

interface PiPConfiguration {
    reparentPip?: boolean;
    retainPipOnSourceChange?: boolean;
    startsAutomatically?: boolean;
}

Properties

reparentPip? retainPipOnSourceChange? startsAutomatically?

Properties

Optional Readonly reparentPip

reparentPip?: boolean

Whether Picture in Picture should reparent player to the root.

Default Value

false

Platform

Android

Optional Readonly retainPipOnSourceChange

retainPipOnSourceChange?: boolean

Whether Picture in Picture should remain active when setting a new (non-undefined) source.

Default Value

false

Platform

iOS

Optional Readonly startsAutomatically

startsAutomatically?: boolean

Whether Picture in Picture should be allowed to start automatically from inline, when transitioning to background.

Default Value

false

Settings

Member Visibility

Theme

On This Page

reparentPipretainPipOnSourceChangestartsAutomatically