Interface VideoPlayerProps

interface VideoPlayerProps {
    config?: Config;
    controls?: boolean;
    fallback?: ReactElement<any, string | JSXElementConstructor<any>>;
    height?: string | number;
    interaction?: boolean;
    light?: string | boolean | ReactElement<any, string | JSXElementConstructor<any>>;
    loop?: boolean;
    muted?: boolean;
    onBuffer?: (() => void);
    onBufferEnd?: (() => void);
    onClickPreview?: ((event) => void);
    onDisablePIP?: (() => void);
    onDuration?: ((duration) => void);
    onEnablePIP?: (() => void);
    onEnded?: (() => void);
    onError?: ((error, data?, hlsInstance?, hlsGlobal?) => void);
    onPause?: (() => void);
    onPlay?: (() => void);
    onProgress?: ((state) => void);
    onReady?: ((player) => void);
    onSeek?: ((seconds) => void);
    onStart?: (() => void);
    opacity?: number;
    pip?: boolean;
    playIcon?: ReactElement<any, string | JSXElementConstructor<any>>;
    playbackRate?: number;
    playing?: boolean;
    playsinline?: boolean;
    previewTabIndex?: null | number;
    progressInterval?: number;
    stopOnUnmount?: boolean;
    style?: CSSProperties;
    url?: string | string[] | SourceProps[] | MediaStream;
    volume?: number;
    width?: string | number;
    wrapper?: ComponentType<{
        children: ReactNode;
    }>;
}

Hierarchy

  • ReactPlayerProps
    • VideoPlayerProps

Properties

config? controls? fallback? height? interaction? light? loop? muted? onBuffer? onBufferEnd? onClickPreview? onDisablePIP? onDuration? onEnablePIP? onEnded? onError? onPause? onPlay? onProgress? onReady? onSeek? onStart? opacity? pip? playIcon? playbackRate? playing? playsinline? previewTabIndex? progressInterval? stopOnUnmount? style? url? volume? width? wrapper?

Properties

Optional config

config?: Config

Optional controls

controls?: boolean

Optional fallback

fallback?: ReactElement<any, string | JSXElementConstructor<any>>

Optional height

height?: string | number

Optional interaction

interaction?: boolean

Optional light

light?: string | boolean | ReactElement<any, string | JSXElementConstructor<any>>

Optional loop

loop?: boolean

Optional muted

muted?: boolean

Optional onBuffer

onBuffer?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onBufferEnd

onBufferEnd?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onClickPreview

onClickPreview?: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: any

      Returns void

Optional onDisablePIP

onDisablePIP?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onDuration

onDuration?: ((duration) => void)

Type declaration

    • (duration): void

    • Parameters

      • duration: number

      Returns void

Optional onEnablePIP

onEnablePIP?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEnded

onEnded?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onError

onError?: ((error, data?, hlsInstance?, hlsGlobal?) => void)

Type declaration

    • (error, data?, hlsInstance?, hlsGlobal?): void

    • Parameters

      • error: any
      • Optional data: any
      • Optional hlsInstance: any
      • Optional hlsGlobal: any

      Returns void

Optional onPause

onPause?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onPlay

onPlay?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onProgress

onProgress?: ((state) => void)

Type declaration

    • (state): void

    • Parameters

      • state: OnProgressProps

      Returns void

Optional onReady

onReady?: ((player) => void)

Type declaration

    • (player): void

    • Parameters

      • player: default

      Returns void

Optional onSeek

onSeek?: ((seconds) => void)

Type declaration

    • (seconds): void

    • Parameters

      • seconds: number

      Returns void

Optional onStart

onStart?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional opacity

opacity?: number

Optional pip

pip?: boolean

Optional playIcon

playIcon?: ReactElement<any, string | JSXElementConstructor<any>>

Optional playbackRate

playbackRate?: number

Optional playing

playing?: boolean

Optional playsinline

playsinline?: boolean

Optional previewTabIndex

previewTabIndex?: null | number

Optional progressInterval

progressInterval?: number

Optional stopOnUnmount

stopOnUnmount?: boolean

Optional style

style?: CSSProperties

Optional url

url?: string | string[] | SourceProps[] | MediaStream

Optional volume

volume?: number

Optional width

width?: string | number

Optional wrapper

wrapper?: ComponentType<{
    children: ReactNode;
}>

Type declaration

  • children: ReactNode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc