xref: /aosp_15_r20/frameworks/av/media/libaudioclient/aidl/android/media/SurroundSoundConfig.aidl (revision ec779b8e0859a360c3d303172224686826e6e0e1)
1 /*
2  * Copyright (C) 2023 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.media.audio.common.AudioFormatDescription;
20 
21 /**
22  * TODO(b/280077672): This is a temporary copy of the stable
23  * android.hardware.audio.core.SurroundSoundConfig parcelable.
24  * Interfaces from the Core API do not support the CPP backend. This copy will
25  * be removed either by moving the AudioRoute from core to a.m.a.common or by
26  * switching the framework internal interfaces to the NDK backend.
27  * {@hide}
28  */
29 parcelable SurroundSoundConfig {
30     parcelable SurroundFormatFamily {
31         /**
32          * A primaryFormat shall get an entry in the Surround Settings dialog on TV
33          * devices. There must be a corresponding Java ENCODING_... constant
34          * defined in AudioFormat.java, and a display name defined in
35          * AudioFormat.toDisplayName.
36          */
37         AudioFormatDescription primaryFormat;
38         /**
39          * List of formats that shall be equivalent to the primaryFormat from the
40          * users' point of view and don't need a dedicated Surround Settings
41          * dialog entry.
42          */
43         AudioFormatDescription[] subFormats;
44     }
45     SurroundFormatFamily[] formatFamilies;
46 }
47