AudioAttributes FLAG_AUDIBILITY_ENFORCED javadoc update

More documentation on the behavior of FLAG_AUDIBILITY_ENFORCED
and its intended use.

Bug: 190612108
Test: make doc-comment-check-docs
Change-Id: Ib982e1185c02e0f55024e6cae6bb18896a994ae3
This commit is contained in:
Jean-Michel Trivi
2021-06-30 09:13:27 -07:00
parent e05b631948
commit e8fb9cb844

View File

@@ -335,6 +335,10 @@ public final class AudioAttributes implements Parcelable {
/**
* Flag defining a behavior where the audibility of the sound will be ensured by the system.
* To ensure sound audibility, the system only uses built-in speakers or wired headphones
* and specifically excludes wireless audio devices.
* <p>Note this flag should only be used for sounds subject to regulatory behaviors in some
* countries, such as for camera shutter sound, and not for routing behaviors.
*/
public final static int FLAG_AUDIBILITY_ENFORCED = 0x1 << 0;
/**