.. You may want to use the usual include line. Uncomment and adjust the path.
.. include:: ../Includes.txt
=================
EXT: Media Center
=================
:Author:
Kasper Skårhøj
:Created:
2002-11-01T00:32:00
:Changed by:
Patrick Rodacker
:Changed:
2009-11-18T10:48:46.430000000
:Author:
Patrick Rodacker
:Email:
patrick.rodacker@the-reflection.de
:Info 3:
:Info 4:
.. _EXT-Media-Center:
EXT: Media Center
=================
Extension Key: **media\_center**
Copyright 2008, `Patrick Rodacker `_ `,
`_ < `http://www.the-reflection.de
`_ >
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.com
.. _Table-of-Contents:
Table of Contents
-----------------
**EXT: Media Center 1**
**Introduction 1**
What does it do? 1
Screenshots 2
Requirements 4
Player License 4
Credits 4
**Users manual 4**
Installation 4
Static template 4
Constant Editor 5
Media Center Files 5
Inserting Plugin 8
Typoscript mode 8
Streaming 8
**Configuration 8**
Flexform Configuration 8
Typoscript 11
Export 13
**Known problems 13**
**To-Do list 13**
**Changelog 14**
.. _Introduction:
Introduction
------------
.. _What-does-it-do:
What does it do?
^^^^^^^^^^^^^^^^
This extension provides a Media Center as frontend plugin using the JW
FLV Media Player showing multiple media files.The key features are:
Integrating JW FLV Player 4.2.90 with full control over the available
configuration settings
Intelligent width and height settings depending on playlist
positioning (right, bottom, over)
Playlist of media files supporting thumbnail, title and description
for each file
New Record “Media Center File” defining local or external files
Support of different media file types: FLV7 video, FLV8 video, Youtube
video, MP3 audio, JPG images, GIF images, PNG images
File references to local files instead of copied files in the upload
branch for large video files (the path has to be assigned as relative
or absolute path manually using the link wizard)
Rendering playlist of the content element as RSS feed (various formats
supported, see Configuration section).
Multiple players on one page
Flash detection and output of alternative contente element for flash
versions not matching the required version using the swfobject 2.1
`http://code.google.com/p/swfobject/
`_
noscript output for users with disabled or missing javascript browser
support using via content element selection
Skinnable layout of the player. Extension ships with five example
skins.
Support for multilingual media center files
.. _Screenshots:
Screenshots
^^^^^^^^^^^
|img-1|
The first image shows the Media Center player with the playlist
position set to *right* .
|img-2|
The second image shows the Media Center with the playlist position set
to *bottom* .
|img-3|
The third image shows the Media Center with the playlist position set
to *over* .
.. _Requirements:
Requirements
^^^^^^^^^^^^
- The clients browser must support Javascript
- The JW FLV Player 4.2 needs at least an installed flash 9.0.0
compatible plugin at clients side.
.. _Player-License:
Player License
^^^^^^^^^^^^^^
The JW Players are licensed under a `Creative Commons
`_ license. It
allows you to use, modify and redistribute the script for
noncommercial purposes. For all other use, buy a `commercial license
`_ .
You must buy a commercial license if:
Your site has any ads (AdSense, display banners, etc.)
You want to remove the players' attribution (eliminate the right-click
link)
You are a corporation (governmental or nonprofit use is free)
You are a content management system
`» Buy a license `_
**Existing license owners and 4.2**
The 4.x version of the JW Player introduces a `new commercial license
`_ . On `this page
`_ , existing license-
owners can download a FREE new proof-of-license PDF by providing their
email address.
.. _Credits:
Credits
^^^^^^^
Thanks to `Jeroen Wijering `_ for the
developing the awesome JW FLV Player.
Thanks to `Mark James `_ for
the silk icon set of the fam fam fam line, which provide the icons for
this the Media Center extension.
Thanks to `Veit Briken `_ for the
great feedback and testing during the initial development.
.. _Users-manual:
Users manual
------------
.. _Installation:
Installation
^^^^^^^^^^^^
The installation of the extension is easy as usual. Just import the
extension (key: **media\_center** ) from the TYPO3 Online Repository
(TER) and install it using the Extension Manager in the backend of
your TYPO3 installation. Make sure you make the updates during
installation process to apply the needed database changes. Elsewehre
use the compare function of the database section within the install
tool.
.. _Static-template:
Static template
^^^^^^^^^^^^^^^
include the static template (Media Center) in your main Typoscript
configuration:
|img-4|
.. _Constant-Editor:
Constant Editor
^^^^^^^^^^^^^^^
use the constant editor to configure the settings via typoscript. All
configuration settings can be overriden via the flexform configuration
of the plugin (see next chapter).
**Attention:** Empty settings and settings with value=0 of the
flexform configuration will be ignored!
The next image shows the first part of the constant editor (32
settings available in total):
|img-5|
.. _Media-Center-Files:
Media Center Files
^^^^^^^^^^^^^^^^^^
The extension introduces a new record Media center file. For each file
in the playlist you have to create a **Media Center File** record at
first.
I recommend to create a separate page from type “SysFolder” and use it
as storage for the media files. Use the List Module to create a new
record. Select “Media Center File”:
|img-6|
The file definition offers different fields, organized in three tabs:
**Tab: File**
If you select a local file, the media file will be copied to the
*upload/tx\_mediacenter* folder (standard TYPO3 behavior). If you want
to integrate external files or use *references* to local files, you
have use the **url to external files (file\_url)** field and enter the
absolute or relative path manually. **Attention:** If a local file is
set, the path in **url to external files (file\_url)** will be
ignored. There is no validation of the external file settings so far,
so be careful with the path and the filename !!!
- set a path to a xml captions file
- xml file has to be in W3C timed text format
- format: `http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/Tim
edTextTags.html `_
- xml file example: http://www.jeroenwijering.com/upload/bunny.xml
- Set a duration if you want to override the length of the media file
manually
- if you enter an url as link a link icon will be displayed in the
control bar
- set the start position (in seconds) to define an offset where the file
should start. Could be used to define chapters if you create multiple
**Media Center Files** for one video file and include them in a
playlist
|img-7|
**Tab: Description**
enter a title which will be displayed in the playlist (required)
- insert an image which will be used as preview image in the video area,
and as thumbnail in the playlist
- enter a description for the playlist
- enter the name of the author (person, company, or something else)
|img-8|
**Tab: Language & Access**
- language
- hide
- time period
- access
|img-9|
.. _Inserting-Plugin:
Inserting Plugin
^^^^^^^^^^^^^^^^
Insert a new content element and choose **Insert Plugin.** Select
**Media Center** as plugin and add at least one Media Center File to
the playlist in the Media Files tab of the flexform Configuration of
the plugin.
|img-10|
.. _Typoscript-mode:
Typoscript mode
^^^^^^^^^^^^^^^
If you want to integrate the player using typoscript only, you don'
net to create any media file records or content element. Just set the
typoscript constant **renderingMode** to *typoscript* and define the
path to a file using the constant **file** as well. This could be
either a local path to a single media file or to a playlist (e.g
*fileadmin/mediapool/videos/video.flv* ) or an external path to a
media file or playlist.
.. _Streaming:
Streaming
^^^^^^^^^
If you want to integrate an external streaming server to deliver the
media files, use the plugin in Typoscript mode, set the file to the
file name on the streaming server and set the flashvar streamer to the
external url. A simple typoscript setup could look like this:
page.30 < plugin.tx\_mediacenter\_pi1
page.30.renderingMode = typoscript
page.30.file = bunny.flv
page.30.flashvars.streamer = rtmp://edge01.fms.dutchview.nl/botr
.. _Skins:
Skins
^^^^^
If you want to use a custom layout or simply want the playlist to not
display thumbnails the extension offers an easy way to integrate a new
look and feel using a different skin from the default one. There is a
flashvar skin which could be used to setting a local or external path
to a swf skin file. Use the constant editor or the flexform
configuration as described in the configuration section.
This extension ships with several example skins located at
EXT:media\_center/lib/mediaplayer/skins
**Example:** If you want to have a playlist where no thumbnails are
displayed and the single entry is only about one line high, you go for
the skin *simple.swf.* Just set the following path to the skin
configuration (constant or flexform) and your done:
typo3conf/ext/media\_center/lib/mediaplayer/skins/simple.swf
.. _Plugins:
Plugins
^^^^^^^
The JW FLV Player version 4.2.x introduces a new plugin architecture
which enables simple integration of third party plugin to extend the
basic functionality of the player. Use the flashvar *plugins* to
enter a comma separated list of plugin keys. See configuration section
for details.
Have a look at `http://www.longtailvideo.com/AddOns/?category=plugins
`_ for public
available plugins.
.. _Multilingual-support:
Multilingual support
^^^^^^^^^^^^^^^^^^^^
Since version 1.0.2 the plugin supports multilingual media center
files when using the default renderingMode *tt\_content* . Make sure
to set the constant languageParameter to the language linkVar you have
assigned for your site.
.. _Configuration:
Configuration
-------------
As described in the user manual, the configuration could be done
easily via flexform configuration of the plugin.
.. _Flexform-Configuration:
Flexform Configuration
^^^^^^^^^^^^^^^^^^^^^^
As mentioned before, it is possible to override every setting made by
the constant editor using the flexform configuration of the plugin
itself.Attention: Empty settings and settings with value=0 of the
flexform configuration will be ignored!
**Tab: Media Files**
- Add at least one **Media Center File** to the playlist
- Since Version 0.1.3 you can add page records to the playlist. In this
case, the inner sorting is based on the manual order of the Media
Center File records on the included page
|img-11|
**Tab: Layout**
- Height:: set the height of the plugin. Attention: the height setting
will be added to the playlist size if the playlist position is set to
bottom
- Width: width of the video area
- Playlist Size: variable (widthif playlist position set to *right,*
height if playlist position set to bottom)
- Playlist position: none (default), bottom, over, right
- Background Colour: overall colour of the flash movie
- Controlbar: position of the control bar (botteom, over, none)
- Url to logo file: include a logo overlay, which will be rendered over
the video area. Use a large transparent image if you need to position
the logo at another location. The transparent image must have the size
of the video area. Position the logo onto the transparent image and
include it here see: `http://www.jeroenwijering.com/?thread=10578
`_
- Url to swf skin file: url to a swf skin file see:
`http://www.jeroenwijering.com/?item=Skinning\_the\_JW\_Player
`_
`http://code.longtailvideo.com/trac/wiki/FlashSkinning
`_
|img-12|
**Tab: Behaviour**
- autostart **:** automatically start the player on load.
- bufferlength:number of seconds of the file that has to be loaded
before starting.
- caption: on/off state of the captions. Is saved as cookie.
- displayclick: what to do when one clicks the display. Can be *play* ,
*link* , *fullscreen* , *none* , *mute* , *next* .
- fullscreen:set to *true* to enable fullscreen.
- item: playlistitem that should start to play. Use this to set a
specific start-item.
- mute: mute all sounds on startup. Is saved as cookie.
- quality: enables high-quality playback. This sets the smoothing of
videos on/off, the deblocking of videos on/off and the dimensions of
the camera small/large. Is saved as cookie.
- repeat: continously repeat playback of the file/playlist.
- schuffle: shuffle playback of playlistitems.
- stretching: defines how to resize images in the display. Can be
*none* (no stretching), *exactfit* (disproportionate), *uniform*
(stretch with black borders) or *fill* (uniform, but completely fill
the display).
- volume: startup volume of the player. Is saved as cookie.
|img-13|
**Tab: External Communication**
- abouttext:text to show in the rightclick menu. Please do not change
this if you don't have a `commercial license
`_ !
- aboutlink ( ` *http://www.jeroenwijering.com/?page=about*
`_ ): url to link to from
the rightclick menu. Do not change this if you don't have a
`commercial license `_ !
- linktarget: browserframe where the links from display are opened in.
Some possibilities are '\_self' (same frame) , '\_blank' (new
browserwindow) or 'none' (links are ignored in the player, so
javascript can handle it).
- streamscript: location of an external PHP file to use for HTTP
streaming. If set to *lighttpd* , the player presumes a `Lighttpd
`_ server is used to stream videos.
- tracecall: name of a javascript function that can be used for tracing
the player activity. All events from the view, model and controller
are sent there.
|img-14|
**Tab: Fallback**
- No Flash:assign several content elements which will be shown if the
clients browser has no flash plugin installed
- No Script: assign several content elements which will be shown if the
clients browser does not support javascript
|img-15|
.. _Typoscript:
Typoscript
^^^^^^^^^^
All typoscript settings of plugin.tx\_mediacenter\_pi1 use constants
and can be set by the constant editor.
plugin.tx\_mediacenter\_pi1
.. ### BEGIN~OF~TABLE ###
.. _renderingMode:
renderingMode
"""""""""""""
.. container:: table-row
Property
renderingMode
Data type
string
Description
the mode the plugin should be rendered. Could be tt\_content or
typoscript. Set to typoscript if you want to include the player using
typoscript setup and without any content elemen. If you set this to
typoscrip make sure to set the file settings as well.
Default
tt\_content
.. _file:
file
""""
.. container:: table-row
Property
file
Data type
string
Description
path to a local file or playlist. Only used if renderingMode is set to
typoscript
Default
.. _wrap:
wrap
""""
.. container:: table-row
Property
wrap
Data type
string
Description
wrap of the the player.
**Note:** the player will be included by default in a
tag with a
unique player id, this allows to inset multiple players on one page
and is needed, because the player will be inserted by the Javascript
SWFObject
Default
.. _noscriptInsideWrap:
noscriptInsideWrap
""""""""""""""""""
.. container:: table-row
Property
noscriptInsideWrap
Data type
string
Description
Wrap of the noscript content inside the