Jamroom Logo Jamroom 5 Core
is now Open Source!
Follow Jamroom on Twitter!

This document applies to Jamroom 3 only!
For current Jamroom 4 Documentation, visit the main Jamroom Documentation section.

Jamroom Ranking System - Radio Mode Index Jamroom Ranking System - Spotlight Mode

Ranking Orders

  1. Order by Song Name (alphabetical) (default)
  2. Order by Song Created Date (oldest to newest)
  3. Order by Song Created Date (newest to oldest)
  4. Order by Song Total Streams (highest to lowest)
  5. Order by Song Total Plays (streams + downloads) (highest to lowest)
  6. Order by Song Genre (Special Order: Only 1 song will be show for each genre)
  7. Order by Song Rating Count (highest to lowest)
  8. Order by Song Rating Count (lowest to highest)
  9. Order by Song Rating Average (highest to lowest)
  10. Order by Song Rating Average (lowest to highest)
  11. Order Randomly
  12. Order by Song Total Downloads (highest to lowest)
  13. Order by Song Total Streams (lowest to highest)
  14. Order by Song Total Plays (streams + downloads) (lowest to highest)
  15. Order by Song Total Downloads (lowest to highest)
  16. Order by Song Order (as entered into "Arrange Songs" by artist)
  17. Order by Song Comment Count (highest to lowest)
  18. Order by Song Comment Count (lowest to highest)

 

Additional Supported Parameters

In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "song" mode also supports the following additional parameters:

PARAMETER TYPE DEFAULT DESCRIPTION
song_id  number n/a The "song_id" parameter tells Jamroom to only return the specified Song ID (s).   Multiple Song ID's may be specified either by Template array, or comma separated list.
genre string n/a The "genre" parameter tells Jamroom to return only songs that match the given genre(s).  Multiple Genres may be given as an array.
letter string n/a If the "letter" parameter is given, then only Songs that have a "Song Name" that begins with the given letter will be shown.
min_ratings number n/a The "min_ratings" parameter tells Jamroom to only return Songs that have at least min_ratings number of User Ratings.
max_ratings number n/a The "max_ratings" parameter tells Jamroom to only return Songs that have less then max_ratings number of User Ratings.
min_average number n/a The "min_average" parameter tells Jamroom to only return Songs that have at least a min_average User Rating average.
max_average number n/a The "max_average" parameter tells Jamroom to only return Songs that have less then max_average User Rating average.
require_image true n/a If the "require_image" parameter is given, then only Songs that have an associated image will be shown.
location string n/a The "location" parameter tells Jamroom to only return Songs for Artists in the given location.
no_explicit_content true n/a If the "no_explicit_content" parameter is given, then only Songs that do NOT have the "Explicit Content" setting checked will be shown.
type string n/a If the "type" parameter is given, then only Songs that match the given type (i.e. "mp3") will be shown.
vault_only true n/a If the "vault_only" option is set, then only Songs that have an associated Vault Item will be shown.
size true n/a If the "size" option is set, then song that have been created WITHOUT any attached song files will be included in the output.  By default, Jamroom requires that at least 1 audio file (HIFI or LOFI) be attached to the song information for it to be shown.

 

Available search_area values

SEARCH_AREA DESCRIPTION
song_name "song_name" will search the "Song Name" (song_name database column).
song_album "song_album" will search the "Song Album" field (song_album database column).
song_label "song_label" will search the "Song Label" field (song_label database column).
song_credits "song_credits" will search the "Song Credits" field (song_credits database column)
song_isrc "song_isrc" will search the "ISRC Code" field (song_isrc database column) - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
song_alicense "song_alicense" will search the "Artist License" field (song_alicense database column) - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
song_slicense "song_slicense" will search the "Songwriter License" field (song_slicense database column) - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
song_lyrics "song_lyrics" will search the "Song Lyrics" field (song_lyrics database column).
song_history "song_history" will search the "Song Info / History" field (song_history database column).
genre_name "genre_name" will search the "Song Genre" field (genre_name database column from jamroom_song_genre table).
song_all_fields song_all_fields will search the song_name, song_album, song_label, song_credits, song_isrc, song_alicense, song_slicense, song_lyrics, song_history and genre_name fields.
song_???? Any Song 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
{$SONG_RANK} The numerical position on the output result set (starting at 1).
{$SONG_ID} Jamroom Song ID for the Song
{$SONG_NAME} The name of the Song
{$SONG_ALBUM} The name of the Album the Song belongs to.
{$SONG_LABEL} The text from the Song Label form entry.
{$SONG_CREATED} The 11 digit epoch time the Song was created.
{$SONG_UPDATE} The 11 digit epoch time the Song was last updated.
{$SONG_CREDITS} The text from the "Song Credits" field.
{$SONG_ADVISE} Will be set to "yes" if the Song has been set as having Explicit Content.
{$SONG_ISRC} The text from the "ISRC Code" field - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
{$SONG_ALICENSE} The text from the "Artist License" field - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
{$SONG_SLICENSE} The text from the "Songwriter License" field - note that this field will only show in the Create/Modify Song form if "Show License Fields" option is set in the Jamroom Quota.
{$SONG_LYRICS} The Lyrics for the Song
{$SONG_INFO} The Song Background/History/Information
{$SONG_GENRE} The Genre the Song belongs to.
{$SONG_IMAGE_URL} The HTML URL to use in an <img> tag to display the Song photo.
{$SONG_HIFI_TIME} The Epoch time the HIFI Song File was created.
{$SONG_HIFI_NAME} The filename of the HIFI Song File.
{$SONG_HIFI_TYPE} The Mime Type of the HIFI Song File.
{$SONG_HIFI_SIZE} The Size (in bytes) of the HIFI Song File.
{$SONG_HIFI_DOWNLOAD} This variable contains the info that determines if the HIFI Song File can be streamed, downloaded, or both.  It will be set to:
  • "no" if the HIFI Song File can only be streamed.
  • "yes" if the HIFI Song File can be both downloaded and streamed.
  • "nos" if the HIFI Song File can only be downloaded (no streaming).
{$SONG_HIFI_EXTENSION} The filename extension of the HIFI Song File (i.e. "mp3")
{$SONG_HIFI_BITRATE} The Bit Rate of the HIFI Song File.
{$SONG_HIFI_SMPRATE} The Sample Rate of the HIFI Song File.
{$SONG_HIFI_LENGTH} The Length of the HIFI Song File in MM:SS format.
{$SONG_HIFI_PLAY_URL} If the HIFI Song File can be streamed, this will create the URL to stream the HIFI Song File.
{$SONG_HIFI_DOWNLOAD_URL} If the HIFI Song File can be downloaded, this will create the URL to download the HIFI Song File.
{$PLAYPAGE_HIFI_###_URL} The special "playpage" url is available in the Jamroom Ranking System header/row/footer templates, and is used to play ALL of the ### type of HIFI audio files on the page, where ### is MP3, WMA, OGG or M4A (i.e. {$PLAYPAGE_HIFI_WMA_URL}.
{$SONG_LOFI_TIME} The Epoch time the LOFI Song File was created.
{$SONG_LOFI_NAME} The filename of the LOFI Song File.
{$SONG_LOFI_TYPE} The Mime Type of the LOFI Song File.
{$SONG_LOFI_SIZE} The Size (in bytes) of the LOFI Song File.
{$SONG_LOFI_DOWNLOAD} This variable contains the info that determines if the LOFI Song File can be streamed, downloaded, or both.  It will be set to:
  • "no" if the LOFI Song File can only be streamed.
  • "yes" if the LOFI Song File can be both downloaded and streamed.
  • "nos" if the LOFI Song File can only be downloaded (no streaming).
{$SONG_LOFI_EXTENSION} The filename extension of the LOFI Song File (i.e. "mp3")
{$SONG_LOFI_BITRATE} The Bit Rate of the LOFI Song File.
{$SONG_LOFI_SMPRATE} The Sample Rate of the LOFI Song File.
{$SONG_LOFI_LENGTH} The Length of the LOFI Song File in MM:SS format.
{$SONG_LOFI_PLAY_URL} If the LOFI Song File can be streamed, this will create the URL to stream the LOFI Song File.
{$SONG_LOFI_DOWNLOAD_URL} If the LOFI Song File can be downloaded, this will create the URL to download the LOFI Song File.
{$PLAYPAGE_LOFI_###_URL} The special "playpage" url is available in the Jamroom Ranking System header/row/footer templates, and is used to play ALL of the ### type of LOFI audio files on the page, where ### is MP3, WMA, OGG or M4A (i.e. {$PLAYPAGE_LOFI_WMA_URL}.
{$SONG_IMAGE_NAME} The filename of the Song Image
{$SONG_IMAGE_TYPE} The Mime Type of the Song Image
{$SONG_IMAGE_SIZE} The Size (in bytes) of the Song Image
{$SONG_IMAGE_EXTENSION} The filename extension of the Song Image (i.e. "png").
{$SONG_IMAGE_URL} Creates the URL that can be used in an <img> tag to generate the Song Image.
{$SONG_RATING_NUMBER} The Number of User Ratings the Song has.
{$SONG_RATING_AVERAGE} The Average of the User Ratings the Song has.
{$SONG_RATING_1} The number of "1" User Ratings the Song has received.
{$SONG_RATING_2} The number of "2" User Ratings the Song has received.
{$SONG_RATING_3} The number of "3" User Ratings the Song has received.
{$SONG_RATING_4} The number of "4" User Ratings the Song has received.
{$SONG_RATING_5} The number of "5" User Ratings the Song has received.
{$SONG_RATING_FORM_URL} Creates the necessary URL to the Song Rating form.
{$SONG_STREAM_COUNT} The number of times the Song has been streamed.
{$SONG_DOWNLOAD_COUNT} The number of times the Song has been downloaded.
{$SONG_TOTAL_COUNT} The number of times the Song has been streamed and downloaded ("total plays")
{$SONG_COMMENT_COUNT} The number of comments/reviews the Song has received.

Jamroom Ranking System - Radio Mode page 71 of 185 Jamroom Ranking System - Spotlight Mode
Solutions Products Support Community Company
Social Media Platform
Social Networking Software
Musician Website Manager
Community Builder
Jamroom 5
Jamroom 5 Modules
Jamroom Marketplace
Support Forum
Documentation
Support Center
Contact Support
Community Forum
Member Sites
Developers
About Us
Contact Us
Privacy Policy
©2003 - 2024 The Jamroom Network