Package | feathers.media |
Class | public class VideoPlayer |
Inheritance | VideoPlayer ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Implements | IVideoPlayer, IProgressiveMediaPlayer |
Product Version : | Feathers 2.2.0 |
flash.net.NetStream
object.
See also
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
![]() | alpha : Number The opacity of the object. | DisplayObject | |
autoPlay : Boolean
Determines if the video starts playing immediately when the
videoSource property is set. | VideoPlayer | ||
![]() | autoSizeMode : String
Determines how the layout group will set its own size when its
dimensions (width and height) aren't set explicitly. | LayoutGroup | |
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
bytesLoaded : uint [read-only]
The number of bytes loaded for the current media. | VideoPlayer | ||
bytesTotal : uint [read-only]
The total number of bytes to load for the current media. | VideoPlayer | ||
![]() | currentTime : Number [read-only]
The current position of the playhead, in seconds. | BaseTimedMediaPlayer | |
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
fullScreenDisplayState : String
When the video player is displayed full-screen, determines the value
of the native stage's displayState property. | VideoPlayer | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all
VideoPlayer components. | VideoPlayer | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
hideRootWhenFullScreen : Boolean
Determines if the Starling root display object is hidden when the
video player switches to full screen mode. | VideoPlayer | ||
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
isFullScreen : Boolean [read-only]
Indicates if the video player is currently full screen or not. | VideoPlayer | ||
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isPlaying : Boolean [read-only]
Determines if the media content is currently playing. | BaseTimedMediaPlayer | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
nativeHeight : Number [read-only]
The original, native height of the loaded video. | VideoPlayer | ||
nativeWidth : Number [read-only]
The original, native width of the loaded video. | VideoPlayer | ||
netConnectionFactory : Function
Creates the flash.net.NetConnection object used to play
the video, and calls the connect() method. | VideoPlayer | ||
netStream : NetStream [read-only]
The flash.net.NetStream object used to play the video. | VideoPlayer | ||
netStreamFactory : Function
Creates the flash.net.NetStream object used to play
the video. | VideoPlayer | ||
![]() | nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
![]() | nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
normalDisplayState : String
When the video player is displayed normally (in other words, when it
isn't full-screen), determines the value of the native stage's
displayState property. | VideoPlayer | ||
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
soundTransform : SoundTransform
Controls properties of the currently playing audio, like volume and
panning. | VideoPlayer | ||
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
texture : Texture [read-only]
The texture used to display the video. | VideoPlayer | ||
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | totalTime : Number [read-only]
The maximum position of the playhead, in seconds. | BaseTimedMediaPlayer | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
videoSource : String
A string representing the video URL or any other accepted value that
may be passed to the play() function of a
NetStream object. | VideoPlayer | ||
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Constructor. | VideoPlayer | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | pause():void
Pauses the media content. | BaseTimedMediaPlayer | |
![]() | play():void
Plays the media content. | BaseTimedMediaPlayer | |
![]() | readjustLayout():void
Readjusts the layout of the group according to its current content. | LayoutGroup | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
![]() | seek(seconds:Number):void
Seeks the media content to a specific position, in seconds. | BaseTimedMediaPlayer | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | stop():void
Stops the media content and returns the playhead to the beginning. | BaseTimedMediaPlayer | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
toggleFullScreen():void
Goes to full screen or returns to normal display. | VideoPlayer | ||
![]() | togglePlayPause():void
Toggles the media content between playing and paused states. | BaseTimedMediaPlayer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when an object is added to a parent. | DisplayObject | ||
![]() | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
Dispatched when the video texture is no longer valid. | VideoPlayer | |||
![]() | Dispatched when the media completes playback because the current time has reached the total time. | BaseTimedMediaPlayer | ||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched when the media player's current playhead time changes. | BaseTimedMediaPlayer | ||
Dispatched when the original native width or height of the video content is calculated. | VideoPlayer | |||
Dispatched when the media player changes to the full-screen display mode or back to the normal display mode. | VideoPlayer | |||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
Dispatched when the flash.net.NetStream object dispatches flash.events.NetStatusEvent.NET_STATUS with certain error codes. | VideoPlayer | |||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
Dispatched when the flash.net.NetStream object dispatches flash.events.IOErrorEvent.IO_ERROR. | VideoPlayer | |||
![]() | Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
![]() | Dispatched when a key on the keyboard is released. | DisplayObject | ||
Dispatched periodically when a media player's content is loading to indicate the current progress. | VideoPlayer | |||
Dispatched when a cue point is reached with the onCuePoint callback from the NetStream instance. | VideoPlayer | |||
Dispatched when the video metadata becomes available with the onMetaData callback from the NetStream instance. | VideoPlayer | |||
![]() | Dispatched when the media player's playback state changes, such as when it begins playing or is paused. | BaseTimedMediaPlayer | ||
Dispatched when the video texture is ready to be rendered. | VideoPlayer | |||
![]() | Dispatched when an object is removed from its parent. | DisplayObject | ||
![]() | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
Dispatched when the media player's sound transform changes. | VideoPlayer | |||
![]() | Dispatched when the media player's total playhead time changes. | BaseTimedMediaPlayer | ||
![]() | Dispatched when an object is touched. | DisplayObject |
autoPlay | property |
autoPlay:Boolean
Determines if the video starts playing immediately when the
videoSource
property is set.
In the following example, automatic playback is disabled:
videoPlayer.autoPlay = false;
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void
See also
bytesLoaded | property |
bytesLoaded:uint
[read-only] The number of bytes loaded for the current media.
public function get bytesLoaded():uint
See also
bytesTotal | property |
bytesTotal:uint
[read-only] The total number of bytes to load for the current media.
public function get bytesTotal():uint
See also
fullScreenDisplayState | property |
fullScreenDisplayState:String
When the video player is displayed full-screen, determines the value
of the native stage's displayState
property.
Using this property, it is possible to set the native stage's
displayState
property to
StageDisplayState.NORMAL
when the video player is in
full screen mode. The video player will still be displayed as a modal
pop-up that fills the entire Starling stage, in this situation.
In the following example, the display state for full-screen mode is changed:
videoPlayer.fullScreenDisplayState = StageDisplayState.FULL_SCREEN;
The default value is StageDisplayState.FULL_SCREEN_INTERACTIVE
.
public function get fullScreenDisplayState():String
public function set fullScreenDisplayState(value:String):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all
VideoPlayer
components.
The default value is null
.
See also
hideRootWhenFullScreen | property |
hideRootWhenFullScreen:Boolean
Determines if the Starling root display object is hidden when the video player switches to full screen mode. By hiding the root display object, rendering performance is optimized because Starling skips a portion of the display list that is obscured by the video player.
In the following example, the root display object isn't hidden when the video player is displayed in full screen:
videoPlayer.hideRootWhenFullScreen = false;
The default value is true
.
public function get hideRootWhenFullScreen():Boolean
public function set hideRootWhenFullScreen(value:Boolean):void
isFullScreen | property |
isFullScreen:Boolean
[read-only]
Indicates if the video player is currently full screen or not. When
the player is full screen, it will be displayed as a modal pop-up
that fills the entire Starling stage. Depending on the value of
fullScreenDisplayState
, it may also change the value of
the native stage's displayState
property.
public function get isFullScreen():Boolean
See also
nativeHeight | property |
nativeHeight:Number
[read-only] The original, native height of the loaded video.
public function get nativeHeight():Number
See also
nativeWidth | property |
nativeWidth:Number
[read-only] The original, native width of the loaded video.
public function get nativeWidth():Number
See also
netConnectionFactory | property |
netConnectionFactory:Function
Creates the flash.net.NetConnection
object used to play
the video, and calls the connect()
method. By default, a
value of null
is passed to the connect()
method. To pass different parameters, you may use a custom
netConnectionFactory
.
The function is expected to have the following signature:
function():NetConnection
In the following example, a custom factory for the
NetConnection
is passed to the video player:
videoPlayer.netConnectionFactory = function():NetConnection { var connection:NetConnection = new NetConnection(); connection.connect( command ); return connection; };
public function get netConnectionFactory():Function
public function set netConnectionFactory(value:Function):void
See also
netStream | property |
netStream:NetStream
[read-only]
The flash.net.NetStream
object used to play the video.
public function get netStream():NetStream
See also
netStreamFactory | property |
netStreamFactory:Function
Creates the flash.net.NetStream
object used to play
the video.
The function is expected to have the following signature:
function(netConnection:NetConnection):NetStream
In the following example, a custom factory for the
NetStream
is passed to the video player:
videoPlayer.netConnectionFactory = function(netConnection:NetConnection):NetStream { var stream:NetStream = new NetStream(netConnection); //change properties here return stream; };
public function get netStreamFactory():Function
public function set netStreamFactory(value:Function):void
See also
normalDisplayState | property |
normalDisplayState:String
When the video player is displayed normally (in other words, when it
isn't full-screen), determines the value of the native stage's
displayState
property.
Using this property, it is possible to set the native stage's
displayState
property to
StageDisplayState.FULL_SCREEN_INTERACTIVE
or
StageDisplayState.FULL_SCREEN
when the video player
is not in full screen mode. This might be useful for mobile apps that
should always display in full screen, while allowing a video player
to toggle between filling the entire stage and displaying at a
smaller size within its parent's layout.
In the following example, the display state for normal mode is changed:
videoPlayer.fullScreenDisplayState = StageDisplayState.FULL_SCREEN_INTERACTIVE;
The default value is StageDisplayState.NORMAL
.
public function get normalDisplayState():String
public function set normalDisplayState(value:String):void
See also
soundTransform | property |
soundTransform:SoundTransform
Controls properties of the currently playing audio, like volume and panning.
public function get soundTransform():SoundTransform
public function set soundTransform(value:SoundTransform):void
See also
texture | property |
texture:Texture
[read-only]
The texture used to display the video. This texture is not
automatically rendered by the VideoPlayer
component. A
component like an ImageLoader
should be added as a child
of the VideoPlayer
to display the texture when it is
ready.
The texture
property will initially return
null
. Listen for Event.READY
to know when
a valid texture is available to render.
In the following example, a listener is added for
Event.READY
, and the texture is displayed by an
ImageLoader
component:
function videoPlayer_readyHandler( event:Event ):void { var view:ImageLoader = new ImageLoader(); view.source = videoPlayer.texture; videoPlayer.addChildAt(view, 0); } videoPlayer.addEventListener( Event.READY, videoPlayer_readyHandler );
public function get texture():Texture
See also
videoSource | property |
videoSource:String
A string representing the video URL or any other accepted value that
may be passed to the play()
function of a
NetStream
object.
In the following example, a video file URL is passed in:
videoPlayer.videoSource = "http://example.com/video.m4v";
public function get videoSource():String
public function set videoSource(value:String):void
See also
VideoPlayer | () | Constructor |
public function VideoPlayer()
Constructor.
toggleFullScreen | () | method |
public function toggleFullScreen():void
Goes to full screen or returns to normal display.
When the player is full screen, it will be displayed as a modal
pop-up that fills the entire Starling stage. Depending on the value
of fullScreenDisplayState
, it may also change the value
of the native stage's displayState
property.
When the player is displaying normally (in other words, when it is not full screen), it will be displayed in its parent's layout like any other Feathers component.
See also
clear | Event |
starling.events.Event
feathers.events.FeathersEventType.CLEAR
Dispatched when the video texture is no longer valid. Indicates that
the texture
property will return a null
value,
and that that the previous texture has been disposed and should not be
rendered any more.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.CLEAR
event type is a generic
event type for when something is "cleared".
See also
dimensionsChange | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.DIMENSIONS_CHANGE
Dispatched when the original native width or height of the video content is calculated.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
displayStateChange | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.DISPLAY_STATE_CHANGE
Dispatched when the media player changes to the full-screen display mode
or back to the normal display mode. The value of the
isFullScreen
property indicates if the media player is
displayed in full screen mode or normally.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
error | Event |
starling.events.Event
feathers.events.FeathersEventType.ERROR
Dispatched when the flash.net.NetStream
object dispatches
flash.events.NetStatusEvent.NET_STATUS
with certain error
codes.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The code from the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.ERROR
event type is used by
Feathers controls when an error occurs that can be caught and
safely ignored.
ioError | Event |
starling.events.Event
starling.events.Event.IO_ERROR
Dispatched when the flash.net.NetStream
object dispatches
flash.events.IOErrorEvent.IO_ERROR
.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The flash.events.IOErrorEvent
dispatched by the flash.net.NetStream . |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
loadProgress | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.LOAD_PROGRESS
Dispatched periodically when a media player's content is loading to
indicate the current progress. The bytesLoaded
and
bytesTotal
properties may be accessed to determine the
exact number of bytes loaded.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | A numeric value between 0
and 1 that indicates how much of the media has loaded so far. |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
metadataReceived | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.CUE_POINT
Dispatched when a cue point is reached with the onCuePoint
callback from the NetStream
instance.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The cue point object passed with the
onCuePoint callback from the NetStream . |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
metadataReceived | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.METADATA_RECEIVED
Dispatched when the video metadata becomes available with the
onMetaData
callback from the NetStream
instance.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The metadata object passed with the
onMetaData callback from the NetStream . |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
ready | Event |
starling.events.Event
starling.events.Event.READY
Dispatched when the video texture is ready to be rendered. Indicates that
the texture
property will return a
starling.textures.Texture
that may be displayed in an
ImageLoader
or another component.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
soundTransformChange | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.SOUND_TRANSFORM_CHANGE
Dispatched when the media player's sound transform changes.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also