summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--media/java/android/media/tv/tuner/dvr/DvrPlayback.java13
-rw-r--r--media/java/android/media/tv/tuner/dvr/DvrRecorder.java13
2 files changed, 22 insertions, 4 deletions
diff --git a/media/java/android/media/tv/tuner/dvr/DvrPlayback.java b/media/java/android/media/tv/tuner/dvr/DvrPlayback.java
index 7c15bb74a94b..dbd9db4b6a45 100644
--- a/media/java/android/media/tv/tuner/dvr/DvrPlayback.java
+++ b/media/java/android/media/tv/tuner/dvr/DvrPlayback.java
@@ -89,6 +89,9 @@ public class DvrPlayback implements AutoCloseable {
/**
* Attaches a filter to DVR interface for recording.
*
+ * <p>There can be multiple filters attached. Attached filters are independent, so the order
+ * doesn't matter.
+ *
* @param filter the filter to be attached.
* @return result status of the operation.
*/
@@ -135,6 +138,7 @@ public class DvrPlayback implements AutoCloseable {
* Stops DVR.
*
* <p>Stops consuming playback data or producing data for recording.
+ * <p>Does nothing if the filter is stopped or not started.</p>
*
* @return result status of the operation.
*/
@@ -164,9 +168,14 @@ public class DvrPlayback implements AutoCloseable {
}
/**
- * Sets file descriptor to read/write data.
+ * Sets file descriptor to read data.
+ *
+ * <p>When a read operation of the filter object is happening, this method should not be
+ * called.
*
- * @param fd the file descriptor to read/write data.
+ * @param fd the file descriptor to read data.
+ * @see #read(long)
+ * @see #read(byte[], long, long)
*/
public void setFileDescriptor(@NonNull ParcelFileDescriptor fd) {
nativeSetFileDescriptor(fd.getFd());
diff --git a/media/java/android/media/tv/tuner/dvr/DvrRecorder.java b/media/java/android/media/tv/tuner/dvr/DvrRecorder.java
index 52ef5e63389f..c1c6c624454e 100644
--- a/media/java/android/media/tv/tuner/dvr/DvrRecorder.java
+++ b/media/java/android/media/tv/tuner/dvr/DvrRecorder.java
@@ -50,6 +50,9 @@ public class DvrRecorder implements AutoCloseable {
/**
* Attaches a filter to DVR interface for recording.
*
+ * <p>There can be multiple filters attached. Attached filters are independent, so the order
+ * doesn't matter.
+ *
* @param filter the filter to be attached.
* @return result status of the operation.
*/
@@ -84,6 +87,7 @@ public class DvrRecorder implements AutoCloseable {
* Starts DVR.
*
* <p>Starts consuming playback data or producing data for recording.
+ * <p>Does nothing if the filter is stopped or not started.</p>
*
* @return result status of the operation.
*/
@@ -125,9 +129,14 @@ public class DvrRecorder implements AutoCloseable {
}
/**
- * Sets file descriptor to read/write data.
+ * Sets file descriptor to write data.
+ *
+ * <p>When a write operation of the filter object is happening, this method should not be
+ * called.
*
- * @param fd the file descriptor to read/write data.
+ * @param fd the file descriptor to write data.
+ * @see #write(long)
+ * @see #write(byte[], long, long)
*/
public void setFileDescriptor(@NonNull ParcelFileDescriptor fd) {
nativeSetFileDescriptor(fd.getFd());