Packagevegas.media
Classpublic class StageVideoExpert
InheritanceStageVideoExpert Inheritance Object
Implements Lockable

This expert control a StageVideo instance.


Public Properties
 PropertyDefined By
  autoSize : Boolean
Indicates if the StageVideo object is resizing when the stage resize event is invoked.
StageVideoExpert
  colorSpaces : Vector.<String>
[read-only] If the stageVideo reference is not null, indicates the names of available color spaces for this video surface.
StageVideoExpert
  depth : int
The depth level of a StageVideo object relative to other StageVideo objects.
StageVideoExpert
  direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null).
StageVideoExpert
  h : Number
Determinates the virtual height value of this component.
StageVideoExpert
  index : uint
The index of the expert to choose the good StageVideo reference in the stage.stageVideos collection.
StageVideoExpert
  isFull : Boolean
Indicates if the StageVideo use full size (use Stage.stageWidth and Stage.stageHeight to update this viewPort property).
StageVideoExpert
  keepAspectRatio : Boolean
Indicates if the pen keep the aspect ratio.
StageVideoExpert
  maxHeight : Number
This property defined the maximum height of this display.
StageVideoExpert
  maxWidth : Number
Defines the maximum width of this display.
StageVideoExpert
  minHeight : Number
This property defined the mimimun height of this display (This value is >= 0).
StageVideoExpert
  minWidth : Number
This property defined the mimimun width of this display (This value is >= 0).
StageVideoExpert
  pan : Point
The index of the expert to choose the good StageVideo reference in the stage.stageVideos collection.
StageVideoExpert
  renderState : Signaler
This signal emit when the StageVideo object render state of the StageVideo object changes.
StageVideoExpert
  stage : Stage
[read-only] The stage reference of this expert.
StageVideoExpert
  stageVideo : StageVideo
[read-only] The StageVideo reference of the expert.
StageVideoExpert
  videoHeight : int
[read-only] If the stageVideo reference is not null, an integer specifying the height of the video stream, in pixels.
StageVideoExpert
  videoWidth : int
[read-only] If the stageVideo reference is not null, an integer specifying the width of the video stream, in pixels.
StageVideoExpert
  viewPort : Rectangle
The absolute position and size of the video surface in pixels.
StageVideoExpert
  w : Number
Determinates the virtual height value of this component.
StageVideoExpert
  x : Number
Determinates the x coordinate of the video in the stage.
StageVideoExpert
  y : Number
Determinates the y coordinate of the video in the stage.
StageVideoExpert
  zoom : Point
The zoom setting of the video, specified as a Point object.
StageVideoExpert
Public Methods
 MethodDefined By
  
StageVideoExpert(stage:Stage, x:Number = 0, h:Number = 0, width:Number = 0, height:Number = 0, index:uint = 0)
Creates a new StageVideoExpert instance.
StageVideoExpert
  
attachNetStream(netStream:NetStream):void
Specifies a video stream to be displayed within the boundaries of the StageVideo object in the application.
StageVideoExpert
  
isLocked():Boolean
Returns true if the object is locked.
StageVideoExpert
  
lock():void
Locks the object.
StageVideoExpert
  
resetLock():void
Reset the lock security of the display.
StageVideoExpert
  
setSize(width:Number, height:Number):void
Sets the virtual width (w) and height (h) values of the component.
StageVideoExpert
  
unlock():void
Unlocks the display.
StageVideoExpert
Protected Methods
 MethodDefined By
  
setUp():void
Set up the StageVideo reference.
StageVideoExpert
  
tearDown():void
Tear down the StageVideo reference.
StageVideoExpert
  
update(e:Event = null):void
Update the stageVideo object.
StageVideoExpert
Property Detail
autoSizeproperty
autoSize:Boolean

Indicates if the StageVideo object is resizing when the stage resize event is invoked.


Implementation
    public function get autoSize():Boolean
    public function set autoSize(value:Boolean):void
colorSpacesproperty 
colorSpaces:Vector.<String>  [read-only]

If the stageVideo reference is not null, indicates the names of available color spaces for this video surface. Usually this list includes "BT.601" and "BT.709". On some configurations, only "BT.601" is supported which means a video is possibly not rendered in the correct color space.

Note: On AIR for TV devices, a value of "BT.601" indicates software playback, and a value of "BT.709" indicates hardware playback.


Implementation
    public function get colorSpaces():Vector.<String>
depthproperty 
depth:int

The depth level of a StageVideo object relative to other StageVideo objects. StageVideo objects always display behind other objects on the stage. If a platform supports more than one StageVideo object, the depth property indicates a StageVideo object's depth level. The bottom StageVideo object's depth property has the smallest value. If multiple StageVideo objects have the same depth setting, the order they appear in the stage,stageVideos Vector determines their relative depth.


Implementation
    public function get depth():int
    public function set depth(value:int):void
directionproperty 
direction:String

Indicates the direction value of the background when the display is in this "full" mode (default value is null).


Implementation
    public function get direction():String
    public function set direction(value:String):void

See also

graphics.Direction
hproperty 
h:Number

Determinates the virtual height value of this component.


Implementation
    public function get h():Number
    public function set h(value:Number):void
indexproperty 
index:uint

The index of the expert to choose the good StageVideo reference in the stage.stageVideos collection.


Implementation
    public function get index():uint
    public function set index(value:uint):void
isFullproperty 
isFull:Boolean

Indicates if the StageVideo use full size (use Stage.stageWidth and Stage.stageHeight to update this viewPort property).


Implementation
    public function get isFull():Boolean
    public function set isFull(value:Boolean):void
keepAspectRatioproperty 
keepAspectRatio:Boolean

Indicates if the pen keep the aspect ratio.


Implementation
    public function get keepAspectRatio():Boolean
    public function set keepAspectRatio(value:Boolean):void
maxHeightproperty 
maxHeight:Number

This property defined the maximum height of this display.


Implementation
    public function get maxHeight():Number
    public function set maxHeight(value:Number):void
maxWidthproperty 
maxWidth:Number

Defines the maximum width of this display.


Implementation
    public function get maxWidth():Number
    public function set maxWidth(value:Number):void
minHeightproperty 
minHeight:Number

This property defined the mimimun height of this display (This value is >= 0).


Implementation
    public function get minHeight():Number
    public function set minHeight(value:Number):void
minWidthproperty 
minWidth:Number

This property defined the mimimun width of this display (This value is >= 0).


Implementation
    public function get minWidth():Number
    public function set minWidth(value:Number):void
panproperty 
pan:Point

The index of the expert to choose the good StageVideo reference in the stage.stageVideos collection.


Implementation
    public function get pan():Point
    public function set pan(value:Point):void
renderStateproperty 
renderState:Signaler

This signal emit when the StageVideo object render state of the StageVideo object changes.


Implementation
    public function get renderState():Signaler
    public function set renderState(value:Signaler):void
stageproperty 
stage:Stage  [read-only]

The stage reference of this expert.


Implementation
    public function get stage():Stage
stageVideoproperty 
stageVideo:StageVideo  [read-only]

The StageVideo reference of the expert.


Implementation
    public function get stageVideo():StageVideo
videoHeightproperty 
videoHeight:int  [read-only]

If the stageVideo reference is not null, an integer specifying the height of the video stream, in pixels.


Implementation
    public function get videoHeight():int
videoWidthproperty 
videoWidth:int  [read-only]

If the stageVideo reference is not null, an integer specifying the width of the video stream, in pixels.


Implementation
    public function get videoWidth():int
viewPortproperty 
viewPort:Rectangle

The absolute position and size of the video surface in pixels. The position of the video is relative to the upper left corner of the stage. The valid range of the x and y properties of the viewPort Rectangle object are -8192 to 8191. Therefore, you can position the video completely or partially off the stage. You can also make the video larger than the stage if you make the width and height properties of the viewPort property larger than the stage.


Implementation
    public function get viewPort():Rectangle
    public function set viewPort(value:Rectangle):void
wproperty 
w:Number

Determinates the virtual height value of this component.


Implementation
    public function get w():Number
    public function set w(value:Number):void
xproperty 
x:Number

Determinates the x coordinate of the video in the stage. If the expert use the isFull mode the x returns always 0 but keep in memory the real value.


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number

Determinates the y coordinate of the video in the stage. If the expert use the isFull mode the y returns always 0 but keep in memory the real value.


Implementation
    public function get y():Number
    public function set y(value:Number):void
zoomproperty 
zoom:Point

The zoom setting of the video, specified as a Point object. The zoom point is a scale factor. By default, the value of zoom is (1.0, 1.0). This default value displays the entire video in the StageVideo.viewPort rectangle. The valid values of the zoom property range from (1.0, 1.0) to (16.0, 16.0). The x property of the zoom Point object specifies the zoom value for the horizontal pixels, and the y property specifies the zoom value for the vertical pixels.


Implementation
    public function get zoom():Point
    public function set zoom(value:Point):void
Constructor Detail
StageVideoExpert()Constructor
public function StageVideoExpert(stage:Stage, x:Number = 0, h:Number = 0, width:Number = 0, height:Number = 0, index:uint = 0)

Creates a new StageVideoExpert instance.

Parameters
stage:Stage — The stage reference.
 
x:Number (default = 0) — index of the StageVideo in the stage.stageVideos Vectors to find the good StageVideo reference (default 0).
 
h:Number (default = 0)
 
width:Number (default = 0)
 
height:Number (default = 0)
 
index:uint (default = 0)
Method Detail
attachNetStream()method
public function attachNetStream(netStream:NetStream):void

Specifies a video stream to be displayed within the boundaries of the StageVideo object in the application. The video stream is either a video file played with NetStream.play(), or null. A video file can be stored on the local file system or on Flash Media Server. If the value of the netStream argument is null, the video is no longer played in the StageVideo object. Before calling attachNetStream() a second time, call the currently attached NetStream object's close() method. Calling close() releases all the resources, including hardware decoders, involved with playing the video. Then you can call attachNetStream() with either another NetStream object or null.

Parameters

netStream:NetStream

isLocked()method 
public function isLocked():Boolean

Returns true if the object is locked.

Returns
Boolean — true if the object is locked.
lock()method 
public function lock():void

Locks the object.

resetLock()method 
public function resetLock():void

Reset the lock security of the display.

setSize()method 
public function setSize(width:Number, height:Number):void

Sets the virtual width (w) and height (h) values of the component.

Parameters

width:Number
 
height:Number

setUp()method 
protected function setUp():void

Set up the StageVideo reference.

tearDown()method 
protected function tearDown():void

Tear down the StageVideo reference.

unlock()method 
public function unlock():void

Unlocks the display.

update()method 
protected function update(e:Event = null):void

Update the stageVideo object.

Parameters

e:Event (default = null)





Mardi Août 16 2011, 02:33 PM +02:00