Interface PiPConfiguration

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

interface PiPConfiguration {
    position?: PiPPosition;
    retainPresentationModeOnSourceChange?: boolean;
    visibility?: number;
}

Properties

position? retainPresentationModeOnSourceChange? visibility?

Properties

Optionalposition

position?: PiPPosition

The corner in which the player should be shown while in picture-in-picture.

Default Value

'bottom-right'

OptionalretainPresentationModeOnSourceChange

retainPresentationModeOnSourceChange?: boolean

Whether the presentation mode should be retained on source changes.

Default Value

false

Optionalvisibility

visibility?: number

The maximum percentage of the original player position that should be visible to enable picture-in-picture automatically.

Remarks


- If not configured, picture-in-picture can only be activated by calling Presentation.requestMode with the 'picture-in-picture' argument.

Default Value

undefined

Settings

Member Visibility

On This Page

Properties