UNPKG

@vonage/vivid-react

Version:

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

36 lines (35 loc) 2.02 kB
import React, { ReactNode, SyntheticEvent } from 'react'; /** Base class for video-player * For more info on this Vivid element please visit https://vivid.deno.dev/components/video-player * @param {string | undefined} poster - Reference to an image which is displayed before the video is played **attribute** `poster` * @param {string | undefined} src - URL of a video file **attribute** `src` * @param {boolean} autoplay - Allows the video will play automatically (muted) **attribute** `autoplay` * @param {boolean} loop - Allows the video to loop back to the beginning when finished **attribute** `loop` * @param {string} playbackRates - Sets the available playback rates. When an empty string, no choices will be available **attribute** `playback-rates` * @param {VideoPlayerMediaSkipBy} skipBy - Allows the video to loop back to the beginning when finished **attribute** `skip-by` * @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging. It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`. * @param {string} componentName - Core component name, without prefix */ declare const VwcVideoPlayer: { (props: { children?: ReactNode; slot?: string | undefined; id?: string | undefined; style?: React.CSSProperties | undefined; ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined; onPlay?: ((event: SyntheticEvent) => void) | undefined; onPause?: ((event: SyntheticEvent) => void) | undefined; onEnded?: ((event: SyntheticEvent) => void) | undefined; poster?: string | undefined; src?: string | undefined; autoplay?: boolean | undefined; loop?: boolean | undefined; playbackRates?: string | undefined; skipBy?: any; VIVID_VERSION?: string | undefined; componentName?: string | undefined; }): JSX.Element; displayName: string; }; export default VwcVideoPlayer;