https://github.com/adamwych/ox-player

Video player with only the most basic features.
https://github.com/adamwych/ox-player

javascript library

Last synced: 3 months ago
JSON representation

Video player with only the most basic features.

• Host: GitHub
• URL: https://github.com/adamwych/ox-player
• Owner: adamwych
• License: gpl-3.0
• Created: 2017-12-12T19:23:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-12T19:47:45.000Z (over 7 years ago)
• Last Synced: 2025-01-13T02:25:12.838Z (4 months ago)
• Topics: javascript, library
• Language: JavaScript
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ox Player

Video player written in JavaScript with only the most basic features, like playing, pausing, and changing the volume.

## Building

To build Ox you will need Node.js.

After you've installed it - follow the instructions on how to download the dependencies and build the library.

Execute following commands from the root directory:

1. Install Gulp's CLI using `npm install -g gulp-cli`.

2. Install required dependencies using `npm install`.

3. Build the library using `gulp build`.

The library should now be in `dist` folder.

## Usage

Simply call oxPlayer() on the `````` element you want to initialize the player for.

```javascript

$('.my-video').oxPlayer(options);

```

You can pass additional options to the function, if you want.

| Name        | Description                                                  | Possible values    | Default value  |

| ----------- |:------------------------------------------------------------:| ------------------:| --------------:|

| autoPlay    | Whether the video should start playing after the page loads. | true/false         | false          |

| volume      | The volume that the video should start playing at.           | number between 0-1 | 0.5            |

## License

GPL v3.