scaffold.libs_as.feathers.media.IProgressiveMediaPlayer.as Maven / Gradle / Ivy

Go to download

/*
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 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 #bytesLoaded
	 * @see #bytesTotal
	 * 
	 * @eventType feathers.events.MediaPlayerEventType.LOAD_PROGRESS
	 */
	[Event(name="loadProgress",type="starling.events.Event")]

	/**
	 * A media player that loads its content progressively.
	 */
	public interface IProgressiveMediaPlayer extends IMediaPlayer
	{
		/**
		 * The number of bytes loaded for the current media.
		 * 
		 * @see #bytesTotal
		 * @see #event:loadProgress feathers.events.MediaPlayerEventType.LOAD_PROGRESS
		 */
		function get bytesLoaded():uint;

		/**
		 * The total number of bytes to load for the current media.
		 * 
		 * @see #bytesLoaded
		 * @see #event:loadProgress feathers.events.MediaPlayerEventType.LOAD_PROGRESS
		 */
		function get bytesTotal():uint;
	}
}

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.