Media Playback

last revision: 4/28/2008

Package: imeem.api.player
Class: public class MediaPlayer

Public Methods

MediaPlayer(apiKey, apiSecret)
Creates a MediaPlayer object.

load():void
Loads the media player. This must be called before any other media player call. Ensure no other method calls are made until the mediaPlayerLoaded event is dispatched.

setOverlayDisplay(container:Sprite):void
Sets the container in which the imeem overlay will be displayed (for buy links, etc). This is designed to overlay your player so as to not waste additional space. A canvas component is recommended. (Minimum dimensions 180x150 px)

setToolbarDisplay(container:Sprite):void
Sets the container in which the imeem toolbar will be displayed. A canvas component is recommended. (Minimum dimensions: 180x25 px)

setVideoDisplay(container:Sprite, preserveAspectRatio:Boolean, allowHDVideo:Boolean):void
Sets the container in which videos will be played.

play(mediaID:String, forceSample:Boolean = false):void
Plays the specified media.

pause():void
Pauses the currently playing media.

resume():void
Resumes the currently paused media.

stop():void
Stops the currently playing media.

seek(position:Number):void
Seeks to the specified position for the current media.

showLoginScreen(defaultValues:Object = null):void
Presents an imeem login screen in the designated overlay display. Allows you to pre-fill fields with default values.

showSignupScreen(defaultvalues:Object = null):void
Presents an imeem signup screen in the designated overlay display. Allows you to pre-fill fields with default values.

Public Properties

volume:Number
The volume level for the player. Accepts and returns values between 0 - 1.

bufferTime:Number
How long to buffer the media before starting playback.

adPlaying:Boolean
Whether an ad is currently playing.

status:String
The play status of the current media.

currentMediaID:String
The ID of the current media.

bytesLoaded:Number
The number of bytes that have been loaded.

bytesTotal:Number
The total number of bytes for the media.

trackPosition:Number
The position of the playhead, in seconds.

trackLength:Number
The total seconds for the current media.

video:Video
The video object for the current media.

Events

mediaPlayerLoaded
Dispatched when the media player has successfully loaded.

mediaPlayerLoadError
Dispatched when there is an error loading the media player.

mediaStart
Dispatched when the media has started playing.

mediaEnd
Dispatched when the media has ended playing.

mediaBuffering
Dispatched when the media is buffering.

mediaDoneBuffering
Dispatched when the media completes buffering.

mediaForcePause
Dispatched when the media is forced to pause due to concurrent playback of another media player.

mediaError
Dispatched when there is a media error.

mediaOverlayShow
Dispatched when an overlay is shown.

mediaOverlayHide
Dispatched when an overlay is hidden.

mediaAdStart
Dispatched when ad playback begins.

mediaAdEnd
Dispatched when ad playback ends.