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

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

Song Spotlight Mode Artist Variables

Variable Name Description
{$ARTIST_URL} URL to Artist’s page
{$BAND_ID} the numeric Jamroom ID of the band (i.e. “5”)
{$BAND_CREATED} the date the band was created, in EPOCH time (i.e. “1059951557”)
{$BAND_DATE1} date the band was created formatted according to $config[date1]
{$BAND_DATE2} date the band was created formatted according to $config[date2]
{$BAND_DATE3} date the band was created formatted according to $config[date3]
{$BAND_NAME} Name of the artist
{$BAND_INFO} The artists background information
{$BAND_RANK} The numerical value of its placement in the output list
{$BAND_LOCATION} The artists location (as entered in Modify Artist)
{$BAND_WEBSITE} The artists website (as entered in Modify Artist)
{$BAND_INFLUENCE} What the Artist’s Influences are (as entered in Modify Artist)
{$BAND_SOUNDLIKE} What the Artist Sounds Like (as entered in Modify Artist)
{$BAND_IMAGE_URL} link to image.php script to generate Band Image - i.e.:
image.php?band_id=(number)&mode=band_image

- use this inside an IMG tag

{$BAND_RATING_FORM_URL} URL to rating.php script to generate Band Rating Form.
{$BAND_RATING_NUMBER} Number of times song has been rated
{$BAND_RATING_AVERAGE} Average Rating of Song
{$BAND_RATING_1} Number of “1” votes the song has received.
{$BAND_RATING_2} Number of “2” votes the song has received.
{$BAND_RATING_3} Number of “3” votes the song has received.
{$BAND_RATING_4} Number of “4” votes the song has received.
{$BAND_RATING_5} Number of “5” votes the song has received.

Song Spotlight Mode Song Variables

Variable Name Description
{$SONG_ID} the numeric Jamroom ID of the song (i.e. “15”)
{$SONG_CREATED} the date the song was created, in EPOCH time (i.e. “1059951557”)
{$SONG_DATE1} date the song was created formatted according to $config[date1]
{$SONG_DATE2} date the song was created formatted according to $config[date2]
{$SONG_DATE3} date the song was created formatted according to $config[date3]
{$SONG_NAME} The title of the song
{$SONG_ALBUM} The title of the album the song belongs to
{$SONG_LABEL} The label name the songs belongs to
{$SONG_GENRE} The musical genre the songs belongs to
{$SONG_GENRE_URL} The musical genre the songs belongs to URLENCODED. NOTE: use this in any URL link you create that includes the Genre - it will handle genres with spaces in them, etc.
{$SONG_CREDITS} The Song Credits field as entered on the Song Create/Modify screen.
{$SONG_ADVISE} Will be set to “yes” if the song contains explicit lyrics.
{$SONG_ISRC} The Song ISRC field (if enabled) as entered on the Song Create/Modify screen.
{$SONG_ALICENSE} The Artist License field (if enabled) as entered on the Song Create/Modify screen.
{$SONG_SLICENSE} The Songwriter License field (if enabled) as entered on the Song Create/Modify screen.
{$SONG_INFO} the background information on the song
{$SONG_LYRICS} the lyrics to the song
{$SONG_RANK} The numerical value of its placement in the output list
{$SONG_IMAGE_URL} link to image.php script to generate Song Image - i.e.:
http://yourdomain.com/jamroom/image.php?band_id=(number)&song_id=(number)&mode=song_image

- use this inside an IMG tag

{$SONG_STREAM_COUNT} Total number of streaming plays ONLY for this song
{$SONG_DOWNLOAD_COUNT} Total number of download plays ONLY for this song
{$SONG_TOTAL_COUNT} Total number of ALL plays (downloads + streams) for this song
{$SONG_RATING_FORM_URL} URL to rating.php script to generate Song Rating Form.
{$SONG_RATING_NUMBER} Number of times song has been rated
{$SONG_RATING_AVERAGE} Average Rating of Song
{$SONG_RATING_1} Number of “1” votes the song has received.
{$SONG_RATING_2} Number of “2” votes the song has received.
{$SONG_RATING_3} Number of “3” votes the song has received.
{$SONG_RATING_4} Number of “4” votes the song has received.
{$SONG_RATING_5} Number of “5” votes the song has received.
{$SONG_HIFI_NAME} The file name of the HIFI Song File as it was when uploaded.
{$SONG_HIFI_TYPE} The mime-type of the HIFI Song File - i.e. “audio/mpeg”
{$SONG_HIFI_EXTENSION} The file extension (i.e. “mp3”) of the HIFI song file.
{$SONG_HIFI_SIZE} The size in bytes of the HIFI song file.
{$SONG_HIFI_DOWNLOAD} Whether or not the HIFI Song File is allowed for download (yes/no).
{$SONG_HIFI_BITRATE} The Bit Rate of the HIFI Song File (i.e. 128).
{$SONG_HIFI_SMPRATE} The Sample Rate of the HIFI Song File (i.e. 44100).
{$SONG_HIFI_LENGTH} The length of the HIFI Song File in HH:MM:SS format (or just MM:SS). To convert to seconds, use the “convert_to_seconds” Smarty variable modifier.
{$SONG_HIFI_PLAY_URL} The URL link to the “play.php” script so this song can be streamed in HiFi mode (if HiFi is available, otherwise is empty)
{$SONG_HIFI_DOWNLOAD_URL} The URL link to the “download.php” script so this song can be downloaded in HiFi mode (if HiFi download is enabled, otherwise is empty)
{$SONG_HIFI_SCOUNT} The number of times the HIFI song has been streamed.
{$SONG_HIFI_DCOUNT} The number of times the HIFI song has been downloaded.
{$SONG_LOFI_TIME} The epoch time the LOFI Song file was last updated. Use the smarty variable modifier date_format to format the date to what you want.
{$SONG_LOFI_NAME} The file name of the LOFI Song File as it was when uploaded.
{$SONG_LOFI_TYPE} The mime-type of the LOFI Song File - i.e. “audio/mpeg”
{$SONG_LOFI_EXTENSION} The file extension (i.e. “mp3”) of the LOFI song file.
{$SONG_LOFI_SIZE} The size in bytes of the LOFI song file.
{$SONG_LOFI_DOWNLOAD} Whether or not the LOFI Song File is allowed for download (yes/no).
{$SONG_LOFI_BITRATE} The Bit Rate of the LOFI Song File (i.e. 32).
{$SONG_LOFI_SMPRATE} The Sample Rate of the LOFI Song File (i.e. 22050).
{$SONG_LOFI_LENGTH} The length of the HIFI Song File in HH:MM:SS format (or just MM:SS). To convert to seconds, use the “convert_to_seconds” Smarty variable modifier.
{$SONG_LOFI_PLAY_URL} The URL link to the “play.php” script so this song can be streamed in LoFi mode (if LoFi is available, otherwise is empty)
{$SONG_LOFI_DOWNLOAD_URL} The URL link to the “download.php” script so this song can be downloaded in LoFi mode (if LoFi download is enabled, otherwise is empty)
{$SONG_LOFI_SCOUNT} The number of times the LOFI song has been streamed.
{$SONG_LOFI_DCOUNT} The number of times the LOFI song has been downloaded.
{$PLAYALL_HIFI_MP3_URL} URL to the play.php to play ALL HIFI MP3‘s for artist.
{$PLAYALL_HIFI_WMA_URL} URL to the play.php to play ALL HIFI WMA’s for artist.
{$PLAYALL_HIFI_OGG_URL} URL to the play.php to play ALL HIFI OGG’s for artist.
{$PLAYALL_LOFI_MP3_URL} URL to the play.php to play ALL LOFI MP3‘s for artist.
{$PLAYALL_LOFI_WMA_URL} URL to the play.php to play ALL LOFI WMA’s for artist.
{$PLAYALL_LOFI_OGG_URL} URL to the play.php to play ALL LOFI OGG’s for artist.

Song Spotlight Mode Rating Variables

Variable Replacement Description
{$SONG_RATING_FORM_URL} The URL link to the “rating.php” script that will launch the “rate form” interface.
{$SONG_RATING_NUMBER} The number of times the song has been rated.
{$SONG_RATING_AVERAGE} The Average value of the ratings the song has received.
{$SONG_RATING_1} The number of “1” ratings the song has received.
{$SONG_RATING_2} The number of “2” ratings the song has received.
{$SONG_RATING_3} The number of “3” ratings the song has received.
{$SONG_RATING_4} The number of “4” ratings the song has received.
{$SONG_RATING_5} The number of “5” ratings the song has received.

Song Spotlight Mode Quota Variables

Variable Replacement Description
{$QUOTA_ID} The numerical Jamroom Quota ID of the quota the Artist Account belongs to.
{$QUOTA_NAME} The name of the Jamroom Quota the Artist Account belongs to.
{$QUOTA_DISK} The amount of disk space the Artist Account is allowed (number).
{$QUOTA_MAX} The number of song slots the Artist Account quota allows (set to 0 if Quota is limited by disk space).
{$QUOTA_MESSAGE} yes/no if the Artist Account is allowed to create messages.
{$QUOTA_SEARCH} yes/no if the Artist Account is allowed to be found in searches.
{$QUOTA_RADIO} yes/no if the Artist Account is allowed to have Radio Stations.
{$QUOTA_STORE} yes/no if the Artist Account is allowed to have a Jamroom Store.
{$QUOTA_RATE} yes/no if the Artist Account is allowed to have Songs and Artist ratings.
{$QUOTA_REMRATE} yes/no if the Artist Account is allowed to be rated by remote site.
{$QUOTA_CALENDAR} yes/no if the Artist Account is allowed to have an Artist Calendar.
{$QUOTA_COMMENTS} yes/no if the Artist Account has Artist/Song comments allowed in their Jamroom Quota.

Song Spotlight Mode Cluster Server Variables

Variable Replacement Description
{$SERVER_URL} URL to Jamroom Cluster Server the Artist Page is located on (This will be the same as {$JAMROOM_URL} unless you are running the Jamroom Cluster Server).

 
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