Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An ExpressionEngine plugin that outputs YouTube embed code, video title, video author and URL, and a thumbnail from a YouTube URL

README.md

Antenna for ExpressionEngine 1 & 2

Antenna is a plugin that will generate the exact, most up-to-date YouTube, Vimeo, Wistia, or Viddler embed code available. It also gives you access to the video's title, its author, the author's YouTube/Vimeo URL, and a thumbnail. All you have to do is pass it a single URL.

You can also output various pieces of metadata about the video.

Support for Expression Engine 1 ended with v1.23. That version can still be downloaded here: https://github.com/vector/Antenna/releases/tag/v1.23

For ExpressionEngine 2 installation, the directory /third_party/antenna should be placed in /system/expressionengine/third_party/

Usage

{exp:antenna url='{the_youtube_or_vimeo_url}' max_width="232" max_height="323"  wmode="transparent|opaque|window"}
    {embed_code}
    {video_title}
    {video_author}
    {video_author_url}
    {video_thumbnail}
    {video_mediumres}
    {video_highres}
    {video_provider}

    {!-- For Vimeo Only --}
    {video_description}

    {if embed_code}
        It worked! {embed_code}
    {if:else}
        No video to display here.
    {/if}

{/exp:antenna}

Set the max_width and/or max_height for whatever size your website requires. The video will be resized to be within those dimensions, and will stay at the correct proportions.

The optional wmode parameter can be used if you're experiencing issues positioning HTML content in front of the embedded media. It accepts values of transparent, opaque and window.

If used as a single tag, it returns the HTML embed/object code for the video. If used as a pair, you get access to the 5 variables above and can use them in conditionals.

There are three image sizes available for videos: {video_thumbnail}, {video_mediumres}, and {video_highres}. They are not consistent across services but they should fall into rough size brackets. {video_thumbnail} is going to be between 100-200px wide; {video_mediumres} will be around 400-500px wide; and {video_highres} will be at least the full size of your uploaded video and could be as wide as 1280px.

Antenna will automatically enforce HTTPS if the provided video URL has a protocol of https:// and is supported by the video service. Alternatively, you can also attempt to force the particular service to return the HTTPS resource by adding the parameter:

  • force_https='true'

If you're using YouTube, you get access to one more parameter:

  • youtube_rel='0/1' -- Show related videos at end of video. Defaults to 1.

If you're using Vimeo, you get access to four more parameters and one more variable:

  • vimeo_byline='true/false' -- Shows the byline on the video. Defaults to true.
  • vimeo_title='true/false' -- Shows the title on the video. Defaults to true.
  • vimeo_portrait='true/false' -- Shows the user's avatar on the video. Defaults to true.
  • vimeo_autoplay='true/false' -- Automatically start playback of the video. Defaults to false.
  • vimeo_api='true/false' -- Adds 'api=1' to the vimeo embed url to allow JavaScript API usage. Defaults to false.
  • {video_description} -- The description of the video, as set in Vimeo

If you're using Viddler, you get access to two more parameters:

  • viddler_type='simple/player' -- Specifies the player type. Defaults to player.
  • viddler_ratio='widescreen/fullscreen' -- Aspect ratio will be automatically determined if not set.

NOTE For this to work with all urls please ensure that in Weblog/Channel -> Preferences, you have 'Automatically turn URLs and email addresses into links?' set to 'No'.

Compatibility

Antenna is compatible with ExpressionEngine 1 & 2. The version for ExpressionEngine 1 has been tested on 1.6.9 but will likely work with older versions. The version for ExpressionEngine 2 has been tested on 2.1+.

You must be using PHP 5.2+, though I haven't tested with PHP 5.3, and you must have either the cURL library installed or allow_url_fopen enabled.

Warranty/License

There's no warranty of any kind. If you find a bug, please tell me and I may try to fix it. It's provided completely as-is; if something breaks, you lose data, or something else bad happens, the author(s) and owner(s) of this plugin are in no way responsible.

This plugin is owned by Matt Weinberg. You can modify it and use it for your own personal or commercial projects, but you can't redistribute it. EE2 and Vimeo functionality added by Adam Wiggall (@turnandface). Wmode compatibility added by Tom Davies (@metadaptive).

Something went wrong with that request. Please try again.