Packagefeathers.media
Interfacepublic interface IAudioPlayer extends ITimedMediaPlayer, IMediaPlayer, IFeathersEventDispatcher
Implementors SoundPlayer

Product Version : Feathers 2.2.0

An interface for media players that play audio content.



Public Properties
 PropertyDefined By
 InheritedcurrentTime : Number
[read-only] The current position of the playhead, in seconds.
ITimedMediaPlayer
 InheritedisPlaying : Boolean
[read-only] Determines if the media content is currently playing.
ITimedMediaPlayer
  soundTransform : SoundTransform
Controls properties of the currently playing audio, like volume and panning.
IAudioPlayer
 InheritedtotalTime : Number
[read-only] The maximum position of the playhead, in seconds.
ITimedMediaPlayer
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
 Inherited
pause():void
Pauses the media content.
ITimedMediaPlayer
 Inherited
play():void
Plays the media content.
ITimedMediaPlayer
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
 Inherited
seek(seconds:Number):void
Seeks the media content to a specific position, in seconds.
ITimedMediaPlayer
 Inherited
stop():void
Stops the media content and returns the playhead to the beginning.
ITimedMediaPlayer
 Inherited
Toggles the media content between playing and paused states.
ITimedMediaPlayer
Events
 Event Summary Defined By
  Dispatched when the media player's sound transform changes.IAudioPlayer
Property Detail
soundTransformproperty
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

See also

Event Detail
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:

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 sound transform is changed.

See also