Packageorg.alivepdf.images.gif.player
Classpublic class GIFPlayer
InheritanceGIFPlayer Inheritance flash.display.Bitmap



Public Properties
 PropertyDefined By
  autoPlay : Boolean
[read-only] Returns is the autoPlay value
GIFPlayer
  currentFrame : int
[read-only] Returns current frame being played
GIFPlayer
  frames : Array
[read-only] Returns an array of GIFFrame objects
GIFPlayer
  loopCount : int
[read-only] Returns how many times the GIF file is played A loop value of 0 means repeat indefinitiely.
GIFPlayer
  preHeight : Number
GIFPlayer
  preWidth : Number
GIFPlayer
  totalFrames : int
[read-only] Returns GIF's total frames
GIFPlayer
Public Methods
 MethodDefined By
  
GIFPlayer(pAutoPlay:Boolean = true)
GIFPlayer
  
getDelay(pFrame:int):int
Retrieves the delay for a specific frame
GIFPlayer
  
getFrame(pFrame:int):GIFFrame
Retrieves a frame from the GIF file as a BitmapData
GIFPlayer
  
gotoAndPlay(pFrame:int):void
Starts playing the GIF at the frame specified as parameter
GIFPlayer
  
gotoAndStop(pFrame:int):void
Moves the playhead to the specified frame and stops playing
GIFPlayer
  
load(pRequest:URLRequest):void
Load any GIF file
GIFPlayer
  
loadBytes(pBytes:ByteArray):BitmapData
Load any valid GIF ByteArray
GIFPlayer
  
play():void
Start playing
GIFPlayer
  
stop():void
Stop playing
GIFPlayer
Property Detail
autoPlayproperty
autoPlay:Boolean  [read-only]

Returns is the autoPlay value


Implementation
    public function get autoPlay():Boolean
currentFrameproperty 
currentFrame:int  [read-only]

Returns current frame being played


Implementation
    public function get currentFrame():int
framesproperty 
frames:Array  [read-only]

Returns an array of GIFFrame objects


Implementation
    public function get frames():Array
loopCountproperty 
loopCount:int  [read-only]

Returns how many times the GIF file is played A loop value of 0 means repeat indefinitiely.


Implementation
    public function get loopCount():int
preHeightproperty 
public var preHeight:Number

preWidthproperty 
public var preWidth:Number

totalFramesproperty 
totalFrames:int  [read-only]

Returns GIF's total frames


Implementation
    public function get totalFrames():int
Constructor Detail
GIFPlayer()Constructor
public function GIFPlayer(pAutoPlay:Boolean = true)



Parameters
pAutoPlay:Boolean (default = true)
Method Detail
getDelay()method
public function getDelay(pFrame:int):int

Retrieves the delay for a specific frame

Parameters

pFrame:int

Returns
int — int
getFrame()method 
public function getFrame(pFrame:int):GIFFrame

Retrieves a frame from the GIF file as a BitmapData

Parameters

pFrame:int

Returns
GIFFrame — BitmapData object
gotoAndPlay()method 
public function gotoAndPlay(pFrame:int):void

Starts playing the GIF at the frame specified as parameter

Parameters

pFrame:int

gotoAndStop()method 
public function gotoAndStop(pFrame:int):void

Moves the playhead to the specified frame and stops playing

Parameters

pFrame:int

load()method 
public function load(pRequest:URLRequest):void

Load any GIF file

Parameters

pRequest:URLRequest

loadBytes()method 
public function loadBytes(pBytes:ByteArray):BitmapData

Load any valid GIF ByteArray

Parameters

pBytes:ByteArray

Returns
BitmapData — void
play()method 
public function play():void

Start playing

stop()method 
public function stop():void

Stop playing