View Categories

Shortcode Reference

2 min read

If you want to further modify the way the video player works, you can add the following options inside the KGVID tag. These will override anything you’ve set in the plugin settings

  • id="xxx" video attachment ID (instead of using a URL).
  • videos="x" number of attached videos to display if no URL or id is given.
  • orderby="menu_order/title/post_date/rand/ID" criteria for sorting attached videos if no URL or ID is given.
  • order="ASC/DESC" sort order.
  • poster="http://www.example.com/image.jpg" sets the thumbnail.
  • endofvideooverlay="http://www.example.com/end_image.jpg" sets the image shown when the video ends.
  • width="xxx"
  • height="xxx"
  • align="left/right/center"
  • inline="true/false" allow other content on the same line as the video
  • volume="0.x" pre-sets the volume for unusually loud videos. Value between 0 and 1.
  • muted="true/false" sets the mute button on or off.
  • controls="true/false"
  • loop="true/false"
  • autoplay="true/false"
  • gifmode="true/false" sets the player to autoplay, loop, muted, and disables controls and other overlays.
  • pauseothervideos="true/false" video will pause other videos on the page when it starts playing.
  • start="mm:ss" video will start playing at this timecode.
  • watermark="http://www.example.com/image.png" or "false" to disable.
  • watermark_link_to=home/parent/attachment/download/false"
  • watermark_url="http://www.example.com/" or "false" to disable. If this is set, it will override the watermark_link_to setting.
  • title="Video Title" or "false" to disable.
  • embedcode="html code" changes text displayed in the embed code overlay in order to provide a custom method for embedding a video or “false” to disable.
  • view_count="true/false" turns the view count on or off.
  • caption="Caption"
  • description="Description" Used for metadata only.
  • downloadlink="true/false" generates a link below the video to make it easier for users to save the video file to their computers.
  • right_click="true/false" allow or disable right-clicking on the video player.
  • resize="true/false" allow or disable responsive resizing.
  • auto_res="automatic/highest/lowest" let the plugin select the best resolution for the size of the player.
  • pixel_ratio="true/false" account for high-density (retina) displays when choosing automatic video resolution.
  • schema="true/false" allow or disable Schema.org search engine metadata.

These options will add a subtitle/caption track

  • track_src="https://www.example.com/subtitles.vtt_.txt" URL of the WebVTT file.
  • track_kind=subtitles/captions/chapters
  • track_srclang=xx the track’s two-character language code (en, fr, es, etc)
  • track_label="Track Label" text that will be shown to the user when selecting the track.
  • track_default="true/false" track is enabled by default.

These options will only affect Video.js playback

  • skin="example-css-class" Completely change the look of the video player. Instructions here.
  • nativecontrolsfortouch="true/false disable Video.js styling and show the built-in video controls on mobile devices. This will disable the resolution selection button.

These options are available for video galleries (options work the same as standard WordPress image galleries)

  • gallery_thumb="xxx" width in pixels to display gallery thumbnails.
  • gallery_exclude="15" comma separated video attachment IDs. Excludes the videos from the gallery.
  • gallery_include="65" comma separated video attachment IDs. Includes only these videos in the gallery. Please note that include and exclude cannot be used together.
  • gallery_orderby="menu_order/title/post_date/rand/ID" criteria for sorting the gallery.
  • gallery_order="ASC/DESC" sort order.
  • gallery_id="241" post ID to display a gallery made up of videos associated with a different post.
  • gallery_end="close/next" either close the pop-up or start playing the next video when the current video finishes playing.
  • gallery_per_page="xx" or"false" to disable pagination. Number of video thumbnails to show on each gallery page.
  • gallery_title="true/false" display the title overlay on gallery thumbnails.

For example

[KGVID autohide="false" loop="true" autoplay="true" poster="https://www.kylegilman.net/wp-content/uploads/2020/01/Kyle-Gilman-2020-A-Decade-of-Editing_thumb2.jpg" width="720" height="404"]https://www.kylegilman.net/wp-content/uploads/2020/01/Kyle-Gilman-2020-A-Decade-of-Editing.mp4[/KGVID]

Powered by BetterDocs