summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Hongguang Chen <hgchen@google.com> 2024-08-28 19:11:06 +0000
committer Android (Google) Code Review <android-gerrit@google.com> 2024-08-28 19:11:06 +0000
commitfc8016bf07becb96faf5ce5b4da0cde0f97d8dcd (patch)
tree0c24191c6dabe67ecd28b0f7bfb69d876a0487b3
parent116d632ed439e19b7eb3eac184fc52bcd28d9382 (diff)
parent3076496de8178f07701c1184b9dd4440cdc8e9e7 (diff)
Merge "Refine new tuner api applyFrontendByType javadoc" into main
-rw-r--r--media/java/android/media/tv/tuner/Tuner.java15
1 files changed, 9 insertions, 6 deletions
diff --git a/media/java/android/media/tv/tuner/Tuner.java b/media/java/android/media/tv/tuner/Tuner.java
index d14275ff2fd6..92f6eaf33c88 100644
--- a/media/java/android/media/tv/tuner/Tuner.java
+++ b/media/java/android/media/tv/tuner/Tuner.java
@@ -2533,16 +2533,19 @@ public class Tuner implements AutoCloseable {
/**
* Request a frontend by frontend type.
*
- * <p> This API is used if the applications want to select a frontend with desired type when
- * there are multiple frontends of the same type is there before {@link tune}. The applied
- * frontend will be one of the not in-use frontend. If all frontends are in-use, this API will
- * reclaim and apply the frontend owned by the lowest priority client if current client has
- * higher priority. Otherwise, this API will not apply any frontend and return
- * {@link #RESULT_UNAVAILABLE}.
+ * <p> This API is used (before {@link #tune(FrontendSettings)}) if the applications want to
+ * select a frontend of a particular type for {@link #tune(FrontendSettings)} when there are
+ * multiple frontends of the same type present, allowing the system to select which one is
+ * applied. The applied frontend will be one of the not-in-use frontends. If all frontends are
+ * in-use, this API will reclaim and apply the frontend owned by the lowest priority client if
+ * current client has higher priority. Otherwise, this API will not apply any frontend and
+ * return {@link #RESULT_UNAVAILABLE}.
*
* @param desiredFrontendType the Type of the desired fronted. Should be one of
* {@link android.media.tv.tuner.frontend.FrontendSettings.Type}
* @return result status of open operation.
+ * @see #applyFrontend(FrontendInfo)
+ * @see #tune(FrontendSettings)
*/
@Result
@FlaggedApi(Flags.FLAG_TUNER_W_APIS)