NATIVE FLASH RADIO Documentation by SODAH


NATIVE FLASH RADIO

Created: 01/02/2014
By: Sodah
Email: forum@sodah.de

Thank you for purchasing my plugin. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!


Table of Contents

  1. HTML Structure
  2. Settings
  3. JavaScript
  4. PHP
  5. API v0.1

A) HTML Structure - top

This NATIVE FLASH RADIO use a empty div container.

HTML Structure

Create a emtpy div container with your height and width. For the width you can use 100% for responsive mode.

	<div id="flashradio" style="height:50px; width:400px;"> Native Flashradio V3 </div>

B) Settings - top

I'm using a settings.xml file.

	
<flashradio>	
	<THEME COLOR="#0d72bf" FONTCOLOR="#ffffff" STARTVOLUME="75" />
	<CHANNEL URL="http://95.110.175.218:8000" TYPE="mpeg" />
	<CHANNEL URL="http://95.110.175.218:7007" TYPE="mpeg" />
	<CHANNEL URL="http://95.110.226.198:8000" TYPE="mpeg" />
	<CHANNEL URL="http://95.110.226.198:80" TYPE="mpeg" />
	<CHANNEL URL="http://93.104.211.141:9998" TYPE="mpeg" />
	<RADIO NAME="Nonsolosuoni  La web radio di sola musica anni 70, 80 e 90" SCROLL="AUTO" AUTOPLAY="FALSE" DEBUG="FALSE" 
	SONGTITLEURL="" INFOTEXT="Nonsolosuoni  La web radio di sola musica anni 70, 80 e 90" INFOLINK="http://www.nonsolosuoni.it/" FIRSTSOLUTION="FLASH" SONGINFORMATIONINTERVAL="20000" />
	<TITLEFONT FONTNAME="Oswald" GOOGLEFONT="Oswald:400" />
	<SONGFONT FONTNAME="Oswald" GOOGLEFONT="Oswald:800" />
</flashradio>

XML Nodes:
STARTVOLUME: set the start volume (0-100) (just for the first visit, the volume controler saved the volume value local)
THEME COLOR: set the RGB value from your native flash radio player theme
THEME FONTCOLOR: set the RGB value from your font
CHANNEL URL: your stream URL from your mpeg-audio stream (Support for MULTIPLY RELAYS)
CHANNEL TYPE: your stream TYPE: mpeg or aac
RADIO NAME: Name from your radio
RADIO SCROLL: you can enabled display scroll (TRUE/FALSE/AUTO)
RADIO AUTOPLAY: you can enabled for Desktop-version the autoplay from your player (TRUE)
RADIO FIRSTSOLUTION: you can set the first solution (FLASH or HTML)
RADIO DEBUG: is just for debugging the player
RADIO SONGINFORMATIONINTERVAL: here you can set the interval for reading song information (in ms)
RADIO SONGTITLEURL: if you have a own URL for your Songtitle
RADIO INFOTEXT: is visible on right-click. If you write as value "FALSE", than will be disable the right click.
RADIO INFOLINK: the link for INFOTEXT
TITLEFONT FONTNAME: is the font family name
TITLEFONT GOOGLEFONT: is the google font name for loading. p.e. Oswald:400:latin,latin-ext please check this out on Google Fonts SONGFONT FONTNAME: is the font family name
SONGFONT GOOGLEFONT: is the google font name for loading. p.e. Oswald:800:latin,latin-ext please check this out on Google Fonts The filename for settings is not important. You can use what you want.


C) JavaScript - top

This plugin imports 2 Javascript files.

  1. jQuery
  2. js/nativeflashradiov3.js
  1. jQuery is a Javascript library that greatly reduces the amount of code that you must write.
  2. For initializing the radio, please use:
    	$("#flashradio").flashradio({settings: "flashradio.xml"});
    

    You can use multiply instances.


D) PHP - top

This plugin uses 2 PHP files.

  1. js/currentsong.php
    this script read the current song with intervall 20sec.
  2. js/radioname.php
    if XML-Node RADIO NAME empty or missing, this script read the radio name

D) API v0.1 - top

Javascript API v0.1 for remote control the native flashradio

  1. $("#myflashradioID").data('flashradio').stopradio();
    Stop the radio (change myflashradioID with your ID)
  2. $("#myflashradioID").data('flashradio').startradio();
    Start the radio (change myflashradioID with your ID)
  3. $("#myflashradioID").data('flashradio').setvolume(100);
    this is beta: Set volume (change myflashradioID with your ID and the value 0-100)

Once again, thank you so much for purchasing this plugin. As I said at the beginning, I'd be glad to help you if you have any questions relating to this plugin. No guarantees, but I'll do my best to assist. If you have a more general question relating to the plugin on ThemeForest, you might consider visiting the forums and asking your question in the "Item Discussion" section.

SODAH

Go To Table of Contents