video_embed_field

Important note:

If you are installing this module for integration with a media library, core already contains all the tools required for embedding remotely hosted videos. This module should no longer be required for most use cases and should be avoided if possible. For more information see the documentation for configuring remote video in core or migrating to core media from Video Embed Field.

Video Embed field creates a simple field type that allows you to embed videos from YouTube and Vimeo and show their thumbnail previews simply by entering the video's url.

Above on the left is an example of using the video field type (displaying an embedded video as well as thumbnail previews of related videos) and on the right is an example of the wysiwyg integration, allowing you to embed videos into ckeditor.

Features

• Responsive out the box, optionally make your videos scale proportionally to their container.
• Large contrib ecosystem of video providers supported.
• Easily pluggable, write simple plugins to support any video platform or provider.
• Robust URL matching to support an array of possible inputs.
• Display videos in a modal window, with Colorbox support.
• Display thumbnails with image style support.
• Role based autoplay override, allows configured roles to suppress video autoplay.
• Easily overridable embed markup.
• A direct WYSIWYG integration, provided by the video_embed_wysiwyg sub-module.
• Integration with the media_entity module for websites using the media suite of modules.
• Migrations to D8 from D7 as well as the D6 emfield module.

Video Providers

Vimeo and YouTube are provided by default, but a number of contrib modules exist for other providers:

• YouTube and Vimeo (packaged with the module)
• Facebook
• Vine
• Dailymotion
• Instagram
• Ted
• AOL
• Wistia
• Google Drive
• HTML5
• Hudl
• Peertube

• Metacafe
• MySpace
• Rutube
• Youku
• Dreambroker
• Vidyard
• Brightcove
• Hulu
• JW Player
• Vzaar
• TwentyThree
• Kaltura

Configuration

Once a video field has been created, simply configure how it should be displayed using the 'Video' or 'Thumbnail' field formatter. Each of these field formatters contain standard configuration options which allow you to customise how the content is displayed. In the Drupal 7 version 'styles' can be created which control the display for different video providers, however in the Drupal 8 version, the configuration for all the field formatters are standardized across all video providers.

Media Entity Integration

For websites using the media suite of modules for Drupal 8, video_embed_field comes with a media_entity integration. This allows you to create a media bundle specifically for storing embeddable videos and use these alongside your other media bundles.

Video WYSIWYG Integration

If you are not using the media suite of modules, there is a direct integration with the WYSIWYG. To use, make sure you have the "video_embed_wysiwyg" module enabled. Visit "Configuration" > "Text formats and editors" > "Configure" your chosen editor. Then drag the video icon onto the ckeditor toolbar and make sure the "Video Embed WYSIWYG" input filter is enabled.

For Developers

For the Drupal 7 version, see video_embed_field.api.php for information on how to create a video provider. For Drupal 8, you can implement a 'VideoEmbedProvider' plugin to allow other video platforms to be supported. For examples of this, see the plugins directory. More information for developers using the Drupal 8 version can be found here.

Support

For support updating to the latest version on the Drupal 7 version, see the documentation page. All other issues can be reported in the issue queue.

Version 3.x

⚠️ Breaking changes from 8.x-2.x

• A new file_system parameter has been added to the ProviderPluginBase constructor. Please update your custom providers accordingly if you need the thumbnail download feature.
• Two new parameters have been added to the renderEmbedCode provider method to improve accessibility (iframe).

Media Entity Support: Which version should I use?

If you are using the 1.x branch of Media Entity, you should continue using the 1.x branch of this module.

If you are building a new site and want to use the new Media in core 8.4.0 or higher, you should use the 2.x branch of this module.

If you have an existing site with Media Entity 1.x and you want to upgrade to Media in core check the upgrade instructions on the Media Entity module page for more information on that process.