-
-
Notifications
You must be signed in to change notification settings - Fork 24
Add Hotkeys Plugin #165
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add Hotkeys Plugin #165
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
88df38c
Add Hotkeys Plugin
rtritto 885a619
Add init and destroy methods
rtritto 962193c
Add options
rtritto 02b1562
Fix bind of onKeydown
rtritto ae13af4
Improve conditions of hokeys if-else
rtritto 14ec53d
Refactor options
rtritto 9b5f7f9
Rename pluginParameter type
rtritto 1f904b6
Add doc
rtritto 322244a
Add elements
rtritto 177633a
Typo
rtritto bddf2b3
Improve conditions
rtritto 7c9337c
Add Vlitejs
rtritto 8b41816
Doc
rtritto 1963214
Doc
rtritto 4ab32a3
Update HTML5 example
rtritto d714d6a
Fix keydown for multiple check
yoriiis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Plugin: Hotkeys | ||
|
||
Supports for hotkeys to add keyboard shortcuts. | ||
|
||
The player accepts the following keyboard shortcuts. | ||
|
||
| Key | Action | | ||
| :---------------: | ------------------------ | | ||
| <kbd>space</kbd> | Toggle playback | | ||
| <kbd>Esc</kbd> | Exit the fullscreen | | ||
| <kbd>←</kbd> | Seek backward of `5s` | | ||
| <kbd>→</kbd> | Seek forward of `5s` | | ||
| <kbd>↑</kbd> | Increase volume of `10%` | | ||
| <kbd>↓</kbd> | Decrease volume of `10%` | | ||
|
||
## Overview | ||
|
||
| <!-- --> | <!-- --> | | ||
| ---------------- | -------------------------------------------- | | ||
| Name | `hotkeys` | | ||
| Path | `vlitejs/plugins/hotkeys` | | ||
| Entry point | `vlitejs/plugins/hotkeys/hotkeys.js` | | ||
| Provider² | `'html5', 'youtube', 'vimeo', 'dailymotion'` | | ||
| Media type³ | `'video', 'audio'` | | ||
|
||
## Usage | ||
|
||
### HTML | ||
|
||
```html | ||
<video id="player" src="<path_to_video_mp4>"></video> | ||
``` | ||
|
||
### JavaScript | ||
|
||
```js | ||
import 'vlitejs/vlite.css'; | ||
import Vlitejs from 'vlitejs'; | ||
import VlitejsHotkeys from 'vlitejs/plugins/hotkeys.js'; | ||
|
||
Vlitejs.registerPlugin('hotkeys', VlitejsHotkeys); | ||
|
||
new Vlitejs('#player', { | ||
plugins: ['hotkeys'] | ||
}); | ||
``` | ||
|
||
## Configuration | ||
|
||
The plugin allows customization with an optional object as the third parameter of the `registerPlugin` function. | ||
|
||
| Event Type | Type | Default | Description | | ||
| ------------ | :--------: | :-----: | ---------------------------------------------------------------------------- | | ||
| `seekTime` | `Number` | `5` | Set seek time seconds of the backward and forward shortcuts | | ||
| `volumeStep` | `Number` | `0.1` | Set the volume step (between 0 and 1) of the increase and decrease shortcuts | | ||
|
||
```js | ||
Vlitejs.registerPlugin('hotkeys', VlitejsHotkeys, { | ||
seekTime: 3, | ||
volumeStep: 0.2 | ||
}); | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.