feathers.media.SoundPlayer

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		alpha : Number The opacity of the object.	DisplayObject
		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
		base : DisplayObject [read-only] The topmost object in the display tree the object is part of.	DisplayObject
		blendMode : String The blend mode determines how the object is blended with the objects underneath.	DisplayObject
		bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent.	DisplayObject
		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
		filter : FragmentFilter The filter that is attached to the display object.	DisplayObject
		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
		is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.	DisplayObject
		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
		mask : DisplayObject The display object that acts as a mask for the current object.	DisplayObject
		maskInverted : Boolean Indicates if the masked region of this object is set to be inverted.	DisplayObject
		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
		name : String The name of the display object (default: null).	DisplayObject
		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
		numChildren : int [read-only] The number of children of this container.	DisplayObjectContainer
		parent : DisplayObjectContainer [read-only] The display object container that contains this display object.	DisplayObject
		pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0).	DisplayObject
		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
		requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e.	DisplayObject
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		root : DisplayObject [read-only] The root object the display object is connected to (i.e.	DisplayObject
		rotation : Number The rotation of the object in radians.	DisplayObject
		scale : Number Sets both 'scaleX' and 'scaleY' to the same value.	DisplayObject
		scaleX : Number The horizontal scale factor.	DisplayObject
		scaleY : Number The vertical scale factor.	DisplayObject
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		skewX : Number The horizontal skew angle in radians.	DisplayObject
		skewY : Number The vertical skew angle in radians.	DisplayObject
		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
		stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage.	DisplayObject
		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
		touchable : Boolean Indicates if this object (and its children) will receive touch events.	DisplayObject
		touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object.	DisplayObjectContainer
		transformationMatrix : Matrix The transformation matrix of the object relative to its parent.	DisplayObject
		transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent.	DisplayObject
		useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite.	DisplayObject
		visible : Boolean The visibility of the object.	DisplayObject
		width : Number [override] The width of the component, in pixels.	FeathersControl
		x : Number The x coordinate of the object relative to the local coordinates of the parent.	DisplayObject
		y : Number The y coordinate of the object relative to the local coordinates of the parent.	DisplayObject

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		items : Vector.<DisplayObject> The items added to the group.	LayoutGroup
		viewPortBounds : ViewPortBounds The view port bounds result object passed to the layout.	LayoutGroup

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SoundPlayer() Constructor.	SoundPlayer
		addChild(child:DisplayObject):DisplayObject Adds a child to the container.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index.	DisplayObjectContainer
		addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object.	DisplayObject
		alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object.	DisplayObject
		broadcastEvent(event:Event):void Dispatches an event on all children (recursively).	DisplayObjectContainer
		broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively).	DisplayObjectContainer
		contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively).	DisplayObjectContainer
		dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type.	EventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type.	EventDispatcher
		dispose():void [override] Disposes the resources of all children.	DisplayObjectContainer
		drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object.	DisplayObject
		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
		getChildAt(index:int):DisplayObject Returns a child object at a certain index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively).	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found.	DisplayObjectContainer
		getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system to another.	DisplayObject
		globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system.	DisplayObject
		globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system.	DisplayObject
		hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for the given event type.	EventDispatcher
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.	DisplayObjectContainer
		hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask.	DisplayObject
		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
		local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates.	DisplayObject
		localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates.	DisplayObject
		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
		removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container.	DisplayObjectContainer
		removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included).	DisplayObjectContainer
		removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object.	DisplayObject
		removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null.	DisplayObject
		removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it.	DisplayObject
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		render(painter:Painter):void [override] Renders the display object with the help of a painter object.	DisplayObjectContainer
		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
		setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index.	DisplayObjectContainer
		setRequiresRedraw():void Forces the object to be redrawn in the next frame.	DisplayObject
		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
		sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class).	DisplayObjectContainer
		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
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children.	DisplayObjectContainer
		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
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	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
		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
		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
		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
		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

Summary	Defined By
added	Dispatched when an object is added to a parent.	DisplayObject
addedToStage	Dispatched when an object is connected to the stage (directly or indirectly).	DisplayObject
complete	Dispatched when the media completes playback because the current time has reached the total time.	BaseTimedMediaPlayer
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
currentTimeChange	Dispatched when the media player's current playhead time changes.	BaseTimedMediaPlayer
enterFrame	Dispatched once every frame on every object that is connected to the stage.	DisplayObject
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
ioError	Dispatched when the flash.media.Sound object dispatches flash.events.IOErrorEvent.IO_ERROR.	SoundPlayer
keyDown	Dispatched when a key on the keyboard is pressed.	DisplayObject
keyUp	Dispatched when a key on the keyboard is released.	DisplayObject
loadComplete	Dispatched when a media player's content is fully loaded and it may be played to completion without buffering.	SoundPlayer
loadProgress	Dispatched periodically when a media player's content is loading to indicate the current progress.	SoundPlayer
metadataReceived	Dispatched when the MP3 ID3 metadata becomes available on the Sound instance.	SoundPlayer
playbackStateChange	Dispatched when the media player's playback state changes, such as when it begins playing or is paused.	BaseTimedMediaPlayer
removed	Dispatched when an object is removed from its parent.	DisplayObject
removedFromStage	Dispatched when an object is removed from the stage and won't be rendered any longer.	DisplayObject
resize	Dispatched when the width or height of the control changes.	FeathersControl
securityError	Dispatched when the flash.media.Sound object dispatches flash.events.SecurityErrorEvent.SECURITY_ERROR.	SoundPlayer
soundTransformChange	Dispatched when the media player's sound transform changes.	SoundPlayer
totalTimeChange	Dispatched when the media player's total playhead time changes.	BaseTimedMediaPlayer
touch	Dispatched when an object is touched.	DisplayObject

Description	Defined By
backgroundDisabledSkin	Type: starling.display.DisplayObject The background to display behind all content when the layout group is disabled. See also backgroundSkin	LayoutGroup
backgroundSkin	Type: starling.display.DisplayObject The default background to display behind all content. See also backgroundDisabledSkin	LayoutGroup
clipContent	Type: Boolean If true, the group will be clipped to its bounds.	LayoutGroup
focusIndicatorSkin	Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when `showFocus()` is called. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft focusPadding	FeathersControl
focusPadding	Type: Number Quickly sets all focus padding properties to the same value. See also focusPaddingTop focusPaddingRight focusPaddingBottom focusPaddingLeft	FeathersControl
focusPaddingBottom	Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingLeft	Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingRight	Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also focusPadding	FeathersControl
focusPaddingTop	Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also focusPadding	FeathersControl
layout	Type: feathers.layout.ILayout Controls the way that the group's children are positioned and sized.	LayoutGroup

	Constant	Defined By
		ALTERNATE_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
		INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = focus [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = styles [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

	Constant	Defined By
		INVALIDATION_FLAG_CLIPPING : String = clipping [static] Flag to indicate that the clipping has changed.	LayoutGroup

Property Detail

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;

Implementation
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void

See also

soundSource

bytesLoaded

property

bytesLoaded:uint [read-only]

The number of bytes loaded for the current media.

Implementation
public function get bytesLoaded():uint

bytesTotal

property

bytesTotal:uint [read-only]

The total number of bytes to load for the current media.

Implementation
public function get bytesTotal():uint

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all SoundPlayer components.

The default value is null.

isLoaded

property

isLoaded:Boolean [read-only]

Indicates if the flash.media.Sound object has finished loading its content.

Implementation
public function get isLoaded():Boolean

isLoading

property

isLoading:Boolean [read-only]

Indicates if the flash.media.Sound object is currently loading its content.

Implementation
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;

Implementation
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.

Implementation
public function get sound():Sound

See also

soundSource

soundChannel

property

soundChannel:SoundChannel [read-only]

The currently playing flash.media.SoundChannel.

Implementation
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);

Implementation
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";

Implementation
public function get soundSource():Object
public function set soundSource(value:Object):void

soundTransform

property

soundTransform:SoundTransform

Controls properties of the currently playing audio, like volume and panning.

Implementation
public function get soundTransform():SoundTransform
public function set soundTransform(value:SoundTransform):void

Constructor Detail

SoundPlayer

()

Constructor

public function SoundPlayer()

Constructor.

Event Detail

ioError

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

loadComplete

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Dispatched when a media player's content is fully loaded and it may be played to completion without buffering.

See also

isLoaded

loadProgress

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Dispatched periodically when a media player's content is loading to indicate the current progress.

See also

bytesLoaded
bytesTotal

metadataReceived

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Dispatched when the media's metadata becomes available.

See also

flash.media.Sound.id3

securityError

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

soundTransformChange

Event

Event Object Type: starling.events.Event
Event.type property = 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.

Dispatched when a media player's sound transform is changed.

See also

soundTransform

Dimanche Mars 3 2019, 06:15 PM +01:00

Starling and Feathers Extensions AS3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
SoundPlayer	Properties \| Methods \| Events \| Styles \| Constants

Package	feathers.media
Class	public class SoundPlayer
Inheritance	SoundPlayer BaseTimedMediaPlayer BaseMediaPlayer LayoutGroup FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements	IAudioPlayer, IProgressiveMediaPlayer