Documentation

Embedding Videos via URL

Simply paste the URL into from a supported video hosting service containing the video you would like to embed on its own line. As a bonus you can pass parameters prefixed with ‘arve-‘. If your URL already contains a query (everything behind a ?) then you need to start with &

ttp://www.youtube.com/watch?v=GjL82KUHVb0&list=PLI46g-I12_9qGBq-4epxOay0hotjys5iA&index=10&arve-mode=thumbnail

Limitations

  • Some providers are not supported via URL, see sidebar.
  • For URLS with a # in it adding arguments with not work (Dailymotion playlists)

Examples

Simple Vimeo embed
http://vimeo.com/23316783

Thumbnail aligned right
http://vimeo.com/23316783?arve-mode=thumbnail&arve-align=right

Embedding via Shortcodes

Press the ‘Embed Video’ button in your post editor in WordPress and paste the URL or Embed code into the field, optionally select options and press ‘Insert Shortcode’. You can of course manually write shortcodes.

Examples

[vimeo id=23316783] will be embedded with settings from the options page.

[youtube id=23316783 mode=normal maxwith=300 align=right parameters="start=123 end=234"] will overwrite mode and maxwidth from the options and apply align and start+endtime in seconds.

For more examples visit the Tests and Examples page.

Supported Attributes

Attribute Used for
id Is required for shortcodes and automatically generated within the shortcode button, obsolete for embeds via URL. For the [iframe] Shortcode this becomes the what would be the src for in a html iframe code
mode lazyload/normal/thumbnail, optional option override
autoplay optional option override
aspect_ratio for example 4:3
maxwidth maximal width for videos in normal mode, optional option override
align left/right/center
start only for vimeo (1m2s format)
parameters support for custom URL parameters providers offer, currently only supported via shortcodes, will merge/overwrite with the values set on the options page

General Iframe Embedding

This plugin not changes anything to usual HTML <iframe> embed codes you have to use the shortcode creator dialog and paste iframe embed codes there or write them manually. They will become [iframe id="http://..."]. The id= represents what is the src= in HTML embeds.

Recommended use of Options and Attributes

Attributes always override options. It is recommended that you set the the options Mode, Maximal Video Width and Autoplay in a way that you want most (if not all) Videos appear on your site. You should only use attributes if you want some videos appear different then general ones rather then declaring this attributes for every single video.

For example if you have set Mode = Normal and Maximal Video Width = 500 the plugins options page, then URLS and Shortcodes will use that options to embed your videos. You can then decide to have a single video displayed as a thumbnail by adding a the mode attribute and setting it to thumbnail

Parameters

The parameters shortcode attribute is meant to allow users to use all kinds of options to customize embeds. They represent the URL paramaters some provioders offer

In ARVE you can use the parameter shortcode attribute to let the plugin create responsive embeds like this for you. And its more advanced that that. It also merges this parameters with the ones you have setup on the options page and allows to replace & characters with spaces for better readability. Lets assume you have the parameters for YouTube set to iv_load_policy=3 rel=0 wmode=transparent where iv_load_policy=3 disables annotations but now you want to enable annotations for a single video and enable related videos at the end. You would create this shortcode:

[youtube id="123456" paramaters="iv_load_policy=1 start=123"]

This shorcode would create the parameters

?iv_load_policy=1&rel=0&wmode=transparent&start=123, rather then just

?iv_load_policy=1&start=123 because it merges the one from the options page, overriding existing ones and adding not set ones.

As for shortcode attributes it is also recommended to prefer options instead of adding the same parameters to every single video. While obviously parameters like start and end make not much sense on the options page.

Parameters for providers that are currently have on option field are ignored inside shortcodes. If you happed to find out one of them supports parameters please let me know.

Manual Shortcode Creation

This is not really needed anymore since the URL embeds and the shortcode Editor should detect the IDs automatically, but in case something fails or you have no access to the rich text editor and need to embed from providers that are not supported via URL.

The id of a video is easy to find in the providers URL, for example:

  • metacafe.com/watch/237147/9_11_alex_jones_and_charlie_sheen_interview
  • youtube.com/watch?v=QFbKhAfw4RI&hd=1
  • vimeo.com/48237385
  • dailymotion.com/video/abcdef_some_long_title

I won’t list all here, they are easy to guess. exceptions below:

For Ustream when you can often get the id from the URL http://www.ustream.tv/recorded/28355397/highlight/316911 all this is the id! Sometimes its just like this http://www.ustream.tv/28355397/ if you are on a channel that has no number in the URL then go hover over the video and click share->url-icon (below the twitter icon), a URL like this http://www.ustream.tv/channel/12882755 will be copied to your clipboard, that number is your video id.

Exceptions for the getting the embed code instead of the URL

  • Videojug: <object […] /player?id=e37b3839-21e4-de7d-f6ee-ff0008ca2ccd“> […]
  • Gametrailers, Comedycentral and Spike: […] <iframe src=”[…] http://media.mtvnservices.com/embed/mgid:arc:video:comedycentral.com:8a0cde95-c528-44b9-ab44-5ff91955a38d” […]