Spec-Zone .ru
спецификации, руководства, описания, API
001/*
002 * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.scene.media;
027
028/**
029 * Audio spectrum callback interface. The observer receives periodic updates of
030 * the audio spectrum. A single observer may be attached to a given {@link MediaPlayer}
031 * using {@link MediaPlayer#setAudioSpectrumListener}.
032 *
033 * @see MediaPlayer
034 */
035public interface AudioSpectrumListener {
036    /**
037     * Notifies the observer about new data available for the audio spectrum.
038     *
039     * <p>The notification period for updates may be set using
040     * {@link MediaPlayer#setAudioSpectrumInterval}, and the number of bands and
041     * sensitivity threshold via {@link MediaPlayer#setAudioSpectrumNumBands} and
042     * {@link MediaPlayer#setAudioSpectrumThreshold}, respectively. The default
043     * values of the settings are an interval of <code>0.1</code> seconds,
044     * <code>128</code> bands, and sensitivity threshold <code>-60.0</code> dB.
045     *
046     * <p>The arrays
047     * passed to the listener should be considered to be read-only as the
048     * underlying implementation may re-use them.</p>
049     *
050     * @param timestamp timestamp of the event in seconds.
051     * @param duration duration for which the spectrum was computed in seconds.
052     * @param magnitudes array containing the non-positive spectrum magnitude in decibels
053     * (dB) for each band.
054     * The size of the array equals the number of bands and should be considered
055     * to be read-only.
056     * @param phases array containing the phase in the range
057     * [<code>Math.PI</code>,&nbsp;<code>Math.PI</code>] for each band.
058     * The size of the array equals the number of bands and should be considered
059     * to be read-only.
060     */
061    public void spectrumDataUpdate(double timestamp, double duration, float[] magnitudes, float[] phases);
062}