“MP3 Sticky Player Wordpress Plugin” Help by FWDesign

---

“MP3 Sticky Player Wordpress Plugin”

---

Table of Contents

1. IMPORTANT NOTES - read this before anything else
2. Wordpress installation
3. API specifications
4. Google analytics
5. Sources and Credits

---

A) IMPORTANT NOTES - make sure you read this! - top

Please note that the MP3 Sticky Player Wordpress Plugin installation and configuration is not complicated but because it has a lot of customizable settings it might seem complicated, so please go through the entire help file and watch the video tutorial before trying to install it into your own Wordpress site and pages.

When something is wrong with the player or an error occurs, a red info box with the problem description will appear over the player. Please note that this box is there to help you understand the problem, for example if a mp3 file is not found the box will appear and inform you about the problem. The box can be closed when clicked or touched.

The MP3 Sticky Player Wordpress Plugin skin is constructed from .png images, only a few settings for changing colors are possible like changing the playlist or title track color. If you want a different skin the .png files must be modified. The skin is really flexible allowing you to customize the player as you like. We have a great designer so if you need a custom skin please contact us!

Currently all browsers except Opera have .mp3 support (this applies to desktop), on a mobile device all browsers have .mp3 support. On a browser that does not have .mp3 support the player will use flash. The good news is that the player will work only with .mp3 files there is no need to use other audio formats.

Preparing SHOUTCAST

In order to stream Shoutcast instead of adding the mp3 track path in the playlist add the Shoutcast server address and at the end of it ";.mp3", like this : http://95.141.24.224:80/;.mp3. Adding the ";.mp3" at the end of the address will force the server to serve the mp3 stream instead of the http web page. Please note that this player has support only for mp3 stream and it will not work correctly with other formats like .acc or .ogg. The good news is that the player will play the stream on all browsers, no matter which operating system is used, this applies to both desktop and mobile devices.

Google drive files.

To get the track path mp3 or mp4 open your google drive page go to Disc – My drive.

Right click on get shareable link the like on screenshot: get video id 1 get video id 2 and use that video ID to create google drive video URL.

This is final URL how google drive video URL should look:https://drive.google.com/uc?export=download&id=videoID

Replace videoID with the id taken from the previous step and use it as the video source:https://drive.google.com/uc?export=download&id=0B4Au_agYmWFZQWdHdHN3OVJLX0E

B) Wordpress installation - top

Here is the link to the YOUTUBE VIDEO TUTORIAL.

To install the MP3 Sticky Player Wordpress Plugin in your Wordpress site, you just need to follow the video tutorial using the "fwdmsp.zip" file, or you can also upload and install it manually if you need to, just unzip the file and copy the "fwdmsp" folder to your "wp-content/plugins/" directory.

C) API specifications - top

The following lists represent all the public API functions and event listeners that you can use from the player externally:

Public methods:

Function	Method	Description
addTrack	addTrack(source:String, title:String, thumbPath:String, duration:String, addAtTheBegginngOfPlaylist:Boolean, download:Boolean, buy:String):void	This method allows to add a track in the current playlist at runtime.... source: the mp3 file relative or absolute path or the youtube video URL or the mp4 video relative or absolute path. title: the track title. thumbPath: the track thumbnail relative or absolute path, if you don't want a thumbnail just set this to "". duration: the track duraton with this format hours:minutes:seconds for example (00:06:14). addAtTheBegginngOfPlaylist: this can be true or false, it allows to add the track at the beggining or end of the playlist. download: this can be yes or no, it allows to download or not the track. buy: this can be URL that will be opened when the buy button is clicked or a javascript function that you can call when the buy button is clicked, for example buyCustomFunction(), if you don't need a buy button just set this to "". Ex:window['player1'].addTrack("content/mp3/01.mp3", "New added track - new added artist", "content/thumbnails/brian.jpg", "05:45", true, true, "myFunction()");
popup	popup():void	Pop-up playler in a new window.
loadPlaylist	loadPlaylist(playlistId):void	Load a playlist based on id, the playlist count starts from 0.
showPlayer	showPlayer():void	Show the entire player.
hidePlayer	hidePlayer():void	Hide the entire player.
showCategories	showCategories():void	Show the playlist selector window.
showPlaylist	showPlaylist():void	Show the playlist.
hidePlaylist	hidePlaylist():void	Hide the playlist.
getCurrentTime	getCurrentTime():String	Returns the track current time.
getDuration	getDuration():String	Returns the total track duration.
share	share():void	Share current track on facebook.
setVolume	setVolume( Number ):void	Set the audio volume, this method accepts a parameter that represents a number between 0 (audio mute state) and 1 (audio maximum volume).
scrub	scrub( Number ):void	Notify instance to scrub (set the audio position), this method accepts a parameter that represents a number between 0 (audio start position) and 1 (audio end position).
playSpecificTrack	playSpecificTrack(categoryId, trackId):void	Play a specific cat based on the category id and track id, both parameters counting is starting from 0.
stop	stop():void	Stops the playback and the loading process if the loading process has started.
play	play():void	Start / play playback.
pause	pause():void	Pause the playback.
playPrev	playPrev():void	Play previous track.
playNext	playNext():void	Play next track.
playShuffle	playShuffle():void	Play shuffle track.
getIsAPIReady	getIsAPIReady():Boolean	Returns the API state, true if ready, false if not.
getCatId	getCatId():Number	Returns the current category id, the counting starts form 0.
getTrackId	getTrackId():Number	Returns the current track id, the counting starts form 0.
getTrackTitle	getTrackTitle():String	Returns the current track title.
setPlaybackRate	tsetPlaybackRate(rate):void	Set the playback rate / speed, the rate argument can be a number betweem 0.5 and 3 where 1 is normal rate /speed .
scrubbAtTime	scrubbAtTime(time):void	Scrub at a specified time in format hour:minutes:seconds for example 00:01:30.

Event listeners:

Event	Prefix	Description
ready	FWDMSP.READY	Dispatched when the MP3 Sticky Player Wordpress Plugin instance API is actually available.
start	FWDMSP.START	Dispatched when the MP3 playing has started.
popup	FWDMSP.POPUP	Dispatched when the player is pop-uped in a new window.
error	FWDMSP.ERROR	Dispatched when the MP3 Sticky Player Wordpress Plugin instance can't load or play the audio file, this event has a property of type string that represents the error message.
startToLoadPlaylist	FWDMSP.START_TO_LOAD_PLAYLIST	Dispatched when the playlist loading has started.
playlistLoadCompleteHandler	FWDMSP.LOAD_PLAYLIST_COMPLETE	Dispatched when the playlist loading is complete.
stop	FWDMSP.STOP	Dispatched when the MP3 Sticky Player Wordpress Plugin instance is stopped.
play	FWDMSP.PLAY	Dispatched when the MP3 Sticky Player Wordpress Plugin instance playback start to play.
pause	FWDMSP.PAUSE	Dispatched when the MP3 Sticky Player Wordpress Plugin instance playback is paused.
update	FWDMSP.UPDATE	Dispatched when the MP3 Sticky Player Wordpress Plugin instance is playing and it's position is changing (useful to update a custom scrub bar), this event has a property of type number between 0 (audio start position) and 1 (audio end position).
updateTime	FWDMSP.UPDATE_TIME	Dispatched when the MP3 Sticky Player Wordpress Plugin instance current duration is changing. This event has two properties of type string curTime and totalTime.
playComplete	FWDMSP.PLAY_COMPLETE	Dispatched when the MP3 Sticky Player Wordpress Plugin instance playback has reached the end of the audio file.

You can access the player instances by their order in the page with the "fwdmspPlayer" name with its order after it, starting from 0. For example if you have 2 instances their names are "fwdmspPlayer0" and "fwdmspPlayer1". Here is an example how to use the API in the Wordpress editor:

		

		Play next track

D) Google analytics - top

Please watch this video tutorial for more info

E) Sources and Credits - top

This component was made by Tibi from FWD (FWDesign) FUTURE WEB DESIGN, for more information and support contact us at [email protected]

Once again, thank you so much for purchasing this item. As I said at the beginning, I'd be glad to help you if you have any questions regarding this MP3 Sticky Player Wordpress Plugin and I'll do my best to assist.

FWDesign

Go To Table of Contents

---