javax.media.protocol
Interface SourceStream

All Superinterfaces:

Controls, Controls

All Known Subinterfaces:

PullBufferStream, PullSourceStream, PushBufferStream, PushSourceStream

All Known Implementing Classes:

InputSourceStream

public interface SourceStream

extends Controls

Abstracts a single stream of media data.

Stream Controls

A SourceStream might support an operation that is not part of the SourceStream definition. For example a stream might support seeking to a particular byte in the stream. In that case, it should implement the Seekable interface. Some streams allow its output format to be changed. It should then implement the Formattable interface.

Many operations are dependent on the stream data, and support cannot be determined until the stream is in use.

To obtain all of the objects that provide control over a stream use getControls. To determine if a particular kind of control is available, and obtain the object that implements the control use getControl.

Version:

1.5, 02/08/21.

See Also:

DataSource, PushSourceStream, PullSourceStream, Seekable

Field Summary

static long

LENGTH_UNKNOWN

Method Summary

boolean	endOfStream() Find out if the end of the stream has been reached.
ContentDescriptor	getContentDescriptor() Get the current content type for this stream.
long	getContentLength() Get the size, in bytes, of the content on this stream.

Methods inherited from interface javax.media.Controls

getControl, getControls

Field Detail

LENGTH_UNKNOWN

public static final long LENGTH_UNKNOWN

See Also:

Constant Field Values

Method Detail

getContentDescriptor

public ContentDescriptor getContentDescriptor()

Get the current content type for this stream.

Returns:

The current ContentDescriptor for this stream.

getContentLength

public long getContentLength()

Get the size, in bytes, of the content on this stream. LENGTH_UNKNOWN is returned if the length is not known.

Returns:

The content length in bytes.

endOfStream

public boolean endOfStream()

Find out if the end of the stream has been reached.

Returns:

Returns true if there is no more data.