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

Profile Variables - Radio Templates Index Profile Variables - Store Templates

Song Information Variables

Variable Replacement Description
{$SONG_ID} the numeric Jamroom ID of the song (i.e. 5)
{$SONG_COUNT} the total number of visible songs this artist has
{$SONG_NUMBER} the numeric ORDER that the song is processed in by the Song Sub-Config file. If you have 8 songs (for example), as each song is processed, the {SONG_NUMBER} variable will be incremented by 1.
{$SONG_NAME} the title of the song
{$SONG_NAME_LOWER} the title of the song in all lower case
{$SONG_NAME_UPPER} the title of the song in ALL UPPER CASE
{$SONG_ALBUM} text from Song Album text field
{$SONG_ALBUM_URL} text from Song Album text field URL encoded
{$SONG_CREDITS} text from Song Credits text field
{$SONG_DATE1} date song was created formated to $config[date1]
{$SONG_DATE2} date song was created formated to $config[date2]
{$SONG_DATE3} date song was created formated to $config[date3]
{$SONG_GENRE} song genre
{$SONG_ISRC} Text entered into Song ISRC box on Song Create/Modify form
{$SONG_ALICENSE} Text entered into Song Artist License box on Song Create/Modify form
{$SONG_SLICENSE} Text entered into Songwriter License box on Song Create/Modify form
{$SONG_HISTORY} text from the song information text box
{$SONG_HISTORY_WORDS} number of words in the Song Information text box
{$SONG_LABEL} text from the Song Label text box
{$SONG_LENGTH} Length of the HIFI song (in MM:SS)
{$SONG_LYRICS} text from the Lyrics text box
{$SONG_LYRICS_WORDS} number of words in the Lyrics text box
{$SONG_ORDER} The internal Jamroom ORDER ID number for this song (as selected in Arrange Songs)
{$SONG_TIME} EPOCH time the song was created
{$SONG_ADVISE} the “explicit lyrics” selection - either “yes” or “no”
{$SONG_ADVISE_IMAGE} if the “explicit lyrics” selection is set to “yes” then this option will be the FULL URL to the advisory.png file which MUST be located in the theme’s images directory.
{$SONG_NAME_FILE_NAME} The Song Name, formatted to link with the {SONG_NAME} Output File Name Variable.
{$SONG_LABEL_FILE_NAME} The Song Label, formatted to link with the {SONG_LABEL} Output File Name Variable.
{$SONG_GENRE_FILE_NAME} The Song Genre, formatted to link with the {SONG_GENRE} Output File Name Variable.
{$SONG_ALBUM_FILE_NAME} The Song Album, formatted to link with the {SONG_ALBUM} Output File Name Variable.

Song Image Variables

Variable Replacement Description
{$SONG_IMAGE} link to show this Songs image via image.php, i.e: http://server/jamroom/image.php?band_id=1&song_id=1&mode=song_image
{$SONG_IMAGE_GD} link for getting song image, and having it resized via Jamroom’s built-in GD functions 1) image.php?band_id=1&mode=song_image&width=xxx&height=xxx)
{$SONG_IMAGE_NAME} the name of the song image file (i.e. image_name1.jpg)
{$SONG_IMAGE_TYPE} the song image mime type (i.e. image/jpeg)
{$SONG_IMAGE_SIZE} size in bytes of the song image
{$SONG_IMAGE_EXTENSION} the song image extension (i.e. jpg)

Song Rating Variables

Variable Replacement Description
{$SONG_RATING_FORM} Creates a URL link to the rating.php form for this song, i.e: rating.php?mode=rate_song&band_id=(band_id)&song_if=(song_id)
{$SONG_RATING_AVG} The average of the song rating values - i.e. “3.24”, or “0” if no rating given yet.
{$SONG_RATING_NUM} The number of ratings this song has received so far.
{$SONG_RATING_1} The number of “1” ratings this song has received.
{$SONG_RATING_2} The number of “2” ratings this song has received.
{$SONG_RATING_3} The number of “3” ratings this song has received.
{$SONG_RATING_4} The number of “4” ratings this song has received.
{$SONG_RATING_5} The number of “5” ratings this song has received.

HIFI Song File Variables

Variable Replacement Description
{$SONG_HIFI_PLAY} URL to play.php to stream the HIFI song, i.e: http://server/jamroom/play.php?band_id=1&song_id=1&mode=song_hifi
{$SONG_HIFI_ALBUM_PLAY} URL to play.php to stream ALL of the HIFI songs from the Album the song belongs to
{$HIFI_BITRATE} the bitrate of the HIFI song file (i.e. 128 KBps)
{$HIFI_DOWNLOAD_COUNT} link to show the count of HIFI downloads, i.e: http://server/jamroom/counter.php?counter=song&band_id=1&song_id=1&mode=hifi_dcount)
{$HIFI_DOWNLOAD_LINK} link to the download.php script for the HIFI song, i.e: http://server/jamroom/download.php?band_id=1&song_id=1&mode=song_hifi
{$HIFI_DOWNLOAD} yes/no if HIFI song is ALLOWED download
{$HIFI_EXTENSION} HIFI song file extension (i.e. mp3)
{$HIFI_FORMATTED_SIZE} HIFI song file size FORMATTED (i.e. 1.26 MB)
{$SONG_HIFI_LENGTH} HIFI song file length in MM:SS (i.e. 01:49)
{$HIFI_NAME} name of the HIFI song file (i.e. song_name1.mp3)
{$HIFI_SAMPLERATE} the sample rate of the HIFI song file (i.e. 44100)
{$SONG_HIFI_SIZE} the size, in bytes, of the hifi song file (i.e. 1320290)
{$HIFI_STREAM_COUNT} the number of STREAM plays for the HIFI song file, i.e: http://server/jamroom/counter.php?counter=song&band_id=1&song_id=1&mode=hifi_scount
{$SONG_HIFI_TYPE} the HIFI song file mime type (i.e. audio/mpeg)
{$XSPF_HIFI_SONG_URL} variable that contains the necessary URL to play this song in the XSPF flash player (part of the Jamroom Power Pack)
{$XSPF_HIFI_PLAYALL_URL} variable that contains the necessary URL to play ALL of the artist’s songs in the XSPF flash player (part of the Jamroom Power Pack)
{$XSPF_HIFI_ALBUM_URL} variable that contains the necessary URL to play the entire album the song belongs to in the XSPF flash player (part of the Jamroom Power Pack)

LOFI Song File Variables

Variable Replacement Description
{$SONG_LOFI_PLAY} URL to play.php to stream the LOFI song, i.e: http://server/jamroom/play.php?band_id=1&song_id=1&mode=song_lofi
{$SONG_LOFI_ALBUM_PLAY} URL to play.php to stream ALL of the LOFI songs from the Album the song belongs to
{$LOFI_BITRATE} the bitrate of the LOFI song file (i.e. 32 KBps)
{$LOFI_DOWNLOAD_COUNT} link to show the count of LOFI downloads, i.e: http://server/jamroom/counter.php?counter=song&band_id=1&song_id=1&mode=lofi_dcount
{$LOFI_DOWNLOAD_LINK} link to the download.php script for the LOFI song file, i.e: http://server/jamroom/download.php?band_id=1&song_id=1&mode=song_lofi
{$LOFI_DOWNLOAD} yes/no if the LOFI song is ALLOWED download
{$LOFI_EXTENSION} the LOFI song file extension (i.e. mp3)
{$LOFI_FORMATTED_SIZE} LOFI song size FORMATTED (i.e. 312.47 KB)
{$SONG_LOFI_LENGTH} LOFI song file length in MM:SS (i.e. 00:29)
{$LOFI_NAME} name of the LOFI song file (i.e. song_name2.mp3)
{$LOFI_SAMPLERATE} the sample rate of the LOFI song file (i.e. 22500)
{$SONG_LOFI_SIZE} the size, in bytes, of the LOFI song file
{$LOFI_STREAM_COUNT} the number of STREAM plays for the LOFI song file, i.e: http://server/jamroom/counter.php?counter=song&band_id=1&song_id=1&mode=lofi_scount
{$SONG_LOFI_TYPE} the LOFI song file mime type (i.e. audio/mpeg)
{$XSPF_LOFI_SONG_URL} variable that contains the necessary URL to play this song in the XSPF flash player (part of the Jamroom Power Pack)
{$XSPF_LOFI_PLAYALL_URL} variable that contains the necessary URL to play ALL of the artist’s songs in the XSPF flash player (part of the Jamroom Power Pack)
{$XSPF_LOFI_ALBUM_URL} variable that contains the necessary URL to play the entire album the song belongs to in the XSPF flash player (part of the Jamroom Power Pack)

Song Comment Variables

Variable Replacement Description
{$SONG_COMMENT_FORM} This variable will produce the URL necessary to lanch the comment.php script.
NOTE: the “template” option must be passed to this variable for it to work correctly - i.e. “{SONG_COMMENT_FORM}&template=add_comment.tpl”
{$SONG_COMMENTS_URL} This variable will produce the URL necessary to view the comments that have been left for the song.
NOTE: the “template” option must be passed to this variable for it to work correctly - i.e. “{SONG_COMMENTS_URL}&template=view_comments.tpl”
{$SONG_COMMENT_COUNT} The number of comments that have been left for the song. Will be set to 0 if no comments have been left.

Song Embedded Audio Player Variables

Variable Replacement Description
{$EMBEDDED_PLAYER} creates an embedded Windows Media Player (when viewed by a windows system), or an embedded Quicktime player (when viewed by a Mac OS system). The player will play the HIFI song if available, or the LOFI if the HIFI is not available. If neither the HIFI or LOFI song is available, then the player is not shown.
{$HIFI_EMBEDDED_PLAYER} the same as {EMBEDDED_PLAYER}, except it pertains to the HIFI song file only.
{$LOFI_EMBEDDED_PLAYER} the same as {EMBEDDED_PLAYER}, except it pertains to the LOFI song file only.

Song Output File Name Variables

Variable Replacement Description
{$SONG_ID} the numeric Jamroom ID of the song (i.e. 5)
{$SONG_NAME} the title of the song
{$SONG_LABEL} text from the Song Label text box
{$SONG_GENRE} song genre
{$SONG_ALBUM} text from Song Album text field
{$SONG_ADVISE} yes/no if the song has explicit lyrics
{$HIFI_TYPE} The song file type (i.e. mp3) for the HIFI song file
{$LOFI_TYPE} The song file type (i.e. mp3) for the LOFI song file
1) Note that this will also allow the image to be “cached” for higher performance on subsequent requests

Profile Variables - Radio Templates page 160 of 171 Profile Variables - Store Templates
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