Video Player Options
This page lists all of the TubePress options that apply to the embedded video player.
Global
The options below apply to all video providers (YouTube, Vimeo, Dailymotion, etc.).
Option name |
autoNext |
Description |
Automatically start the next video in a gallery when playback of a video finishes. |
Default value |
false |
Valid values |
true or false |
Example shortcode |
[tubepress autoNext="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('autoNext="true"');
|
Option name |
autoplay |
Description |
Automatically start video playback of any embedded video when the page is loaded. |
Default value |
false |
Valid values |
true or false |
Example shortcode |
[tubepress autoplay="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('autoplay="true"');
|
Option name |
embeddedHeight |
Description |
The height, in pixels, of the embedded video player that TubePress builds. If you are using responsive embeds, this will help dictate the aspect ratio of the video player. |
Default value |
390 |
Valid values |
Any positive integer |
Example shortcode |
[tubepress embeddedHeight="350"]
|
Example in PHP |
<?php TubePressPro::getHTML('embeddedHeight="350"');
|
Option name |
embeddedScrollDuration |
Description |
For playerLocation values that involve a scroll, this value defines the duration, in milliseconds,
of how long the scroll should last. Set to 0 for an instant scroll.
|
Default value |
0 |
Valid values |
Any non-negative integer |
Example shortcode |
[tubepress embeddedScrollDuration="100"]
|
Example in PHP |
<?php TubePressPro::getHTML('embeddedScrollDuration="100"');
|
Option name |
embeddedScrollOffset |
Description |
For playerLocation values that involve a scroll, this value defines the offset, in pixels, from the
top of the video player to where the browser window will scroll. Set to 0 to scroll to the exact top of the video
player. Negative values will scroll to above the player, and positive values will scroll to below the player.
|
Default value |
0 |
Valid values |
Any integer |
Example shortcode |
[tubepress embeddedScrollOffset="30"]
|
Example in PHP |
<?php TubePressPro::getHTML('embeddedScrollOffset="30"');
|
Option name |
embeddedScrollOn |
Description |
For playerLocation values that involve a scroll, this will either enable or disable the
automated scroll behavior.
|
Default value |
true |
Valid values |
true or false |
Example shortcode |
[tubepress embeddedScrollOn="false"]
|
Example in PHP |
<?php TubePressPro::getHTML('embeddedScrollOn="false"');
|
Option name |
embeddedWidth |
Description |
The width, in pixels, of the embedded video player that TubePress builds. If you are using responsive embeds, this will help dictate the aspect ratio of the video player. |
Default value |
640 |
Valid values |
Any positive integer |
Example shortcode |
[tubepress embeddedWidth="600"]
|
Example in PHP |
<?php TubePressPro::getHTML('embeddedWidth="600"');
|
Option name |
lazyPlay |
Description |
If enabled, video playback will auto-start after users clicks a video's thumbnail. |
Default value |
true |
Valid values |
true or false |
Example shortcode |
[tubepress lazyPlay="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('lazyPlay="true"');
|
Option name |
loop |
Description |
If enabled, immediately restart playback of each video after it finishes. |
Default value |
false |
Valid values |
true or false |
Example shortcode |
[tubepress loop="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('loop="true"');
|
Option name |
playerImplementation |
Description |
Defines the "brand" of the embedded video player. |
Default value |
provider_based |
Valid values |
-
provider_based Uses the provider’s player (e.g. the standard YouTube/Vimeo player)
-
embedplus Plays videos with EmbedPlus
-
longtail Plays videos with JW Player 5
|
Example shortcode |
[tubepress playerImplementation="longtail"]
|
Example in PHP |
<?php TubePressPro::getHTML('playerImplementation="longtail"');
|
Option name |
playerLocation |
Description |
Defines the "location" of the embedded video player. This allows you to choose the location and effect of how the embedded videos play. |
Default value |
normal |
Valid values |
-
normal Embedded player is placed inline above the thumbnail array
-
popup Videos play in an HTML popup window
-
youtube User is taken to the video’s home on youtube.com for viewing.
-
vimeo User is taken to the video’s home on vimeo.com for viewing.
-
shadowbox Video plays in a modal window with Shadowbox.js
-
jqmodal Video plays in a modal window with jqModal<
/li>
-
solo Page refreshes, and video player replaces the entire thumbnail gallery
-
static Like normal , but each thumbnail click triggers a page refresh
-
tinybox Video plays in a modal window with TinyBox.
-
fancybox Video plays in a modal window with Fancybox.
|
Example shortcode |
[tubepress playerLocation="popup"]
|
Example in PHP |
<?php TubePressPro::getHTML('playerLocation="popup"');
|
Option name |
responsiveEmbeds |
Description |
Enable or disable the resizing of the video player to best fit its container. |
Default value |
true |
Valid values |
true or false |
Example shortcode |
[tubepress responsiveEmbeds="false"]
|
Example in PHP |
<?php TubePressPro::getHTML('responsiveEmbeds="true"');
|
Option name |
showInfo |
Description |
Show or hide the video's title, description, and other meta information on the embedded video itself before playback begins. |
Default value |
false |
Valid values |
true or false |
Example shortcode |
[tubepress showInfo="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('showInfo="true"');
|
YouTube
The options below apply only to YouTube.
Option name |
autoHide |
Description |
Automatically fade out elements of the video player after a few moments of playback. |
Default value |
fadeOnlyProgressBar |
Valid values |
-
fadeBoth Fade both the progress bar and the video controls
-
fadeNone Always show both the progress bar and the video controls
-
fadeOnlyProgressBar Fade only the progress bar, but continue to show the video controls
|
YouTube docs |
Click here |
Example shortcode |
[tubepress autoHide="fadeNone"]
|
Example in PHP |
<?php TubePressPro::getHTML('autoHide="fadeNone"');
|
Option name |
fullscreen |
Description |
Enable or disable fullscreen playback capability. |
Default value |
true |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress fullscreen="false"]
|
Example in PHP |
<?php TubePressPro::getHTML('fullscreen="false"');
|
Note |
Only applies to YouTube |
Option name |
modestBranding |
Description |
If enabled, hides the YouTube logo from the video controls area. |
Default value |
true |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress modestBranding="false"]
|
Example in PHP |
<?php TubePressPro::getHTML('modestBranding="false"');
|
Note |
Only applies to YouTube |
Option name |
showRelated |
Description |
Toggles display of related videos when playback finishes. |
Default value |
true |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress showRelated="false"]
|
Example in PHP |
<?php TubePressPro::getHTML('showRelated="false"');
|
Note |
Only applies to YouTube |
Option name |
showRelated |
Description |
Show closed captions by default. |
Default value |
false |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress youtubeClosedCaptions="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('youtubeClosedCaptions="true"');
|
Note |
Only applies to YouTube |
Option name |
showRelated |
Description |
Disable all keyboard controls for the video. |
Default value |
false |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress youtubeDisableKeyboardControls="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('youtubeDisableKeyboardControls="true"');
|
Note |
Only applies to YouTube |
Option name |
youtubePlayerTheme |
Description |
The color theme of the video player. |
Default value |
dark |
Valid values |
dark or light
|
YouTube docs |
Click here |
Example shortcode |
[tubepress youtubePlayerTheme="light"]
|
Example in PHP |
<?php TubePressPro::getHTML('youtubePlayerTheme="light"');
|
Option name |
youtubeShowAnnotations |
Description |
Show video annotations by default. |
Default value |
false |
Valid values |
true or false |
YouTube docs |
Click here |
Example shortcode |
[tubepress youtubeShowAnnotations="true"]
|
Example in PHP |
<?php TubePressPro::getHTML('youtubeShowAnnotations="true"');
|
Note |
Only applies to YouTube |
Yes
I found this article helpful
No
I did not find this article helpful
Last Updated Feb 22, 2016 11:39PM PST