Package-level declarations

Types

open class DocumentPictureInPicture : EventTarget

The DocumentPictureInPicture interface of the Document Picture-in-Picture API is the entry point for creating and handling document picture-in-picture windows. Available only in secure contexts.

DocumentPictureInPictureEvent

open class DocumentPictureInPictureEvent(val type: EventType<DocumentPictureInPictureEvent>, init: DocumentPictureInPictureEventInit) : Event

The DocumentPictureInPictureEvent interface of the Document Picture-in-Picture API is the event object for the enter event, which fires when the Picture-in-Picture window is opened. Available only in secure contexts.

DocumentPictureInPictureEventInit

interface DocumentPictureInPictureEventInit : EventInit

MDN Reference

DocumentPictureInPictureOptions

interface DocumentPictureInPictureOptions

Properties

documentPictureInPicture

external val documentPictureInPicture: DocumentPictureInPicture

The documentPictureInPicture read-only property of the Window interface returns a reference to the DocumentPictureInPicture object for the current document context. Available only in secure contexts.

ENTER

val DocumentPictureInPictureEvent.Companion.ENTER: EventType<DocumentPictureInPictureEvent>

enterEvent

val <C : DocumentPictureInPicture> C.enterEvent: EventInstance<DocumentPictureInPictureEvent, C, C>

MDN Reference

Functions

requestWindow

inline suspend fun DocumentPictureInPicture.requestWindow(): Window

inline suspend fun DocumentPictureInPicture.requestWindow(options: DocumentPictureInPictureOptions): Window

The requestWindow() method of the DocumentPictureInPicture interface opens the Picture-in-Picture window for the current main browsing context. It returns a Promise that fulfills with a Window instance representing the browsing context inside the Picture-in-Picture window.