Interface mx.controls.streamingmedia.IPlayer

mx.controls.streamingmedia.IPlayer

Description

IPlayer defines the interface for the implementation classes that play streaming media files.

Method Index

addListener(), bufferIsFull(), close(), getMediaBytesLoaded(), getMediaBytesTotal(), getMediaUrl(), getPlayheadTime(), getTotalTime(), getVolume(), isPlaying(), isSizeChange(), isSizeSet(), load(), logError(), mediaLoaded(), pause(), play(), playStopped(), removeAllListeners(), resizeVideo(), setMediaUrl(), setPlayheadTime(), setSeeking(), setVolume(), stop()

Method Detail

load

function load():Void
Load the media without playing it.

play

public function play(startingPoint:
Number):Void
Play the media starting at the specified starting point. If the media hasn't yet been loaded, load it.
Parameters
startingPoint The number of seconds into the media to start at. This is an optional parameter. If omitted, playing will occur at the current playhead position.

pause

public function pause():Void
Stop playback of the media without moving the playhead.

stop

function stop():Void
Stop playback of the media and reset the playhead to zero.

getPlayheadTime

function getPlayheadTime():
Number
Return
The playhead position, measued in seconds since the start.

setPlayheadTime

function setPlayheadTime(position:
Number):Void

getMediaUrl

function getMediaUrl():
String

setMediaUrl

function setMediaUrl(aUrl:
String):Void

getVolume

function getVolume():
Number

setVolume

function setVolume(aVol:
Number):Void

isPlaying

function isPlaying():
Boolean
Is the playhead moving?

getMediaBytesLoaded

function getMediaBytesLoaded():
Number
Return
The number of bytes of the media that has loaded.

getMediaBytesTotal

function getMediaBytesTotal():
Number
Return
The total number of bytes of the media.

getTotalTime

function getTotalTime():
Number
Return
The total time of the media, in seconds. For some media types this will be calculated based on the elapsed time, bytes loaded, and bytes total. For others, it will be a property.

addListener

function addListener(aListener:
Object):Void

removeAllListeners

function removeAllListeners():Void

playStopped

function playStopped():Void

bufferIsFull

function bufferIsFull():Void

resizeVideo

function resizeVideo():Void

mediaLoaded

function mediaLoaded():Void
Called when the media is completely loaded.

close

function close():Void
Close the player

logError

function logError(error:
String):Void

isSizeSet

function isSizeSet():
Boolean

isSizeChange

function isSizeChange():
Boolean

setSeeking

function setSeeking(isSeeking:
Boolean):Void