Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
mx.controls.streamingmedia

interface IPlayer

All Known Implementing Classes:
FLVPlayer, MP3Player, RTMPPlayer
interface IPlayer

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


Author:
Andrew Guldman

Method Summary


addListener ( aListener: Object ): Void



bufferIsFull ( ): Void



close ( ): Void
Close the player


getMediaBytesLoaded ( ): Number



getMediaBytesTotal ( ): Number



getMediaUrl ( ): String



getPlayheadTime ( ): Number



getTotalTime ( ): Number



getVolume ( ): Number



isPlaying ( ): Boolean
Is the playhead moving?


isSizeChange ( ): Boolean



isSizeSet ( ): Boolean



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


logError ( error: String ): Void



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

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

public
play ( startingPoint: Number ): Void
Play the media starting at the specified starting point.


playStopped ( ): Void



removeAllListeners ( ): Void



resizeVideo ( ): Void



setMediaUrl ( aUrl: String ): Void



setPlayheadTime ( position: Number ): Void



setSeeking ( isSeeking: Boolean ): Void



setVolume ( aVol: Number ): Void



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


Method Documentation

addListener

function addListener(aListener: Object): Void

bufferIsFull

function bufferIsFull(): Void

close

function close(): Void
Close the player

getMediaBytesLoaded

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

getMediaBytesTotal

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

getMediaUrl

function getMediaUrl(): String

getPlayheadTime

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

getTotalTime

function getTotalTime(): Number
Returns:
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.

getVolume

function getVolume(): Number

isPlaying

function isPlaying(): Boolean
Is the playhead moving?

isSizeChange

function isSizeChange(): Boolean

isSizeSet

function isSizeSet(): Boolean

load

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

logError

function logError(error: String): Void

mediaLoaded

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

pause

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

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.

playStopped

function playStopped(): Void

removeAllListeners

function removeAllListeners(): Void

resizeVideo

function resizeVideo(): Void

setMediaUrl

function setMediaUrl(aUrl: String): Void

setPlayheadTime

function setPlayheadTime(position: Number): Void

setSeeking

function setSeeking(isSeeking: Boolean): Void

setVolume

function setVolume(aVol: Number): Void

stop

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

The documentation was generated from the following file:

Copyright © 1997-2005 Macromedia, Inc. All rights reserved. Generated with AS2Doc