Packagefeathers.media
Classpublic class BaseTimedMediaPlayer
InheritanceBaseTimedMediaPlayer Inheritance BaseMediaPlayer Inheritance LayoutGroup Inheritance FeathersControl Inheritance starling.display.Sprite
Implements ITimedMediaPlayer
Subclasses SoundPlayer, VideoPlayer

Product Version : Feathers 2.2.0

An abstract superclass for media players that should implement the feathers.media.ITimedMediaPlayer interface.



Public Properties
 PropertyDefined By
 InheritedautoSizeMode : String
Determines how the layout group will set its own size when its dimensions (width and height) aren't set explicitly.
LayoutGroup
  currentTime : Number
[read-only] The current position of the playhead, in seconds.
BaseTimedMediaPlayer
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : 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
 InheritedfocusOwner : 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
 InheritedglobalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all LayoutGroup components.
LayoutGroup
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : 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
 InheritedisInitialized : 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
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : 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
 InheritedpreviousTabFocus : 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
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoolTip : 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
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 Inheriteditems : Vector.<DisplayObject>
The items added to the group.
LayoutGroup
 InheritedviewPortBounds : ViewPortBounds
The view port bounds result object passed to the layout.
LayoutGroup
Public Methods
 MethodDefined By
  
Constructor.
BaseTimedMediaPlayer
 Inherited
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
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
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
 Inherited
Readjusts the layout of the group according to its current content.
LayoutGroup
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
  
seek(seconds:Number):void
Seeks the media content to a specific position, in seconds.
BaseTimedMediaPlayer
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
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
  
Toggles the media content between playing and paused states.
BaseTimedMediaPlayer
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
  
pauseMedia():void
Internal function that pauses the media content.
BaseTimedMediaPlayer
  
playMedia():void
Internal function that starts playing the media content.
BaseTimedMediaPlayer
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Choose the appropriate background skin based on the control's current state.
LayoutGroup
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
Refreshes the values in the viewPortBounds variable that is passed to the layout.
LayoutGroup
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
  
seekMedia(seconds:Number):void
Internal function that seeks the media content to a specific playhead time, in seconds.
BaseTimedMediaPlayer
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
  Dispatched when the media completes playback because the current time has reached the total time.BaseTimedMediaPlayer
 InheritedDispatched after the component has validated for the first time.FeathersControl
  Dispatched when the media player's current playhead time changes.BaseTimedMediaPlayer
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
  Dispatched when the media player's playback state changes, such as when it begins playing or is paused.BaseTimedMediaPlayer
 InheritedDispatched when the width or height of the control changes.FeathersControl
  Dispatched when the media player's total playhead time changes.BaseTimedMediaPlayer
Styles
 StyleDefined By
 Inherited
backgroundDisabledSkin : DisplayObject
The background to display behind all content when the layout group is disabled.
LayoutGroup
 Inherited
backgroundSkin : DisplayObject
The default background to display behind all content.
LayoutGroup
 Inherited
clipContent : Boolean
If true, the group will be clipped to its bounds.
LayoutGroup
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 Inherited
layout : ILayout
Controls the way that the group's children are positioned and sized.
LayoutGroup
Public Constants
 ConstantDefined By
 InheritedALTERNATE_STYLE_NAME_TOOLBAR : String = "feathers-toolbar-layout-group"
[static] An alternate style name to use with LayoutGroup to allow a theme to give it a toolbar style.
LayoutGroup
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = "clipping"
[static] Flag to indicate that the clipping has changed.
LayoutGroup
Property Detail
currentTimeproperty
currentTime:Number  [read-only]

The current position of the playhead, in seconds.


Implementation
    public function get currentTime():Number

See also

isPlayingproperty 
isPlaying:Boolean  [read-only]

Determines if the media content is currently playing.


Implementation
    public function get isPlaying():Boolean

See also

totalTimeproperty 
totalTime:Number  [read-only]

The maximum position of the playhead, in seconds.


Implementation
    public function get totalTime():Number

See also

Constructor Detail
BaseTimedMediaPlayer()Constructor
public function BaseTimedMediaPlayer()

Constructor.

Method Detail
pause()method
public function pause():void

Pauses the media content.

See also

pauseMedia()method 
protected function pauseMedia():void

Internal function that pauses the media content. Subclasses are expected override this function with a custom implementation for their specific type of media content.

play()method 
public function play():void

Plays the media content.

See also

playMedia()method 
protected function playMedia():void

Internal function that starts playing the media content. Subclasses are expected override this function with a custom implementation for their specific type of media content.

seek()method 
public function seek(seconds:Number):void

Seeks the media content to a specific position, in seconds.

Parameters

seconds:Number

seekMedia()method 
protected function seekMedia(seconds:Number):void

Internal function that seeks the media content to a specific playhead time, in seconds. Subclasses are expected override this function with a custom implementation for their specific type of media content.

Parameters

seconds:Number

stop()method 
public function stop():void

Stops the media content and returns the playhead to the beginning.

See also

togglePlayPause()method 
public function togglePlayPause():void

Toggles the media content between playing and paused states.

See also

Event Detail
complete Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.COMPLETE

Dispatched when the media completes playback because the current time has reached the total time.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.

currentTimeChange Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.MediaPlayerEventType.CURRENT_TIME_CHANGE

Dispatched when the media player's current playhead time changes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.

Dispatched when a media player's current playhead time changes.

See also

playbackStateChange Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.MediaPlayerEventType.PLAYBACK_STATE_CHANGE

Dispatched when the media player's playback state changes, such as when it begins playing or is paused.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.

Dispatched when a media player's playback state changes, such as when it begins playing or is paused.

See also

totalTimeChange Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.MediaPlayerEventType.TOTAL_TIME_CHANGE

Dispatched when the media player's total playhead time changes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.

Dispatched when a media player's total playhead time changes.

See also