Help
This plugin requires at least WordPress 3.0
- Video Tutorials
- Manage Players
- Player Settings
- Shoutcast and Iceast Link Structure
- ShortCode
- Facebook Share
How to install and use the plugin - https://www.youtube.com/watch?v=dIQGk1EcMhg
From this section you can:
- add a new player
-
select the player you want to edit by clicking "Player Settings"
- duplicate and existing player by clicking "Duplicate"
- delete an existing player by clicking "Delete"
From this section you can define the radio player settings.
| General settings | |
| Radio Stream Link | The radio stream you want to play. Please check Shoutcast and Iceast link structure section for additional details. |
| Radio Name | The radio station name |
| AzuraCast nowplaying API URL | ONLY if you'll use an AzuraCast radio stream you'll define the url to the Azura nowplaying API. Example: https://YOUR_RADIO_DOMAIN.com/api/nowplaying/YOUR_RADIO_SHORTCODE |
| Grab Artist Photo From AzuraCast API | Possible values: true - the player will get the artist image from the AzuraCast nowplaying API false - the player will get the artist image from the musicbrainz.org database |
| Url custom metadata file ( OPTIONAL ) | in the case your radio server doesn't offer a standard location for the metadata file, you can add the direct url to your radio stream metadata file here. |
| Metadata File Type ( OPTIONAL ) | in the case you've set an url for 'Url custom metadata file ( OPTIONAL )' parameter you need to also define it's type. This parameeter can take these values: - default - stats?sid=1 - 7.html - status-json.xsl - status.xsl |
| The MSCP PRO json Api URL ( OPTIONAL ) | in the case you are using a MSCP PRO radio server, you can add the direct url to the MSCP PRO Api, json version, so that the cover image will be taken from MSCP PRO radio server. |
| Skin Name | The audio player comes with 2 predefined controllers skins (white and black). By controllers we understand play, pause, volume, facebook, twitter, show/hide playlist buttons. These buttons are saved as .png images. If you need another color for these controllers, you have the PSD files included and you can save over one skin, the controllers with another color.
Possible values: |
| Responsive |
Possible values: true - the player will responsive false - the player will not be responsive |
| Player Width | player width |
| Image Height | top image height. For image width it will use 'playerWidth' parameter |
| Auto Play | Possible values: true - autoplays audio file false - doesn't autoplay audio file |
| Song Title Color | Audio file Title text area color (hexa) |
| Author Title Color | Audio file Author text area color (hexa) |
| Line Separator Color | The line separator between the song title and song author |
| Radio Station Color | Radio name text area color (hexa) |
| Frame Behind Text Color | The color (hexa) of the frame behind song title and song author |
| Frame Behind Buttons Color | The color (hexa) of the frame behind radio name and share buttons |
| Player Border Size | The size for entire player border (including history area) |
| Player Border Color | The player border color (hexa) |
| Sticky | Possible values: true - the radio player will be positioned on the right-bottom corner beeing fixed while the page scrolls false - the radio player will NOT be sticky and it will behave like any other element on the page. |
| Activate For Footer | Possible values: true - the player will be added in the website footer and it will be present on all pages false - the player will be added in the website footer and it will be present only on the pages where the shortcode has been added |
| Start Minified | Possible values: true - the radio player start with large image and history area hidden. If you set this parameter true you also need to set sticky:true false - the radio player will start with large image and history area visible. |
| Show Only Play Button | Possible values: true - all the elements of the player will be hidden except for play/pause button false - all the elements of the player will be visible |
| Center Player | Possible values: true - the radio player will be centered in your layout containing div false - the radio player will be centered |
| Facebook App ID | FaceBook AppID. Please check Facebook Share section, for more informations |
| Facebook Share Title | The title which will appear on FaceBook share. Please check Facebook Share section, for more informations |
| Facebook Share Description | The description which will appear on FaceBook share. Please check Facebook Share section, for more informations |
| Facebook Share Image | The image which will appear on FaceBook share. Please check Facebook Share section, for more informations |
| Refresh Interval for Now-Playing Info | The calling interval (in seconds) for the file which reads the current playing song |
| Player Loading Delay | The timeout delay (in seconds) for player loading |
| Use The Original Upper&LowerCase for Song & Author As It Is In the Radio Metadata file | Possible values: true - the current playing song title and author letters will be displayed as they come from the metadata file false - the current playing song title will have text-transform:uppercase and author will have text-transform:capitalize |
| Grab Artist Photo | Possible values: true - it will grab the artist photo false - it will always use the image specified by 'noImageAvailable' parameter |
| No Image Available | The path to 'No Image Available' image which will appear when there's no image found in the database |
| Check IceCast Metadata File First | Possible values: true - it will first read the metadata files of the IceCast stream false - it will first read the metadata files of the ShoutCast stream |
| Path to the artist images/album covers folder ( OPTIONAL ) | in the case you have your images stored on your server (the same as your website) and you want to use those images for the current playing song. The image name should be identical with the current playing song. Example: Artist Name - Song Name.jpg |
| Display the number of listeners | Possible values: true - it will display the number of listeners near the radio name false - it will not display the number of listeners near the radio name |
| Translate Listeners | You can translate "Listeners" in your own language, if you'll display the number of listeners |
| Controllers Settings: Show/Hide buttons & elements | |
| Show Volume | Possible values: true - volume button will appear false -volume button will not appear |
| Show Facebook But | Possible values: true - facebook button will appear false - facebook button will not appear |
| Show Twitter But | Possible values: true - twitter button will appear false - twitter button will not appear |
| Show Radio Station | Possible values: true - radio station name will appear false - radio station name will not appear |
| Show Title | Possible values: true - current playing song will appear false - current playing song will appear |
| Show History But | Possible values: true - show/hide history button will appear false - show/hide history button will not appear |
| History Settings | |
| Show History | Possible values: true - history will appear false - history will not appear |
| Show History On Init | Possible values: true - history will appear on init false - history will not appear on init |
| Translate Reading Data | You can translate "reading history..." in your own language (if needed) |
| History Translate | You can translate "HISTORY - latest played songs" in your own language (if needed) |
| History Title Color | history title color (hexa) |
| History Bg Color | history background color (hexa) |
| History Record Bg Color | history item background color (hexa) |
| History Record Bottom Border Color | history item bottom border color (hexa) |
| History Record Song Color | history item song title color (hexa) |
| History Record Autho rColor | history item song author color (hexa) |
| History Record Song Bottom Border Color | history item line color between the song title and song author (hexa) |
| Number Of Thumbs Per Screen | Number of items shown in the history. You'll have to scroll to see the rest |
| History Padding | history inner padding |
| History Record Title Limit | The history record title characters limit. All the other characters will be remoeved and replaced with ... |
| History Record Author Limit | The history record author characters limit. All the other characters will be remoeved and replaced with ... |
| History Max Number of Songs | The player will use this parameter to limit the number of songs displayed in the history |
Shoutcast and Iceast Link Structure
- SHOUTCAST LINK
http://[domain]:[port] OR
http://[ip]:[port]
Ex: http://83.169.60.45:80
IMPORTANT: For the vast majority of the shoutcast streams, try appending "/;" to the stream so it looks like this:
http://[ip]:[port]/;
Ex: http://83.169.60.45:80/;
- ICECAST LINK
http://[domain]:[port]/mountpoint
Ex: http://87.230.59.20:80/iloveradio2.mp3
- RADIONOMY LINK
For radio hosted by radionomy.com, the link looks like this: http://streaming.radionomy.com/ABC-Piano
Due to the fact that the IP is unknown, the player can't access current playing song name and artist photo. It will play it and it will display the radio name.
NOTE: Radio Stream should be MP3 type, no support for AAC/AAC+ stream
The shortcode is:
[lbg_audio6_html5_shoutcast settings_id='1']
where
settings_id is the player ID defined in "Manage Players" section
OPTIONAL PARAMETERS:
'url_custom_metadata_file' is the url to a custom radio metadata file
'metadata_file_type' the number of the metadata file type. The value can be 1 ; 2 ; 3 or 4
1 - stats?sid=1
2 - 7.html
3 - status-json.xsl
4 - status.xsl
'optional_images_path' the path to a folder on your server where you have the current playing song images. The image name should be identical with the current playing song.
Example: Artist Name - Song Name.jpg
In order for the Facebook share button to work you need to obtain a Facebook Application ID
1. Go to the Facebook Developers Apps page and and sign in with your Facebook username and password.
2. Click the "Add a New App" button.
If you do not see the option to create a new app in the upper right hand corner, click on "Register as Developer."
3. After that you'll obtain an 'App ID' which you'll paste in FaceBook AppID field in Manage Players->Player Settings area of our plugin
4. Go to Settings->Basic tab (left area), select 'Website' and insert your website URL and fill all the other information. Below you have a demo screenshot. Of course, you'll use your own info.
5. Go to Settings->Advanced tab (left area) and activate 'Social Discovery'
6. To personalize more the share content you can use FaceBook Share Title and FaceBook Share Description fields in Manage Players->Player Settings area of our plugin. Please check Player Settings section, to see all available parameters