“Royal Audio Player Wordpress Plugin” Help by FWDesign

---

“Royal Audio Player Wordpress Plugin”

---

Table of Contents

1. IMPORTANT NOTES - read this before anything else
2. Wordpress Installation
3. Get Youtube API key
4. API specifications
5. Google analytics
6. Sources and Credits

---

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

Please note that the Royal Audio 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 Royal Audio 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

Please watch this video tutorial for more info.

Google Drive

For this method I've created a video tutorial here so plese watch it.

https://www.googleapis.com/drive/v3/files/[file_id]?alt=media&key=[api_key]&v=[.mp4][.mp3]

Example of working .mp4 file https://www.googleapis.com/drive/v3/files/0B4Au_agYmWFZNHNtZTlXUm1UUUE?alt=media&key=AIzaSyBsJ8HRNI4iHUqpszDtx3Ijq3ZKoXLUx-E&v=.mp4 and mp3 file https://www.googleapis.com/drive/v3/files/0B4Au_agYmWFZVG0zc2pzalVCVjg?alt=media&key=AIzaSyBsJ8HRNI4iHUqpszDtx3Ijq3ZKoXLUx-E&v=.mp3 .

Dropbox

Copy the drop box video or audio link, then replace www.dropbox.com with dl.dropboxusercontent.com.

Thus the URL: https://www.dropbox.com/s/abcd/file.mp4?dl=0&type=.mp3 will become: https://dl.dropboxusercontent.com/s/acbd/file.mp4?dl=0&type=.mp3 . If you are using mp4 files change the type to .mp4 like this &type=.mp4 .

B) Wordpress installation - top

Here is the link to the YOUTUBE VIDEO TUTORIAL.

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

C) Get Youtube API key - top

If you want to use Youtube playlists a Youtube API key is required, this key is added in your preset in the Youtube API key input in the plugin general settings. Here is a video tutorial about how to get a Youtube key.

D) API specifications - top

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

API - 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 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 "".
loadPlaylist	loadPlaylist(playlistId):void	Load a playlist based on id, the playlist count starts from 0.
showCategories	showCategories():void	Show the playlist selector window.
showPlaylist	showPlaylist():void	Show the playlist.
hidePlaylist	hidePlaylist():void	Hide the playlist.
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).
stop	stop():void	Stops the playback and the loading process if the loading process has started.
play	play():void	Start / play playback.
playSpecificTrack	playSpecificTrack(playlistId, trackId):void	Play a specific track from a playlist.
pause	pause():void	Pause the playback.
playPrev	playPrev():void	Play previous track.
playNext	playNext():void	Play next track.
playShuffle	playShuffle():void	Play shuffle track.
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.
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.

API - event listeners:

Event	Prefix	Description
ready	FWDRAP.READY	Dispatched when the Royal Audio Player instance API is actually available.
start	FWDRAP.START	Dispatched when the Mp3 playing has started.
popup	FWDRAP.POPUP	Dispatched when the player is pop-uped in a new window.
error	FWDRAP.ERROR	Dispatched when the Royal Audio Player instance can't load or play the audio file, this event has a property of type string that represents the error message.
startToLoadPlaylist	FWDRAP.START_TO_LOAD_PLAYLIST	Dispatched when the playlist loading has started.
playlistLoadCompleteHandler	FWDRAP.LOAD_PLAYLIST_COMPLETE	Dispatched when the playlist loading is complete.
stop	FWDRAP.STOP	Dispatched when the Royal Audio Player instance is stopped.
play	FWDRAP.PLAY	Dispatched when the Royal Audio Player instance playback start to play.
pause	FWDRAP.PAUSE	Dispatched when the Royal Audio Player instance playback is paused.
update	FWDRAP.UPDATE	Dispatched when the Royal Audio Player 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	FWDRAP.UPDATE_TIME	Dispatched when the Royal Audio Player instance current duration is changing. This event has two properties of type string curTime and totalTime.
playComplete	FWDRAP.PLAY_COMPLETE	Dispatched when the Royal Audio Player instance playback has reached the end of the audio file.

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

		
		Play next track

E) Google analytics - top

Please watch this video tutorial for more info

F) Sources and Credits - top

This component was made by Tibi from FWD (FWDesign) FUTURE WEB DESIGN, for more information and support contact us at tibi_diablo@yahoo.com

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 Royal Audio Player Wordpress Plugin and I'll do my best to assist.

FWDesign

Go To Table of Contents

---