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: Readable name of your extension¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed: | 2011-09-05T22:55:31 |
| Classification: | extensionkey |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
| Keywords: | keywords comma-separated |
| Author: | Author Name |
| Email: | your@email.com |
| Info 4: | |
| Language: | en |
EXT: Readable name of your extension - extensionkey
Free mp3-Player¶
Extension Key: free_mp3player
Language: en
Keywords: mp3 player, free, audio, flashplayer, neolao, t3user
Copyright 2000-2008, Gunther Schoebinger, <g.schoebinger@t3user.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.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 5 <#1.3.Users%20manual|outline>`_
`Administration 6 <#1.4.Administration|outline>`_
`Configuration 7 <#1.5.Configuration|outline>`_
Extension manager – configuration 9
`Known problems 11 <#1.6.Known%20problems|outline>`_
`To-Do list 12 <#1.7.To-Do%20list|outline>`_
`ChangeLog 13 <#1.8.ChangeLog|outline>`_
Introduction¶
What does it do?¶
- This extension integrates the free mp3-player from neolao productions. The flash-based audio player offers playlist and individual colors for every element. You can customize the player with less clicks as frontend-plugin.
- You will find more about the developers and the flash player here: http://flash-mp3-player.net – the player uses MAXI and MULTI versions of the player.
- Due to incompatibility of the licenses GPL (TER) and MPL (source- player) the original files are removed from the extension an you have to download the required 2 files manually. The flash-player is open- source an free to use – have a look into the section 'Install'.
Users manual¶
Install¶
- Import and install the extension from TER.
- Download the required source-files (multi and maxi - swf) from google- code http://code.google.com/p/mp3player/downloads/list
- At the moment you have to download the files: player_mp3_multi_1.2.1.swf and player_mp3_maxi_0.6.0.swf
- Upload the 2 files to your web server. Configurate the path to the files by using the Extension-Configuration (Screenshot below)
Use¶
- Place the player through the content elements as a plugin.
- Inside the frontend-plugin you can import one or more mp3 audio files directly by flexform. The ID3-Tags in version 1 are automatically detected. You can override every title in a separate form-field.
Administration¶
No Page/User Tsconfig necessary. Just install the extension, configuration directly through flexform and color-configuration in extension manager.
Configuration¶
Frontend-Plugin¶
After inserting the player as content element you will find 2 tabs of configuration:
General-Tab¶
Files:
You can choose files either from the media-database of TYPO3 or upload them directly from your hard-disc. If the playlist is enabled, you can select each file in the frontend. The upload is limited on 10 MB.
Override ID3-Title:
The extension automatically detects ID3v1 tags from the mp3-files. If the detection can not fetch anything, it will display the filename in the playlist. If you want to override or set the title and artist information manually, you must put the data here. Every line represents one file: for example if you put information in the second row, it overrides the title of the second file.
Width:
The width of the player in pixel. Per default the value is set to 200px.
Height:
The height of the player in pixel. Per default the value is set to 20px in non-playlist mode and 100px in playlist mode.
Enable playlist:
You can choose playlist or non-playlist mode.
Show Playlistnumbers:
Inside the playlist you can enable/disable the preceded numbers.
Loop:
Loop mode for playback.
Autoplay:
Autoplay the first title.
Randomplay:
Plays randomly all files of the playlist.
Buttons-Tab¶
Show stop:
If you are using the non-playlist mode, you can enable/disable the stop-button here.
Show info:
Enable/disable the info-button here.
Show volume:
Enable/disable the volume-button here.
Show slider:
Enable/disable the slider-button here.
Buttonwidth:
The width of the buttons in pixel. Per default the value is set to 26px.
Sliderwidth:
The width of the slider in pixel. Per default the value is set to 20px.
Sliderheight:
The height of the slider in pixel. Per default the value is set to 10px.
Volumewidth:
The width of the volume in pixel. Per default the value is set to 30px.
Volumeheight:
The height of the volume in pixel. Per default the value is set to 6px.
Extension manager – configuration¶
- Set the path to the local source-files of the player (multi and maxi) here
- All colors are defined inside the extension-manger
Just fill in your customized color and all player instances on the website look the same.
Set Volume¶
You can set the volume of the extension global by adding the URL parameter “tx_freemp3player_pi1[volume]”. This is useful to realize a button for sound on/off or other settings. The Get-parameter should look like this:
&tx_freemp3player_pi1[volume]=100
The following settings are recognized: 'off', 25, 50, 75, 100, 125, 150, 175, 200
Via TS the value for sound could be passed by the menu settings like this:
additionalParams = &tx_freemp3player_pi1[volume]={ Gpvar:tx_freemp3player_pi1|volume}additionalParams.insertData=1
If you want to realize a on/off-button you probably have to add the no _cache-parameter like this:
tx_t3consultlist_pi1[zip]=10&no_cache=1
Known problems¶
No problems found, let me know.
To-Do list¶
- Better caching system.
- Detect ID3v2 tags.
- Add skin images.