Function __global->show_gallery_video_media

Definitions

sources/galleries.php

  • Show a gallery media entry (not an image, something more complex); all these will render under the 'video' type even if they're technically not.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url URLPATH No No required parameter N/A N/A URL to media
$thumb_url URLPATH No No required parameter N/A N/A URL to thumbnail
$width integer No No required parameter N/A N/A Width
$height integer No No required parameter N/A N/A Height
$length integer No No required parameter N/A N/A Length
$submitter MEMBER No No required parameter N/A N/A The entry submitter
$closed_captions_url URLPATH No No required parameter N/A N/A The URL to the closed captions file for this video

Returns

  • Displayed media
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Show a gallery media entry (not an image, something more complex); all these will render under the 'video' type even if they're technically not.
 *
 * @param  URLPATH $url URL to media
 * @param  URLPATH $thumb_url URL to thumbnail
 * @param  integer $width Width
 * @param  integer $height Height
 * @param  integer $length Length
 * @param  MEMBER $submitter The entry submitter
 * @param  URLPATH $closed_captions_url The URL to the closed captions file for this video
 * @return Tempcode Displayed media
 */
function show_gallery_video_media(string $url, string $thumb_url, int $width, int $height, int $length, int $submitter, string $closed_captions_url) : object