Clip - FlowPlayer 3.2.3 API documentation

	Property	Defined by
		accelerated : Boolean	Clip
		autoBuffering : Boolean	Clip
		autoPlay : Boolean	Clip
		autoPlayNext : Boolean	Clip
		baseUrl : String	Clip
		bufferLength : int	Clip
		completeUrl : String [read-only]	Clip
		configuredProviderName : String [read-only]	Clip
		connectionProvider : String	Clip
		cuepointMultiplier : Number	Clip
		cuepoints : Array [read-only]	Clip
		currentTime : Number	Clip
		customProperties : Object	Clip
		duration : Number	Clip
		durationFromMetadata : Number	Clip
		endLimit : Number	Clip
		extension : String [read-only]	Clip
		fadeInSpeed : int	Clip
		fadeOutSpeed : int	Clip
		hasChildren : Boolean [read-only]	Clip
		height : int	Clip
		image : Boolean Use the previous clip in the playlist as an image for this audio clip? This is only for audio clips.	Clip
		index : int [read-only]	Clip
		isCommon : Boolean [read-only]	Clip
		isFlashVideo : Boolean [read-only]	Clip
		isInStream : Boolean [read-only]	Clip
		isMidroll : Boolean [read-only]	Clip
		isNullClip : Boolean [read-only]	Clip
		isOneShot : Boolean [read-only]	Clip
		isPostroll : Boolean [read-only]	Clip
		isPreroll : Boolean [read-only]	Clip
		linkUrl : String	Clip
		linkWindow : String	Clip
		live : Boolean	Clip
		metaData : Object	Clip
		originalHeight : int	Clip
		originalUrl : String [read-only]	Clip
		originalWidth : int	Clip
		parent : Clip	Clip
		parentUrl : String [read-only]	Clip
		played : Boolean	Clip
		playlist : Array [read-only]	Clip
		position : Number	Clip
		postroll : Clip [read-only]	Clip
		preroll : Clip [read-only]	Clip
		provider : String	Clip
		resolvedUrl : String [read-only]	Clip
		scaling : MediaSize	Clip
		scalingStr : String [read-only]	Clip
		seekableOnBegin : Boolean	Clip
		smoothing : Boolean	Clip
		start : Number	Clip
		startDispatched : Boolean	Clip
		type : ClipType	Clip
		typeStr : String [read-only]	Clip
		url : String	Clip
		urlResolverObjects : Array [write-only]	Clip
		urlResolvers : Array [read-only]	Clip
		width : int	Clip

	Property	Defined by
		allEvents : Dictionary	ClipEventDispatcher
		cancellableEvents : Dictionary	ClipEventDispatcher
		cuepointsInNegative : Array [read-only]	Clip

	Method	Defined by
		Clip()	Clip
		addChild(clip:Clip):void Use Playlist#addClip() to add child clips to the playlist.	Clip
		addCuepoint(cue:Cuepoint):void	Clip
		addCuepoints(cuepoints:Array):void	Clip
		clearResolvedUrls():void Clears all resolved URLs.	Clip
		create(clipObj:Object, url:String, baseUrl:String = null):Clip [static]	Clip
		dispatch(eventType:ClipEventType, info:Object = null, info2:Object = null, info3:Object = null):void	ClipEventDispatcher
		dispatchBeforeEvent(event:AbstractEvent):Boolean	ClipEventDispatcher
		dispatchError(error:ClipError, info:Object = null):void	ClipEventDispatcher
		dispatchEvent(event:ClipEvent):void	ClipEventDispatcher
		dispatchNetStreamEvent(name:String, infoObject:Object):void	Clip
		getContent():DisplayObject	Clip
		getCuepoints(time:int, dur:Number = -1):Array	Clip
		getCustomProperty(property:String):Object	Clip
		getMidroll(time:int):Clip	Clip
		getNetStream():NetStream Gets the NetStream object that is currently associated with this clip, or `null` if none is currently associated.	Clip
		getParentPlaylist():Playlist	Clip
		getPreviousResolvedUrl(resolver:ClipURLResolver):String Gets the url that was resolved using the resolver that's before the specified resolver in the resolver chain.	Clip
		getResolvedUrl(resolver:ClipURLResolver = null):String Gets the url that was resolved using the specified resolver.	Clip
		onAll(listener:Function, clipFilter:Function = null):void	ClipEventDispatcher
		onBeforeAll(listener:Function, clipFilter:Function = null):void	ClipEventDispatcher
		onBeforeBegin(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBeforeClipEvent(event:ClipEvent):void	Clip
		onBeforeFinish(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBeforePause(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBeforeResume(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBeforeSeek(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBeforeStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBegin(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBufferEmpty(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBufferFull(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onBufferStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onClipAdd(listener:Function, addToFront:Boolean = false):void	ClipEventDispatcher
		onClipEvent(event:ClipEvent):void	Clip
		onConnect(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onConnectionEvent(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onCuepoint(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onError(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onFinish(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onLastSecond(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onMetaData(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onNetStreamEvent(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onPause(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onPlaylistReplace(listener:Function, addToFront:Boolean = false):void	ClipEventDispatcher
		onResume(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onSeek(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onStart(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void Adds a listener for the start event.	ClipEventDispatcher
		onStop(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		onUpdate(listener:Function, clipFilter:Function = null, addToFront:Boolean = false):void	ClipEventDispatcher
		removeChild(child:Clip):void	Clip
		removeCuepoints(filter:Function = null):void Removes cuepoints from this clip	Clip
		setContent(content:DisplayObject):void	Clip
		setCustomProperty(property:String, value:Object):void	Clip
		setEventListeners(playlist:Playlist):void	Clip
		setNetStream(value:NetStream):void	Clip
		setParentPlaylist(playlist:Playlist):void	Clip
		setResolvedUrl(resolver:ClipURLResolver, val:String):void Sets the resolved url-	Clip
		setScaling(scaling:String):void	Clip
		setType(type:String):void	Clip
		setUrlResolvers(val:Object):void	Clip
		toString():String	Clip
		unbindEventListeners():void	Clip

Property detail

accelerated

property

accelerated:Boolean  [read-write]Implementation
    public function get accelerated():Boolean
    public function set accelerated(value:Boolean):void

autoBuffering

property

autoBuffering:Boolean  [read-write]Implementation
    public function get autoBuffering():Boolean
    public function set autoBuffering(value:Boolean):void

autoPlay

property

autoPlay:Boolean  [read-write]Implementation
    public function get autoPlay():Boolean
    public function set autoPlay(value:Boolean):void

autoPlayNext

property

autoPlayNext:Boolean  [read-write]Implementation
    public function get autoPlayNext():Boolean
    public function set autoPlayNext(value:Boolean):void

baseUrl

property

baseUrl:String  [read-write]Implementation
    public function get baseUrl():String
    public function set baseUrl(value:String):void

bufferLength

property

bufferLength:int  [read-write]Implementation
    public function get bufferLength():int
    public function set bufferLength(value:int):void

clipObject

property

clipObject:Object [read-only]Implementation
flow_internal function get clipObject():Object

completeUrl

property

completeUrl:String [read-only]Implementation
public function get completeUrl():String

configuredProviderName

property

configuredProviderName:String [read-only]Implementation
public function get configuredProviderName():String

connectionProvider

property

connectionProvider:String  [read-write]Implementation
    public function get connectionProvider():String
    public function set connectionProvider(value:String):void

cuepointMultiplier

property

cuepointMultiplier:Number  [read-write]Implementation
    public function get cuepointMultiplier():Number
    public function set cuepointMultiplier(value:Number):void

cuepoints

property

cuepoints:Array [read-only]Implementation
public function get cuepoints():Array

cuepointsInNegative

property

cuepointsInNegative:Array [read-only]Implementation
protected function get cuepointsInNegative():Array

currentTime

property

currentTime:Number  [read-write]Implementation
    public function get currentTime():Number
    public function set currentTime(value:Number):void

customProperties

property

customProperties:Object  [read-write]Implementation
    public function get customProperties():Object
    public function set customProperties(value:Object):void

duration

property

duration:Number  [read-write]Implementation
    public function get duration():Number
    public function set duration(value:Number):void

durationFromMetadata

property

durationFromMetadata:Number  [read-write]Implementation
    public function get durationFromMetadata():Number
    public function set durationFromMetadata(value:Number):void

endLimit

property

endLimit:Number  [read-write]Implementation
    public function get endLimit():Number
    public function set endLimit(value:Number):void

extension

property

extension:String [read-only]Implementation
public function get extension():String

fadeInSpeed

property

fadeInSpeed:int  [read-write]Implementation
    public function get fadeInSpeed():int
    public function set fadeInSpeed(value:int):void

fadeOutSpeed

property

fadeOutSpeed:int  [read-write]Implementation
    public function get fadeOutSpeed():int
    public function set fadeOutSpeed(value:int):void

hasChildren

property

hasChildren:Boolean [read-only]Implementation
public function get hasChildren():Boolean

height

property

height:int  [read-write]Implementation
    public function get height():int
    public function set height(value:int):void

image

property

image:Boolean [read-write]

Use the previous clip in the playlist as an image for this audio clip? This is only for audio clips.

Implementation
public function get image():Boolean
public function set image(value:Boolean):void

index

property

index:int [read-only]Implementation
public function get index():int

isCommon

property

isCommon:Boolean [read-only]Implementation
public function get isCommon():Boolean

isFlashVideo

property

isFlashVideo:Boolean [read-only]Implementation
public function get isFlashVideo():Boolean

isInStream

property

isInStream:Boolean [read-only]Implementation
public function get isInStream():Boolean

isMidroll

property

isMidroll:Boolean [read-only]Implementation
public function get isMidroll():Boolean

isNullClip

property

isNullClip:Boolean [read-only]Implementation
public function get isNullClip():Boolean

isOneShot

property

isOneShot:Boolean [read-only]Implementation
public function get isOneShot():Boolean

isPostroll

property

isPostroll:Boolean [read-only]Implementation
public function get isPostroll():Boolean

isPreroll

property

isPreroll:Boolean [read-only]Implementation
public function get isPreroll():Boolean

linkUrl

property

linkUrl:String  [read-write]Implementation
    public function get linkUrl():String
    public function set linkUrl(value:String):void

linkWindow

property

linkWindow:String  [read-write]Implementation
    public function get linkWindow():String
    public function set linkWindow(value:String):void

live

property

live:Boolean  [read-write]Implementation
    public function get live():Boolean
    public function set live(value:Boolean):void

metaData

property

metaData:Object  [read-write]Implementation
    public function get metaData():Object
    public function set metaData(value:Object):void

originalHeight

property

originalHeight:int  [read-write]Implementation
    public function get originalHeight():int
    public function set originalHeight(value:int):void

originalUrl

property

originalUrl:String [read-only]Implementation
public function get originalUrl():String

originalWidth

property

originalWidth:int  [read-write]Implementation
    public function get originalWidth():int
    public function set originalWidth(value:int):void

parent

property

parent:Clip  [read-write]Implementation
    public function get parent():Clip
    public function set parent(value:Clip):void

parentUrl

property

parentUrl:String [read-only]Implementation
public function get parentUrl():String

played

property

played:Boolean  [read-write]Implementation
    public function get played():Boolean
    public function set played(value:Boolean):void

playlist

property

playlist:Array [read-only]Implementation
public function get playlist():Array

position

property

position:Number  [read-write]Implementation
    public function get position():Number
    public function set position(value:Number):void

postroll

property

postroll:Clip [read-only]Implementation
public function get postroll():Clip

preroll

property

preroll:Clip [read-only]Implementation
public function get preroll():Clip

provider

property

provider:String  [read-write]Implementation
    public function get provider():String
    public function set provider(value:String):void

resolvedUrl

property

resolvedUrl:String [read-only]Implementation
public function get resolvedUrl():String

scaling

property

scaling:MediaSize  [read-write]Implementation
    public function get scaling():MediaSize
    public function set scaling(value:MediaSize):void

scalingStr

property

scalingStr:String [read-only]Implementation
public function get scalingStr():String

seekableOnBegin

property

seekableOnBegin:Boolean  [read-write]Implementation
    public function get seekableOnBegin():Boolean
    public function set seekableOnBegin(value:Boolean):void

smoothing

property

smoothing:Boolean  [read-write]Implementation
    public function get smoothing():Boolean
    public function set smoothing(value:Boolean):void

start

property

start:Number  [read-write]Implementation
    public function get start():Number
    public function set start(value:Number):void

startDispatched

property

startDispatched:Boolean  [read-write]Implementation
    public function get startDispatched():Boolean
    public function set startDispatched(value:Boolean):void

type

property

type:ClipType  [read-write]Implementation
    public function get type():ClipType
    public function set type(value:ClipType):void

typeStr

property

typeStr:String [read-only]Implementation
public function get typeStr():String

url

property

url:String  [read-write]Implementation
    public function get url():String
    public function set url(value:String):void

urlResolverObjects

property

urlResolverObjects:Array [write-only]Implementation
public function set urlResolverObjects(value:Array):void

urlResolvers

property

urlResolvers:Array [read-only]Implementation
public function get urlResolvers():Array

width

property

width:int  [read-write]Implementation
    public function get width():int
    public function set width(value:int):void

Constructor detail

Clip

()

constructor

public function Clip()

Method detail

addChild

()

method

public function addChild(clip:Clip):void

Use Playlist#addClip() to add child clips to the playlist. This is for internal use only.

Parameters

clip:Clip

addCuepoint

()

method

public function addCuepoint(cue:Cuepoint):voidParameters

cue:Cuepoint

addCuepoints

()

method

public function addCuepoints(cuepoints:Array):voidParameters

cuepoints:Array

clearResolvedUrls

()

method

public function clearResolvedUrls():void

Clears all resolved URLs.

create

()

method

public static function create(clipObj:Object, url:String, baseUrl:String = null):ClipParameters

	`clipObj:Object`

	`url:String`

	`baseUrl:String` (default = `null`)

Returns

Clip

dispatchNetStreamEvent

()

method

public function dispatchNetStreamEvent(name:String, infoObject:Object):voidParameters

	`name:String`

	`infoObject:Object`

getContent

()

method

public function getContent():DisplayObject

Returns

DisplayObject

getCuepoints

()

method

public function getCuepoints(time:int, dur:Number = -1):ArrayParameters

	`time:int`

	`dur:Number` (default = `-1`)

Returns

Array

getCustomProperty

()

method

public function getCustomProperty(property:String):ObjectParameters

property:String

Returns

Object

getMidroll

()

method

public function getMidroll(time:int):ClipParameters

time:int

Returns

Clip

getNetStream

()

method

public function getNetStream():NetStream

Gets the NetStream object that is currently associated with this clip, or null if none is currently associated.

Returns

NetStream

getParentPlaylist

()

method

public function getParentPlaylist():Playlist

Returns

Playlist

getPreviousResolvedUrl

()

method

public function getPreviousResolvedUrl(resolver:ClipURLResolver):String

Gets the url that was resolved using the resolver that's before the specified resolver in the resolver chain. URL resolvers should use this method to fetch the URL that is used as the starting point in resolving.

Parameters

resolver:ClipURLResolver

Returns

String

getResolvedUrl

()

method

public function getResolvedUrl(resolver:ClipURLResolver = null):String

Gets the url that was resolved using the specified resolver.

Parameters

resolver:ClipURLResolver (default = null) — the resolver whose result to look up, if null returns the result of the most recent resolver that was executed. null if no resolvers are in use, or if the url has not been resolved yet.

Returns

String

onBeforeClipEvent

()

method

public function onBeforeClipEvent(event:ClipEvent):voidParameters

event:ClipEvent

onClipEvent

()

method

public function onClipEvent(event:ClipEvent):voidParameters

event:ClipEvent

removeChild

()

method

public function removeChild(child:Clip):voidParameters

child:Clip

removeCuepoints

()

method

public function removeCuepoints(filter:Function = null):void

Removes cuepoints from this clip

Parameters

filter:Function (default = null) — a filter function, that should return true for all cuepoints to be removed. takes in the cuepoint object.

setContent

()

method

public function setContent(content:DisplayObject):voidParameters

content:DisplayObject

setCustomProperty

()

method

public function setCustomProperty(property:String, value:Object):voidParameters

	`property:String`

	`value:Object`

setEventListeners

()

method

public function setEventListeners(playlist:Playlist):voidParameters

playlist:Playlist

setNetStream

()

method

public function setNetStream(value:NetStream):voidParameters

value:NetStream

setParentPlaylist

()

method

public function setParentPlaylist(playlist:Playlist):voidParameters

playlist:Playlist

setResolvedUrl

()

method

public function setResolvedUrl(resolver:ClipURLResolver, val:String):void

Sets the resolved url-

Parameters

	`resolver:ClipURLResolver` — the resolver used in resolving

	`val:String`

setScaling

()

method

public function setScaling(scaling:String):voidParameters

scaling:String

setType

()

method

public function setType(type:String):voidParameters

type:String

setUrlResolvers

()

method

public function setUrlResolvers(val:Object):voidParameters

val:Object

toString

()

method

public function toString():String

Returns

String

unbindEventListeners

()

method

public function unbindEventListeners():void

FlowPlayer 3.2.3 API documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Clip	Properties \| Methods

Package	org.flowplayer.model
Class	public class Clip
Inheritance	Clip ClipEventDispatcher org.flowplayer.model.EventDispatcher