Package | feathers.media |
Class | public class VideoPlayer |
Inheritance | VideoPlayer ![]() ![]() ![]() ![]() ![]() |
Implements | IVideoPlayer |
flash.net.NetStream
object.
Beta Component: This is a new component, and its APIs may need some changes between now and the next version of Feathers to account for overlooked requirements or other issues. Upgrading to future versions of Feathers may involve manual changes to your code that uses this component. The Feathers deprecation policy will not go into effect until this component's status is upgraded from beta to stable.
See also
Property | Defined By | ||
---|---|---|---|
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 | |
![]() | backgroundDisabledSkin : DisplayObject
The background to display behind all content when the layout group is
disabled. | LayoutGroup | |
![]() | backgroundSkin : DisplayObject
The default background to display behind all content. | LayoutGroup | |
![]() | clipContent : Boolean
If true, the group will be clipped to its bounds. | LayoutGroup | |
![]() | 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 | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | 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 | |
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 | 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 | |
![]() | layout : ILayout
Controls the way that the group's children are positioned and sized. | LayoutGroup | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | 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 | |
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 | ||
netStream : NetStream [read-only]
The flash.net.NetStream object used to play the video. | VideoPlayer | ||
![]() | nextTabFocus : IFocusDisplayObject | 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 | 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 | ||
![]() | 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 | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | 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
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | stop():void
Stops the media content and returns the playhead to the beginning. | BaseTimedMediaPlayer | |
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 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 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 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):void
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
netStream | property |
netStream:NetStream
[read-only]
The flash.net.NetStream
object used to play the video.
public function get netStream():NetStream
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
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
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
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 | 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
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