DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Overheids Media Player¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Patrick Broens |
Changed: | 2009-12-03T09:29:02.760000000 |
Classification: | overheidsmediaplayer |
Keywords: | media, player, layered, flv, mov, mp3, mp4, wma, wmv, srt, flash, video, audio, quicktime |
Author: | Patrick Broens (Netcreators) |
Email: | patrick@netcreators.com |
Info 4: | |
Language: | en |
EXT: Overheids Media Player - overheidsmediaplayer
EXT: Overheids Media Player¶
Extension Key: overheidsmediaplayer
Language: en
Keywords: media, player, layered, flv, mov, mp3, mp4, wma, wmv, srt, flash, video, audio, quicktime
Copyright 2000-2008, Patrick Broens (Netcreators), <patrick@netcreators.com>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 6 <#1.2.Users%20manual|outline>`_
Adding the Overheids Media Player 8
`Administration 15 <#1.3.Administration|outline>`_
Include static Typoscript templates 15
`Configuration 16 <#1.4.Configuration|outline>`_
`Known problems 21 <#1.5.Known%20problems|outline>`_
`To-Do list 22 <#1.6.To-Do%20list|outline>`_
`ChangeLog 23 <#1.7.ChangeLog|outline>`_
Introduction¶
What does it do?¶
The Overheids (Government) Media Player was specifically written for the Dutch Governmental Ministries and complies with the Dutch Style Guide for Corporate Websites for Ministries. It can also be used for Belgian Government websites , because they adapted the same player.
The extension offers completely layered ‘video- and audio functionality’ on a webpage to the user. Access to the information will be offered in as much user scenarios as possible. This approach complies with the government wide web guidelines in The Netherlands. When all code is ready, this means the following for visitors:
Video¶
- All users will get a link to the transcription of the video.
- All users will get links to different video formats, which they can download and play in a local media player which has been installed on their own computer.
- All users will get a link to the closed captions file of the video.
- Users which have the Flash plugin, version 7.0 or higher, will see an embedded Flash video player, with the opportunity to turn closed captions on or off.
- Users which have the Flash plugin, lower than version 7.0, or no Flash plugin at all, will see an embedded Quicktime video player.
- Users which do not have the Quicktime plugin as well, will see an embedded Windows Media video player.
- Users which do not have all mentioned plugins only have the opportunity to download the movie, transcription and/or closed caption file.
- Users which do not have Javascript support will also have the opportunity to download the movie, the transcription and/or the closed caption file only.
Audio¶
- All users will get a link to the transcription of the audio fragment.
- All users will get a link to the audio file, which they can download and play in a local media player which has been installed on their own computer.
- Users which have the Flash plugin, version 7.0 or higher, will see an embedded Flash audio player.
- Users which have the Flash plugin, lower than version 7.0, or no Flash plugin at all, will see an embedded Quicktime audio player.
- Users which do not have the Quicktime plugin as well, will see an embedded Windows Media audio player.
- Users which do not have all mentioned plugins only have the opportunity to download the audio file and/or the transcription.
- Users which do not have Javascript support will also have the opportunity to download the audio file and/or the transcription only.
Using these methods the information will be offered layered, which gives access to the information in most ways possible.
License¶
The extension comes with two flv players, JW Player and Flowplayer .
The main reason is JW Player, developed by Jeroen Wijering. Note that the Creative Commons BY NC SA 3.0 is applied to this player, which does not allow commercial use without a license from the author.
The player also contains the Flowplayer, which has a GPL v3 license, which can be used freely for commercial use.
Before using this extension for commercial purposes, enable the Flowplayer, which is not used by default. If you specifically want to use JW Player, contact the author of JW Player.
Screenshots¶
Flash video player with title, description, closed caption, downloads and transcription
The video download menu
Part of the transcription
The Flash audio player with title, description, downloads and transcription
Users manual¶
The user manual is based on the default TYPO3 settings. Therefor your “Page module” might look differently when, for instance, your TYPO3 installation is using the TemplaVoila extension.
You need to have proper know-how of the TYPO3 backend; Know how to add content, use the DAM (Digital Asset Management) extension, also known as ‘Media’ in the main menu.
Preparation¶
You need some files in advance before you continue adding the video or audio player. These files are needed by the player to work properly, but also for being compliant with the governmental web guidelines. These files are:
Video¶
- .jpg – An image file with a frame from the video. This will be shown before the video plays.
- .flv – A Flash video file. Used by the embedded Flash player.
- .mp4 / .mov – MP4 or Quicktime movie. Used by the embedded Quicktime player.
- .wmv – Windows Media Video file – Used by the embedded Windows Media Player.
- .3gp – Video file for mobile devices – Only for download.
- .srt – Closed Caption file – Used for Closed Caption in the embedded Flash player.
Audio¶
- .mp3 – MP3 Audio file. Used by embedded Flash and Quicktime audio players.
- .wma – Windows Media Audio file – Used by the embedded Windows Media Player.
Conversion¶
The extension does not convert the files to the proper formats. This has to be done in advance.
Uploading files¶
Go to the module ‘Media > File’, which is part of the DAM (Digital Asset Management) extension.
Go to the proper folder in the folder tree, or make a new one.
At the top of the screen, select ‘Upload’ in the dropdown or click the upload button if not already selected.
Select all the files you need by clicking the “browse” button next to an empty field. The files need to be available on your local computer.
Click on the button “Upload files”. The files will be uploaded to the webserver and indexed. When the upload process has been finished (this can take a while), the upload module will return with a list of uploaded files.
You’re done uploading!
Adding the Overheids Media Player¶
Web > Page¶
Go to the ‘Web > Page’ module.
Select the page in the page tree where the media player should be inserted.
Click on one of the ‘Create new content element’ buttons to insert the media player or use the ‘Create page content’ button.
You should do this in the proper column. When using the button in the docHeader, which is located at the top of your screen, or the ‘New Content’ button, it will ask for the position on the screen after the ‘New Content Element Wizard’.
The ‘New Content Element Wizard’ will be displayed.
Select ‘Video with Overheids Media Player’ or ‘Audio with Overheids Media Player’ according to your wishes.
Web > List¶
Go to the ‘Web > List’ module.
Select the page in the page tree where the media player should be inserted.
Click on one of the buttons to add page content. If you don’t have any content on the page yet, use the button in the docHeader at the top of the screen. If you already have content, select the proper position.
In the ‘New Record Wizard’, ‘Click here for Wizard!’ below ‘Pagecontent’
The ‘New Content Element Wizard’ will be displayed.
Select ‘Video with Overheids Media Player’ or ‘Audio with Overheids Media Player’ according to your wishes.
Configuration¶
Now that you’ve added the content element, you can configure it. The specific settings for the media players are located in the tab ‘Plugin’.
Video with Overheids Media Player¶
The video media player settings has 6 tabs:
General¶
Optionally you can enter the title and a description for the video.
Player settings¶
This tab has four options:
Width (in pixels) – The width of the player, in pixels, on your web page. When using the default HTML templates for Ministries, this should be 400px (default), when the media player is located in the center column.
Height (in pixels) – The height of the player, in pixels, on your web page. (default = 224px)
Show links to download video files – When not checked, this will hide the option below the player to download video files. (default = checked, recommended)
Show link to download caption file – When not checked, this will hide the option below the player to download the closed caption file (default = checked, recommended)
Videos¶
This part is used to link the video to the player in different formats:
- Video for Flash Player (.flv)
- Video for QuickTime Player (.mp4 or .mov)
- Video for Windows Media Player (.wmv)
- Video for Mobile Devices (.3gp)
For each format, click on the folder icon (Browse for records) at the right side of the field.
A popup will appear. Select the tab Media and go to the folder where the files are located.
You can only select the files which are allowed in this field. Click on the name of the file to select it. By clicking the name, the popup will close automatically.
If all is well, the file has been inserted in the field.
Repeat the above for all fields.
Image¶
Do the same actions as you did in the tab ‘Videos’ to select the image.
Transcription¶
The transcription tab shows a text editor. You can enter the transcription text here, with layout functionality like Bold or Italic.
Audio with Overheids Media Player¶
The audio media player settings has 6 tabs:
General¶
Optionally you can enter the title and a description for the audio fragment.
Player settings¶
This tab has two options:
Width (in pixels) – The width of the player, in pixels, on your web page. When using the default HTML templates for Ministries, this should be 400px (default), when the media player is located in the center column.
Show links to download audio files – When not checked, this will hide the option below the player to download audio files. (default = checked, recommended)
Audio¶
This part is used to link the audio to the player in different formats:
- Audio for most players (.mp3)
- Audio for Windows Media Player (.wma)
For each format, click on the folder icon (Browse for records) at the right side of the field.
A popup will appear. Select the tab Media and go to the folder where the files are located.
You can only select the files which are allowed in this field. Click on the name of the file to select it. By clicking the name, the popup will close automatically.
If all is well, the file has been inserted in the field.
Repeat the above for all fields.
Transcription¶
The transcription tab shows a text editor. You can enter the transcription text here, with layout functionality like Bold or Italic.
FAQ¶
- I don’t have the module ‘Media > File’ in my main menu at the left side?You probably don’t have access rights to this module. Ask your administrator for it.
- I cannot upload files?There could be two issues;You don’t have the proper access rights. Ask your administrator.The files are too big. Take a look at the file sizes and the note below the upload fields. This note will tell you what the maximum upload size is. If your files are bigger than this number, you need to ask the administrator to raise this number.
- I don’t see all these buttons for adding content?This depends on the configuration of your website and the user settings. Some buttons and columns might have been removed by the administrator, because they are not usefull for your website.
Administration¶
Installation¶
Install the extension with the Extension Manager, which you can find at ‘Admin tools > Ext Manager’. There is no additional configuration needed for the extension itself
Include static Typoscript templates¶
Create a new Typoscript template for this extension or use an existing one.
Open this Typoscript template.
Go to the tab ‘Includes’ and scroll down to the section ‘Include static (from extensions)’
Include the following items:
- Default TS Video (overheidsmediaplayer)
- Default TS Audio (overheidsmediaplayer)
- Default CSS (overheidsmediaplayer)
Page TSconfig¶
There is no Page TSconfig available for this extension.
User TSconfig¶
There is no User TSconfig available for this extension.
Rights and Permissions¶
The basics about the Rights & Permissions concepts of TYPO3 can be found in the ” getting started ” document.
Configuration¶
Reference¶
useFlowplayer¶
Property
useFlowplayer
Data type
boolean
Description
Use Flowplayer instead of JW Player (JW Player needs a license for commercial websites)
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
useFlowplayer = 1
}
Default
0
title¶
Property
title
Data type
stdWrap
Description
Standard wrap for the title
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
title {
htmlSpecialChars = 1
}
}
Default
htmlSpecialChars = 1
description¶
Property
description
Data type
stdWrap
Description
Standard wrap for the description
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
description {
htmlSpecialChars = 1
}
}
Default
htmlSpecialChars = 1
secureDownloads¶
Property
secureDownloads
Data type
boolean
Description
If set, the links to the downloadable files are not directly visible to the visitor of the website. A download request will be diverted through the extension.
This option is also very convenient when content disposition is not properly set at the server, which means no proper http–headers are sent to the browser.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
secureDownloads = 1
}
Default
1
templateFile¶
Property
templateFile
Data type
resource
Description
The HTML template file.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
templateFile = EXT:overheidsmediaplayer/Resources/Private/Templates/HTML/Video.html
}
Default
EXT:overheidsmediaplayer/Resources/Private/Templates/HTML/Video.html
date¶
Property
date
Data type
stdWrap
Description
Formatting of the date of downloadable video files with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
video {
date {
date = d-m-Y
}
}
}
Default
date = d-m-Y
size¶
Property
size
Data type
stdWrap
Description
Formatting of the size of downloadable video files with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
video {
size {
bytes = 1
bytes {
labels = B| KB| MB| GB
}
}
}
}
Default
bytes = 1
bytes {
labels = B| KB| MB| GB
}
date¶
Property
date
Data type
stdWrap
Description
Formatting of the date of downloadable caption file with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
caption {
date {
date = d-m-Y
}
}
}
Default
date = d-m-Y
size¶
Property
size
Data type
stdWrap
Description
Formatting of the size of downloadable caption file with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
caption {
size {
bytes = 1
bytes {
labels = B| KB| MB| GB
}
}
}
}
Default
bytes = 1
bytes {
labels = B| KB| MB| GB
}
quicktime¶
Property
quicktime
Data type
resource
Description
The icon file for Quicktime videos.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
icons {
quicktime = EXT:overheidsmediaplayer/Resources/Public/Icons/qt.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/qt.gif
windowsmedia¶
Property
windowsmedia
Data type
resource
Description
The icon file for Windows Media videos.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
icons {
windowsmedia = EXT:overheidsmediaplayer/Resources/Public/Icons/wmv.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/wmv.gif
mobile¶
Property
mobile
Data type
resource
Description
The icon file for mobile devices videos.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
icons {
mobile = EXT:overheidsmediaplayer/Resources/Public/Icons/3gp.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/3gp.gif
caption¶
Property
caption
Data type
resource
Description
The icon file for Close Caption files.
Example:
plugin.tx_overheidsmediaplayer_videocontroller {
icons {
caption = EXT:overheidsmediaplayer/Resources/Public/Icons/srt.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/srt.gif
[tsref:(plugin).tx_overheidsmediaplayer_videocontroller]
useFlowplayer¶
Property
useFlowplayer
Data type
boolean
Description
Use Flowplayer instead of JW Player (JW Player needs a license for commercial websites)
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
useFlowplayer = 1
}
Default
0
title¶
Property
title
Data type
stdWrap
Description
Standard wrap for the title
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
title {
htmlSpecialChars = 1
}
}
Default
htmlSpecialChars = 1
description¶
Property
description
Data type
stdWrap
Description
Standard wrap for the description
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
description {
htmlSpecialChars = 1
}
}
Default
htmlSpecialChars = 1
secureDownloads¶
Property
secureDownloads
Data type
boolean
Description
If set, the links to the downloadable files are not directly visible to the visitor of the website. A download request will be diverted through the extension.
This option is also very convenient when content disposition is not properly set at the server, which means no proper http–headers are sent to the browser.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
secureDownloads = 1
}
Default
1
templateFile¶
Property
templateFile
Data type
resource
Description
The HTML template file.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
templateFile = EXT:overheidsmediaplayer/Resources/Private/Templates/HTML/Audio.html
}
Default
EXT:overheidsmediaplayer/Resources/Private/Templates/HTML/Audio.html
date¶
Property
date
Data type
stdWrap
Description
Formatting of the date of downloadable audio files with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
audio {
date {
date = d-m-Y
}
}
}
Default
date = d-m-Y
size¶
Property
size
Data type
stdWrap
Description
Formatting of the size of downloadable audio files with stdWrap.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
audio {
size {
bytes = 1
bytes {
labels = B| KB| MB| GB
}
}
}
}
Default
bytes = 1
bytes {
labels = B| KB| MB| GB
}
mp3¶
Property
mp3
Data type
resource
Description
The icon file for MP3 audio files.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
icons {
mp3 = EXT:overheidsmediaplayer/Resources/Public/Icons/mp3.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/mp3.gif
windowsmedia¶
Property
windowsmedia
Data type
resource
Description
The icon file for Windows Media audio files.
Example:
plugin.tx_overheidsmediaplayer_audiocontroller {
icons {
windowsmedia = EXT:overheidsmediaplayer/Resources/Public/Icons/wmv.gif
}
}
Default
EXT:overheidsmediaplayer/Resources/Public/Icons/wmv.gif
[tsref:(plugin).tx_overheidsmediaplayer_audiocontroller]
Known problems¶
None
To-Do list¶
None