# @plotly/dash-player > Dash player component for videos Latest version **1.1.0** (published 2023-03-22) · MIT license · 0 weekly downloads ## Install ```sh npm install @plotly/dash-player pnpm add @plotly/dash-player yarn add @plotly/dash-player bun add @plotly/dash-player ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2023-03-22 | | First published | 2022-09-19 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | ^16.17.0 | | Dependencies | 1 | | Unpacked size | 1.8 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 81 | | Author | Xing Han Lu | | Maintainers | lconnors, alexshoe, t4rk, bronsolo, jmmease, chriddyp, bpostlethwaite, alexcjohnson, nicolaskruchten, antrg, archmoj, xhlu, hammadtheone | ## Links - npm: https://www.npmjs.com/package/@plotly/dash-player - Repository: https://github.com/plotly/dash-player - Issues: https://github.com/plotly/dash-player/issues - npm.io page: https://npm.io/package/@plotly/dash-player ## Dependencies (1) - [react-player](https://npm.io/package/react-player.md) 2.12.0 ## Recent versions - 1.1.0 (latest) — 2023-03-22 - 1.0.6 — 2022-12-12 - 1.0.5 — 2022-12-08 - 1.0.4 — 2022-12-02 - 1.0.1 — 2022-10-20 - 0.0.2 — 2022-09-19 ## README # Dash Player ![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg) [![GitHub stars](https://img.shields.io/github/stars/xhlulu/dash-player.svg)](https://github.com/xhlulu/dash-player/stargazers) Dash Player is a Dash component for playing a variety of URLs, including file paths, YouTube, Facebook, Twitch, SoundCloud, Streamable, Vimeo, Wistia, Mixcloud, and DailyMotion. It is wrapped around the [ReactPlayer](https://github.com/cookpete/react-player) component. For more detailed documentation on Dash Player and how to use it, visit the official [Dash Player documentation page](https://dash.plotly.com/dash-player) For updates and more, please see the ongoing changes to this repository's issue tracker or the Dash community discussion on Dash Player. This is a custom community component, so if your organization or company is interested in sponsoring enhancements to this project, [please reach out to the Plotly Dash team](https://plot.ly/dash/pricing). ## Getting started Here are the following steps to get started with using Dash Player in your own Dash apps ```sh $ pip install dash-player ``` ## Documentation | Prop | Description | Default | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `id` | The ID used to identify this component in Dash callbacks. | | `className` | The CSS class used to identify this component in external stylesheets. | | `url` | The url of the media to be played. | | `playing` | Whether or not the media is currently playing. Can be set to `True` or `False` to play and pause the media, respectively. | `false` | | `loop` | Whether or not the media will loop once the player reaches the end. Can be set to `True` or `False` to set looping on or off, respectively. | `false` | | `controls` | Set to true or false to display native player controls. Vimeo, Twitch and Wistia player will always display controls. | `false` | | `volume` | A number between `0` and `1` representing the volume of the player. If set to None, Dash Player ises default volume on all players. | `null` | | `muted` | Set to true or false to mute or unmute player volume, respectively. Only works if volume is set. | `false` | | `playbackRate` | Set the playback rate of the player (only supported by YouTube, Wistia, and file paths). | | `width` | A number or string representing the pixel width of the player. | `640px` | | `height` | A number or string representing the pixel height of the player. | `360px` | | `style` | Optional additional CSS styles. If width or height are supplied within style, then this will override the component-level width or height. | `{}` | | `playsinline` | Applies the html5 playsinline attribute where supported, which allows videos to be played inline and will not automatically enter fullscreen mode when playback begins (for iOS). | `false` | | `currentTime` | Returns the number of seconds that have been played | | `secondsLoaded` | Returns the number of seconds that have been loaded | | `duration` | Returns the duration (in seconds) of the currently playing media | | `intervalCurrentTime` | Interval in milliseconds at which currentTime prop is updated. | `40` | | `intervalSecondsLoaded` | Interval in milliseconds at which secondsLoaded prop is updated. | `500` | | `intervalDuration` | Interval in milliseconds at which duration prop is updated. | `500` | | `seekTo` | Seek to the given number of seconds, or fraction if amount is between `0` and `1` | `null` | ## Built With - [Dash](https://dash.plot.ly/) - Main server and interactive components - [ReactPlayer](https://www.npmjs.com/package/react-player) - The react component that was wrapped by this ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. ## Authors - **Xing Han** - _Initial Work_ - [@xhluca](https://github.com/xhluca) - **Alex Hsu** - _Maintainer/Ongoing Developer_ - [@alexshoe](https://github.com/alexshoe) - **Alex Johnson** - _Code Review_ - [@alexcjohnson](https://github.com/alexcjohnson) See also the list of [contributors](https://github.com/xhlulu/dash-player/contributors) who participated in this project. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details ## Partnership Changes to `dash-player` were sponsored by Volkswagen's Center of Excellence for Battery Systems.

--- _Source: https://npm.io/package/@plotly/dash-player · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._