This manual gives the full explanation how to setup the default configuration for the plugin. By setting defaults, you can determine typical options for the whole site and you do not need to bother filling in the same options again for individual media, although you can override settings per media.
If it is the first time you setup Footprint Player, it is best not to use default settings. Instead, try set up a single video or audio first. When that works, you have a better understanding about which default settings are useful to you.
To set the default options, go to Extension > Plugin Manager and locate Content - Footprint Player in the list of plugins.
Make sure the plugin is enabled.
Then select Default settings.
This will open an interface with a load of options. Below we discuss every option in turn. Every label next to a field or option has a tool tip with more info when you hover over it with the mouse. You will find that it gives quite detailed reminders.
We discovered over the years with S3Media Stream that many users do not make use of default settings or sparingly. As a result, when something needs to be changed site wide, they can’t do it in one go because most features are set per instance. Don't fall into that trap. Make use of default settings as much as possible, it will save you trouble later when you have to make changes site wide. Some fields can be overridden in shortcode.
There are 6 groups of defaults, all on the same page and we discuss these in the order they appear:
- Media Settings
- AWS related settings
- Branding options
- Look & behavior
- Download link behavior
- Accessibility options
The media type
If you know beforehand you are going to work primarily with a certain type of media, it is a good idea to set the MediaType upfront. Currently it has 3 possible options:
- Audio HLS, Mpeg-dash, mp3, m4a, wav
- Video HLS, Mpeg-dash, mp4, webm, ogg
- Protected download link
In most cases, you set the Video mediatype for video and Audio for audio.
It is unlikely you will want to set it to Download link unless you only plan to distribute files instead. In any case, select the option you will need most.
Use only for Protected Download link. Use the web distribution, like https://dxxxxxxx.cloudfront.net without trailing slash.
Fallback for RTMP
Backward compatibility field for users S3Media Stream only, working with existing RTMP shortcodes. RTMP is no longer supported. By filling in this field, all RTMP embeds transform automatically to progressive download so that you have the time to change over to HLS. Note that this field will be deprecated in the Joomla 4 version (probably end 2019).
Find here a tutorial to make sure your fallback media is compatible: http://www.miracletutorials.com/elastic-transcoder-tutorial/
You can override this setting in individual media, either by using another value or 0 to disable the default.
This is expressed in seconds. Thus: 10minutes = 600, 1 hour = 3600, a day = 86400, ... For expiring URLs. If you do not want the URL to expire, the media must be made Public.The length of the video or audio in seconds is a safe bet to prevent problems with iOS devices.
You can set a default image for those media you have no poster image for. This can be interesting to automatically brand your media. You can override this per media embedding.
The extension presumes you uploaded the poster image to the images folder unless you use a full path. Images can be .PNG, .GIF or .JPG. Use .PNG for flat colored graphics and desktop screenshots. Use JPG for photos or artwork with many gradients. You can use poster images for audio as well. This makes it more interesting.
Example: myposter.jpg or https://dxxxxxxxx.cloudfront.net/myposter.jpg
Interesting option to set site-wide. Usually a logo in .GIF or .PNG format, png with transparency set works best. You are not restricted to logos. This can be any sort of image. The extension presumes you uploaded the poster image to the images folder unless you use a full path.
Example: myWatermark.png or https://dxxxxxxxx.cloudfront.net/myWatermark.png.
Note: watermarks are shown in their xact dimensions, therefore don't make them too big.
Note 2: the name watermark.png is reserved, see: Dynamic watermark to prevent screen capturing
This is either Top-left, Top-right, Bottom-left(default) and Bottom-right. In our experience, it is best set at Top-left or Top-right. You can override this per media.
An absolute path to any page you like. you can override it per media. So, the link here should be a general site URL. I'm sure you can find good use for this.
Whether the player preloads the media. Auto means the media is preloaded except on mobiles. Metadata is the default. It only loads the meta data of the video, which includes information like the duration and dimensions of the video. None means nothing is preloaded.
As this feature may be a little difficult to decide upon, let's presume a few scenarios:
- When there is a video and nothing else on the page you probably want to set the preload to auto, so that it is buffered immediately after page load, because the chance that the visitor is actually going to play the video is quite big. This way, the video will start almost immediately when the visitor activates it.
- If your video is embedded with a lot of text on the page, it is probably better to use metadata so that the video is not automatically downloaded, only the header information, which is very small. This can spare you quite some bandwidth.
- I would use none only when you have a whole range of videos on the same page but you could use metadata also. It doesn’t add much overhead.
Limit initial bandwidth
Limit the initial bandwidth to the current size of the player. Counts only for HLS and Mpeg-Dash. This speeds up start time, but the quality is lower. If you find that the initial quality is too low in general, disable this setting. Whatever the setting, visitors can change the bandwidth manually on HLS. Mpeg-Dash currently has no quality selector.
Automatically play the video when the page loads. Default set to No. Be careful, setting video or audio to Autoplay is generally regarded as user unfriendly. Only use this feature if you are sure your visitors expect this sort of behavior. You can override it per media if you want.
To loop the video or audio. I.e.; when the video or audio ends, it restarts automatically and keeps repeating until the visitor stops it.
This determines the height in relation to the width. For HD video this is generally 16:9 and for SD video 4:3 but you can use any custom value. The first number is the width, the second the relation width and height. Sometimes banding may appear if the poster image doesn't have the correct aspect ratio, like the image below:
If the aspect ratio(relation width-height) is set incorrectly, you either get black horizontal- or vertical bars during playback. But the video itself will not distort. Adjust the aspect ratio until it is right.
This can be overridden per instance in case you have a format that differs from the others. Set here the value that will appear most on your site.
Use only if the player does not align properly in your template. Default is none.
Control bar position
Determines whether the control bar shows up or not. Normally you should set this to Show because if set to Hide, the user has no control over de player whatsoever.
Select a Skin
Footprint Player ships with two skins, Business and Magmatic. Default is Magmatic. If you want to develop your own skin, use that skin as a basis. It is located in components/footprintplayer/assets/skins/ . When you upload your new skin, it will be ecognised and made available in the dropdown list.
This is meant in case there is little contrast between the video and the background. It creates a border of 1 pixels around the player. Use a hexidecimal value, like #666 or #a6f6a6
Show the speed selector to speed up or slow down the video or audio. The pitch of voices or the soundtrack does not change, it goes only quicker or slower, unless with extremes like 0.5 or 3. This feature is quite popular now.
For protected downloads links only. File types which are recognized by the browser are opened within the browser window. If you want to prevent this, you can force a download instead. NOTE: This does not work on all browsers. Chrome also disregards the download option when the file is a pdf.
Select Closed Captions if this is meant for the hearing impaired. The result is that the subtitles will show up automatically, otherwise it shows only upon action from the visitor when he/she clicks on the CC button in the controlbar of the video or audio. Keep in mind that Closed Captions also requires the indication of background noises and music. See also: https://dcmp.org/learn/520. Subtitles are convenient for translations, not only of foreign languages, also for dialect in native tongue. This can be overridden per media.
Save the settings when you are ready.