rc-dplayer
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

rc-dplayer

This is a wrapper of DPlyer;

It contains hls.js and flv.js,you can play your video directly.

As of version 1.0.0, the HLS protocol supports HEVC encoding.

Since Chrome 107 version supports HEVC hardware decoding function, this project upgrades hls.js and realizes HLS + HEVC video stream playback based on hardware decoding capability

Install

npm

npm install rc-dplayer

pnpm

pnpm add rc-dplayer

Examples

import { Player as RcDPlayer } from "rc-dplayer";

const App = () => {
  return (
    <RcDPlayer
      src="/test.mp4"
      options={{
        autoplay: true,
      }}
      onLoad={(dp) => {
        console.log("DPlayer instance", dp);
      }}
      onError={(event) => {
        console.error("error", event);
      }}
    />
  );
};

Props

name type description default
src string Video source . -
mseType MseType MSE type . MseType.default
autoLoad boolean Auto load video when it`s true and src exits. true
options DPlayerOptions The other options of DPlayer . -
customControllers CustomController[] Custom controller -
onLoad (dp: DPlayer) => void Callback of player loaded -

Events

Support HTML media events and DPlayer events.

// React DPlayer Events
export interface DPlayerEventsProps {
  onScreenshot?: (blobUrl: string) => void;
  onThumbnailsShow?: () => void;
  onThumbnailsHide?: () => void;
  onDanmakuShow?: () => void;
  onDanmakuHide?: () => void;
  onDanmakuClear?: () => void;
  onDanmakuLoaded?: () => void;
  onDanmakuSend?: () => void;
  onDanmakuOpacity?: () => void;
  onContextmenuShow?: () => void;
  onContextmenuHide?: () => void;
  onNoticeShow?: () => void;
  onNoticeHide?: () => void;
  onQualityStart?: () => void;
  onQualityEnd?: () => void;
  onDestroy?: () => void;
  onFullscreen?: () => void;
  onFullscreenCancel?: () => void;
  onSubtitleShow?: () => void;
  onSubtitleHide?: () => void;
  onSubtitleChange?: () => void;
}

Interface

export enum MseType {
  hls = "m3u8",
  flv = "flv",
  default = "default",
}
type ControllerPosition = "left" | "right";

export interface CustomController {
  key: Key;
  position: ControllerPosition;
  component: ReactNode;
  onClick?: (event: ReactMouseEvent<HTMLDivElement, MouseEvent>) => void;
}

Ref methods

name type description
load (url?: string, mseType?: MseType) => DPlayer Load video by yourself .

License

rc-dplayer is released under the MIT license.

Package Sidebar

Install

npm i rc-dplayer

Weekly Downloads

85

Version

1.0.0

License

MIT

Unpacked Size

3.02 MB

Total Files

13

Last publish

Collaborators

  • linktodream