Package: dash-player
Dash PlayerDash 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 theReactPlayercomponent.For more detailed documentation on Dash Player and how to use it, visit the officialDash Player documentation pageFor 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.Getting startedHere are the following steps to get started with using Dash Player in your own Dash apps$pipinstalldash-playerDocumentationPropDescriptionDefaultidThe ID used to identify this component in Dash callbacks.classNameThe CSS class used to identify this component in external stylesheets.urlThe url of the media to be played.playingWhether or not the media is currently playing. Can be set toTrueorFalseto play and pause the media, respectively.falseloopWhether or not the media will loop once the player reaches the end. Can be set toTrueorFalseto set looping on or off, respectively.falsecontrolsSet to true or false to display native player controls. Vimeo, Twitch and Wistia player will always display controls.falsevolumeA number between0and1representing the volume of the player. If set to None, Dash Player ises default volume on all players.nullmutedSet to true or false to mute or unmute player volume, respectively. Only works if volume is set.falseplaybackRateSet the playback rate of the player (only supported by YouTube, Wistia, and file paths).widthA number or string representing the pixel width of the player.640pxheightA number or string representing the pixel height of the player.360pxstyleOptional additional CSS styles. If width or height are supplied within style, then this will override the component-level width or height.{}playsinlineApplies 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).falsecurrentTimeReturns the number of seconds that have been playedsecondsLoadedReturns the number of seconds that have been loadeddurationReturns the duration (in seconds) of the currently playing mediaintervalCurrentTimeInterval in milliseconds at which currentTime prop is updated.40intervalSecondsLoadedInterval in milliseconds at which secondsLoaded prop is updated.500intervalDurationInterval in milliseconds at which duration prop is updated.500seekToSeek to the given number of seconds, or fraction if amount is between0and1nullBuilt WithDash- Main server and interactive componentsReactPlayer- The react component that was wrapped by thisContributingPlease readCONTRIBUTING.mdfor details on our code of conduct, and the process for submitting pull requests to us.AuthorsXing Han-Initial Work-@xhlucaAlex Hsu-Maintainer/Ongoing Developer-@alexshoeAlex Johnson-Code Review-@alexcjohnsonSee also the list ofcontributorswho participated in this project.LicenseThis project is licensed under the MIT License - see theLICENSEfile for detailsPartnershipChanges todash-playerwere sponsored by Volkswagen's Center of Excellence for Battery Systems.