javax.media

Interface CachingControl

All Superinterfaces:

Control

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	LENGTH_UNKNOWN Use to indicate that the CachingControl doesn't know how long the content is.

Method Summary

Methods

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

Field Detail

LENGTH_UNKNOWN

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

See Also:

Constant Field Values

Method Detail

isDownloading

boolean isDownloading()

Check whether or not media is being downloaded.

Returns:

Returns true if media is being downloaded; otherwise returns false. .

getContentLength

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.

getContentProgress

long getContentProgress()

Get the total number of bytes of media data that have been downloaded so far.

Returns:

The number of bytes downloaded.

getProgressBarComponent

Component getProgressBarComponent()

Get a Component for displaying the download progress.

Returns:

Progress bar GUI.

getControlComponent

Component getControlComponent()

Get a Component that provides additional download control. Returns null if only a progress bar is provided.

Specified by:

getControlComponent in interface Control

Returns:

Download control GUI.