All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface javax.media.CachingControl

public interface CachingControl
extends Control
CachingControl is an interface supported by Players that are capable of reporting download progress. Typically, this control is accessed through the Controller.getControls method. A Controller that supports this control will post CachingControlEvents often enough to support the implementation of custom progress GUIs.

Version:
1.18, 97/08/25.
See Also:
Controller, ControllerListener, CachingControlEvent, Player

Variable Index

 o LENGTH_UNKNOWN
Use to indicate that the CachingControl doesn't know how long the content is.

The definition is: LENGTH_UNKNOWN == Long.MAX_VALUE

Method Index

 o getContentLength()
Get the total number of bytes in the media being downloaded.
 o getContentProgress()
Get the total number of bytes of media data that have been downloaded so far.
 o getControlComponent()
Get a Component that provides additional download control.
 o getProgressBarComponent()
Get a Component for displaying the download progress.
 o isDownloading()
Check whether or not media is being downloaded.

Variables

 o LENGTH_UNKNOWN
 public static final long LENGTH_UNKNOWN
Use to indicate that the CachingControl doesn't know how long the content is.

The definition is: LENGTH_UNKNOWN == Long.MAX_VALUE

Methods

 o isDownloading
 public abstract boolean isDownloading()
Check whether or not media is being downloaded.

Returns:
Returns true if media is being downloaded; otherwise returns false. .
 o getContentLength
 public abstract long getContentLength()
Get the total number of bytes in the media being downloaded. Returns LENGTH_UNKNOWN if this information is not available.

Returns:
The media length in bytes, or LENGTH_UNKNOWN.
 o getContentProgress
 public abstract long getContentProgress()
Get the total number of bytes of media data that have been downloaded so far.

Returns:
The number of bytes downloaded.
 o getProgressBarComponent
 public abstract Component getProgressBarComponent()
Get a Component for displaying the download progress.

Returns:
Progress bar GUI.
 o getControlComponent
 public abstract Component getControlComponent()
Get a Component that provides additional download control. Returns null if only a progress bar is provided.

Returns:
Download control GUI.

All Packages  Class Hierarchy  This Package  Previous  Next  Index