+Show TOC
×Hide TOC

VideoLoadEvent

Kind of class:	public class
Package:	org.casalib.events
Inherits from:	LoadEvent < ProgressEvent
Dispatched by:	VideoLoad
Version:	10/27/08
Author:	Aaron Clinger
Classpath:	org.casalib.events.VideoLoadEvent
File last modified:	Monday, 01 December 2008, 11:16:36

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.events {
    import flash.events.Event;
    import org.casalib.events.LoadEvent;
    import org.casalib.math.Percent;
    
    /**
        An event dispatched from {@link VideoLoad}.
        
        @author Aaron Clinger
        @version 10/27/08
    */
    public class VideoLoadEvent extends LoadEvent {
        public static const BUFFERED:String = 'buffered';
        public static const PROGRESS:String = 'progress';
        protected var _buffer:Percent = new Percent();
        protected var _millisecondsUntilBuffered:int = -1;
        
        
        /**
            Creates a new VideoLoadEvent.
            
            @param type: The type of event.
            @param bubbles: Determines whether the Event object participates in the bubbling stage of the event flow.
            @param cancelable: Determines whether the Event object can be canceled.
        */
        public function VideoLoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) {
            super(type, bubbles, cancelable);
        }
        
        /**
            The time remaining in milliseconds until the video has completely buffered.
            
            @usageNote {@link VideoLoad} will report {@code -1} milliseconds until two seconds of load time has elapsed.
        */
        public function get millisecondsUntilBuffered():int {
            return this._millisecondsUntilBuffered;
        }
        
        public function set millisecondsUntilBuffered(milliseconds:int):void {
            this._millisecondsUntilBuffered = milliseconds;
        }
        
        /**
            The percent the video has buffered.
            
            @usageNote {@link VideoLoad} will report {@code 0} percent until two seconds of load time has elapsed.
        */
        public function get buffer():Percent {
            return this._buffer.clone();
        }
        
        public function set buffer(percent:Percent):void {
            this._buffer = percent.clone();
        }
        
        /**
            @return A string containing all the properties of the event.
        */
        override public function toString():String {
            return formatToString('VideoLoadEvent', 'type', 'bubbles', 'cancelable', 'Bps', 'buffer', 'bytesLoaded', 'bytesTotal', 'millisecondsUntilBuffered', 'progress');
        }
        
        /**
            @return Duplicates an instance of the event.
        */
        override public function clone():Event {
            var e:VideoLoadEvent        = new VideoLoadEvent(this.type, this.bubbles, this.cancelable);
            e.progress                  = this.progress;
            e.Bps                       = this.Bps;
            e.bytesLoaded               = this.bytesLoaded;
            e.bytesTotal                = this.bytesTotal;
            e.millisecondsUntilBuffered = this.millisecondsUntilBuffered;
            e.buffer                    = this.buffer;
            
            return e;
        }
    }
}

An event dispatched from VideoLoad.

Summary

Constructor

VideoLoadEvent (type:String, bubbles:Boolean = false, cancelable:Boolean = false)
- Creates a new VideoLoadEvent.

Constants

BUFFERED : String
PROGRESS : String

Constants inherited from LoadEvent

COMPLETE PROGRESS START STOP

Instance properties

millisecondsUntilBuffered : int
- The time remaining in milliseconds until the video has completely buffered.
buffer : Percent
- The percent the video has buffered.

Instance properties inherited from LoadEvent

_Bps _progress Bps progress

Instance methods

toString : String
clone : Event

Instance methods inherited from LoadEvent

clone toString

Constructor

VideoLoadEvent

public function VideoLoadEvent (

type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a new VideoLoadEvent.

Parameters:

type :

The type of event.

bubbles :

Determines whether the Event object participates in the bubbling stage of the event flow.

cancelable:

Determines whether the Event object can be canceled.

Constants

BUFFERED

public static const BUFFERED:String = 'buffered'

(read)

PROGRESS

public static const PROGRESS:String = 'progress'

(read)

Instance properties

buffer

public buffer:Percent

(read,write)

The percent the video has buffered.

Usage note:

VideoLoad will report 0 percent until two seconds of load time has elapsed.

millisecondsUntilBuffered

public millisecondsUntilBuffered:int

(read,write)

The time remaining in milliseconds until the video has completely buffered.

Usage note:

VideoLoad will report -1 milliseconds until two seconds of load time has elapsed.

Instance methods

clone

override public function clone (

) : Event

Returns:

Duplicates an instance of the event.

Overrides:

LoadEvent.clone

toString

override public function toString (

) : String

Returns:

A string containing all the properties of the event.

Overrides:

LoadEvent.toString