Type Alias WhepClientViewRef

A type that represents the ref to the WhepClientView component. It contains methods to start, stop, and toggle Picture-in-Picture mode.

type WhepClientViewRef = {
    startPip: () => void;
    stopPip: () => void;
    togglePip: () => void;
}

Properties

startPip: () => void

Starts the Picture-in-Picture mode. On android enters the Picture-in-Picture mode and background the app.

stopPip: () => void

Stops the Picture-in-Picture mode. Does nothing on Android as PiP is not supported in foreground.

togglePip: () => void

Toggles the Picture-in-Picture mode. On android enters the Picture-in-Picture mode and background the app.