rooks
Version:
Collection of awesome react hooks
20 lines (19 loc) • 680 B
TypeScript
import { RefObject } from "react";
type PictureInPictureApi = {
isPiPActive: boolean;
isSupported: boolean;
error: Error | null;
pipWindow: PictureInPictureWindow | null;
enterPiP: () => Promise<void>;
exitPiP: () => Promise<void>;
toggle: () => Promise<void>;
};
/**
* Hook for managing Picture-in-Picture video functionality
*
* @param videoRef - Reference to the video element
* @returns Object containing PiP state and control functions
* @see https://rooks.vercel.app/docs/hooks/usePictureInPictureApi
*/
declare function usePictureInPictureApi(videoRef: RefObject<HTMLVideoElement>): PictureInPictureApi;
export { usePictureInPictureApi };