File Doc Category Size Date Package
PlayerListener.java API Doc J2ME MIDP 2.0 6834 Thu Nov 07 12:02:30 GMT 2002 javax.microedition.media

PlayerListener

public interface PlayerListener

PlayerListener is the interface for receiving asynchronous events generated by Players. Applications may implement this interface and register their implementations with the addPlayerListener method in Player.

A number of standard Player events are defined here in this interface. Event types are defined as strings to support extensibility as different implementations may introduce proprietary events by adding new event types. To avoid name conflicts, proprietary events should be named with the "reverse-domainname" convention. For example, a company named "mycompany" should name its proprietary event names with strings like "com.mycompany.myEvent" etc.

Applications that rely on proprietary events may not function properly across different implementations. In order to make the applications that use those events to behave well in environments that don't implement them, String.equals() should be used to check the event.

Code fragment for catching standard events in playerUpdate()

if (eventType == PlayerListener.STARTED) {...}

Code fragment for catching proprietary events in playerUpdate()

if (eventType.equals("com.company.myEvent")) {...}

see: Player

Fields Summary
String
STARTED
Posted when a Player is started. When this event is received, the eventData parameter will be a Long object designating the media time when the Player is started.
Value started is assigned to STARTED.
String
STOPPED
Posted when a Player stops in response to the stop method call. When this event is received, the eventData parameter will be a Long object designating the media time when the Player stopped.
Value stopped is assigned to STOPPED.
String
END_OF_MEDIA
Posted when a Player has reached the end of the media. When this event is received, the eventData parameter will be a Long object designating the media time when the Player reached end of media and stopped.
Value endOfMedia is assigned to END_OF_MEDIA.
String
DURATION_UPDATED
Posted when the duration of a Player is updated. This happens for some media types where the duration cannot be derived ahead of time. It can only be derived after the media is played for a period of time -- for example, when it reaches a key frame with duration info; or when it reaches the end of media.
When this event is received, the eventData parameter will be a Long object designating the duration of the media.
Value durationUpdated is assigned to DURATION_UPDATED.
String
DEVICE_UNAVAILABLE
Posted when the system or another higher priority application has temporarily taken control of an exclusive device which was previously available to the Player.
The Player will be in the REALIZED state when this event is received.
This event must be followed by either a DEVICE_AVAILABLE event when the device becomes available again, or an ERROR event if the device becomes permanently unavailable.
The eventData parameter is a String specifying the name of the device.
Value deviceUnavailable is assigned to DEVICE_UNAVAILABLE.
String
DEVICE_AVAILABLE
Posted when the system or another higher priority application has released an exclusive device which is now available to the Player.
The Player will be in the REALIZED state when this event is received. The application may acquire the device with the prefetch or start method.
A DEVICE_UNAVAILABLE event must preceed this event.
The eventData parameter is a String specifying the name of the device.
Value deviceAvailable is assigned to DEVICE_AVAILABLE.
String
VOLUME_CHANGED
Posted when the volume of an audio device is changed. When this event is received, the eventData parameter will be a VolumeControl object. The new volume can be queried from the VolumeControl.
Value volumeChanged is assigned to VOLUME_CHANGED.
String
ERROR
Posted when an error had occurred. When this event is received, the eventData parameter will be a String object specifying the error message.
Value error is assigned to ERROR.
String
CLOSED
Posted when a Player is closed. When this event is received, the eventData parameter is null.
Value closed is assigned to CLOSED.
Constructors Summary
Methods Summary
public void playerUpdate(Player player, java.lang.String event, java.lang.Object eventData)
This method is called to deliver an event to a registered listener when a Player event is observed.
param
player The player which generated the event.
param
event The event generated as defined by the enumerated types.
param
eventData The associated event data.