Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

AudioPlaybackConfiguration docs and channel format annotation

Browse Source 
Better javdoc (referencing the Spatializer class) for isSpatialized.
IntDef for result format of getChannelMask

Bug: 265304425
Test: atest AudioPlaybackConfigurationTest
Change-Id: Ic57790a3b1af4232a6dcaa5b724d5dcf4d560d50
This commit is contained in:
Jean-Michel Trivi
2023-01-19 16:22:02 +00:00
parent 7a07aa7264
commit e282cc572e
2 changed files with 37 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
media/java/android/media/AudioFormat.java
View File

@@ -608,6 +608,40 @@ public final class AudioFormat implements Parcelable {
CHANNEL_OUT_LOW_FREQUENCY_2);
// CHANNEL_OUT_ALL is not yet defined; if added then it should match AUDIO_CHANNEL_OUT_ALL
/** @hide */
@IntDef(flag = true, prefix = "CHANNEL_OUT", value = {
CHANNEL_OUT_FRONT_LEFT,
CHANNEL_OUT_FRONT_RIGHT,
CHANNEL_OUT_FRONT_CENTER,
CHANNEL_OUT_LOW_FREQUENCY,
CHANNEL_OUT_BACK_LEFT,
CHANNEL_OUT_BACK_RIGHT,
CHANNEL_OUT_FRONT_LEFT_OF_CENTER,
CHANNEL_OUT_FRONT_RIGHT_OF_CENTER,
CHANNEL_OUT_BACK_CENTER,
CHANNEL_OUT_SIDE_LEFT,
CHANNEL_OUT_SIDE_RIGHT,
CHANNEL_OUT_TOP_CENTER,
CHANNEL_OUT_TOP_FRONT_LEFT,
CHANNEL_OUT_TOP_FRONT_CENTER,
CHANNEL_OUT_TOP_FRONT_RIGHT,
CHANNEL_OUT_TOP_BACK_LEFT,
CHANNEL_OUT_TOP_BACK_CENTER,
CHANNEL_OUT_TOP_BACK_RIGHT,
CHANNEL_OUT_TOP_SIDE_LEFT,
CHANNEL_OUT_TOP_SIDE_RIGHT,
CHANNEL_OUT_BOTTOM_FRONT_LEFT,
CHANNEL_OUT_BOTTOM_FRONT_CENTER,
CHANNEL_OUT_BOTTOM_FRONT_RIGHT,
CHANNEL_OUT_LOW_FREQUENCY_2,
CHANNEL_OUT_FRONT_WIDE_LEFT,
CHANNEL_OUT_FRONT_WIDE_RIGHT,
CHANNEL_OUT_HAPTIC_B,
CHANNEL_OUT_HAPTIC_A
})
@Retention(RetentionPolicy.SOURCE)
public @interface ChannelOut {}
/** Minimum value for sample rate,
* assuming AudioTrack and AudioRecord share the same limitations.
* @hide

5
media/java/android/media/AudioPlaybackConfiguration.java
View File

@@ -559,7 +559,8 @@ public final class AudioPlaybackConfiguration implements Parcelable {
/**
* @hide
* Return whether this player's output is spatialized
* Return whether this player's output is being processed by the spatializer effect backing
* the {@link android.media.Spatializer} implementation.
* @return true if spatialized, false if not or playback hasn't started
*/
@SystemApi
@@ -588,7 +589,7 @@ public final class AudioPlaybackConfiguration implements Parcelable {
* the definitions for the <code>CHANNEL_OUT_*</code> values used for the mask's bitfield
*/
@SystemApi
public int getChannelMask() {
public @AudioFormat.ChannelOut int getChannelMask() {
synchronized (mUpdateablePropLock) {
return (AudioFormat.convertNativeChannelMaskToOutMask(mFormatInfo.mNativeChannelMask));
}