@kbss-cvut/s-forms
Version:
Semantic forms generator and processor
38 lines (37 loc) • 1.6 kB
TypeScript
export default VideoJS;
/**
* VideoJS
*
* React wrapper component for initializing and managing a Video.js player
* instance.
*
* @component
*
* @param {Object} props
* @param {string} props.type - MIME type of the video source (e.g. "application/x-mpegURL").
* @param {string} props.src - Source URL of the video stream.
* @param {boolean} [props.autoplay=false] - Whether playback should start automatically.
* @param {boolean} [props.muted=true] - Whether the video should start muted.
* @param {boolean} [props.controls=true] - Whether player controls should be visible.
* @param {boolean} [props.allowFullScreen=false] - Enables custom fullscreen handling.
* @param {boolean} [props.responsive=true] - Enables responsive resizing.
* @param {string} [props.aspectRatio="16:9"] - Aspect ratio used for fluid layout.
* @param {Function} [props.onReady] - Callback invoked when the player is ready.
* @param {Function} [props.onFullScreen] - Optional callback for custom fullscreen handling.
*
* @returns {JSX.Element} Video.js player container.
*
* @see https://videojs.org/guides/react/
*/
declare function VideoJS({ type, src, autoplay, muted, controls, allowFullScreen, responsive, aspectRatio, onReady, onFullScreen, }: {
type: string;
src: string;
autoplay?: boolean | undefined;
muted?: boolean | undefined;
controls?: boolean | undefined;
allowFullScreen?: boolean | undefined;
responsive?: boolean | undefined;
aspectRatio?: string | undefined;
onReady?: Function | undefined;
onFullScreen?: Function | undefined;
}): JSX.Element;