Packageorg.flowplayer.model
Classpublic class Playlist
InheritancePlaylist Inheritance ClipEventSupport Inheritance ClipEventDispatcher Inheritance org.flowplayer.model.EventDispatcher


Public Properties
 PropertyDefined by
 InheritedchildClips : Array
ClipEventSupport
 Inheritedclips : Array
ClipEventSupport
  commonClip : Clip
[read-only]
Playlist
  current : Clip
Playlist
  currentIndex : Number
[read-only]
Playlist
  currentPreroll : Clip
[read-only]
Playlist
  length : Number
[read-only]
Playlist
  nextClip : Clip
[read-only]
Playlist
  previousClip : Clip
[read-only]
Playlist
Protected Properties
 PropertyDefined by
 InheritedallEvents : Dictionary
ClipEventDispatcher
 InheritedcancellableEvents : Dictionary
ClipEventDispatcher
Public Methods
 MethodDefined by
  
Playlist(commonClip:Clip = null)
Playlist
  
addClip(clip:Clip, pos:int = -1, silent:Boolean = false):void
Adds a new clip into the playlist.
Playlist
 Inherited
dispatch(eventType:ClipEventType, info:Object = null, info2:Object = null, info3:Object = null):void
ClipEventDispatcher
 Inherited
dispatchBeforeEvent(event:AbstractEvent):Boolean
ClipEventDispatcher
 Inherited
dispatchError(error:ClipError, info:Object = null):void
ClipEventDispatcher
 Inherited
dispatchEvent(event:ClipEvent):void
ClipEventDispatcher
  
getClip(index:Number):Clip
Gets the clip with the specified index.
Playlist
  
hasNext(skipPreAndPostRolls:Boolean = true):Boolean
Playlist
  
hasPrevious(skipPreAndPostRolls:Boolean = true):Boolean
Playlist
  
hasType(type:ClipType):Boolean
Does this playlist have a clip with the specified type?
Playlist
  
indexOf(clip:Clip):Number
Playlist
  
next(skipPreAndPostRolls:Boolean = true):Clip
Playlist
 Inherited
onAll(listener:Function, clipFilter:Function = null):void
ClipEventDispatcher
 Inherited
onBeforeAll(listener:Function, clipFilter:Function = null):void
ClipEventDispatcher
 Inherited
onBeforeBegin(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBeforeFinish(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBeforePause(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBeforeResume(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBeforeSeek(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBeforeStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBegin(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBufferEmpty(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBufferFull(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onBufferStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onClipAdd(listener:Function, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onConnect(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onConnectionEvent(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onCuepoint(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onError(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onFinish(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onLastSecond(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onMetaData(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onNetStreamEvent(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onPause(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onPlaylistReplace(listener:Function, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onResume(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onSeek(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onStart(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
Adds a listener for the start event.
ClipEventDispatcher
 Inherited
onStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
 Inherited
onUpdate(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void
ClipEventDispatcher
  
previous(skipPreAndPostRolls:Boolean = true):Clip
Playlist
  
removeChildClip(clip:Clip):void
Removes the specified child clip.
Playlist
 Inherited
removeListener(event:EventType, listener:Function, beforePhase:Boolean = false):void
ClipEventSupport
  
replaceClips(clip:Clip):void
Discards all clips and adds the specified clip to the list.
Playlist
  
replaceClips2(clips:Array):void
Discards all clips and addes the specified clips to the list.
Playlist
  
setInStreamClip(clip:Clip):void
Playlist
  
toIndex(index:Number):Clip
Playlist
  
toString():String
Playlist
 Inherited
typeFilter(type:ClipType):Function
[static]
ClipEventSupport
Property detail
commonClipproperty
commonClip:Clip  [read-only]Implementation
    public function get commonClip():Clip
currentproperty 
current:Clip  [read-write]Implementation
    public function get current():Clip
    public function set current(value:Clip):void
currentIndexproperty 
currentIndex:Number  [read-only]Implementation
    public function get currentIndex():Number
currentPrerollproperty 
currentPreroll:Clip  [read-only]Implementation
    public function get currentPreroll():Clip
lengthproperty 
length:Number  [read-only]Implementation
    public function get length():Number
nextClipproperty 
nextClip:Clip  [read-only]Implementation
    public function get nextClip():Clip
previousClipproperty 
previousClip:Clip  [read-only]Implementation
    public function get previousClip():Clip
Constructor detail
Playlist()constructor
public function Playlist(commonClip:Clip = null)Parameters
commonClip:Clip (default = null)
Method detail
addClip()method
public function addClip(clip:Clip, pos:int = -1, silent:Boolean = false):void

Adds a new clip into the playlist. Insertion of clips does not change the current clip.

Parameters
clip:Clip
 
pos:int (default = -1) — optional insertion point, if not given the clip is added to the end of the list.
 
silent:Boolean (default = false) — if true does not dispatch the CLIP_ADD event

See also

ClipEventType.CLIP_ADD
dispatchPlaylistReplace()method 
flow_internal function dispatchPlaylistReplace(oldClips:Array = null):voidParameters
oldClips:Array (default = null)
getClip()method 
public function getClip(index:Number):Clip

Gets the clip with the specified index.

Parameters
index:Number — of the clip to retrieve, if -1 returns the common clip

Returns
Clip
hasNext()method 
public function hasNext(skipPreAndPostRolls:Boolean = true):BooleanParameters
skipPreAndPostRolls:Boolean (default = true)

Returns
Boolean
hasPrevious()method 
public function hasPrevious(skipPreAndPostRolls:Boolean = true):BooleanParameters
skipPreAndPostRolls:Boolean (default = true)

Returns
Boolean
hasType()method 
public function hasType(type:ClipType):Boolean

Does this playlist have a clip with the specified type?

Parameters
type:ClipType

Returns
Boolean
indexOf()method 
public function indexOf(clip:Clip):NumberParameters
clip:Clip

Returns
Number
next()method 
public function next(skipPreAndPostRolls:Boolean = true):ClipParameters
skipPreAndPostRolls:Boolean (default = true)

Returns
Clip
previous()method 
public function previous(skipPreAndPostRolls:Boolean = true):ClipParameters
skipPreAndPostRolls:Boolean (default = true)

Returns
Clip
removeChildClip()method 
public function removeChildClip(clip:Clip):void

Removes the specified child clip.

Parameters
clip:Clip
replaceClips()method 
public function replaceClips(clip:Clip):void

Discards all clips and adds the specified clip to the list.

Parameters
clip:Clip
replaceClips2()method 
public function replaceClips2(clips:Array):void

Discards all clips and addes the specified clips to the list.

Parameters
clips:Array
setClips()method 
flow_internal override function setClips(clips:Array):voidParameters
clips:Array
setInStreamClip()method 
public function setInStreamClip(clip:Clip):voidParameters
clip:Clip
toIndex()method 
public function toIndex(index:Number):ClipParameters
index:Number

Returns
Clip
toString()method 
public function toString():String

Returns
String