@front10/landing-page-book
Version:
A react library for landing page
25 lines (23 loc) • 1.87 kB
Markdown
# Video
[](https://github.com/RichardLitt/standard-readme)
## Properties
| </br>Name | </br>Type | </br>Summary | </br>Default |
| ---- | ---- | ---- | ---- |
| className | `string` | Class to apply to button. | `''` |
| controls | `bool` | Set to true or false to display native player controls. Vimeo, Twitch and Wistia player will always display controls. | `true` |
| loop | `bool` | Set to true or false to loop the media. | `false` |
| muted | `bool` | Mutes the player. | `false` |
| onBuffer | `func` | Called when media starts buffering | `() => {}` |
| onDuration | `func` | Callback containing duration of the media, in seconds | `() => {}` |
| onEnded | `func` | Called when media finishes playing | `() => {}` |
| onError | `func` | Called when an error occurs whilst attempting to play media | `() => {}` |
| onPause | `func` | Called when media is paused | `() => {}` |
| onPlay | `func` | Called when media starts or resumes playing after pausing or buffering | `() => {}` |
| onProgress | `func` | Callback containing played and loaded progress as a fraction ('{ played: 0.12, playedSeconds: 11.3, loaded: 0.34, loadedSeconds: 16.7 }') | `() => {}` |
| onReady | `func` | Called when media is loaded and ready to play. If playing is set to true, media will play immediately | `() => {}` |
| onSeek | `func` | Called when media seeks with seconds parameter | `() => {}` |
| onStart | `func` | Called when media starts playing | `() => {}` |
| playing | `bool` | Set to true or false to pause or play the media. | `false` |
| source | `string` | The url of a video or song to play. | `''` |
| style | `objectOf` | Css style applied to the component | `null` |
| volume | `number` | Set the volume of the player, between 0 and 1. | `1` |