| Package | feathers.media |
| Class | public class VideoPlayer |
| Inheritance | VideoPlayer BaseTimedMediaPlayer BaseMediaPlayer LayoutGroup FeathersControl starling.display.Sprite |
| 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 | |
| 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 | |
| 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
| 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 | ||
![]() | 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 | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| soundTransform : SoundTransform
Controls properties of the currently playing audio, like volume and
panning. | VideoPlayer | ||
![]() | 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 | |
| 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 | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | VideoPlayer | ||
![]() | 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 | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
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 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 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 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 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 | ||
| 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):voidSee also
| bytesLoaded | property |
bytesLoaded:uint [read-only] The number of bytes loaded for the current media.
public function get bytesLoaded():uintSee also
| bytesTotal | property |
bytesTotal:uint [read-only] The total number of bytes to load for the current media.
public function get bytesTotal():uintSee 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):voidSee 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:BooleanDetermines 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():BooleanSee also
| nativeHeight | property |
nativeHeight:Number [read-only] The original, native height of the loaded video.
public function get nativeHeight():NumberSee also
| nativeWidth | property |
nativeWidth:Number [read-only] The original, native width of the loaded video.
public function get nativeWidth():NumberSee 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):voidSee also
| netStream | property |
netStream:NetStream [read-only]
The flash.net.NetStream object used to play the video.
public function get netStream():NetStreamSee 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):voidSee 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):voidSee also
| soundTransform | property |
soundTransform:SoundTransformControls properties of the currently playing audio, like volume and panning.
public function get soundTransform():SoundTransform public function set soundTransform(value:SoundTransform):voidSee 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():TextureSee 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):voidSee also
| VideoPlayer | () | Constructor |
public function VideoPlayer()Constructor.
| toggleFullScreen | () | method |
public function toggleFullScreen():voidGoes 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.Eventfeathers.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.Eventfeathers.events.MediaPlayerEventType.DIMENSIONS_CHANGEDispatched 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.Eventfeathers.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.Eventfeathers.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.Eventstarling.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.Eventfeathers.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.Eventfeathers.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.Eventfeathers.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.Eventstarling.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.Eventfeathers.events.MediaPlayerEventType.SOUND_TRANSFORM_CHANGEDispatched 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