org.jaudiolibs.audioservers.javasound.JSTimingMode Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2019 Neil C Smith.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details.
 *
 * You should have received a copy of the GNU General Public License version 2
 * along with this work; if not, see http://www.gnu.org/licenses/
 *
 *
 * Linking this work statically or dynamically with other modules is making a
 * combined work based on this work. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this work give you permission
 * to link this work with independent modules to produce an executable,
 * regardless of the license terms of these independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module. An independent module is a module which is not
 * derived from or based on this work. If you modify this work, you may extend
 * this exception to your version of the work, but you are not obligated to do so.
 * If you do not wish to do so, delete this exception statement from your version.
 *
 * Please visit https://www.neilcsmith.net if you need additional information or
 * have any questions.
 */
package org.jaudiolibs.audioservers.javasound;

/**
 * Timing mode used by the server.
 *
 * For lowest latency try {@link #FramePosition} or {@link #Estimated}.
 */
public enum JSTimingMode {

    /**
     * Blocking timing mode. Block on write to output line. Javasound output
     * buffer is same size as internal buffers.
     */
    Blocking,
    /**
     * FramePosition timing mode. Use large Javasound output buffer. Determine
     * when to write to output line via getLongFramePosition().
     */
    FramePosition,
    /**
     * Estimated timing mode. Use large Javasound output buffer. Determine when
     * to write to output line by estimating position using System.nanotime().
     */
    // @TODO Investigate whether xruns in underlying library are causing latency to increase.
    Estimated
}