/* * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * 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. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * 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 (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.media.sound; import java.util.Map; import javax.sound.midi.MidiSystem; import javax.sound.midi.MidiUnavailableException; import javax.sound.midi.Synthesizer; import javax.sound.sampled.AudioFormat; import javax.sound.sampled.AudioInputStream; import javax.sound.sampled.SourceDataLine; /** * {@code AudioSynthesizer} is a {@code Synthesizer} * which renders it's output audio into {@code SourceDataLine} * or {@code AudioInputStream}. * * @see MidiSystem#getSynthesizer * @see Synthesizer * * @author Karl Helgason */ public interface AudioSynthesizer extends Synthesizer { /** * Obtains the current format (encoding, sample rate, number of channels, * etc.) of the synthesizer audio data. * *
If the synthesizer is not open and has never been opened, it returns
* the default format.
*
* @return current audio data format
* @see AudioFormat
*/
AudioFormat getFormat();
/**
* Gets information about the possible properties for the synthesizer.
*
* @param info a proposed list of tag/value pairs that will be sent on open.
* @return an array of {@code AudioSynthesizerPropertyInfo} objects
* describing possible properties. This array may be an empty array if
* no properties are required.
*/
AudioSynthesizerPropertyInfo[] getPropertyInfo(Map An application opening a synthesizer explicitly with this call
* has to close the synthesizer by calling {@link #close}. This is
* necessary to release system resources and allow applications to
* exit cleanly.
*
* Note that some synthesizers, once closed, cannot be reopened.
* Attempts to reopen such a synthesizer will always result in
* a {@code MidiUnavailableException}.
*
* @param line which {@code AudioSynthesizer} writes output audio into.
* If {@code line} is null, then line from system default mixer is used.
* @param info a {@code Map An application opening a synthesizer explicitly with this call
* has to close the synthesizer by calling {@link #close}. This is
* necessary to release system resources and allow applications to
* exit cleanly.
*
* Note that some synthesizers, once closed, cannot be reopened.
* Attempts to reopen such a synthesizer will always result in
* a {@code MidiUnavailableException}.
*
* @param targetFormat specifies the {@code AudioFormat}
* used in returned {@code AudioInputStream}.
* @param info a {@code Map