Antenna

Developer

Vector Media Group

3rd Party (Free)

651 downloads (last 90 days)

Download v2.2

EE Version Support

  • ExpressionEngine 1.x
  • ExpressionEngine 2
  • ExpressionEngine 3
  • ExpressionEngine 4

Compatibility

If an item is crossed out, it might be untested, not applicable or incompatible. Contact the developer to be sure.

Requirements

  • jQuery for the Control Panel

Add-On Type(s)

Plugin

Tags

Outputs embed code, video title, video author and URL, and the thumbnail from a regular YouTube, Vimeo, Wistia, or Viddler URL. Also supports any video service provider available through embed.ly.

Antenna is a plugin that will generate the exact, most up-to-date YouTube, Vimeo, Wistia, or Viddler embed code available. With an embed.ly API key, you also have access to hundreds more video providers. In addition to the video’s embed code, Antenna also provides you with 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 ExpressionEngine 1 ended with v1.23. That version can still be downloaded here: https://github.com/vector/Antenna/releases/tag/v1.23.

Support for ExpressionEngine 3 started with version 2.

Installation

ExpressionEngine 2:

     
  1. Place the directory /third_party/antenna in /system/expressionengine/third_party/.

ExpressionEngine 3:

     
  1. Place the directory /third_party/antenna in /system/user/addons/.
  2.  
  3. Go go the addon manager and click “Install” next to Antenna.

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}
    {video_provider_id}
    {video_ratio}
    {video_width}
    {video_height}

    {!-- 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 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 several more parameters, such as:

youtube_rel=‘0/1’—Show related videos at end of video. Defaults to 1.
youtube_showinfo =‘0/1’—Show the video title and uploader. Defaults to 1.

See this guide from Google for the full list of HTML5 parameters available for YouTube videos. Prefix each parameter with youtube_ when adding these parameters to your Antenna template tag.

If you’re using Vimeo, you get access to 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.
- vimeo_color=‘EFEFEF’—changes the color of the player controls, and the color of the video title (if enabled). The parameter here expects a hex color code.
- vimeo_loop=‘true/false’—loops the Vimeo video automatically
- {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.

The plugin automatically caches returned data for one week. You can control this setting with the cache_minutes parameter, or set cache_minutes to “0” to disable the cache.

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’.

Embed.ly Support
By including an embed.ly API key, you have access to hundreds more video providers. If your URL is not for YouTube, Vimeo, Wistia, or Viddler, Antenna will check embed.ly to pull the correct relevant video embed and information.

{exp:antenna url='{example_vine_url}' embedly_key="xxxxxxxxxx" max_width="232" max_height="323"  wmode="transparent|opaque|window"}
    ...
{/exp:antenna}

or set your embed.ly API key globally by adding it to ExpressionEngine’s config.php file:

$config['antenna_embedly_key'] = 'xxxxxxxxxx';

Compatibility

Antenna is compatible with ExpressionEngine 2 & 3. The version for ExpressionEngine 2 requires 2.6+. The version for ExpressionEngine 3 has been tested on 3.0+.

You must be using PHP 5.2+ and you must have either the cURL library installed or allow_url_fopen enabled.

Note for Wistia users: Wistia doesn’t return as much data as the other providers, so not all of the above variables will work. Also, you may need to contact Wistia and ask them to enable “oEmbed support” on your account.

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).

Download Antenna

EE Support Downloads Add-On Version Release Date
2.6.0+ Download 2.2 Oct 8, 2017

Antenna Links

This entry was created September 8, 2010, 5:48 pm.
This entry was last updated January 31, 2018, 2:06 pm.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!

Returns: devot:ee has a 30-day return policy on all commercial add-ons sold through devot-ee.com. If you need to return an add-on, do not go to the developer or the developer's site, but rather visit our returns page at https://devot-ee.com/returns to initiate your return. If you have questions, email support@devot-ee.com.

16 Reviews:

William Jackson 09.06.16

William Jackson
Rating - {addon_rating_average}

Incredible add-on

atelier 01.28.15

atelier
Rating - {addon_rating_average}

Excellent…! (6 stars)

Loughlin 04.07.14

Loughlin
Rating - {addon_rating_average}

Excellent add-on.  This, Stash and Datagrab are pretty much part of the core for me - they are the very first add-ons I install before I even start thinking about channels and channel groups.  Syntax is basic (good), functionailty is concise (good) and it’s fast (excellent).  Nice work Matt and VMG.

David Hyland 12.18.13

David Hyland
Rating - {addon_rating_average}

Genius!

asmith 08.07.13

asmith
Rating - {addon_rating_average}

Awesome addon. Works great and easy to set up!

AJP 09.25.12

AJP
Rating - {addon_rating_average}

Makes working with external video sources a complete breeze. Great stuff from VMG.

Adam Khan 06.07.12

Adam Khan
Rating - {addon_rating_average}

Works well and remains free. Praises and thanks, Matt.

Zac Gordon 03.25.12

Zac Gordon
Rating - {addon_rating_average}

Great plugin!  Works just like it should.  Thanks Matt

davidbehan 02.22.12

davidbehan
Rating - {addon_rating_average}

It works! :)

Portnull 12.29.11

Portnull
Rating - {addon_rating_average}

great plugin! a parameter to not display the avatar on vimeo videos would make it even better.

EDIT: The “vimeo_portrait=‘false’” parameter would do what Portnull wants – Matt W.

whitenoise 10.17.11

whitenoise
Rating - {addon_rating_average}

Great plugin! You can also use a fourth Vimeo parameter to remove the avatar icon - vimeo_portrait=“false”

Greg Wineman 08.24.11

Greg Wineman
Rating - {addon_rating_average}

Works perfect! I was able to resize the thumbnails with the Image Sizer plugin. You just need to make sure remote=“on” (on Image Sizer) - You may also need to embed the Image Sizer code depending on your situation.

Matt Weinberg 08.17.11

Matt Weinberg
Rating - {addon_rating_average}

@Alex Roper—you should be able to embed videos larger than that. Other people are. If you’re having trouble let me know in the forum above.

Alex Roper 06.16.11

Alex Roper
Rating - {addon_rating_average}

Works pretty well but it’s picky about the URL you supply. It can’t use YouTube’s new short URLs (http://youtu.be/) nor direct embed URLs. Also, since you can only specify the max dimensions of the video, you can only embed videos at 425 × 344px and smaller. It won’t embed anything larger.

JCDerrick 02.23.11

JCDerrick
Rating - {addon_rating_average}

This is a great add on for including videos to your website. I especially like the thumbnail feature; though I wish you could re-size the thumbnail using image re-sizer plugins (I couldn’t get that to work). Overall an excellent plugin for putting videos on your site. Easy to use and implement.

Establish 10.29.10

Establish
Rating - {addon_rating_average}

Perfect! Makes it extremely simple for the client to upload video. I went with this one over ‘Video Player’ as this allows you control over Vimeo display settings. The only plus point that ‘Video Player’ has over Antenna is it allows a greater range of videos to be uploaded from different sites.