Packageqnx.media
Classpublic class VideoDisplay
InheritanceVideoDisplay Inheritance UIComponent Inheritance flash.display.MovieClip

The VideoDisplay class represents the display area of video playback when using the MediaPlayer object.

View the examples

See also

MediaPlayer

Public Properties
 PropertyDefined By
  allowOverlay : Boolean
Gets or sets the options that allow Flash content to appear on top of the video content.
VideoDisplay
  backgroundColor : uint
The background color of the VideoDisplay object.
VideoDisplay
 Inheritedcontainment : String
Gets or sets a property that determines how a component is contained within a parent container.
UIComponent
 Inheritedsize : Number
Gets or sets the size for this component (as a percentage of the container's size, or in pixels).
UIComponent
 InheritedsizeMode : String
Gets or sets the size mode for this component.
UIComponent
 InheritedsizeUnit : String
Gets or sets the unit of measure for the size property.
UIComponent
  videoHeight : uint
[read-only] Returns the height of the video, or 0 if there is no video, no display was set, or the height has not been determined yet.
VideoDisplay
  videoWidth : uint
[read-only] Returns the width of the video, or 0 if there is no video, no display was set, or the width has not been determined yet.
VideoDisplay
Public Methods
 MethodDefined By
  
VideoDisplay(allowOverlay:Boolean = true, groupId:String = null)
Creates a VideoDisplay object.
VideoDisplay
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
drawNow():void
Calls the draw() method.
UIComponent
 Inherited
invalidate(property:String, invalidateNow:Boolean = false):void
Marks the property as invalid and the draw() method is called on the next frame or the next render, whichever comes first.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSize(w:Number, h:Number):void
Sets the width and height of the component.
UIComponent
Protected Methods
 MethodDefined By
 Inherited
callLater(method:Function):void
Calls the specified method on the next frame or the next render, which ever happens first.
UIComponent
 Inherited
createInstance(linkage:Object):DisplayObject
Calling this method will attempt to create a DisplayObject instance based on the value of the linkage parameter.
UIComponent
 Inherited
draw():void
Called every time you set the width and height of the component.
UIComponent
 Inherited
isInvalid(property:String, ... properties):Boolean
Checks to see if the property is invalid and returns true if it is.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
setEnabled(val:Boolean):void
Called when the enabled property changes.
UIComponent
 Inherited
validate(property:String):void
Lets the component know that the specified property has been validated.
UIComponent
Property Detail
allowOverlayproperty
allowOverlay:Boolean

Gets or sets the options that allow Flash content to appear on top of the video content.

If set to true the Flash content placed at the same area of the screen as the video will be visible, if false the Flash content will not be visible.


Implementation
    public function get allowOverlay():Boolean
    public function set allowOverlay(value:Boolean):void
backgroundColorproperty 
backgroundColor:uint

The background color of the VideoDisplay object.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
videoHeightproperty 
videoHeight:uint  [read-only]

Returns the height of the video, or 0 if there is no video, no display was set, or the height has not been determined yet.

The qnx.events.MediaPlayerEvent.INFO_CHANGE event can be used to provide a notification when the height is available.


Implementation
    public function get videoHeight():uint

See also

MediaPlayerEvent
videoWidthproperty 
videoWidth:uint  [read-only]

Returns the width of the video, or 0 if there is no video, no display was set, or the width has not been determined yet.

The qnx.events.MediaPlayerEvent.INFO_CHANGE event can be used to provide a notification when the width is available.


Implementation
    public function get videoWidth():uint

See also

MediaPlayerEvent
Constructor Detail
VideoDisplay()Constructor
public function VideoDisplay(allowOverlay:Boolean = true, groupId:String = null)

Creates a VideoDisplay object.

Parameters
allowOverlay:Boolean (default = true) — A Boolean indicating whether or not overlay is allowed. Overlay indicates whether or not other UI components can be displayed over top of the VideoDisplay instance. true to allow overlay, otherwise false.
 
groupId:String (default = null) — The group ID of the VideoDisplay.

See also

IowWindow
Examples

In the following example, VideoDisplay and MediaPlayer instances are created. The VideoDisplay instance is positioned and added to the stage. It is then associated with the MediaPlayer object using the videoDisplay property: 

            _myVD = new VideoDisplay;
            _myVD.setPosition(1024/2 - 800/2, 600/2 - 480/2);
            _myVD.setSize(800, 480);
            _myVD.backgroundColor = 0x000000;
            addChild(_myVD);
            
            _myPlayer = new MediaPlayer();
            _myPlayer.addEventListener(MediaPlayerEvent.INFO_CHANGE, infoChange);            
            _myPlayer.url = "/accounts/1000/shared/videos/Vancouver City.mp4"            
            _myPlayer.videoDisplay = _myVD;



Copyright 2010 Research In Motion Limited. 295 Phillip Street‚ Waterloo‚ Ontario‚ Canada‚ N2L 3W8. All Rights Reserved.

Mon Apr 18 2011, 03:27 PM -04:00