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

Merge "Fix the Tuner Framework javadoc @link format"

Browse Source
This commit is contained in:
Amy Zhang
2020-12-15 20:46:52 +00:00
committed by Android (Google) Code Review
parent 99e0f9b5a1 2605889886
commit 2d1c83c610
20 changed files with 84 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
media/java/android/media/tv/tuner/Descrambler.java
View File

@@ -117,9 +117,9 @@ public class Descrambler implements AutoCloseable {
* <p>A descrambler instance can have only one key slot to link, but a key slot can hold a few
* keys for different purposes. {@link Tuner.VOID_KEYTOKEN} is considered valid.
*
* @param keyToken the token to be used to link the key slot. Use {@link Tuner.VOID_KEYTOKEN}
* @param keyToken the token to be used to link the key slot. Use {@link Tuner#VOID_KEYTOKEN}
* to remove the current key from descrambler. If the current keyToken comes from a
* MediaCas session, use {@link Tuner.VOID_KEYTOKEN} to remove current key before
* MediaCas session, use {@link Tuner#VOID_KEYTOKEN} to remove current key before
* closing the MediaCas session.
* @return result status of the operation.
*/

32
media/java/android/media/tv/tuner/Tuner.java
View File

@@ -685,7 +685,7 @@ public class Tuner implements AutoCloseable {
*
* <p>Tuner resource manager (TRM) uses the client priority value to decide whether it is able
* to get frontend resource. If the client can't get the resource, this call returns {@link
* Result#RESULT_UNAVAILABLE}.
* #RESULT_UNAVAILABLE}.
*
* <p>
* This locks the frontend to a frequency by providing signal
@@ -699,7 +699,7 @@ public class Tuner implements AutoCloseable {
*
* <p>Tuning with {@link android.media.tv.tuner.frontend.DtmbFrontendSettings} is only
* supported in Tuner 1.1 or higher version. Unsupported version will cause no-op. Use {@link
* TunerVersionChecker.getTunerVersion()} to get the version information.
* TunerVersionChecker#getTunerVersion()} to get the version information.
*
* @param settings Signal delivery information the frontend uses to
* search and lock the signal.
@@ -748,7 +748,7 @@ public class Tuner implements AutoCloseable {
*
* <p>Scanning with {@link android.media.tv.tuner.frontend.DtmbFrontendSettings} is only
* supported in Tuner 1.1 or higher version. Unsupported version will cause no-op. Use {@link
* TunerVersionChecker.getTunerVersion()} to get the version information.
* TunerVersionChecker#getTunerVersion()} to get the version information.
*
* @param settings A {@link FrontendSettings} to configure the frontend.
* @param scanType The scan type.
@@ -854,7 +854,7 @@ public class Tuner implements AutoCloseable {
* <p>This retrieve the statuses of the frontend for given status types.
*
* @param statusTypes an array of status types which the caller requests. Any types that are not
* in {@link FrontendInfo.getStatusCapabilities()} would be ignored.
* in {@link FrontendInfo#getStatusCapabilities()} would be ignored.
* @return statuses which response the caller's requests. {@code null} if the operation failed.
*/
@Nullable
@@ -903,7 +903,7 @@ public class Tuner implements AutoCloseable {
* use the output from CI-CAM as the input after this call.
*
* <p> Note that this API is used to connect the CI-CAM to the Demux module while
* {@link connectFrontendToCiCam(int)} is used to connect CI-CAM to the Frontend module.
* {@link #connectFrontendToCiCam(int)} is used to connect CI-CAM to the Frontend module.
*
* @param ciCamId specify CI-CAM Id to connect.
* @return result status of the operation.
@@ -925,20 +925,20 @@ public class Tuner implements AutoCloseable {
* the TS directly from the frontend.
*
* <p> Note that this API is used to connect the CI-CAM to the Frontend module while
* {@link connectCiCam(int)} is used to connect CI-CAM to the Demux module.
* {@link #connectCiCam(int)} is used to connect CI-CAM to the Demux module.
*
* <p>Use {@link #disconnectFrontendToCiCam(int)} to disconnect.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op and return {@link INVALID_LTS_ID}. Use {@link TunerVersionChecker.getTunerVersion()} to
* check the version.
* no-op and return {@link #INVALID_LTS_ID}. Use {@link TunerVersionChecker#getTunerVersion()}
* to check the version.
*
* @param ciCamId specify CI-CAM Id, which is the id of the Conditional Access Modules (CAM)
* Common Interface (CI), to link.
* @return Local transport stream id when connection is successfully established. Failed
* operation returns {@link INVALID_LTS_ID} while unsupported version also returns
* {@link INVALID_LTS_ID}. Check the current HAL version using
* {@link TunerVersionChecker.getTunerVersion()}.
* operation returns {@link #INVALID_LTS_ID} while unsupported version also returns
* {@link #INVALID_LTS_ID}. Check the current HAL version using
* {@link TunerVersionChecker#getTunerVersion()}.
*/
public int connectFrontendToCiCam(int ciCamId) {
if (TunerVersionChecker.checkHigherOrEqualVersionTo(TunerVersionChecker.TUNER_VERSION_1_1,
@@ -956,7 +956,7 @@ public class Tuner implements AutoCloseable {
* <p>The demux will use the output from the frontend as the input after this call.
*
* <p> Note that this API is used to disconnect the CI-CAM to the Demux module while
* {@link disconnectFrontendToCiCam(int)} is used to disconnect CI-CAM to the Frontend module.
* {@link #disconnectFrontendToCiCam(int)} is used to disconnect CI-CAM to the Frontend module.
*
* @return result status of the operation.
*/
@@ -974,15 +974,15 @@ public class Tuner implements AutoCloseable {
* <p>It is used by the client to unlink CI-CAM to a Frontend.
*
* <p> Note that this API is used to disconnect the CI-CAM to the Demux module while
* {@link disconnectCiCam(int)} is used to disconnect CI-CAM to the Frontend module.
* {@link #disconnectCiCam(int)} is used to disconnect CI-CAM to the Frontend module.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param ciCamId specify CI-CAM Id, which is the id of the Conditional Access Modules (CAM)
* Common Interface (CI), to disconnect.
* @return result status of the operation. Unsupported version would return
* {@link RESULT_UNAVAILABLE}
* {@link #RESULT_UNAVAILABLE}
*/
@Result
public int disconnectFrontendToCiCam(int ciCamId) {
@@ -1291,7 +1291,7 @@ public class Tuner implements AutoCloseable {
/**
* Opens a Descrambler in tuner.
*
* @return a {@link Descrambler} object.
* @return a {@link Descrambler} object.
*/
@RequiresPermission(android.Manifest.permission.ACCESS_TV_DESCRAMBLER)
@Nullable

8
media/java/android/media/tv/tuner/filter/AvSettings.java
View File

@@ -251,9 +251,9 @@ public class AvSettings extends Settings {
* Sets the Audio Stream Type.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param audioStreamType the {@link AudioStreamType} to set.
* @param audioStreamType the audio stream type to set.
*/
@NonNull
public Builder setAudioStreamType(@AudioStreamType int audioStreamType) {
@@ -269,9 +269,9 @@ public class AvSettings extends Settings {
* Sets the Video Stream Type.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param videoStreamType the {@link VideoStreamType} to set.
* @param videoStreamType the video stream type to set.
*/
@NonNull
public Builder setVideoStreamType(@VideoStreamType int videoStreamType) {

12
media/java/android/media/tv/tuner/filter/Filter.java
View File

@@ -323,25 +323,25 @@ public class Filter implements AutoCloseable {
}
/**
* Configure the Filter to monitor scrambling status and ip cid change. Set corresponding bit of
* {@link MonitorEventTypeMask} to monitor the change. Reset to stop monitoring.
* Configure the Filter to monitor scrambling status and ip cid change. Set corresponding bit
* to monitor the change. Reset to stop monitoring.
*
* <p>{@link ScramblingStatusEvent} should be sent at the following two scenarios:
* <ul>
* <li>When this method is called with {@link MONITOR_EVENT_SCRAMBLING_STATUS}, the first
* <li>When this method is called with {@link #MONITOR_EVENT_SCRAMBLING_STATUS}, the first
* detected scrambling status should be sent.
* <li>When the Scrambling status transits into different status, event should be sent.
* <ul/>
*
* <p>{@link IpCidChangeEvent} should be sent at the following two scenarios:
* <ul>
* <li>When this method is called with {@link MONITOR_EVENT_IP_CID_CHANGE}, the first detected
* CID for the IP should be sent.
* <li>When this method is called with {@link #MONITOR_EVENT_IP_CID_CHANGE}, the first
* detected CID for the IP should be sent.
* <li>When the CID is changed to different value for the IP filter, event should be sent.
* <ul/>
*
* <p>This configuration is only supported in Tuner 1.1 or higher version. Unsupported version
* will cause no-op. Use {@link TunerVersionChecker.getTunerVersion()} to get the version
* will cause no-op. Use {@link TunerVersionChecker#getTunerVersion()} to get the version
* information.
*
* @param monitorEventTypesMask Types of event to be monitored. Set corresponding bit to

4
media/java/android/media/tv/tuner/filter/IpCidChangeEvent.java
View File

@@ -22,7 +22,7 @@ import android.annotation.SystemApi;
* Ip Cid Change event sent from {@link Filter} objects new ip cid.
*
* <p>This event is only sent in Tuner 1.1 or higher version. Use
* {@link TunerVersionChecker.getTunerVersion()} to get the version information.
* {@link TunerVersionChecker#getTunerVersion()} to get the version information.
*
* @hide
*/
@@ -38,7 +38,7 @@ public final class IpCidChangeEvent extends FilterEvent {
* Gets ip cid.
*
* <p>This event is only sent in Tuner 1.1 or higher version. Use
* {@link TunerVersionChecker.getTunerVersion()} to get the version information.
* {@link TunerVersionChecker#getTunerVersion()} to get the version information.
*/
public int getIpCid() {
return mCid;

4
media/java/android/media/tv/tuner/filter/IpFilterConfiguration.java
View File

@@ -100,7 +100,7 @@ public final class IpFilterConfiguration extends FilterConfiguration {
* Gets the ip filter context id. Default value is {@link #INVALID_IP_FILTER_CONTEXT_ID}.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would return
* default value. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* default value. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@IntRange(from = 0, to = 0xefff)
public int getIpFilterContextId() {
@@ -194,7 +194,7 @@ public final class IpFilterConfiguration extends FilterConfiguration {
* Sets the ip filter context id. Default value is {@link #INVALID_IP_FILTER_CONTEXT_ID}.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
public Builder setIpFilterContextId(int ipContextId) {

16
media/java/android/media/tv/tuner/filter/MmtpRecordEvent.java
View File

@@ -65,8 +65,8 @@ public class MmtpRecordEvent extends FilterEvent {
* Get the MPU sequence number of the filtered data.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link android.media.tv.tuner.Tuner.INVALID_MMTP_RECORD_EVENT_MPT_SEQUENCE_NUM}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version
* return {@link android.media.tv.tuner.Tuner#INVALID_MMTP_RECORD_EVENT_MPT_SEQUENCE_NUM}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version
* information.
*/
public int getMpuSequenceNumber() {
@@ -78,8 +78,8 @@ public class MmtpRecordEvent extends FilterEvent {
* and has the same format as the PTS in ISO/IEC 13818-1.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link android.media.tv.tuner.Tuner.INVALID_TIMESTAMP}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version
* return {@link android.media.tv.tuner.Tuner#INVALID_TIMESTAMP}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version
* information.
*/
public long getPts() {
@@ -90,8 +90,8 @@ public class MmtpRecordEvent extends FilterEvent {
* Get the address of the first macroblock in the slice defined in ITU-T Rec. H.264.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link android.media.tv.tuner.Tuner.INVALID_FIRST_MACROBLOCK_IN_SLICE}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version
* return {@link android.media.tv.tuner.Tuner#INVALID_FIRST_MACROBLOCK_IN_SLICE}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version
* information.
*/
public int getFirstMacroblockInSlice() {
@@ -102,8 +102,8 @@ public class MmtpRecordEvent extends FilterEvent {
* Get the offset of the recorded keyframe from MMT Packet Table.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link RecordSettings.TS_INDEX_INVALID}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the
* return {@link RecordSettings#TS_INDEX_INVALID}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the
* version information.
*/
@RecordSettings.TsIndexMask

2
media/java/android/media/tv/tuner/filter/RestartEvent.java
View File

@@ -22,7 +22,7 @@ import android.annotation.SystemApi;
* An Event that the client would reveice after stopping, reconfiguring and restarting a filter.
*
* <p>After stopping and restarting the filter, the client has to discard all coming events until
* it receive {@link RestartedEvent} to avoid using the events from the previous configuration.
* it receives {@link RestartEvent} to avoid using the events from the previous configuration.
*
* <p>Recofiguring must happen after stopping the filter.
*

4
media/java/android/media/tv/tuner/filter/ScramblingStatusEvent.java
View File

@@ -22,7 +22,7 @@ import android.annotation.SystemApi;
* Scrambling Status event sent from {@link Filter} objects with Scrambling Status type.
*
* <p>This event is only sent in Tuner 1.1 or higher version. Use
* {@link TunerVersionChecker.getTunerVersion()} to get the version information.
* {@link TunerVersionChecker#getTunerVersion()} to get the version information.
*
* @hide
*/
@@ -38,7 +38,7 @@ public final class ScramblingStatusEvent extends FilterEvent {
* Gets Scrambling Status Type.
*
* <p>This event field is only sent in Tuner 1.1 or higher version. Use
* {@link TunerVersionChecker.getTunerVersion()} to get the version information.
* {@link TunerVersionChecker#getTunerVersion()} to get the version information.
*/
@Filter.ScramblingStatus
public int getScramblingStatus() {

8
media/java/android/media/tv/tuner/filter/TsRecordEvent.java
View File

@@ -83,8 +83,8 @@ public class TsRecordEvent extends FilterEvent {
* and has the same format as the PTS in ISO/IEC 13818-1.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link android.media.tv.tuner.Tuner.INVALID_TIMESTAMP}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version
* return {@link android.media.tv.tuner.Tuner#INVALID_TIMESTAMP}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version
* information.
*/
public long getPts() {
@@ -95,8 +95,8 @@ public class TsRecordEvent extends FilterEvent {
* Get the address of the first macroblock in the slice defined in ITU-T Rec. H.264.
*
* <p>This field is only supported in Tuner 1.1 or higher version. Unsupported version will
* return {@link android.media.tv.tuner.Tuner.INVALID_FIRST_MACROBLOCK_IN_SLICE}. Use
* {@link android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version
* return {@link android.media.tv.tuner.Tuner#INVALID_FIRST_MACROBLOCK_IN_SLICE}. Use
* {@link android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version
* information.
*/
public int getFirstMacroblockInSlice() {

2
media/java/android/media/tv/tuner/frontend/AnalogFrontendSettings.java
View File

@@ -264,7 +264,7 @@ public class AnalogFrontendSettings extends FrontendSettings {
* Set Aft flag.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param aftFlag the value to set the aft flag. The default value is
* {@link #AFT_FLAG_UNDEFINED}.

21
media/java/android/media/tv/tuner/frontend/DtmbFrontendCapabilities.java
View File

@@ -46,8 +46,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets modulation capability.
*
* @return full modulation capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.Modulation} is true, then that modulation is supported.
* @return the bit mask of all the supported modulations.
*/
@DtmbFrontendSettings.Modulation
public int getModulationCapability() {
@@ -57,9 +56,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets Transmission Mode capability.
*
* @return full Transmission Mode capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.TransmissionMode} is true, then that transmission mode
* is supported.
* @return the bit mask of all the supported transmission modes.
*/
@DtmbFrontendSettings.TransmissionMode
public int getTransmissionModeCapability() {
@@ -69,9 +66,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets Guard Interval capability.
*
* @return full Guard Interval capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.GuardInterval} is true, then that Guard Interval is
* supported.
* @return the bit mask of all the supported guard intervals.
*/
@DtmbFrontendSettings.GuardInterval
public int getGuardIntervalCapability() {
@@ -81,9 +76,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets Time Interleave Mode capability.
*
* @return full Time Interleave Mode capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.TimeInterleaveMode} is true, then that Time Interleave
* Mode is supported.
* @return the bit mask of all the supported time interleave modes.
*/
@DtmbFrontendSettings.TimeInterleaveMode
public int getTimeInterleaveModeCapability() {
@@ -93,8 +86,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets Code Rate capability.
*
* @return full Code Rate capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.CodeRate} is true, then that Code Rate is supported.
* @return the bit mask of all the supported code rates.
*/
@DtmbFrontendSettings.CodeRate
public int getCodeRateCapability() {
@@ -104,8 +96,7 @@ public final class DtmbFrontendCapabilities extends FrontendCapabilities {
/**
* Gets Bandwidth capability.
*
* @return full Bandwidth capabilies. If the caps bitwise AND with any value from
* bit masks {@link DtmbFrontendSettings.Bandwidth} is true, then that Bandwidth is supported.
* @return the bit mask of all the supported bandwidth.
*/
@DtmbFrontendSettings.Bandwidth
public int getBandwidthCapability() {

2
media/java/android/media/tv/tuner/frontend/DtmbFrontendSettings.java
View File

@@ -29,7 +29,7 @@ import java.lang.annotation.RetentionPolicy;
* Frontend settings for DTMB.
*
* <p>DTMB Frontend is only supported in Tuner HAL 1.1 or higher. Use {@link
* android.media.tv.tuner.TunerVersionChecker.getTunerVersion()} to get the version information.
* android.media.tv.tuner.TunerVersionChecker#getTunerVersion()} to get the version information.
*
* @hide
*/

6
media/java/android/media/tv/tuner/frontend/DvbcFrontendCapabilities.java
View File

@@ -45,9 +45,9 @@ public class DvbcFrontendCapabilities extends FrontendCapabilities {
/**
* Gets inner FEC capability.
*
* @deprecated Use {@link getInnerFecCapability()} with long return value instead. This function
* returns the correct cap value when the value is not bigger than the max integer
* value. Otherwise it returns {@link FrontendSettings#FEC_UNDEFINED}.
* @deprecated Use {@link #getInnerFecCapability()} with long return value instead. This
* function returns the correct cap value when the value is not bigger than the max
* integer value. Otherwise it returns {@link FrontendSettings#FEC_UNDEFINED}.
*/
@Deprecated
@FrontendSettings.InnerFec

6
media/java/android/media/tv/tuner/frontend/DvbcFrontendSettings.java
View File

@@ -120,7 +120,7 @@ public class DvbcFrontendSettings extends FrontendSettings {
/**
* @deprecated Use the {@link FrontendSettings#FrontendSpectralInversion} instead.
* @deprecated Use the {@code FrontendSpectralInversion} instead.
* @hide
*/
@Deprecated
@@ -439,7 +439,7 @@ public class DvbcFrontendSettings extends FrontendSettings {
* Set the time interleave mode.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param interleaveMode the value to set as the time interleave mode. Default value is
* {@link #TIME_INTERLEAVE_MODE_UNDEFINED}.
@@ -456,7 +456,7 @@ public class DvbcFrontendSettings extends FrontendSettings {
* Set the Bandwidth.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param bandwidth the value to set as the bandwidth. Default value is
* {@link #BANDWIDTH_UNDEFINED}.

6
media/java/android/media/tv/tuner/frontend/DvbsFrontendSettings.java
View File

@@ -344,7 +344,7 @@ public class DvbsFrontendSettings extends FrontendSettings {
* Get if the client can handle the Diseqc Rx Message or not. Default value is false.
*
* The setter {@link Builder#setCanHandleDiseqcRxMessage(boolean)} is only supported with
* Tuner HAL 1.1 or higher. Use {@link TunerVersionChecker.getTunerVersion()} to check the
* Tuner HAL 1.1 or higher. Use {@link TunerVersionChecker#getTunerVersion()} to check the
* version.
*/
public boolean canHandleDiseqcRxMessage() {
@@ -394,7 +394,7 @@ public class DvbsFrontendSettings extends FrontendSettings {
* Set the scan type.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param scanType the value to set as the scan type. Default value is
* {@link android.media.tv.tuner.frontend.DvbsFrontendSettings#DVBS_SCAN_TYPE_UNDEFINED}.
@@ -414,7 +414,7 @@ public class DvbsFrontendSettings extends FrontendSettings {
* channel in the hardware layer.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
public Builder setCanHandleDiseqcRxMessage(boolean canHandleDiseqcMessage) {

4
media/java/android/media/tv/tuner/frontend/DvbtFrontendSettings.java
View File

@@ -586,7 +586,7 @@ public class DvbtFrontendSettings extends FrontendSettings {
*
* <p>{@link #TRANSMISSION_MODE_EXTENDED_8K}, {@link #TRANSMISSION_MODE_EXTENDED_16K} and
* {@link #TRANSMISSION_MODE_EXTENDED_32K} are only supported by Tuner HAL 1.1 or higher.
* Unsupported version would cause no-op. Use {@link TunerVersionChecker.getTunerVersion()}
* Unsupported version would cause no-op. Use {@link TunerVersionChecker#getTunerVersion()}
* to check the version.
*
* <p>Default value is {@link #TRANSMISSION_MODE_UNDEFINED}.
@@ -617,7 +617,7 @@ public class DvbtFrontendSettings extends FrontendSettings {
* <p>{@link #CONSTELLATION_QPSK_R}, {@link #CONSTELLATION_16QAM_R},
* {@link #CONSTELLATION_64QAM_R} and {@link #CONSTELLATION_256QAM_Rare} are only supported
* by Tuner HAL 1.1 or higher. Unsupported version would cause no-op. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* <p>Default value is {@link #CONSTELLATION_UNDEFINED}.
*/

2
media/java/android/media/tv/tuner/frontend/FrontendInfo.java
View File

@@ -57,7 +57,7 @@ public class FrontendInfo {
/**
* Gets frontend ID.
*
* @return the frontend ID or {@link android.media.tv.tuner.Tuner.INVALID_FRONTEND_ID}
* @return the frontend ID or {@link android.media.tv.tuner.Tuner#INVALID_FRONTEND_ID}
* if invalid
*/
public int getId() {

4
media/java/android/media/tv/tuner/frontend/FrontendSettings.java
View File

@@ -321,7 +321,7 @@ public abstract class FrontendSettings {
* Set Spectral Inversion.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param inversion the value to set as the spectral inversion. Default value is {@link
* #FRONTEND_SPECTRAL_INVERSION_UNDEFINED}.
@@ -338,7 +338,7 @@ public abstract class FrontendSettings {
* would be no-op.
*
* <p>This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause
* no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version.
* no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version.
*
* @param endFrequency the end frequency used during blind scan. The default value is
* {@link android.media.tv.tuner.Tuner#INVALID_FRONTEND_SETTING_FREQUENCY}.

30
media/java/android/media/tv/tuner/frontend/FrontendStatus.java
View File

@@ -680,7 +680,7 @@ public class FrontendStatus {
* Gets an array of the current extended bit error ratio.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
public int[] getBers() {
@@ -696,7 +696,7 @@ public class FrontendStatus {
* Gets an array of the current code rates.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
@FrontendSettings.InnerFec
@@ -713,7 +713,7 @@ public class FrontendStatus {
* Gets the current bandwidth information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@FrontendBandwidth
public int getBandwidth() {
@@ -729,7 +729,7 @@ public class FrontendStatus {
* Gets the current guard interval information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@FrontendGuardInterval
public int getGuardInterval() {
@@ -745,7 +745,7 @@ public class FrontendStatus {
* Gets the current transmission mode information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@FrontendTransmissionMode
public int getTransmissionMode() {
@@ -762,7 +762,7 @@ public class FrontendStatus {
* since the last tune operation.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
public int getUec() {
TunerVersionChecker.checkHigherOrEqualVersionTo(
@@ -777,7 +777,7 @@ public class FrontendStatus {
* Gets the current DVB-T2 system id.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@IntRange(from = 0, to = 0xffff)
public int getSystemId() {
@@ -793,7 +793,7 @@ public class FrontendStatus {
* Gets an array of the current interleaving mode information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
@FrontendInterleaveMode
@@ -811,7 +811,7 @@ public class FrontendStatus {
* channels.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
@IntRange(from = 0, to = 0xff)
@@ -828,7 +828,7 @@ public class FrontendStatus {
* Gets an array of the Transport Stream Data Rate in BPS of the current channel.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
public int[] getTsDataRate() {
@@ -844,7 +844,7 @@ public class FrontendStatus {
* Gets an array of the current extended modulations information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@NonNull
@FrontendModulation
@@ -861,7 +861,7 @@ public class FrontendStatus {
* Gets the current roll off information.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
@FrontendRollOff
public int getRollOff() {
@@ -877,7 +877,7 @@ public class FrontendStatus {
* Gets is MISO enabled or not.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
public boolean isMisoEnabled() {
TunerVersionChecker.checkHigherOrEqualVersionTo(
@@ -892,7 +892,7 @@ public class FrontendStatus {
* Gets is the Code Rate of the frontend is linear or not.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
public boolean isLinear() {
TunerVersionChecker.checkHigherOrEqualVersionTo(
@@ -907,7 +907,7 @@ public class FrontendStatus {
* Gets is the Short Frames enabled or not.
*
* <p>This query is only supported by Tuner HAL 1.1 or higher. Use
* {@link TunerVersionChecker.getTunerVersion()} to check the version.
* {@link TunerVersionChecker#getTunerVersion()} to check the version.
*/
public boolean isShortFramesEnabled() {
TunerVersionChecker.checkHigherOrEqualVersionTo(