logo
THEOplayer
ABR
Ads
Caching
Content protection
Analytics
Casting
Media and Text Tracks
Miscellaneous
Verizon Media
Source
Events
SSAI
Network
Presentation
PiPConfigurationPiPPositionPresentationPresentationEventMapPresentationModePresentationModeChangeEvent
Player
UI
VR

THEOplayer > PiPConfiguration

PiPConfiguration interface

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

Signature:

export interface PiPConfiguration 

Properties

Property

Type

Description

position (optional)

PiPPosition

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

retainPresentationModeOnSourceChange (optional)

boolean

Whether the presentation mode should be retained on source changes.

visibility (optional)

number | undefined

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

Property Details

position

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

Signature:

position?: PiPPosition;

retainPresentationModeOnSourceChange

Whether the presentation mode should be retained on source changes.

Signature:

retainPresentationModeOnSourceChange?: boolean;

visibility

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

Signature:

visibility?: number | undefined;

Remarks


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

github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
San Francisco
Singapore
Barcelona