Package | com.brightcove.api.components |
Class | public class ChromelessVideoPlayer |
Inheritance | ChromelessVideoPlayer ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
ChromelessVideoPlayer(element:Object)
Constructor. | ChromelessVideoPlayer | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void [override]
Adds a listener for an event. | APIModule | |
![]() | cueVideo(id:Object, property:String = id):Boolean
Loads a video in the video window without playing it. | VideoPlayerModule | |
![]() | enableInitialBandwidthDetection(enable:Boolean = true):void
Enables/disables initial bandwidth detection for streaming videos, allowing for faster startup. | VideoPlayerModule | |
![]() | getAlpha():Number
Returns the alpha value of the component. | VideoPlayerModule | |
![]() | getBackBufferCapacity():Number
Returns the current maximum capacity for the back buffer. | VideoPlayerModule | |
![]() | getBackBufferLength():Number
Returns the amount of seconds of cached video available preceding the current playhead position. | VideoPlayerModule | |
![]() | getBlendMode():String
Returns the blend mode of the component. | VideoPlayerModule | |
![]() | getBufferCapacity():Number
Returns the current maximum capacity for the buffer. | VideoPlayerModule | |
![]() | getBufferLength():Number
Returns the number of seconds of cached video available to the player beyond the current playhead position. | VideoPlayerModule | |
![]() |
Returns the interface for the layout container of the element. | VideoPlayerModule | |
![]() | getContentTypeDisplayed():String
Returns whether an ad or video content are playing. | VideoPlayerModule | |
Returns the layout box that holds the controls in the player. | ChromelessVideoPlayer | ||
getControlsVisible():Boolean
Returns whether the overlay controls are currently visible. | ChromelessVideoPlayer | ||
![]() | getCSS():String
Returns the CSS used for this component instance. | VideoPlayerModule | |
![]() | getCurrentBandwidth():Number
Gets the current bandwidth measurement. | VideoPlayerModule | |
![]() | getCurrentDisplayHeight():Number
Returns the height of the available display area for videos. | VideoPlayerModule | |
![]() | getCurrentDisplayWidth():Number
Returns the width of the available display area for videos. | VideoPlayerModule | |
![]() | getCurrentDisplayX():Number
Returns the x-coordinate for the location of the video display area
relative to the global origin. | VideoPlayerModule | |
![]() | getCurrentDisplayY():Number
Returns the y-coordinate for the location of the video display area
relative to the global origin. | VideoPlayerModule | |
![]() | getCurrentFrameRate():Number
Gets the current frame rate for playback. | VideoPlayerModule | |
![]() |
Returns the rendition DTO for the rendition of the video currently in the video window. | VideoPlayerModule | |
![]() |
Returns the video DTO for the video currently in the video window. | VideoPlayerModule | |
![]() | getCurrentVideoHeight():Number
Returns the height of the actual video content as rendered. | VideoPlayerModule | |
![]() | getCurrentVideoWidth():Number
Returns the width of the actual video content as rendered. | VideoPlayerModule | |
![]() | getDefaultBufferTime():uint
Returns the default buffer time in seconds that will be set on new stream instances. | VideoPlayerModule | |
![]() | getDefinition():String
Returns the XML definition for the element. | VideoPlayerModule | |
![]() | getDisplayHeight():Number
Returns the pixel height of the video display. | VideoPlayerModule | |
![]() | getDisplayWidth():Number
Returns the pixel width of the video display. | VideoPlayerModule | |
![]() | getEnabled():Boolean
Returns whether component is enabled. | VideoPlayerModule | |
![]() | getHeight():Number
Returns the pixel height of the component. | VideoPlayerModule | |
![]() | getID():String
Returns the ID of the element as set from the markup. | VideoPlayerModule | |
getIncludeInLayout():Boolean
Returns whether the component is included in layout calculations and rendering in parent layout box. | ChromelessVideoPlayer | ||
![]() | getIndex():int
Returns the index of this element in its parent's elements array. | VideoPlayerModule | |
![]() | getInitialBandwidthDetectionEnabled():Boolean
Returns whether initial bandwidth detection for streaming has been enabled. | VideoPlayerModule | |
![]() | getMediaControllerProperty(pProperty:String):Object
Returns a property from the media controller currently being used. | VideoPlayerModule | |
![]() |
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array. | VideoPlayerModule | |
![]() |
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array. | VideoPlayerModule | |
![]() | getPrivacyMode():Boolean
Gets the current state of privacy mode (which is either set through the embed code
or via an API). | VideoPlayerModule | |
![]() | getRotation():Number
Returns the rotation of the component. | VideoPlayerModule | |
![]() | getVideoBytesLoaded():Number
For progressively downloaded video, returns the total number of bytes currently loaded for the video. | VideoPlayerModule | |
![]() | getVideoBytesTotal():Number
For progressively downloaded video, returns the total number of bytes for the current video. | VideoPlayerModule | |
![]() | getVideoDuration(format:Boolean = false):Object
Returns the time duration of the currently playing video. | VideoPlayerModule | |
![]() | getVideoPosition(format:Boolean = false):Object
Returns the time position of the currently playing video. | VideoPlayerModule | |
![]() | getVisible():Boolean
Returns whether the component is visible. | VideoPlayerModule | |
![]() | getVolume():Number
Returns the current volume in the player. | VideoPlayerModule | |
![]() | getWidth():Number
Returns the pixel width of the component. | VideoPlayerModule | |
![]() | getX(global:Boolean = false):Number
Returns the position of the component on the x axis. | VideoPlayerModule | |
![]() | getY(global:Boolean = false):Number
Returns the position of the component on the y axis. | VideoPlayerModule | |
![]() | goFullScreen(fullScreen:Boolean = true):void
Sets the display mode for the player, fullscreen or default. | VideoPlayerModule | |
![]() | isMuted():Boolean
Returns whether the video player currently is muted. | VideoPlayerModule | |
![]() | isPlayerDefined():Boolean
Returns whether the video player is defined for the player instance. | VideoPlayerModule | |
![]() | isPlaying():Boolean
Returns whether the video currently displayed in the video window is playing. | VideoPlayerModule | |
![]() | loadVideo(id:Object, property:String = id, mode:String = full):Boolean
Plays a video in the video window. | VideoPlayerModule | |
![]() | mediaIsLive():Boolean
Returns whether the current media loaded is live (true) or on demand (false). | VideoPlayerModule | |
![]() | move(x:Number, y:Number, global:Boolean = false):void
Positions the element within the experience. | VideoPlayerModule | |
![]() | mute(mute:Boolean = true):void
Mutes or unmutes the sound in the player. | VideoPlayerModule | |
![]() | overlay():Sprite
Returns an Sprite that overlays the video display area. | VideoPlayerModule | |
![]() | pause(pause:Boolean = true):void
Pauses or resumes playback of the current title in the video window. | VideoPlayerModule | |
![]() | play():void
Starts playback of the current title in the video window. | VideoPlayerModule | |
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | APIModule | |
![]() | removeUserMessage():void
Removes the user message dialog, if present. | VideoPlayerModule | |
![]() | requestRenditionChange():void
Forces the rendition selection algorithm to run, potentially changing the currently playing rendition. | VideoPlayerModule | |
![]() | seek(time:Number):void
Seeks to a specified time position in the video. | VideoPlayerModule | |
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | VideoPlayerModule | |
![]() | setBackBufferCapacity(pTime:uint):void
Sets the desired maximum capacity of the back buffer. | VideoPlayerModule | |
![]() | setBitRateRange(min:int, max:Number):Object
Sets the minimum and maximum available renditions. | VideoPlayerModule | |
![]() | setBlendMode(mode:String):void
Sets the blend mode of the component. | VideoPlayerModule | |
![]() | setBufferCapacity(pTime:uint):void
Sets the desired maximum capacity of the buffer. | VideoPlayerModule | |
![]() | setConnectOnLoad(connect:Boolean):void
Sets whether for a streaming video the player should connect to FMS on load in order
to determine user bandwidth or whether the connection should be delayed until playback
is requested by the user. | VideoPlayerModule | |
![]() | setDefaultBufferTime(time:uint):void
Sets the default buffer time in seconds that will be set on new stream instances. | VideoPlayerModule | |
![]() | setEnabled(enable:Boolean):void
Enables/disables component for events. | VideoPlayerModule | |
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box. | ChromelessVideoPlayer | ||
![]() | setPrivacyMode(pMode:Boolean):void
Sets the current state of privacy mode (which is either set through the embed code
or via an API). | VideoPlayerModule | |
![]() | setRenditionSelectionCallback(callback:Function):void
Sets callback for dynamic delivery determination so that developer can set
which renditions play when the player changes size or the video buffer, or
on initial playback. | VideoPlayerModule | |
![]() | setRotation(rotation:Number):void
Sets the rotation of the component. | VideoPlayerModule | |
![]() | setSize(width:Number, height:Number):void
Sets the pixel dimensions of the element. | VideoPlayerModule | |
![]() | setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors. | VideoPlayerModule | |
![]() | setVideoFilter(filter:Object):void
Applies a bitmap video filter to the video currently loaded. | VideoPlayerModule | |
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | VideoPlayerModule | |
![]() | setVolume(volume:Number):void
Sets the volume for video playback in the player. | VideoPlayerModule | |
showControls(show:Boolean = true):void
Shows or hides the overlay controls. | ChromelessVideoPlayer | ||
![]() | showVolumeControls(show:Boolean = true):void
Opens or closes the volume controls over the video screen, depending on the argument passed in. | VideoPlayerModule | |
![]() | stop():void
Stops playback of the current title in the video window, sending its position to the start. | VideoPlayerModule | |
![]() | toggleMenuPage(page:String, media:Object = null):void
Toggles Brightcove menu, opening to specified page with data displayed for the media passed in, or closing menu if page is displayed for the same media. | VideoPlayerModule | |
![]() | toggleVolumeControls():void
Toggles the volume controls opened and closed. | VideoPlayerModule |
ChromelessVideoPlayer | () | Constructor |
public function ChromelessVideoPlayer(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getControls | () | method |
public function getControls():LayoutBox
Returns the layout box that holds the controls in the player.
ReturnsLayoutBox |
getControlsVisible | () | method |
public function getControlsVisible():Boolean
Returns whether the overlay controls are currently visible.
ReturnsBoolean |
getIncludeInLayout | () | method |
public function getIncludeInLayout():Boolean
Returns whether the component is included in layout calculations and rendering in parent layout box.
ReturnsBoolean |
setIncludeInLayout | () | method |
public function setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Parameters
includeInLayout:Boolean — Boolean value determining whether component is included in layout.
|
showControls | () | method |
public function showControls(show:Boolean = true):void
Shows or hides the overlay controls.
Parameters
show:Boolean (default = true ) — Whether to show or hide the overlay controls.
|