Packagecom.brightcove.api.components
Classpublic class ChromelessVideoPlayer
InheritanceChromelessVideoPlayer Inheritance VideoPlayerModule Inheritance APIModule Inheritance flash.events.EventDispatcher

The ChromelessVideoPlayer UI component in the player.



Public Properties
 PropertyDefined By
 Inheritedmodule : Object
[read-only] Returns the instance of the module that is wrapped by this instance.
APIModule
Public Methods
 MethodDefined By
  
ChromelessVideoPlayer(element:Object)
Constructor.
ChromelessVideoPlayer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
APIModule
 Inherited
cueVideo(id:Object, property:String = id):Boolean
Loads a video in the video window without playing it.
VideoPlayerModule
 Inherited
enableInitialBandwidthDetection(enable:Boolean = true):void
Enables/disables initial bandwidth detection for streaming videos, allowing for faster startup.
VideoPlayerModule
 Inherited
getAlpha():Number
Returns the alpha value of the component.
VideoPlayerModule
 Inherited
Returns the current maximum capacity for the back buffer.
VideoPlayerModule
 Inherited
Returns the amount of seconds of cached video available preceding the current playhead position.
VideoPlayerModule
 Inherited
getBlendMode():String
Returns the blend mode of the component.
VideoPlayerModule
 Inherited
Returns the current maximum capacity for the buffer.
VideoPlayerModule
 Inherited
Returns the number of seconds of cached video available to the player beyond the current playhead position.
VideoPlayerModule
 Inherited
Returns the interface for the layout container of the element.
VideoPlayerModule
 Inherited
Returns whether an ad or video content are playing.
VideoPlayerModule
  
Returns the layout box that holds the controls in the player.
ChromelessVideoPlayer
  
Returns whether the overlay controls are currently visible.
ChromelessVideoPlayer
 Inherited
getCSS():String
Returns the CSS used for this component instance.
VideoPlayerModule
 Inherited
Gets the current bandwidth measurement.
VideoPlayerModule
 Inherited
Returns the height of the available display area for videos.
VideoPlayerModule
 Inherited
Returns the width of the available display area for videos.
VideoPlayerModule
 Inherited
Returns the x-coordinate for the location of the video display area relative to the global origin.
VideoPlayerModule
 Inherited
Returns the y-coordinate for the location of the video display area relative to the global origin.
VideoPlayerModule
 Inherited
Gets the current frame rate for playback.
VideoPlayerModule
 Inherited
Returns the rendition DTO for the rendition of the video currently in the video window.
VideoPlayerModule
 Inherited
Returns the video DTO for the video currently in the video window.
VideoPlayerModule
 Inherited
Returns the height of the actual video content as rendered.
VideoPlayerModule
 Inherited
Returns the width of the actual video content as rendered.
VideoPlayerModule
 Inherited
Returns the default buffer time in seconds that will be set on new stream instances.
VideoPlayerModule
 Inherited
getDefinition():String
Returns the XML definition for the element.
VideoPlayerModule
 Inherited
Returns the pixel height of the video display.
VideoPlayerModule
 Inherited
Returns the pixel width of the video display.
VideoPlayerModule
 Inherited
getEnabled():Boolean
Returns whether component is enabled.
VideoPlayerModule
 Inherited
getHeight():Number
Returns the pixel height of the component.
VideoPlayerModule
 Inherited
getID():String
Returns the ID of the element as set from the markup.
VideoPlayerModule
  
Returns whether the component is included in layout calculations and rendering in parent layout box.
ChromelessVideoPlayer
 Inherited
getIndex():int
Returns the index of this element in its parent's elements array.
VideoPlayerModule
 Inherited
Returns whether initial bandwidth detection for streaming has been enabled.
VideoPlayerModule
 Inherited
getMediaControllerProperty(pProperty:String):Object
Returns a property from the media controller currently being used.
VideoPlayerModule
 Inherited
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array.
VideoPlayerModule
 Inherited
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array.
VideoPlayerModule
 Inherited
getPrivacyMode():Boolean
Gets the current state of privacy mode (which is either set through the embed code or via an API).
VideoPlayerModule
 Inherited
getRotation():Number
Returns the rotation of the component.
VideoPlayerModule
 Inherited
For progressively downloaded video, returns the total number of bytes currently loaded for the video.
VideoPlayerModule
 Inherited
For progressively downloaded video, returns the total number of bytes for the current video.
VideoPlayerModule
 Inherited
getVideoDuration(format:Boolean = false):Object
Returns the time duration of the currently playing video.
VideoPlayerModule
 Inherited
getVideoPosition(format:Boolean = false):Object
Returns the time position of the currently playing video.
VideoPlayerModule
 Inherited
getVisible():Boolean
Returns whether the component is visible.
VideoPlayerModule
 Inherited
getVolume():Number
Returns the current volume in the player.
VideoPlayerModule
 Inherited
getWidth():Number
Returns the pixel width of the component.
VideoPlayerModule
 Inherited
getX(global:Boolean = false):Number
Returns the position of the component on the x axis.
VideoPlayerModule
 Inherited
getY(global:Boolean = false):Number
Returns the position of the component on the y axis.
VideoPlayerModule
 Inherited
goFullScreen(fullScreen:Boolean = true):void
Sets the display mode for the player, fullscreen or default.
VideoPlayerModule
 Inherited
isMuted():Boolean
Returns whether the video player currently is muted.
VideoPlayerModule
 Inherited
isPlayerDefined():Boolean
Returns whether the video player is defined for the player instance.
VideoPlayerModule
 Inherited
isPlaying():Boolean
Returns whether the video currently displayed in the video window is playing.
VideoPlayerModule
 Inherited
loadVideo(id:Object, property:String = id, mode:String = full):Boolean
Plays a video in the video window.
VideoPlayerModule
 Inherited
mediaIsLive():Boolean
Returns whether the current media loaded is live (true) or on demand (false).
VideoPlayerModule
 Inherited
move(x:Number, y:Number, global:Boolean = false):void
Positions the element within the experience.
VideoPlayerModule
 Inherited
mute(mute:Boolean = true):void
Mutes or unmutes the sound in the player.
VideoPlayerModule
 Inherited
overlay():Sprite
Returns an Sprite that overlays the video display area.
VideoPlayerModule
 Inherited
pause(pause:Boolean = true):void
Pauses or resumes playback of the current title in the video window.
VideoPlayerModule
 Inherited
play():void
Starts playback of the current title in the video window.
VideoPlayerModule
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
APIModule
 Inherited
Removes the user message dialog, if present.
VideoPlayerModule
 Inherited
Forces the rendition selection algorithm to run, potentially changing the currently playing rendition.
VideoPlayerModule
 Inherited
seek(time:Number):void
Seeks to a specified time position in the video.
VideoPlayerModule
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
VideoPlayerModule
 Inherited
setBackBufferCapacity(pTime:uint):void
Sets the desired maximum capacity of the back buffer.
VideoPlayerModule
 Inherited
setBitRateRange(min:int, max:Number):Object
Sets the minimum and maximum available renditions.
VideoPlayerModule
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
VideoPlayerModule
 Inherited
setBufferCapacity(pTime:uint):void
Sets the desired maximum capacity of the buffer.
VideoPlayerModule
 Inherited
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
 Inherited
setDefaultBufferTime(time:uint):void
Sets the default buffer time in seconds that will be set on new stream instances.
VideoPlayerModule
 Inherited
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
 Inherited
setPrivacyMode(pMode:Boolean):void
Sets the current state of privacy mode (which is either set through the embed code or via an API).
VideoPlayerModule
 Inherited
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
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
VideoPlayerModule
 Inherited
setSize(width:Number, height:Number):void
Sets the pixel dimensions of the element.
VideoPlayerModule
 Inherited
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
VideoPlayerModule
 Inherited
setVideoFilter(filter:Object):void
Applies a bitmap video filter to the video currently loaded.
VideoPlayerModule
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
VideoPlayerModule
 Inherited
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
 Inherited
showVolumeControls(show:Boolean = true):void
Opens or closes the volume controls over the video screen, depending on the argument passed in.
VideoPlayerModule
 Inherited
stop():void
Stops playback of the current title in the video window, sending its position to the start.
VideoPlayerModule
 Inherited
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
 Inherited
Toggles the volume controls opened and closed.
VideoPlayerModule
Events
 Event Summary Defined By
 InheritedDispatched when media playback first begins.VideoPlayerModule
 InheritedDispatched when a buffering window begins for the current media, pausing playback.VideoPlayerModule
 InheritedDispatched when media finishes a buffering window.VideoPlayerModule
 InheritedDispatched when new media has been loaded or cued in the player.VideoPlayerModule
 InheritedDispatched when the current media completes.VideoPlayerModule
 InheritedDispatched when there is an onEdge event dispatched by the NetStream object.VideoPlayerModule
 InheritedDispatched when there is an error connecting to or playing the current media.VideoPlayerModule
 InheritedDispatched when media's audio is muted or unmuted.VideoPlayerModule
 InheritedDispatched when media begins or resumes playback.VideoPlayerModule
 InheritedDispatched as media is played back.VideoPlayerModule
 InheritedDispatched when the transition to a new rendition is completed.VideoPlayerModule
 InheritedDispatched when a new rendition of the current media is requested.VideoPlayerModule
 InheritedDispatched when media is requested to be sent to a new position.VideoPlayerModule
 InheritedDispatched when media has completed being sent to a new position.VideoPlayerModule
 InheritedDispatched when media is paused or stopped.VideoPlayerModule
 InheritedDispatched when the volume in the player is changed.VideoPlayerModule
Public Constants
 ConstantDefined By
 InheritedCONTENT_TYPE_AD : String = ad
[static]
VideoPlayerModule
 InheritedCONTENT_TYPE_BUMPER : String = bumper
[static]
VideoPlayerModule
 InheritedCONTENT_TYPE_VIDEO : String = video
[static]
VideoPlayerModule
Constructor Detail
ChromelessVideoPlayer()Constructor
public function ChromelessVideoPlayer(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.
Method Detail
getControls()method
public function getControls():LayoutBox

Returns the layout box that holds the controls in the player.

Returns
LayoutBox
getControlsVisible()method 
public function getControlsVisible():Boolean

Returns whether the overlay controls are currently visible.

Returns
Boolean
getIncludeInLayout()method 
public function getIncludeInLayout():Boolean

Returns whether the component is included in layout calculations and rendering in parent layout box.

Returns
Boolean
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.