Positionable.java

/*
 * @(#)Positionable.java	1.4 02/08/21
 *
 * Copyright (c) 1996-2002 Sun Microsystems, Inc.  All rights reserved.
 */

package javax.media.protocol;

import javax.media.*;

/**
 * A media object implements the <CODE>Positionable</CODE> interface
 * if it supports changing the media position within the stream.
 * <p>
 * This is the JMF 1.0 
 * <a href = http://www.javasoft.com/products/java-media/jmf/forDevelopers/playerapi/javax.media.protocol.Positionable.html> Positionable </a> 
 * interface.
 * 
 * @version 1.11, 98/06/23.
 */
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 round The rounding technique to be used: RoundUp, RoundDown, RoundNearest.
     * @return The actual position set.
     */
    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 <CODE>true</CODE> if the source is random access; <CODE>false</CODE> if the source can only
     * be reset to the beginning of the stream.
     */
    boolean isRandomAccess();

}