devot:eeDevoted to ExpressionEngine

Outputs embed code, video title, video author and URL, and the thumbnail from a regular YouTube, Vimeo, Wistia, or Viddler URL. Supports conditionals.

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 YouTube/Vimeo/Wistia/Viddler video.

For ExpressionEngine 1 installation, pi.antenna.php should be added to /system/plugins/

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

Usage

{exp:antenna url='{the_youtube_or_vimeo_url}' max_width="232" max_height="323" cache_minutes="120" wmode="transparent|opaque|window"}

    {embed_code}
    {video_title}
    {video_author}
    {video_author_url}
    {video_thumbnail}

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

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 three more parameters:

- 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_autoplay=‘true/false’—Automatically start playback of the video. Defaults to false.

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

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 the PECL json and either cURL or allow_url_fopen.

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

Antenna Links

• Developer Homepage

This entry was last updated March 28, 2012, 3:00 am.

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!