1 /* 2 * Copyright (C) 2018 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.audiofx; 18 19 /** 20 * DefaultEffect is the base class for controlling default audio effects linked into the 21 * Android audio framework. 22 * <p>DefaultEffects are effects that get attached automatically to all AudioTracks, 23 * AudioRecords, and MediaPlayer instances meeting some criteria. 24 * <p>Applications should not use the DefaultEffect class directly but one of its derived classes 25 * to control specific types of defaults: 26 * <ul> 27 * <li> {@link android.media.audiofx.SourceDefaultEffect}</li> 28 * <li> {@link android.media.audiofx.StreamDefaultEffect}</li> 29 * </ul> 30 * <p>Creating a DefaultEffect object will register the corresponding effect engine as a default 31 * for the specified criteria. Whenever an audio session meets the criteria, an AudioEffect will 32 * be created and attached to it using the specified priority. 33 * @hide 34 */ 35 36 public abstract class DefaultEffect { 37 /** 38 * System wide unique default effect ID. 39 */ 40 int mId; 41 } 42