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 - Vault Mode Index Jamroom Ranking System - Video Spotlight Mode

Ranking Orders

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

 

Additional Supported Parameters

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

PARAMETER TYPE DEFAULT DESCRIPTION
video_id  number n/a The "video_id" parameter tells Jamroom to only return the specified Video ID(s).   Multiple Video 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 Videos 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 Videos that have a "Video Name" that begins with the given letter will be shown.
min_ratings number n/a The "min_ratings" parameter tells Jamroom to only return Videos that have at least min_ratings number of Video Ratings.
max_ratings number n/a The "max_ratings" parameter tells Jamroom to only return Videos that have less then max_ratings number of Video Ratings.
min_average number n/a The "min_average" parameter tells Jamroom to only return Videos that have at least a min_average Video Rating average.
max_average number n/a The "max_average" parameter tells Jamroom to only return Videos that have less then max_average Video Rating average.
require_image true n/a If the "require_image" parameter is given, then only Videos that have an associated image will be shown.
location string n/a The "location" parameter tells Jamroom to only return Videos for Artists in the given location.
no_explicit_content true n/a If the "no_explicit_content" parameter is given, then only Vidoes that do NOT have the "Explicit Content" setting checked will be shown.
type string n/a If the "type" parameter is given, then only Videos that match the given type (i.e. "flv") will be shown.
vault_only true n/a If the "vault_only" option is set, then only Videos that have an associated Vault Item will be shown.
size true n/a If the "size" option is set, then vidoes that have been created WITHOUT any attached video file will be included in the output.  By default, Jamroom requires that a video file be attached to the video information for it to be shown.

 

Available search_area values

SEARCH_AREA DESCRIPTION
video_name "video_name" will search the "Video Name " field (video_name database column)
video_album "video_album" will search the "Video Album" field (video_album database column).
video_caption "video_caption" will search the "Video Caption" field (video_caption database column).
video_filename "video_filename" will search the "Video Filename" field (video_filename database column).
video_extension "video_extension" will search the Video filename field, and only return Video Files that match the given video_extension - i.e. "wmv" would match all WMV Video Files.
video_license "video_license" will search the "Video License" field (video_license database column).
video_credits "video_credits" will search the "Video Credits" field (video_credits database column).
video_type "video_type" will search the Video Type database column, which stores the Mime Type for the Video File.
video_all_fields video_all_fields will search the video_name, video_album, video_caption, video_filename, video_extension, video_license, video_credits and video_type database columns.
video_???? Any Video 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
{$VIDEO_RANK} The numerical position on the output result set (starting at 1).
{$VIDEO_ID} Jamroom Video ID for the Video
{$VIDEO_NAME} The name of the Video
{$VIDEO_ALBUM} The name of the Album the Video belongs to.
{$VIDEO_CAPTION} The text from the Video Caption form entry.
{$VIDEO_CREATED} The 11 digit epoch time the Video was created.
{$VIDEO_UPDATED} The 11 digit epoch time the Video was last updated.
{$VIDEO_SIZE} The size (in bytes) of the Video File
{$VIDEO_FILENAME} The File Name of the Video File
{$VIDEO_EXTENSION} The Filename Extension of the Video File (i.e. "wmv").
{$VIDEO_BITRATE} The encoding Bit Rate of the Video File
{$VIDEO_RESOLUTION} The resolution in WIDTHxHEIGHT of the Video File
{$VIDEO_LENGTH} The Length of the Video File in MM:SS format
{$VIDEO_CREDITS} The text from the "Video Credits" field.
{$VIDEO_ADVISE} Will be set to "yes" if the Video has been set as having Explicit Content.
{$VIDEO_LICENSE} The text from the "Video License" field.
{$VIDEO_GENRE} The Genre the Video belongs to.
{$VIDEO_IMAGE_URL} The HTML URL to use in an <img> tag to display the Video photo.
{$VIDEO_MIMETYPE} The File Mime Type for the Video File
{$VIDEO_RATING_FORM_URL} The HTML <form> used to provide a Rating Form so users can rate the Video.  This contains the HTML that is used in the "action" part of the Rating form.
{$VIDEO_COMMENT_COUNT} The number of comments/reviews that are associated with the Video.
{$VIDEO_STREAM_COUNT} The number of times the Video has been streamed.
{$VIDEO_DOWNLOAD_COUNT} The number of times the Video has been downloaded.
{$VIDEO_TOTAL_COUNT} The number of times the video has been streamed and downloaded (total plays).
{$VIDEO_IMAGE_NAME} The filename of the associated video image.
{$VIDEO_MIME_TYPE} The Mime Type of the associated video image.
{$VIDEO_IMAGE_SIZE} The size (in bytes) of the associated video image.
{$VIDEO_IMAGE_EXTENSION} The filename extension of the associated video image (i.e. "png").
{$VIDEO_IMAGE_URL} The URL to be used in an <img> tag to produce the Video image.
{$VIDEO_RATING_NUMBER} The number of Ratings the Video has received.
{$VIDEO_RATING_AVERAGE} The average of the Ratings the Video has received.
{$VIDEO_RATING_1} The number of "1" Ratings the Video has received.
{$VIDEO_RATING_2} The number of "2" Ratings the Video has received.
{$VIDEO_RATING_3} The number of "3" Ratings the Video has received.
{$VIDEO_RATING_4} The number of "4" Ratings the Video has received.
{$VIDEO_RATING_5} The number of "5" Ratings the Video has received.
{$VIDEO_RATING_FORM_URL} The URL that can be used in an anchor tag to generate the link to the rating form (template is required).

Jamroom Ranking System - Vault Mode page 76 of 185 Jamroom Ranking System - Video 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