1 /*
2  * Copyright 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.media;
18 
19 import android.annotation.NonNull;
20 import android.media.VolumeShaper.Configuration;
21 
22 /**
23  * {@code VolumeAutomation} defines an interface for automatic volume control
24  * of {@link AudioTrack} and {@link MediaPlayer} objects.
25  */
26 public interface VolumeAutomation {
27     /**
28      * Returns a {@link VolumeShaper} object that can be used modify the volume envelope
29      * of the player or track.
30      *
31      * @param configuration the {@link VolumeShaper.Configuration configuration}
32      *        that specifies the curve and duration to use.
33      * @return a {@code VolumeShaper} object
34      * @throws IllegalArgumentException if the {@code configuration} is not allowed by the player.
35      * @throws IllegalStateException if too many {@code VolumeShaper}s are requested
36      *         or the state of the player does not permit its creation (e.g. player is released).
37      */
createVolumeShaper( @onNull VolumeShaper.Configuration configuration)38     public @NonNull VolumeShaper createVolumeShaper(
39             @NonNull VolumeShaper.Configuration configuration);
40 }
41