Carma list videos
From TMM Wiki
Jump to navigationJump to searchcarma_list_videos
- Purpose: Display a list of video galleries on any template.
- Usage: {carma_list_videos count=20 start=0 section=1}
- Required: none
- Optional: count, start, section, order, tpl, easy_keys, data_only, assign_prefix, assign, display_on_assign, actors, locations, categories, groups
- Default Templates Used: show_videos
- Variables created: $carma_content, $carma_content_count, $params
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| count | Show this many videos | Any whole number greater than zero | 20 (Shows 20 videos) | count=5 |
| start | Don't show the videos lower than this number | Any whole number, zero or greater | 0 (Shows all videos) | start=20 |
| section | Which section the items belong to | A comma-delimited list of section I.D.s or a specific section I.D | None. Uses the current section. | section="123" |
| order | what order to sort the videos in | active, caption | active | order="caption" |
| tpl | Display videos using this template | Any valid template name | list_videos (Display videos using the list_videos template) | tpl="my_template" |
| easy_keys | Use continuous keys instead of keys based on the gallery's I.D. in the $carma_content array. | 1 | None. Does not use continuous keys | easy_keys="1" |
| data_only | Put the videos in an array | 1 | None. Displays videos | data_only=1 |
| assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
| assign | Name of the Smarty variable that stores the output | Any valid Smarty variable name | None. Output is displayed, not stored | assign="my_var" |
| display_on_assign | Display videos even when the assign parameter (above) is used | 1 | None If assign is used, no videos are displayed | display_on_assign=1 |
| actors | Get information about actors | 1 | None. Does not get this information | actors="1" |
| locations | Get information about locations | 1 | None. Does not get this information | locations="1" |
| categories | Get information about categories | 1 | None. Does not get this information | categories="1" |
| groups | Get information about groups | 1 | None. Does not get this information | groups="1" |
| full_metadata | Put the following information in variables: total length, total size, name, clip_count, files, files size, and files length | 1 | None. Does not store full metadata | full_metadata="1" |
full_metadata Variables
By default, the following Smarty variables are created when you enable the full_metadata parameter
- {$entry.type_data.wmv.total_length}
- {$entry.type_data.wmv.total_size}
- {$entry.type_data.wmv.name}
- {$entry.type_data.wmv.clip_count}
- {$entry.type_data.wmv.files} an array of clips
- {$entry.type_data.wmv.files_size} an array of clips sizes
- {$entry.type_data.wmv.files_length}
Description
Displays the count video content sets starting at start for the current or a given (set of) section(s). It uses the show_videos template to display this information.
Examples
Paging
This function has built in paging. You just need to set start to be the start of output and it will go to 'count'. On the next call it has to be start+count and the go backward it would be start-count. Out default list_videos template takes care of the math for you, but you need to add the start value to the function call like this:
{carma_list_videos count=20 section=1 start=$smarty.request.start }
$smarty.request.start will always contain the page's start value.
