https://github.com/dennisinteractive/video-player-plugin

Video player plugin that uses the Youtube api
https://github.com/dennisinteractive/video-player-plugin

Last synced: 6 days ago
JSON representation

Video player plugin that uses the Youtube api

• Host: GitHub
• URL: https://github.com/dennisinteractive/video-player-plugin
• Owner: dennisinteractive
• License: mit
• Created: 2016-05-16T15:08:18.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-23T14:21:00.000Z (over 6 years ago)
• Last Synced: 2024-12-12T11:47:56.063Z (22 days ago)
• Language: HTML
• Homepage: http://dennisinteractive.github.io/video-player-plugin/
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Youtube video player plugin

Video player plugin that uses the Youtube api

## Usage

Install with [Bower](http://bower.io): `$ bower install video-player-plugin --save`.

```javascript

  var myVideo = new Player({

    videoId: '9FiNW55mPxw'

  });

```

-- or --

```HTML

  


```


## Settings

Option | Type | Default | Description

------ | ---- | ------- | -----------

videoId | string | null | Sets ID of video to be displayed.

width | int | 480 | Sets width of video.

height | int | 270 | Sets height of video.

responsive | int | null | Sets width of player to 100% and maintains aspect ratio.

autoPlay | int | null | Autoplay video on page load. Takes 1 or 0. Use 0 to turn autoPlay off.

controls | int | null | Show/ hide the default vide controls. Takes 1 or 0. Use 0 to turn controls off.

relatedVideos | int | 0 | Show/ hide vide controls. Takes 1 or 0.

showInfo | int | null | Show/ hide video title and Youtube header on video. Takes 1 or 0.

mute | boolean | null | Mute Youtube video. Takes 1 or 0.

playBtn | string | null | Custom play button selector. Creates button and adds custom class to it.

playBtnText | string | 'Play' | Customise play button text.

pauseBtn | string | null | Custom pause button selector. Creates button and adds custom class to it.

pauseBtnText | string | 'Pause' | Customise pause button text.

placement | string | null | Specify where you would like the video to appear. After body tag by default.

videoContainer | string | null | Specify where you would like the video to appear when using data attributes. A selector string which identifies the element to use to place the video that exists within the video container.

## Road map

- ~~Ability to place more than one video on the same page

    (Currently works when using the API)~~

- ~~Allow users to hook into the Youtube events and create custom ones if needed~~

- ~~Reduce the need to look for an element on the page twice when using data attributes~~

---

© 2016, produced and maintained for [Dennis Digital][dennis], free under the [MIT License][license]

[license]:https://raw.githubusercontent.com/dennisinteractive/video-player-plugin/master/LICENSE

[dennis]:http://www.dennis.co.uk/