Merge "Fix the Tuner Framework javadoc @link format" (2d1c83c6) · Commits · e / os / android_frameworks_base

media/java/android/media/tv/tuner/Descrambler.java

+2 −2

Original line number	Diff line number	Diff line
		@@ -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.
		*/

media/java/android/media/tv/tuner/Tuner.java

+16 −16

Original line number	Diff line number	Diff line
		@@ -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) {

media/java/android/media/tv/tuner/filter/AvSettings.java

+4 −4

Original line number	Diff line number	Diff line
		@@ -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) {

media/java/android/media/tv/tuner/filter/Filter.java

+6 −6

Original line number	Diff line number	Diff line
		@@ -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

media/java/android/media/tv/tuner/filter/IpCidChangeEvent.java

+2 −2

Original line number	Diff line number	Diff line
		@@ -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;