Extension Docs

User Guide: SJ Video Player

Details
Category: SJ Video Player

This guide will take you through the entire process of setting up the SJ Video Player, from installation to advanced customization. Follow these steps to create a professional video playlist for your audience.

Table of Contents

1. Requirements & Compatibility

Before installing, ensure your environment meets the following criteria to guarantee a smooth performance:

  • Joomla Version: Compatible with Joomla 4.x, Joomla 5.x., Joomla 6.x.
  • PHP Version: PHP 7.4 or higher (PHP 8.x recommended).
  • Browser Support: Modern browsers (Chrome, Firefox, Safari, Edge).
  • Video Formats: Local files must be in .mp4 (H.264) for maximum compatibility.

2. Installation & Updates

2.1. Installation

Log in to your Joomla Administrator area. Navigate to System → Install → Extensions. Upload the mod_sj_video_player.zip file. Once finished, go to Content → Site Modules to open the module and begin configuration.

2.2. Performing Updates

To update the module, simply install the newest version over the existing one. Your settings and playlists are stored in the database and will not be lost during this process.

2.3. License Key

In the General Setup tab, enter your Update Key. This allows you to see update notifications directly in your Joomla dashboard, keeping your site secure and up to date.

3. Initial Setup & Global Settings

Before adding videos, define how the player sits on your page. These settings ensure the player matches your site's layout.

  • Module Position: Assign the module to a template position (e.g., "Main Content" or "Sidebar").
  • Menu Assignment: Choose which pages should display the player.
  • Player Dimensions: Set the Max Width (e.g., 100% for full width or 800px for fixed) and Alignment.

4. Adding Content: Manual vs. Folder Mode

The module offers two ways to populate your playlist. You can choose your mode in the Content Mode dropdown.

4.1. Manual Mode (The "Hand-Picked" Approach)

Use this mode if you want to mix sources like YouTube, Vimeo, and specific local files. You add each video row manually.

  • Adding Rows: Click "Add New" to create a row.
  • Sources: Paste a direct link or select a file from the Media Manager.
  • Poster: Select a custom image. For YouTube/Vimeo, the player can often fetch these automatically.

4.2. Folder Mode (The "Automation" Approach)

This is the fastest method for local MP4 files. The module "reads" your folder and builds the playlist for you.

  1. The Folder: Select a folder from your /images directory.
  2. Scan & Sync: Click the "Scan & Sync Folder" button. The module identifies every .mp4 file in that folder.
  3. Automatic Titles: The module automatically cleans the file names (e.g., 01_intro_video.mp4 becomes Intro Video).
  4. Automatic Posters: If an image in that folder has the same name as the video, it is automatically assigned as the cover.

5. Organizing Your Playlist

Control the flow of your content to improve user experience.

  • Ordering Options: Select between Alphabetical, By Date (Newest first), or Manual order.
  • Playlist Height: If you have many videos, set a Max Height (e.g., 600px). This keeps the player compact and adds a professional scrollbar to the list.

6. Customizing the Design

This is where you make the module yours. No coding is required; just use the intuitive interface.

6.1. Colors & Branding

Match your brand using the color pickers for the Accent Color (buttons/progress), Playlist Background, and Text Color.

6.2. Visual Effects

Enable Box Shadows to make the player "pop" off the page. Adjust Hover Styles to change the color of a playlist item when a user moves their mouse over it.

6.3. Descriptions

Choose the font size and the height for the video description area. Clear descriptions help users understand what they are about to watch.

7. Troubleshooting & FAQ

If you encounter issues, check these common solutions:

  • Video doesn't play: Ensure the file is an .mp4 and the filename has no spaces or special characters.
  • YouTube error: Verify that "Embedding" is allowed in the video settings on YouTube.
  • Module is missing: Confirm the module is Published and assigned to the correct Menu Item.

8. Support & Feedback

We provide full support for our users. If you have questions that aren't answered here:

  • Official Tickets: Open a support ticket on our website.
  • Bug Reports: We appreciate technical feedback to help us improve the module for everyone.

Thank you for choosing SJ Video Player!