javax.media.protocol.Positionable Maven / Gradle / Ivy
/**
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example,
this file and any files generated from it may be used to generate other documentation,
such as a unified set of documents of API signatures for a platform
that includes technologies expressed as Java APIs.
This file may also be used to produce "compilation stubs,"
which allow applications to be compiled and validated for such platforms.
By contrast, no permission is given for you to incorporate this file,
in whole or in part, in an implementation of a Java specification.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.
In the event of a discrepency between this work and the JSR 927 specification,
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/
package javax.media.protocol;
import javax.media.Time;
/**
* A DataSource implements the Positionable interface
* if it supports changing the media position within the stream.
*
* @see Datasource
* @version 1.7, 05/10/17.
*/
public interface Positionable
{
public static final int RoundUp = 1;
public static final int RoundDown = 2;
public static final int RoundNearest = 3;
/**
* Set the position to the specified time.
* Returns the rounded position that was actually set.
*
* @param time The new position in the stream.
* @param rounding The rounding technique to be used: RoundUp, RoundDown, RoundNearest.
* @return The actual position set.
*/
public Time setPosition(Time where, int rounding);
/**
* Find out if this source can be repositioned to any point in the stream.
* If not, the source can only be repositioned to the beginning of the stream.
*
* @return Returns true if the source is random access; false if the source can only
* be reset to the beginning of the stream.
*/
public boolean isRandomAccess();
}