Package | feathers.media |
Class | public class SoundPlayer |
Inheritance | SoundPlayer BaseTimedMediaPlayer BaseMediaPlayer LayoutGroup FeathersControl starling.display.Sprite |
Implements | IAudioPlayer, IProgressiveMediaPlayer |
Product Version : | Feathers 2.2.0 |
flash.media.Sound
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 sound starts playing immediately when the
soundSource property is set. | SoundPlayer | ||
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. | SoundPlayer | ||
bytesTotal : uint [read-only]
The total number of bytes to load for the current media. | SoundPlayer | ||
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 | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all
SoundPlayer components. | SoundPlayer | ||
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 | ||
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 | ||
isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | ||
isLoaded : Boolean [read-only]
Indicates if the flash.media.Sound object has finished
loading its content. | SoundPlayer | ||
isLoading : Boolean [read-only]
Indicates if the flash.media.Sound object is currently
loading its content. | SoundPlayer | ||
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 | ||
loop : Boolean
Determines if, upon reaching the end of the sound, the playhead
automatically returns to the start of the media and plays again. | SoundPlayer | ||
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 | ||
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 | ||
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 | ||
sound : Sound [read-only]
The flash.media.Sound object that has loaded the
content specified by soundSource. | SoundPlayer | ||
soundChannel : SoundChannel [read-only]
The currently playing flash.media.SoundChannel. | SoundPlayer | ||
soundLoaderContext : SoundLoaderContext
If a custom SoundLoaderContext is provided, it will be
passed to the load() method of the
flash.media.Sound when loading a sound from a URL. | SoundPlayer | ||
soundSource : Object
A URL specified as a String representing a URL, a
flash.net.URLRequest, or a
flash.media.Sound object. | SoundPlayer | ||
soundTransform : SoundTransform
Controls properties of the currently playing audio, like volume and
panning. | SoundPlayer | ||
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 | ||
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 | ||
width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | SoundPlayer | ||
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 | ||
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 after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | |||
Dispatched when the flash.media.Sound object dispatches flash.events.IOErrorEvent.IO_ERROR. | SoundPlayer | |||
Dispatched when a media player's content is fully loaded and it may be played to completion without buffering. | SoundPlayer | |||
Dispatched periodically when a media player's content is loading to indicate the current progress. | SoundPlayer | |||
Dispatched when the MP3 ID3 metadata becomes available on the Sound instance. | SoundPlayer | |||
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 flash.media.Sound object dispatches flash.events.SecurityErrorEvent.SECURITY_ERROR. | SoundPlayer | |||
Dispatched when the media player's sound transform changes. | SoundPlayer | |||
Dispatched when the media player's total playhead time changes. | BaseTimedMediaPlayer |
autoPlay | property |
autoPlay:Boolean
Determines if the sound starts playing immediately when the
soundSource
property is set.
In the following example, automatic playback is disabled:
soundPlayer.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
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all
SoundPlayer
components.
The default value is null
.
See also
isLoaded | property |
isLoaded:Boolean
[read-only]
Indicates if the flash.media.Sound
object has finished
loading its content.
public function get isLoaded():Boolean
See also
isLoading | property |
isLoading:Boolean
[read-only]
Indicates if the flash.media.Sound
object is currently
loading its content.
public function get isLoading():Boolean
loop | property |
loop:Boolean
Determines if, upon reaching the end of the sound, the playhead automatically returns to the start of the media and plays again.
If loop
is true
, the
autoRewind
property will be ignored because looping will
always automatically rewind to the beginning.
In the following example, looping is enabled:
soundPlayer.loop = true;
public function get loop():Boolean
public function set loop(value:Boolean):void
sound | property |
sound:Sound
[read-only]
The flash.media.Sound
object that has loaded the
content specified by soundSource
.
public function get sound():Sound
See also
soundChannel | property |
soundChannel:SoundChannel
[read-only]
The currently playing flash.media.SoundChannel
.
public function get soundChannel():SoundChannel
soundLoaderContext | property |
soundLoaderContext:SoundLoaderContext
If a custom SoundLoaderContext
is provided, it will be
passed to the load()
method of the
flash.media.Sound
when loading a sound from a URL.
This property must be set before the soundSource
property.
In the following example, a custom
SoundLoaderContext
is used:
soundPlayer.soundLoaderContext = new SoundLoaderContext(1000, true);
public function get soundLoaderContext():SoundLoaderContext
public function set soundLoaderContext(value:SoundLoaderContext):void
See also
soundSource | property |
soundSource:Object
A URL specified as a String
representing a URL, a
flash.net.URLRequest
, or a
flash.media.Sound
object. In the case of a
String
or a URLRequest
, a new
flash.media.Sound
object will be created internally and
the content will by loaded automatically.
In the following example, a sound file URL is passed in:
soundPlayer.soundSource = "http://example.com/sound.mp3";
public function get soundSource():Object
public function set soundSource(value:Object):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
SoundPlayer | () | Constructor |
public function SoundPlayer()
Constructor.
ioError | Event |
starling.events.Event
starling.events.Event.IO_ERROR
Dispatched when the flash.media.Sound
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.media.Sound . |
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
loadComplete | Event |
starling.events.Event
feathers.events.MediaPlayerEventType.LOAD_COMPLETE
Dispatched when a media player's content is fully loaded and it may be played to completion without buffering.
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
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.METADATA_RECEIVED
Dispatched when the MP3 ID3 metadata becomes available on the
Sound
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 flash.media.ID3Info
instance returned by the id3 property of the
Sound instance. |
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
securityError | Event |
starling.events.Event
starling.events.Event.SECURITY_ERROR
Dispatched when the flash.media.Sound
object dispatches
flash.events.SecurityErrorEvent.SECURITY_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.SecurityErrorEvent
dispatched by the flash.media.Sound . |
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