react-player/index.d.ts

A react component for playing a variety of URLs, including file paths, YouTube, Facebook, SoundCloud, Streamable, Vidme, Vimeo and Wistia

import * as React from 'react';

export interface SourceProps {
  src: string;
  type: string;
}

export interface TrackProps {
  kind: string;
  src: string;
  srcLang: string;
  default?: boolean;
}

export interface ReactPlayerProps {
  url?: string|string[]|SourceProps[];
  playing?: boolean;
  loop?: boolean;
  controls?: boolean;
  volume?: number;
  muted?: boolean;
  playbackRate?: number;
  width?: string|number;
  height?: string|number;
  style?: Object;
  progressFrequency?: number;
  playsinline?: boolean;
  hidden?: boolean;
  className?: string;
  soundcloudConfig?: {
    options: Object;
  };
  youtubeConfig?: {
    playerVars: Object;
    preload: boolean;
  };
  facebookConfig?: {
    appId: string;
  };
  dailymotionConfig?: {
    params: Object;
    preload: boolean;
  };
  vimeoConfig?: {
    iframeParams: Object;
    preload: boolean;
  };
  vidmeConfig?: {
    format: string;
  };
  fileConfig?: {
    attributes: Object;
    tracks: TrackProps[];
    forceAudio: boolean;
    forceHLS: boolean;
    forceDASH: boolean;
  };
  wistiaConfig?: {
    options: Object;
  };
  onReady?(): void;
  onStart?(): void;
  onPlay?(): void;
  onPause?(): void;
  onBuffer?(): void;
  onEnded?(): void;
  onError?(error: any): void;
  onDuration?(duration: number): void;
  onSeek?(seconds: number): void;
  onProgress?(state: { played: number, loaded: number }): void;
}

export default class ReactPlayer extends React.Component<ReactPlayerProps, any> {
  seekTo(fraction: number): void;
}