1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/sound/src/main/java/org/netbeans/html/sound/spi/AudioEnvironment.java Tue Aug 26 18:13:30 2014 +0200
1.3 @@ -0,0 +1,94 @@
1.4 +/**
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
1.8 + *
1.9 + * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
1.10 + * Other names may be trademarks of their respective owners.
1.11 + *
1.12 + * The contents of this file are subject to the terms of either the GNU
1.13 + * General Public License Version 2 only ("GPL") or the Common
1.14 + * Development and Distribution License("CDDL") (collectively, the
1.15 + * "License"). You may not use this file except in compliance with the
1.16 + * License. You can obtain a copy of the License at
1.17 + * http://www.netbeans.org/cddl-gplv2.html
1.18 + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
1.19 + * specific language governing permissions and limitations under the
1.20 + * License. When distributing the software, include this License Header
1.21 + * Notice in each file and include the License file at
1.22 + * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
1.23 + * particular file as subject to the "Classpath" exception as provided
1.24 + * by Oracle in the GPL Version 2 section of the License file that
1.25 + * accompanied this code. If applicable, add the following below the
1.26 + * License Header, with the fields enclosed by brackets [] replaced by
1.27 + * your own identifying information:
1.28 + * "Portions Copyrighted [year] [name of copyright owner]"
1.29 + *
1.30 + * Contributor(s):
1.31 + *
1.32 + * The Original Software is NetBeans. The Initial Developer of the Original
1.33 + * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
1.34 + *
1.35 + * If you wish your version of this file to be governed by only the CDDL
1.36 + * or only the GPL Version 2, indicate your decision by adding
1.37 + * "[Contributor] elects to include this software in this distribution
1.38 + * under the [CDDL or GPL Version 2] license." If you do not indicate a
1.39 + * single choice of license, a recipient has the option to distribute
1.40 + * your version of this file under either the CDDL, the GPL Version 2 or
1.41 + * to extend the choice of license to its licensees as provided above.
1.42 + * However, if you add GPL Version 2 code and therefore, elected the GPL
1.43 + * Version 2 license, then the option applies only if the new code is
1.44 + * made subject to such option by the copyright holder.
1.45 + */
1.46 +package org.netbeans.html.sound.spi;
1.47 +
1.48 +import net.java.html.BrwsrCtx;
1.49 +import org.netbeans.html.context.spi.Contexts;
1.50 +
1.51 +/** Basic interface for sound playback providers. Register your implementation
1.52 + * in a way {@link java.util.ServiceLoader} can find it - e.g. use
1.53 + * {@link org.openide.util.lookup.ServiceProvider} annotation. Possibly
1.54 + * one can register the provider into {@link Contexts#newBuilder()}, in
1.55 + * case the implementation is somehow associated
1.56 + * with the actual {@link BrwsrCtx} (works since version 0.8.3).
1.57 + *
1.58 + * @author antonepple
1.59 + * @param <Audio> custom type representing the internal audio state
1.60 + */
1.61 +public interface AudioEnvironment<Audio> {
1.62 + /** Checks if the provided URL can be a supported audio stream
1.63 + * and if so, it create an object to represent it. The created object
1.64 + * will be used in future callbacks to other methods of this interface
1.65 + * (like {@link #play(java.lang.Object)}).
1.66 + * @param src the URL pointing to the media stream
1.67 + * @return an internal representation object or <code>null</code> if this
1.68 + * environment does not know how to handle such stream
1.69 + */
1.70 + public Audio create(String src);
1.71 +
1.72 + /** Starts playback of the audio.
1.73 + *
1.74 + * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
1.75 + */
1.76 + public void play(Audio a);
1.77 +
1.78 + /** Pauses playback of the audio.
1.79 + *
1.80 + * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
1.81 + */
1.82 + public void pause(Audio a);
1.83 +
1.84 + /** Changes volume for the playback of the audio.
1.85 + *
1.86 + * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
1.87 + * @param volume value between 0.0 and 1.0
1.88 + */
1.89 + public void setVolume(Audio a, double volume);
1.90 +
1.91 + /** Checks whether given audio is supported
1.92 + *
1.93 + * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
1.94 + * @return <code>true</code> or <code>false</code>
1.95 + */
1.96 + public boolean isSupported(Audio a);
1.97 +}