Duration.java

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

package javax.media;

/**
 * The <code>Duration</code> interface provides a way to determine the
 * duration of the media being played by a media object.
 * Media objects that expose a media duration
 * implement this interface. 
 * <p>
 * This is the JMF 1.0 
 * <a href = http://www.javasoft.com/products/java-media/jmf/forDevelopers/playerapi/javax.media.Duration.html> Duration </a> interface.
 * @version 1.21, 98/06/23
 */
public interface Duration {

    /**
     * Returned by <code>getDuration</code>.
     */
    public final static Time DURATION_UNBOUNDED = new Time(Long.MAX_VALUE);
    /**
     * Returned by <code>getDuration</code>.
     */
    public final static Time DURATION_UNKNOWN = new Time(Long.MAX_VALUE - 1);
    
    /**
     * Get the duration of the media represented
     * by this object.
     * The value returned is the media's duration
     * when played at the default rate.
     * If the duration can't be determined  (for example, the media object is presenting live
     * video)  <CODE>getDuration</CODE> returns <CODE>DURATION_UNKNOWN</CODE>.
     *
     * @return A <CODE>Time</CODE> object representing the duration or DURATION_UNKNOWN.
     */
    public Time getDuration();
}