scaffold.libs_as.feathers.media.ITimedMediaPlayer.as Maven / Gradle / Ivy
/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.
This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.media
{
/**
* Dispatched when the media player's total playhead time changes.
*
* The properties of the event object have the following values:
*
* Property Value 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.
*
* @see #totalTime
*
* @eventType feathers.events.MediaPlayerEventType.TOTAL_TIME_CHANGE
*/
[Event(name="totalTimeChange",type="starling.events.Event")]
/**
* Dispatched when the media player's current playhead time changes.
*
* The properties of the event object have the following values:
*
* Property Value 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.
*
* @see #currentTime
*
* @eventType feathers.events.MediaPlayerEventType.CURRENT_TIME_CHANGE
*/
[Event(name="currentTimeChange",type="starling.events.Event")]
/**
* 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 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.
*
* @see #isPlaying
*
* @eventType feathers.events.MediaPlayerEventType.PLAYBACK_STATE_CHANGE
*/
[Event(name="playbackStageChange",type="starling.events.Event")]
/**
* Dispatched when the media has played to its end.
*
* The properties of the event object have the following values:
*
* Property Value 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.
*
* @eventType starling.events.Event.COMPLETE
*/
[Event(name="complete",type="starling.events.Event")]
/**
* An interface for media players that play timed content.
*/
public interface ITimedMediaPlayer extends IMediaPlayer
{
/**
* The current position of the playhead, in seconds.
*
* @see #event:currentTimeChange feathers.events.MediaPlayerEventType.CURRENT_TIME_CHANGE
*/
function get currentTime():Number;
/**
* The maximum position of the playhead, in seconds.
*
* @see #event:totalTimeChange feathers.events.MediaPlayerEventType.TOTAL_TIME_CHANGE
*/
function get totalTime():Number;
/**
* Determines if the media content is currently playing.
*
* @see #event:playbackStateChange feathers.events.MediaPlayerEventType.PLAYBACK_STATE_CHANGE
*/
function get isPlaying():Boolean;
/**
* Toggles the media content between playing and paused states.
*
* @see #isPlaying
* @see #play()
* @see #pause()
*/
function togglePlayPause():void;
/**
* Plays the media content.
*
* @see #isPlaying
* @see #pause()
* @see #stop()
*/
function play():void;
/**
* Pauses the media content.
*
* @see #isPlaying
* @see #play()
*/
function pause():void;
/**
* Stops the media content and returns the playhead to the beginning.
*
* @see #isPlaying
* @see #play()
* @see #pause()
*/
function stop():void;
/**
* Seeks the media content to a specific position, in seconds.
*/
function seek(seconds:Number):void;
}
}