Easy Youtube Embed

Introduction

Easy YouTube Embed is a Joomla which allows you to easily embed YouTube videos in your Joomla content using customizable shortcodes. The plugin includes a shortcode generator for the editor, making it simple to generate the required code. This documentation covers the installation, configuration, and usage of the Easy YouTube Embed plugin.

Installation

Downloading the Extension

Email: After you purchase the extension from our store, you will receive an email containing a link to download the extension.

Store: Alternatively, you can download the extension from the "Downloads" section in our store. If you are a new user, you need to create an account using the same email address you used for the purchase.

Click to download the extension package: EasyYouTubeEmbed_UNZIP.zip

Unzipping the Package

Use any file unzipper tool or WinRAR to unzip the EasyYouTubeEmbed_UNZIP.zip package. After unzipping, you will find the following contents:

• pkg_easyyoutubeembed.zip: This is the installation file compatible with Joomla 4.x and Joomla 5.x.
• ReadMe.txt: Contains vital information about the current version of the extension.

Installing the Extension

To install the extension, log in to the backend of your Joomla website.

• For Joomla 4 & 5: Navigate to Extensions > Install, then click on the "Upload Package File" tab. Click "Browse" to select the installation file (pkg_easyyoutubeembed.zip), then click "Upload and Install."

A success message will be displayed once the installation is complete, and the following plugins will be installed:

• plg_easyyoutubeembed.zip
• plg_btn_easyyoutubeembedbutton.zip

Configuration

General Settings for Easy YouTube Embed

• Default Width: Set the default width for the video player.
• Default Height: Set the default height for the video player.
• Autoplay: Enable or disable autoplay by default.
• Controls: Show or hide video player controls by default.
• Loop: Enable or disable video looping by default.
• Mute: Mute the video by default.
• Show Info: Show or hide video information like title and uploader.
• Modest Branding: Enable or disable modest branding.

General Settings for Easy YouTube Embed Button

Usage

Once configured, you can use the Easy YouTube Embed plugin to embed YouTube videos in your Joomla content. Use the following syntax to generate the shortcode.

Shortcode Syntax

Here is the syntax to integrate YouTube videos into your content:

{youtube id="VIDEO_ID" width="WIDTH" height="HEIGHT" autoplay="1|0" controls="1|0" loop="1|0" mute="1|0" playlist="VIDEO_IDs" start="SECONDS" end="SECONDS" showinfo="1|0" modestbranding="1|0"}

Example

{youtube id="dQw4w9WgXcQ" width="640" height="360" autoplay="1" controls="1" loop="1" mute="1" playlist="dQw4w9WgXcQ,5NV6Rdv1a3I" start="60" end="120" showinfo="1" modestbranding="1"}

Shortcode Attributes

• id (Required): The ID of the YouTube video you want to embed.
  • Example: id="dQw4w9WgXcQ"
• width (Optional): The width of the video player.
  • Example: width="640"
• height (Optional): The height of the video player.
  • Example: height="360"
• autoplay (Optional): Enables or disables autoplay. Set to 1 to enable autoplay, 0 to disable.
  • Example: autoplay="1"
• controls (Optional): Shows or hides the video player controls. Set to 1 to show controls, 0 to hide.
  • Example: controls="1"
• loop (Optional): Enables or disables video looping. Set to 1 to enable looping, 0 to disable.
  • Example: loop="1"
• mute (Optional): Mutes the video by default. Set to 1 to mute, 0 to unmute.
  • Example: mute="1"
• playlist (Optional): A comma-separated list of video IDs to create a playlist.
  • Example: playlist="dQw4w9WgXcQ,5NV6Rdv1a3I"
• start (Optional): Specifies the start time of the video in seconds.
  • Example: start="60"
• end (Optional): Specifies the end time of the video in seconds.
  • Example: end="120"
• showinfo (Optional): Displays or hides the video information like title and uploader. Set to 1 to show, 0 to hide.
  • Example: showinfo="1"
• modestbranding (Optional): Enables modest branding, which reduces YouTube branding on the video player. Set to 1 to enable, 0 to disable.
  • Example: modestbranding="1"

Features

• Customizable Video Embeds: Control various aspects of the embedded YouTube video through shortcode attributes.
• Shortcode Generator: Easily generate the required shortcode using the editor button.
• Responsive Design: Supports both fixed and responsive dimensions for the video player.
• Playlist Support: Create YouTube playlists using a comma-separated list of video IDs.

FAQ

• How do I embed a YouTube video?

  • Use the {youtube id="VIDEO_ID"} shortcode in your Joomla content.

• Can I customize the video player dimensions?

  • Yes, use the width and height attributes in the shortcode.

• How do I enable autoplay for a video?

  • Set the autoplay attribute to 1 in the shortcode.

• Can I create a YouTube playlist?

  • Yes, use the playlist attribute with a comma-separated list of video IDs.

Troubleshooting

• Video Not Displaying: Ensure the video ID is correct, the plugin is enabled, and your browser allows embedded videos.
• Incorrect Dimensions: Check the width and height attributes in the shortcode. If not specified, the video will be fully responsive with a 16:9 aspect ratio.
• Autoplay Not Working: Verify the autoplay attribute is set to 1 and that your browser supports autoplay functionality. Some browsers restrict autoplay to enhance user experience and reduce data usage.