https://github.com/luwes/vimeowrap.js

Vimeo player embedder extendable with plugins
https://github.com/luwes/vimeowrap.js

javascript vimeo vimeo-api

Last synced: 17 days ago
JSON representation

Vimeo player embedder extendable with plugins

• Host: GitHub
• URL: https://github.com/luwes/vimeowrap.js
• Owner: luwes
• Created: 2012-05-15T06:25:52.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T14:46:23.000Z (over 3 years ago)
• Last Synced: 2024-10-03T12:16:30.511Z (about 1 month ago)
• Topics: javascript, vimeo, vimeo-api
• Language: JavaScript
• Homepage: https://wesleyluyten.com/projects/vimeo-wrap/
• Size: 4.86 MB
• Stars: 48
• Watchers: 10
• Forks: 25
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Deprecated!

See https://github.com/playerxo/playerx for the evolution of this project!

# vimeowrap.js

vimeowrap is an easy to use Vimeo player embedder that can be extended with plugins.

## Features

* Uses oEmbed so the embed code is always up to date

* Playlist support, play videos one after another

* Extendable with plugins

## Usage

### Basic

``` html



	vimeowrap('player').setup({

		urls: [

			'https://vimeo.com/user3709818'

		]

	});

```

### Carousel Plugin

``` html



	vimeowrap('player').setup({

		urls: [

			'https://vimeo.com/user3709818'

		],

		plugins: {

			'carousel': {}

		}

	});

```

## Configuration

	parameter

	default

	description

	

		urls

		

		(required) Array with the Vimeo URL's. User or video URL's are supported.

	

	

		width

		480

		Width of the Vimeo player.

	

	

		height

		280

		Height of the Vimeo player.

	

	

		autoplay

		false

		Automatically start playback of the video. Note that this won’t work on some devices.

	

	

		repeat

		none

		

			What to do when the video has ended.


			none: stop playback when a video is completed.


			list: play each video in the playlist once, stop at the end.


			always: continously play the video (or all videos in the playlist).


			single: continously repeat the current video in the playlist.

		

	

	

		item

		0

		Use this to load the player with a specific playlist item instead of the first item.

	

	

		plugins

		

		Object with plugins. Plugins are seperate javascript files that extend the functionality of vimeowrap.

	

	

		color

		00adef

		Specify the color of the video controls.

	

	

		byline

		true

		Show the byline on the video.

	

	

		title

		true

		Show the title on the video.

	

	

		portrait

		true

		Show the user's portrait on the video.