Package | feathers.media |
Class | public class BaseTimedMediaPlayer |
Inheritance | BaseTimedMediaPlayer ![]() ![]() ![]() ![]() |
Implements | ITimedMediaPlayer |
Subclasses | SoundPlayer, VideoPlayer |
feathers.media.ITimedMediaPlayer
interface.
Property | Defined By | ||
---|---|---|---|
![]() | 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 | |
![]() | globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all LayoutGroup
components. | LayoutGroup | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 | |
totalTime : Number [read-only]
The maximum position of the playhead, in seconds. | BaseTimedMediaPlayer | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | BaseTimedMediaPlayer | ||
![]() | 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 | ||
togglePlayPause():void
Toggles the media content between playing and paused states. | BaseTimedMediaPlayer | ||
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | ||
![]() | refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current
state. | LayoutGroup | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | refreshViewPortBounds():void
Refreshes the values in the viewPortBounds variable that
is passed to the layout. | LayoutGroup | |
seekMedia(seconds:Number):void
Internal function that seeks the media content to a specific playhead
time, in seconds. | BaseTimedMediaPlayer | ||
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | 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 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 | |||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
Dispatched when the media player's total playhead time changes. | BaseTimedMediaPlayer |
currentTime | property |
currentTime:Number
[read-only] The current position of the playhead, in seconds.
public function get currentTime():Number
See also
isPlaying | property |
isPlaying:Boolean
[read-only] Determines if the media content is currently playing.
public function get isPlaying():Boolean
See also
totalTime | property |
totalTime:Number
[read-only] The maximum position of the playhead, in seconds.
public function get totalTime():Number
See also
BaseTimedMediaPlayer | () | Constructor |
public function BaseTimedMediaPlayer()
Constructor.
pause | () | method |
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 |
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
complete | Event |
starling.events.Event
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:
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. |
currentTimeChange | Event |
starling.events.Event
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:
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
playbackStageChange | Event |
starling.events.Event
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:
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
totalTimeChange | Event |
starling.events.Event
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:
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