Ranking Orders
- Order by Radio Name (alphabetical) (default)
- Order by Radio Name (reverse alphabetical)
- Order by Radio Created Date (newest to oldest)
- Order by Radio Created Date (oldest to newest)
- Order by Radio Plays (highest to lowest)
- Order Randomly
- Order by Radio Rating Average (highest to lowest)
- Order by Radio Rating Average (lowest to highest)
- Order by Radio Rating Number (highest to lowest)
- Order by Radio Rating Number (lowest to highest)
- Order by Radio Comment Count (highest to lowest)
- Order by Radio Comment Count (lowest to highest)
- Order as set in "Order Stations" (top to bottom)
- Order as set in "Order Stations" (bottom to top)
Additional Supported Parameters
In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "radio" mode also supports the following additional parameters:
| PARAMETER |
TYPE |
DEFAULT |
DESCRIPTION |
| radio_id |
number |
n/a |
The "radio_id" parameter tells Jamroom to only return the specified Radio ID. |
| letter |
string |
n/a |
If the "letter" parameter is given, then only Radio Stations that have a "Radio Name" that begins with the given letter will be shown. |
| min_ratings |
number |
n/a |
The "min_ratings" parameter tells Jamroom to only return Radio Stations that have at least min_ratings number of User Ratings. |
| max_ratings |
number |
n/a |
The "max_ratings" parameter tells Jamroom to only return Radio Stations that have less then max_ratings number of User Ratings. |
| min_average |
number |
n/a |
The "min_average" parameter tells Jamroom to only return Radio Stations that have at least a min_average User Rating average. |
| max_average |
number |
n/a |
The "max_average" parameter tells Jamroom to only return Radio Stations that have less then max_average User Rating average. |
| require_image |
true |
n/a |
If the "require_image" parameter is given, then only Radio Stations that have an associated image will be shown. |
| location |
string |
n/a |
The "location" parameter tells Jamroom to only return Radio Stations for Artist/Members in the given location. |
| showall |
true |
false |
By default, the Jamroom Ranking system will only return radio stations that have at least 1 song - you can set the showall parameter to "true" and Jamroom will return all radio stations regardless of the number of songs in them. |
Available search_area values
| SEARCH_AREA |
DESCRIPTION |
| radio_name |
"radio_name" will search the "Radio Name" (radio_name database column). |
| radio_desc |
"radio_desc" will search the "Radio Description" (radio_desc database column). |
| radio_type |
"radio_type" will search the "Radio Type" field, which will contain "mp3" for MP3 stations, "wma" for WMA stations, etc. |
| radio_mode |
"radio_mode" will search the "Radio Mode" field, which will be either set to "song_hifi" ir "song_lofi" for HIFI and LOFI stations. |
| radio_all_fields |
radio_all_fields will search the radio_name, radio_desc, radio_type and radio_mode fields. |
| radio_???? |
Any Radio Custom Form fields are also searchable - consult the Custom Form Fields section of your Jamroom Config for details on the search_area name to use. |
Template Variables for use in the row_template
In addition to the following Template Variables, you also have access to:
| VARIABLE |
DESCRIPTION |
| {$RADIO_RANK} |
The numerical position on the output result set (starting at 1). |
| {$RADIO_ID} |
Jamroom Radio ID for the Radio Station |
| {$RADIO_NAME} |
The name of the Radio Station. |
| {$RADIO_DESCRIPTION} |
The Description of the Radio Station. |
| {$RADIO_NUM_SONGS} |
The Number of Songs that are part of the play list for the Radio Station. |
| {$RADIO_CREATED} |
The 11 digit epoch time the Radio Station was created. |
| {$RADIO_TYPE} |
The "type" of Radio Station - i.e. it will be set to "mp3" for a Radio Station that is made of MP3 songs, "wma" for a Radio Station that is comprised of WMA songs, etc. |
| {$RADIO_MODE} |
The "mode" of the songs in the Radio Station - will be set to either "hifi" (for HIFI song files) or "lofi" (for LOFI song files). |
| {$RADIO_IMAGE_URL} |
The HTML URL to use in an <img> tag to display the Radio Station photo. |
|
