|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bramosystems.oss.player.youtube.client.PlayerParameters
public class PlayerParameters
Holds the parameters of the YouTube player
Nested Class Summary | |
---|---|
static class |
PlayerParameters.AutoHideMode
An enum of autohide parameters for YouTubePlayer |
Constructor Summary | |
---|---|
PlayerParameters()
|
Method Summary | |
---|---|
PlayerParameters.AutoHideMode |
getAutoHide()
Returns the autohide mode of the player |
String |
getPlayerAPIId()
Gets the player identification value used internally by the YouTube player |
String |
getPrimaryBorderColor()
Deprecated. Will be removed in a future version |
String |
getSecondaryBorderColor()
Deprecated. Will be removed in a future version |
int |
getStartTime()
Gets the time at which the player starts playback |
boolean |
isAutoplay()
Checks if the initial video will autoplay when loaded |
boolean |
isEnhancedGenieMenuEnabled()
Deprecated. Will be removed in a future version |
boolean |
isFullScreenEnabled()
Checks if the fullscreen button is enabled |
boolean |
isHDEnabled()
Deprecated. Will be removed in a future version |
boolean |
isJSApiEnabled()
Checks if the Javascript API is enabled |
boolean |
isKeyboardControlsEnabled()
Checks if keyboard controls are enabled |
boolean |
isLoadRelatedVideos()
Checks if player is set to load related videos |
boolean |
isLoopEnabled()
Checks if player is set to repeat playback |
boolean |
isModestBranding()
Returns the status of the YouTube logo on the control bar |
boolean |
isShowBorder()
Checks if the showing of player's borders is enabled |
boolean |
isShowControls()
Returns the status of the video player controls |
boolean |
isShowSearchBox()
Deprecated. Will be removed in a future version |
boolean |
isShowVideoAnnotations()
Checks if video annotations are shown by default |
boolean |
isShowVideoInformation()
Checks if the display of video information is enabled |
void |
setAutoHide(PlayerParameters.AutoHideMode autoHide)
Sets the autohide mode of the player |
void |
setAutoplay(boolean autoplay)
Sets whether or not the initial video will autoplay when the player loads. |
void |
setEnhancedGenieMenuEnabled(boolean enable)
Deprecated. Will be removed in a future version |
void |
setFullScreenEnabled(boolean enable)
Enables or disables the player's fullscreen button |
void |
setHDEnabled(boolean enable)
Deprecated. Will be removed in a future version |
void |
setJSApiEnabled(boolean enable)
Enables or disables the player's Javascript API |
void |
setKeyboardControlsEnabled(boolean enable)
Enables or disables keyboard controls |
void |
setLoadRelatedVideos(boolean loadRelatedVideos)
Sets whether the player should load related videos once playback of the initial video starts. |
void |
setLoopEnabled(boolean loop)
Sets player to repeat video playback again and again. |
void |
setModestBranding(boolean modestBranding)
Shows or hides the YouTube logo on the control bar |
void |
setPlayerAPIId(String playerAPIId)
Sets the player identification value used internally by the YouTube player. |
void |
setPrimaryBorderColor(String color)
Deprecated. Will be removed in a future version |
void |
setSecondaryBorderColor(String color)
Deprecated. Will be removed in a future version |
void |
setShowControls(boolean showControls)
Shows or hides the video player controls |
void |
setStartTime(int startTime)
Sets the time at which the player begins video playback. |
void |
showBorder(boolean show)
Enables or disables the player's borders |
void |
showSearchBox(boolean show)
Deprecated. Will be removed in a future version |
void |
showVideoAnnotations(boolean show)
Enables or disables showing video annotations by default. |
void |
showVideoInformation(boolean show)
Enables or disables the display of information like the video title and rating before the video starts playing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlayerParameters()
Method Detail |
---|
public boolean isAutoplay()
true
if autoplay is active, false
otherwisepublic void setAutoplay(boolean autoplay)
autoplay
- true
to autoplay, false
otherwisepublic String getPrimaryBorderColor()
public void setPrimaryBorderColor(String color)
color
- an RGB value in hexadecimal formatpublic String getSecondaryBorderColor()
public void setSecondaryBorderColor(String color)
color
- an RGB value in hexadecimal formatpublic boolean isKeyboardControlsEnabled()
true
if enabled, false
otherwisepublic void setKeyboardControlsEnabled(boolean enable)
enable
- true
to enable keyboard controls, false
otherwisepublic boolean isEnhancedGenieMenuEnabled()
true
is genie menu is enabled, false
otherwisesetEnhancedGenieMenuEnabled(boolean)
public void setEnhancedGenieMenuEnabled(boolean enable)
enable
- true
to enable genie menu, false
otherwisepublic boolean isJSApiEnabled()
true
if enabled, false
otherwisepublic void setJSApiEnabled(boolean enable)
enable
- true
to enable the Javascript API, false
otherwisepublic boolean isFullScreenEnabled()
true
if enabled, false
otherwisepublic void setFullScreenEnabled(boolean enable)
enable
- true
to enable the fullscreen, false
otherwisepublic boolean isHDEnabled()
true
if enabled, false
otherwise.public void setHDEnabled(boolean enable)
enable
- true
to enable HD playback, false
otherwisepublic boolean isShowVideoAnnotations()
true
if annotations are shown by default, false
otherwisepublic void showVideoAnnotations(boolean show)
show
- true
to show annotations, false
otherwisepublic boolean isLoadRelatedVideos()
true
if related videos are loaded, false
otherwisepublic void setLoadRelatedVideos(boolean loadRelatedVideos)
loadRelatedVideos
- true
to load related videos, false
otherwisepublic boolean isLoopEnabled()
true
if playback is set to repeat, false
otherwisepublic void setLoopEnabled(boolean loop)
loop
- true
to repeat playback, false
otherwisepublic boolean isShowBorder()
true
if player's borders is set to show, false
otherwisepublic void showBorder(boolean show)
show
- true
to show the player's borders, false
otherwisepublic boolean isShowVideoInformation()
true
if display of video information is enabled, false
otherwisepublic void showVideoInformation(boolean show)
show
- true
if video information should show, false
otherwisepublic boolean isShowSearchBox()
true
if the search box is enabled, false
otherwise.public void showSearchBox(boolean show)
Note that if setLoadRelatedVideos(boolean) is false, then the search box will also be disabled.
show
- true
to show the search box, false
otherwise.public int getStartTime()
public void setStartTime(int startTime)
startTime
- time to begin playback (in seconds)public String getPlayerAPIId()
public void setPlayerAPIId(String playerAPIId)
playerAPIId
- player IDpublic PlayerParameters.AutoHideMode getAutoHide()
autohide
mode of the player
public void setAutoHide(PlayerParameters.AutoHideMode autoHide)
autohide
mode of the player
autoHide
- the autohide modepublic boolean isShowControls()
false
otherwisepublic void setShowControls(boolean showControls)
showControls
- true
to show video player controls and false
otherwisepublic boolean isModestBranding()
false
otherwisepublic void setModestBranding(boolean modestBranding)
modestBranding
- true
to show video player controls and false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |