qnx.fuse.ui.media.VideoDisplay

VideoDisplay

Properties | Methods | Events | Examples


Packageqnx.fuse.ui.media
Classpublic class VideoDisplay
InheritanceVideoDisplay Inheritance UIComponent Inheritance flash.display.MovieClip
Implements IVideoDisplay

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

The VideoDisplay class relies on qnxmedia.swc being included in your project's build configuration.



Class information:
BlackBerry 10 Version:   10.0.0

View the examples

See also

MediaControl



Public Properties

 PropertyDefined By
  allowOverlay : Boolean
Gets or sets wether the video is shown above or below the display list.
VideoDisplay
  backgroundColor : uint
The background color of the VideoDisplay object.
VideoDisplay
 InheritedcontextActions : Vector.<ActionSet>
Gets or Sets a Vector of ActionSet objects.
UIComponent
 InheritedcontextMultiSelectText : String
Gets or Sets a String to be displayed when showing the Multi Select Context Menu.
UIComponent
 InheritedcurrentTheme : String
[read-only] Returns the current theme this component is styled with.
UIComponent
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 Inheritedid : String
The id is a name for the component that can be used in CSS using the # selector.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Gets or sets the layoutData.
UIComponent
 Inheritedlocale : String
Gets or sets the current locale of the component.
UIComponent
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
 InheritedstyleChildren : Boolean
Allows you to style the children of this component with CSS.
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

Protected Properties

 PropertyDefined By
 InheritedaccessibilityImplimentationClass : Class
UIComponent
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
VideoDisplay
 InheritedexplicitLocale : Boolean
Set to true when the locale property has been set externally.
UIComponent
 InheritedinternalID : String
The Component's Id used for styling.
UIComponent
 InheritedlongPressEnabled : Boolean
Specifies whether the UIComponent can detect a long press.
UIComponent

Public Methods

 MethodDefined By
  
VideoDisplay(allowOverlay:Boolean = true, groupId:String = null)
Creates a VideoDisplay object.
VideoDisplay
 Inherited
Cancels a long press from occuring on the component.
UIComponent
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the CSS selector for the object, composing it from its position in the display hierarchy and an optional ID selector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
updateDefaultLocale(updateChildren:Boolean = true):void
Updates the locale property to be the same as the locale of the device.
UIComponent
 Inherited
Lets a component that contains text know that it should update its font formats as the font settings have changed.
UIComponent
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
allowShowContextMenu(target:IEventDispatcher):Boolean
When the user presses on the component this method is called with the object that dispatched the event.
UIComponent
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
Style the component after the style has changed.
UIComponent
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
excemptFromCSSStyling(target:*, property:String = null):void
Exempts a property on an object from being styled by CSS.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
getStyleApplier():Function
A style applier is a method that gets called every time a property from the stylesheet should be applied to the component.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
Is called when a user is no longer long pressing on the component.
UIComponent
 Inherited
Is called when a user long presses on the component.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
Calling this function will refresh the ContextMenu with whatever actions were set by contextActions.
UIComponent
 Inherited
Shows the context menu if there are contextActions associated with the control.
UIComponent
 Inherited
styleState():void
Style the component after state has changed.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent

Events

 Event Summary Defined By
 InheritedDispatched when an action in the Context Menu is selected.UIComponent
 InheritedDispatched when the Context Menu has closed to the DISMISSED state.UIComponent
 InheritedDispatched when the ContextMenu is closing to the DISMISSED state.UIComponent
 InheritedDispatched when the Context Menu has opened to the PEEK or EXPANDED state.UIComponent
 InheritedDispatched when the ContextMenu is opening from the DISMISSED state.UIComponent
 InheritedDispatched when the CrossCut multiselect has been canceled.UIComponent

Property Detail

allowOverlay


allowOverlay:Boolean

Gets or sets wether the video is shown above or below the display list.

If set to true content on the display list that covers the video will be visible, if false the content on the display list will not be visible.


Implementation

public function get allowOverlay():Boolean
public function set allowOverlay(value:Boolean):void

backgroundColor


backgroundColor:uint

The background color of the VideoDisplay object.


Implementation

public function get backgroundColor():uint
public function set backgroundColor(value:uint):void

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is VideoDisplay.


Implementation

protected function get cssID():String

videoHeight


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

videoWidth


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()


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;
     




comments powered by Disqus