{jr_image_rotator}
The {jr_image_rotator} function is used to embed an "image rotator" into a Jamroom Template. This makes use of the Jeroen Image Rotator flash object that is part of the Jamroom Skin Pack. This function requires the Jamroom Skin Pack to be installed, and was first introduced in Jamroom 3.3.8.
Parameters:
| Name |
Type |
Required |
Default |
Description |
| type |
string |
no |
band_image |
The "type" parameter tells Jamroom the "type" of image(s) you want to load into the Image Rotator. Valid "type" parameters are:
- band_image
- song_image
- video_image
- photo_image
- store_image
- vault_image
- event_image
- radio_image
- channel_image
- user_image
Default is "band_image" if no "type" parameter is given.
|
| width |
integer |
no |
320 |
The "width" parameter tells Jamroom how wide to make the Image Rotator. |
| height |
integer |
no |
200 |
The "height" parameter tells Jamroom how tall to make the Image Rotator |
| random |
string |
no |
n/a |
The "random" parameter tells Jamroom to randomize the images. Valid values are "true" and "false".
|
| media_id |
mixed |
no |
n/a |
If you would like to specify the "media_id" to show, you can use the media_id parameter to set the id's. |
| show |
integer |
no |
12 |
The "show" parameter allows you to define how many images will be rotated in the Image Rotator. |
| assign |
string |
no |
n/a |
If the "assign" parameter is given, then the HTML code that is created by the {jr_image_rotator} function will be saved to the name given as "assign" and can be access later in the template as $name, where $name is the string given. |
Examples:
embedded {jr_image_rotator} showing 10 random band_images:
| {jr_image_rotator type="band_image" width="500" height="100" random="true" show="10"} |
embedded {jr_image_rotator} rotating through a set of song_id's in "song_image" mode:
| {jr_image_rotator type="song_image" media_id="5,9,13,21,45,78,99,105,312" width="500" height="125"} |
Note: the {jr_image_rotator} will only return "valid" images - it will not return media items that do not have an associated image - i.e. no "default" images will be shown.
|
