| Name |
Type |
Required |
Default |
Description |
| type |
string |
no |
"audio" |
the "type" parameter tells Jamroom what type of output you want - either an "audio" chart or a "video" chart. |
| order |
integer |
no |
"1" |
The "order" parameter tells Jamroom what type of "plays" to consider when creating the chart:
1 - All Plays (streams + downloads)
2 - Streams Only
3 - Downloads Only
(Note: if a genre (or group of genres) is given, then only order "1" is valid - Jamroom will internally force the order to 1 if it receives a genre) |
| header_template |
string |
yes |
"jr_chart_header.tpl" |
Defines the template to use as the HEADER template for the output.
If you do not want to use a header_template, you must specify an empty template name - i.e.
{jr_chart header_template="" ... }
|
| row_template |
string |
yes |
"jr_chart_row.tpl" |
Defines the template to use as the ROW template for the output. |
| footer_template |
string |
yes |
"jr_chart_footer.tpl" |
Defines the template to use as the FOOTER template for the output.
If you do not want to use a footer_template, you must specify an empty template name - i.e.
{jr_chart footer_template="" ... }
|
| topspot_template |
string |
no |
n/a |
If given, the very "top" spot in the rendered chart will use this template instead of the row_template. Note: this option is here for backwards compatibility only - it is recommended to use template logic for rendering different output in your row_template. |
| topten_template |
string |
no |
n/a |
If given, the "top ten" spots in the rendered chart will use this template instead of the row_template. Note: this option is here for backwards compatibility only - it is recommended to use template logic for rendering different output in your row_template. |
| tpl_dir |
string |
no |
"skin" |
directory containing the Jamroom templates - can be "skin" or "theme" |
| theme |
string |
no |
n/a |
if a tpl_dir value of "theme" is given, then the name of the Artist Theme needs to be passed in with the theme parameter |
| skin |
string |
no |
n/a |
The skin parameter tells the function to look in the skins/<skin_name> directory to find the template. If this is not supplied, the function will look in the Active Skin directory. |
| pagebreak |
integer |
no |
system default |
The "pagebreak" parameter defines the number of entries that will be on a single page in the chart. |
| pagenum |
integer |
no |
"1" |
If given, the chart will be output beginning on this page. |
| band_id |
mixed |
no |
n/a |
If a single band_id (or array of band_ids) is is given, then only entries from the given ID's will be returned. |
| genre |
mixed |
no |
n/a |
If a genre (or array of genres) is given, then the resulting Chart will only consist of songs or videos in the specified genre(s). Note that the genres MUST be urlencoded to function properly (use the jr_urlencode variable modifier) |
| show |
integer |
no |
n/a |
limits the number of songs or videos returned to the "show" amount. |
| max_songs |
integer |
no |
n/a |
Only available when creating an audio chart, the "max_songs" parameter defines the maximum number of songs that can appear on the chart by 1 artist. |
| max_videos |
integer |
no |
n/a |
Only available when creating a video chart, the "max_videos" parameter defines the maximum number of videos that can appear on the chart by 1 artist. |
| chart_days |
integer |
no |
"1" |
The "chart_days" parameter tells Jamroom how many days to "chart" plays for. the default of "1" will create a Chart that ranks based on the number of plays in the preceding 24 hours. A "chart_days" of 7 would create a week long chart, etc. |
| month |
integer |
no |
n/a |
If given, the "month" parameter tells Jamroom to build a chart for a specific month. The month must be in numerical format, 2 digits, from 01 to 12. |
| year |
integer |
no |
n/a |
If given, the "year" parameter tells Jamroom to build a chart for a specific year. The year must be 4 digits. |
| start_date |
integer |
no |
n/a |
If given the "start_date" parameter, the chart will BEGIN on the given date, in YYYYMMDD format. |
| end_date |
integer |
no |
n/a |
If given the "end_date" parameter, the chart will END on the given date, in YYYYMMDD format. |
| chart_topspot |
integer |
no |
n/a |
If a "topspot_template" has been defined, the "chart_topspot" number can be used to define the number of "top" spots to render using the topspot_template. |
| chart_topten |
integer |
no |
n/a |
If a "topten_template" has been defined, the "chart_topten" number can be used to define the number of "top" spots to render using the topten_template. |
| showall |
string |
no |
false |
By default, Jamroom will only show songs and videos that have had at least 1 play during the chart_days period. If you set the "showall" parameter to true (i.e. showall="true"), then every song or video will be shown, even those with 0 plays. |
| assign |
string |
no |
n/a |
optional "assign" parameter - if given, the output of the function will be assigned to a template variable of the same name. |
