com.sun.tv.media.content.video.mpeg

Class Handler

java.lang.Object

com.sun.tv.media.MediaController

com.sun.tv.media.MediaPlayer

com.sun.tv.media.content.video.mpeg.Handler

All Implemented Interfaces:

EventListener, Clock, Controller, ControllerListener, Duration, GainChangeListener, MediaHandler, Player

public class Handler
extends MediaPlayer

A MPEG player implementation for windows that runs on top of Active Movie.

Field Summary

Fields

Modifier and Type	Field and Description
protected AMController	amController Variables

Fields inherited from class com.sun.tv.media.MediaPlayer

controls, defaultColorModel, gainControl, source, systemTimeBase, VERSION

Fields inherited from class com.sun.tv.media.MediaController

parent, state

Fields inherited from interface javax.media.Controller

LATENCY_UNKNOWN, Prefetched, Prefetching, Realized, Realizing, Started, Unrealized

Fields inherited from interface javax.media.Clock

RESET

Fields inherited from interface javax.media.Duration

DURATION_UNBOUNDED, DURATION_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
Handler() Methods

Method Summary

Methods

Modifier and Type	Method and Description
boolean	audioEnabled() Return true if the player is currently playing media with an audio track.
protected boolean	connectNodes() This is invoked from doRealize() after all the nodes created in createNode() is fully realized.
protected void	createGainControl() If the Player can play audio, a gain control adapter is created and the player is registered a listener for gain change events
protected boolean	createNodes() This is invoked from doRealize() during the player realization stage.
void	doClose() This is called when close() is invoked on the Player.
protected boolean	doRealize() The stub function (invoked from realize()) to perform the steps to realize the player.
Component	getControlPanelComponent() Get the Component with the default user interface for controlling this player.
GainControl	getGainControl() Get the object for controlling audio gain.
protected TimeBase	getMasterTimeBase() This should be implemented by the subclass.
Component	getVisualComponent() Get the Component this player will output its visual media to.
void	processEvent(ControllerEvent evt) Process one event from another Controller which we are listening to.
void	setSource(DataSource source) Set the DataSource that provides the media for this player.
void	updateStats()
boolean	videoEnabled() Return true if the player is currently playing media with a video track.

Methods inherited from class com.sun.tv.media.MediaPlayer

abortPrefetch, abortRealize, addController, addControls, addNode, addNode, allocBuffers, close, completePrefetch, completeRealize, deviceBusy, doFailedPrefetch, doFailedRealize, doPrefetch, doSetMediaTime, doSetRate, doStart, doStop, flush, gainChange, getControls, getDuration, getNodeList, getSource, muteChange, removeController, removeNode, setMediaLength, setMediaTime, setRate, setStopTime, setTimeBase, setVisualComponent, slaveToMasterTimeBase, start, stop, stop, stopAtTime, synchronousPrefetch, synchronousRealize, syncStart, updateDuration

Methods inherited from class com.sun.tv.media.MediaController

addControllerListener, cleanup, controllerUpdate, deallocate, dispatchEvent, doDeallocate, getControl, getMediaClockTime, getMediaNanoseconds, getMediaTime, getRate, getStartLatency, getState, getStopTime, getSyncTime, getTargetState, getTimeBase, mapToTimeBase, prefetch, realize, removeControllerListener, sendEvent, setTargetState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.media.Controller

addControllerListener, deallocate, getControl, getStartLatency, getState, getTargetState, prefetch, realize, removeControllerListener

Methods inherited from interface javax.media.Clock

getMediaNanoseconds, getMediaTime, getRate, getStopTime, getSyncTime, getTimeBase, mapToTimeBase

Field Detail

amController

protected AMController amController

Variables

Constructor Detail

Handler

public Handler()

Methods

Method Detail

setSource

public void setSource(DataSource source)
               throws IOException,
                      IncompatibleSourceException

Description copied from class: MediaPlayer

Set the DataSource that provides the media for this player. MediaPlayer only supports PullDataSource by default. Subclasses can override this method to support other DataSources.

Specified by:

setSource in interface MediaHandler

Overrides:

setSource in class MediaPlayer

Parameters:

source - of media for this player.

Throws:

IOException - thrown when an i/o error occurs in reading information from the data source.

IncompatibleSourceException - thrown if the Player can't use this source.

getMasterTimeBase

protected TimeBase getMasterTimeBase()

Description copied from class: MediaPlayer

This should be implemented by the subclass. The subclass method should return the master TimeBase -- the TimeBase that all other Controllers (nodes) slave to. Use SystemTimeBase if unsure.

Specified by:

getMasterTimeBase in class MediaPlayer

Returns:

the master time base.

updateStats

public void updateStats()

getVisualComponent

public Component getVisualComponent()

Get the Component this player will output its visual media to. If this player has no visual component (e.g. audio only) getVisualComponent() will return null.

Specified by:

getVisualComponent in interface Player

Overrides:

getVisualComponent in class MediaPlayer

Returns:

the media display component.

getGainControl

public GainControl getGainControl()

Get the object for controlling audio gain. Returns null if this player does not have a GainControl (e.g. no audio).

Specified by:

getGainControl in interface Player

Overrides:

getGainControl in class MediaPlayer

Returns:

the GainControl object for this player.

getControlPanelComponent

public Component getControlPanelComponent()

Get the Component with the default user interface for controlling this player. If this player has no default control panel null is returned.

Specified by:

getControlPanelComponent in interface Player

Overrides:

getControlPanelComponent in class MediaPlayer

Returns:

the default control panel GUI.

createNodes

protected boolean createNodes()

Description copied from class: MediaPlayer

This is invoked from doRealize() during the player realization stage. See doRealize() for a detail description. Subclasses should implement this to construct the internals of the player. The method in the subclass should create all the nodes (Controllers) that it needs to assemble a Player, use addNode(node) to add them to the list maintained by the MediaPlayer. The nodes should not be connected at this point since they haven't been realized. The MediaPlayer's doRealize() call will be responsible for invoking realize() on each node, wait for their RealizeCompleteEvent. At that point, it will invoke connectNodes(). Only at that point should subclasses connect up the nodes.

In addition, this method should also choose a master timebase to be used by this player. This should be returned on a getMasterTimeBase() call.

It should return success/failure. A subsequent call to createNodes() after the first successful completion should just return true.

Specified by:

createNodes in class MediaPlayer

Returns:

true if successful; false if failed.

connectNodes

protected boolean connectNodes()

Description copied from class: MediaPlayer

This is invoked from doRealize() after all the nodes created in createNode() is fully realized. At this point, subclasses should implement this method to connect up the nodes. It should return a boolean signifying success/failure.

Specified by:

connectNodes in class MediaPlayer

Returns:

true if successful; false if failed.

createGainControl

protected void createGainControl()

Description copied from class: MediaPlayer

If the Player can play audio, a gain control adapter is created and the player is registered a listener for gain change events

Overrides:

createGainControl in class MediaPlayer

doRealize

protected boolean doRealize()

Description copied from class: MediaPlayer

The stub function (invoked from realize()) to perform the steps to realize the player. It performs the following:

• invoke createNodes() to allow subclasses to create the internal nodes of a player;
• call realize() on each node created from createNode();
• wait for RealizeCompleteEvent from each node;
• call connectNodes() to allow subclasses to connect up the nodes after they are realized.

Subclasses are allowed to override doRealize(). But this should be done in caution. createNodes() and connectNodes() should have provided all the flexiblity needed without changing doRealize(). This is called from a separately running thread.

Overrides:

doRealize in class MediaPlayer

Returns:

true if successful.

doClose

public void doClose()

Description copied from class: MediaPlayer

This is called when close() is invoked on the Player. close() takes care of the general behavior before invoking doClose(). Subclasses should implement this only if it needs to do something specific to close the player.

Overrides:

doClose in class MediaPlayer

audioEnabled

public boolean audioEnabled()

Description copied from class: MediaPlayer

Return true if the player is currently playing media with an audio track.

Specified by:

audioEnabled in class MediaPlayer

Returns:

true if the player is playing audio.

videoEnabled

public boolean videoEnabled()

Description copied from class: MediaPlayer

Return true if the player is currently playing media with a video track.

Specified by:

videoEnabled in class MediaPlayer

Returns:

true if the player is playing video.

processEvent

public void processEvent(ControllerEvent evt)

Description copied from class: MediaController

Process one event from another Controller which we are listening to. This is invoked by the recvEvtQueue when there is at least one event in the queue. If you need to extend this methods, please also invoke this such that the events can be catched by the work threads.

Overrides:

processEvent in class MediaPlayer

Parameters:

evt - controller event to be processed