Merge "Fix missing javadoc links in radio API" into main (5d9641f1) · Commits · e / os / android_frameworks_base

core/java/android/hardware/radio/ProgramSelector.java

+14 −14

Original line number	Original line	Diff line number	Diff line
	@@ -62,55 +62,55 @@ import java.util.stream.Stream;
	@SystemApi		@SystemApi
	public final class ProgramSelector implements Parcelable {		public final class ProgramSelector implements Parcelable {
	/** Invalid program type.		/** Invalid program type.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link IdentifierType} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_INVALID = 0;		public static final int PROGRAM_TYPE_INVALID = 0;
	/** Analog AM radio (with or without RDS).		/** Analog AM radio (with or without RDS).
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link IdentifierType} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_AM = 1;		public static final int PROGRAM_TYPE_AM = 1;
	/** analog FM radio (with or without RDS).		/** analog FM radio (with or without RDS).
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link IdentifierType} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_FM = 2;		public static final int PROGRAM_TYPE_FM = 2;
	/** AM HD Radio.		/** AM HD Radio.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_AM_HD = 3;		public static final int PROGRAM_TYPE_AM_HD = 3;
	/** FM HD Radio.		/** FM HD Radio.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_FM_HD = 4;		public static final int PROGRAM_TYPE_FM_HD = 4;
	/** Digital audio broadcasting.		/** Digital audio broadcasting.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_DAB = 5;		public static final int PROGRAM_TYPE_DAB = 5;
	/** Digital Radio Mondiale.		/** Digital Radio Mondiale.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_DRMO = 6;		public static final int PROGRAM_TYPE_DRMO = 6;
	/** SiriusXM Satellite Radio.		/** SiriusXM Satellite Radio.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_SXM = 7;		public static final int PROGRAM_TYPE_SXM = 7;
	/** Vendor-specific, not synced across devices.		/** Vendor-specific, not synced across devices.
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	*/		*/
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_VENDOR_START = 1000;		public static final int PROGRAM_TYPE_VENDOR_START = 1000;
	/** @deprecated use {@link ProgramIdentifier} instead */		/** @deprecated use {@link Identifier} instead */
	@Deprecated		@Deprecated
	public static final int PROGRAM_TYPE_VENDOR_END = 1999;		public static final int PROGRAM_TYPE_VENDOR_END = 1999;
	/**		/**
	* @deprecated use {@link ProgramIdentifier} instead		* @deprecated use {@link Identifier} instead
	* @removed mistakenly exposed previously		* @removed mistakenly exposed previously
	*/		*/
	@Deprecated		@Deprecated
	@@ -271,7 +271,7 @@ public final class ProgramSelector implements Parcelable {
	*/		*/
	public static final int IDENTIFIER_TYPE_HD_STATION_NAME = 10004;		public static final int IDENTIFIER_TYPE_HD_STATION_NAME = 10004;
	/**		/**
	* @see {@link IDENTIFIER_TYPE_DAB_SID_EXT}		* @see #IDENTIFIER_TYPE_DAB_SID_EXT
	*		*
	* @deprecated use {@link #IDENTIFIER_TYPE_DAB_DMB_SID_EXT} instead		* @deprecated use {@link #IDENTIFIER_TYPE_DAB_DMB_SID_EXT} instead
	*/		*/
	@@ -381,7 +381,7 @@ public final class ProgramSelector implements Parcelable {
	*/		*/
	public static final int IDENTIFIER_TYPE_VENDOR_START = PROGRAM_TYPE_VENDOR_START;		public static final int IDENTIFIER_TYPE_VENDOR_START = PROGRAM_TYPE_VENDOR_START;
	/**		/**
	* @see {@link IDENTIFIER_TYPE_VENDOR_START}		* @see #IDENTIFIER_TYPE_VENDOR_START
	*/		*/
	public static final int IDENTIFIER_TYPE_VENDOR_END = PROGRAM_TYPE_VENDOR_END;		public static final int IDENTIFIER_TYPE_VENDOR_END = PROGRAM_TYPE_VENDOR_END;
	/**		/**
	@@ -771,7 +771,7 @@ public final class ProgramSelector implements Parcelable {
	* Returns whether this Identifier's type is considered a category when filtering		* Returns whether this Identifier's type is considered a category when filtering
	* ProgramLists for category entries.		* ProgramLists for category entries.
	*		*
	* @see {@link ProgramList.Filter#areCategoriesIncluded()}		* @see ProgramList.Filter#areCategoriesIncluded
	* @return False if this identifier's type is not tuneable (e.g. DAB ensemble or		* @return False if this identifier's type is not tuneable (e.g. DAB ensemble or
	* vendor-specified type). True otherwise.		* vendor-specified type). True otherwise.
	*/		*/

core/java/android/hardware/radio/RadioManager.java

+6 −5

Original line number	Original line	Diff line number	Diff line
	@@ -311,7 +311,7 @@ public class RadioManager {
	}		}

	/** Unique module identifier provided by the native service.		/** Unique module identifier provided by the native service.
	* For use with {@link #openTuner(int, BandConfig, boolean, Callback, Handler)}.		* For use with {@link #openTuner(int, BandConfig, boolean, RadioTuner.Callback, Handler)}.
	* @return the radio module unique identifier.		* @return the radio module unique identifier.
	*/		*/
	public int getId() {		public int getId() {
	@@ -1561,7 +1561,7 @@ public class RadioManager {
	/** Main channel expressed in units according to band type.		/** Main channel expressed in units according to band type.
	* Currently all defined band types express channels as frequency in kHz		* Currently all defined band types express channels as frequency in kHz
	* @return the program channel		* @return the program channel
	* @deprecated Use {@link getSelector()} instead.		* @deprecated Use {@link ProgramInfo#getSelector} instead.
	*/		*/
	@Deprecated		@Deprecated
	public int getChannel() {		public int getChannel() {
	@@ -1575,7 +1575,7 @@ public class RadioManager {

	/** Sub channel ID. E.g 1 for HD radio HD1		/** Sub channel ID. E.g 1 for HD radio HD1
	* @return the program sub channel		* @return the program sub channel
	* @deprecated Use {@link getSelector()} instead.		* @deprecated Use {@link ProgramInfo#getSelector} instead.
	*/		*/
	@Deprecated		@Deprecated
	public int getSubChannel() {		public int getSubChannel() {
	@@ -1604,7 +1604,7 @@ public class RadioManager {

	/** {@code true} if the received program is digital (e.g HD radio)		/** {@code true} if the received program is digital (e.g HD radio)
	* @return {@code true} if digital, {@code false} otherwise.		* @return {@code true} if digital, {@code false} otherwise.
	* @deprecated Use {@link getLogicallyTunedTo()} instead.		* @deprecated Use {@link ProgramInfo#getLogicallyTunedTo()} instead.
	*/		*/
	@Deprecated		@Deprecated
	public boolean isDigital() {		public boolean isDigital() {
	@@ -1913,7 +1913,8 @@ public class RadioManager {
	* Removes previously registered announcement listener.		* Removes previously registered announcement listener.
	*		*
	* @param listener announcement listener, previously registered with		* @param listener announcement listener, previously registered with
	* {@link addAnnouncementListener}		* {@link #addAnnouncementListener(Executor, Set, Announcement.OnListUpdatedListener)}
			* or {@link #addAnnouncementListener(Set, Announcement.OnListUpdatedListener)}
	*/		*/
	@RequiresPermission(Manifest.permission.ACCESS_BROADCAST_RADIO)		@RequiresPermission(Manifest.permission.ACCESS_BROADCAST_RADIO)
	public void removeAnnouncementListener(@NonNull Announcement.OnListUpdatedListener listener) {		public void removeAnnouncementListener(@NonNull Announcement.OnListUpdatedListener listener) {

core/java/android/hardware/radio/RadioMetadata.java

+3 −3

Original line number	Original line	Diff line number	Diff line
	@@ -593,7 +593,7 @@ public final class RadioMetadata implements Parcelable {
	* Helper for getting the String key used by {@link RadioMetadata} from the		* Helper for getting the String key used by {@link RadioMetadata} from the
	* corrsponding native integer key.		* corrsponding native integer key.
	*		*
	* @param editorKey The key used by the editor		* @param nativeKey The key used by the editor
	* @return the key used by this class or null if no mapping exists		* @return the key used by this class or null if no mapping exists
	* @hide		* @hide
	*/		*/
	@@ -743,11 +743,11 @@ public final class RadioMetadata implements Parcelable {
	* Put a {@link RadioMetadata.Clock} into the meta data. Custom keys may be used, but if the		* Put a {@link RadioMetadata.Clock} into the meta data. Custom keys may be used, but if the
	* METADATA_KEYs defined in this class are used they may only be one of the following:		* METADATA_KEYs defined in this class are used they may only be one of the following:
	* <ul>		* <ul>
	* <li>{@link #MEADATA_KEY_CLOCK}</li>		* <li>{@link #METADATA_KEY_CLOCK}</li>
	* </ul>		* </ul>
	*		*
	* @param utcSecondsSinceEpoch Number of seconds since epoch for UTC + 0 timezone.		* @param utcSecondsSinceEpoch Number of seconds since epoch for UTC + 0 timezone.
	* @param timezoneOffsetInMinutes Offset of timezone from UTC + 0 in minutes.		* @param timezoneOffsetMinutes Offset of timezone from UTC + 0 in minutes.
	* @return the same Builder instance.		* @return the same Builder instance.
	*/		*/
	public Builder putClock(String key, long utcSecondsSinceEpoch, int timezoneOffsetMinutes) {		public Builder putClock(String key, long utcSecondsSinceEpoch, int timezoneOffsetMinutes) {