2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package org.apidesign.html.sound.spi;
45 /** Basic interface for sound playback providers. Register your implementation
46 * in a way {@link java.util.ServiceLoader} can find it - e.g. use
47 * {@link org.openide.util.lookup.ServiceProvider} annotation.
50 * @param <Audio> custom type representing the internal audio state
52 public interface AudioEnvironment<Audio> {
53 /** Checks if the provided URL can be a supported audio stream
54 * and if so, it create an object to represent it. The created object
55 * will be used in future callbacks to other methods of this interface
56 * (like {@link #play(java.lang.Object)}).
57 * @param src the URL pointing to the media stream
58 * @return an internal representation object or <code>null</code> if this
59 * environment does not know how to handle such stream
61 public Audio create(String src);
63 /** Starts playback of the audio.
65 * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
67 public void play(Audio a);
69 /** Pauses playback of the audio.
71 * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
73 public void pause(Audio a);
75 /** Changes volume for the playback of the audio.
77 * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
78 * @param volume value between 0.0 and 1.0
80 public void setVolume(Audio a, double volume);
82 /** Checks whether given audio is supported
85 * @return <code>true</code> or <code>false</code>
87 public boolean isSupported(Audio a);