loliball/media
1
0
Fork 0
mirror of https://github.com/androidx/media.git synced 2025-04-30 06:46:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add missing Javadoc for AudioAttributes.

Browse Source 
#minor-release

PiperOrigin-RevId: 427712140
This commit is contained in:
tonihei 2022-02-10 12:20:28 +00:00 committed by Ian Baker
parent ed111cbfaa
commit 4633e404fc
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libraries/common/src/main/java/androidx/media3/common/AudioAttributes.java
View File

@ -43,6 +43,11 @@ import java.lang.reflect.Method;
*/ */
public final class AudioAttributes implements Bundleable { public final class AudioAttributes implements Bundleable {
/**
* The default audio attributes, where the content type is {@link C#CONTENT_TYPE_UNKNOWN}, usage
* is {@link C#USAGE_MEDIA}, capture policy is {@link C#ALLOW_CAPTURE_BY_ALL} and no flags are
* set.
*/
public static final AudioAttributes DEFAULT = new Builder().build(); public static final AudioAttributes DEFAULT = new Builder().build();
/** Builder for {@link AudioAttributes}. */ /** Builder for {@link AudioAttributes}. */
@ -68,19 +73,19 @@ public final class AudioAttributes implements Bundleable {
spatializationBehavior = C.SPATIALIZATION_BEHAVIOR_AUTO; spatializationBehavior = C.SPATIALIZATION_BEHAVIOR_AUTO;
} }
/** @see android.media.AudioAttributes.Builder#setContentType(int) */ /** See {@link android.media.AudioAttributes.Builder#setContentType(int)} */
public Builder setContentType(@C.AudioContentType int contentType) { public Builder setContentType(@C.AudioContentType int contentType) {
this.contentType = contentType; this.contentType = contentType;
return this; return this;
} }
/** @see android.media.AudioAttributes.Builder#setFlags(int) */ /** See {@link android.media.AudioAttributes.Builder#setFlags(int)} */
public Builder setFlags(@C.AudioFlags int flags) { public Builder setFlags(@C.AudioFlags int flags) {
this.flags = flags; this.flags = flags;
return this; return this;
} }
/** @see android.media.AudioAttributes.Builder#setUsage(int) */ /** See {@link android.media.AudioAttributes.Builder#setUsage(int)} */
public Builder setUsage(@C.AudioUsage int usage) { public Builder setUsage(@C.AudioUsage int usage) {
this.usage = usage; this.usage = usage;
return this; return this;
@ -94,7 +99,7 @@ public final class AudioAttributes implements Bundleable {
// TODO[b/190759307] Update javadoc to link to AudioAttributes.Builder#setSpatializationBehavior // TODO[b/190759307] Update javadoc to link to AudioAttributes.Builder#setSpatializationBehavior
// once compile SDK target is set to 32. // once compile SDK target is set to 32.
/** See AudioAttributes.Builder#setSpatializationBehavior(int). */ /** See {@code android.media.AudioAttributes.Builder.setSpatializationBehavior(int)}. */
public Builder setSpatializationBehavior(@C.SpatializationBehavior int spatializationBehavior) { public Builder setSpatializationBehavior(@C.SpatializationBehavior int spatializationBehavior) {
this.spatializationBehavior = spatializationBehavior; this.spatializationBehavior = spatializationBehavior;
return this; return this;
@ -107,10 +112,15 @@ public final class AudioAttributes implements Bundleable {
} }
} }
/** The {@link C.AudioContentType}. */
public final @C.AudioContentType int contentType; public final @C.AudioContentType int contentType;
/** The {@link C.AudioFlags}. */
public final @C.AudioFlags int flags; public final @C.AudioFlags int flags;
/** The {@link C.AudioUsage}. */
public final @C.AudioUsage int usage; public final @C.AudioUsage int usage;
/** The {@link C.AudioAllowedCapturePolicy}. */
public final @C.AudioAllowedCapturePolicy int allowedCapturePolicy; public final @C.AudioAllowedCapturePolicy int allowedCapturePolicy;
/** The {@link C.SpatializationBehavior}. */
public final @C.SpatializationBehavior int spatializationBehavior; public final @C.SpatializationBehavior int spatializationBehavior;
@Nullable private android.media.AudioAttributes audioAttributesV21; @Nullable private android.media.AudioAttributes audioAttributesV21;