Merge "Tuner API: improve the JavaDoc of Dvr" into rvc-dev am: 03e1b5a327 am: abdbebb860 am: 513bfac9c5

Change-Id: Ie722d628c1ffdc690419b9f0226839c232cac054
This commit is contained in:
Automerger Merge Worker
2020-03-05 05:30:55 +00:00
2 changed files with 22 additions and 4 deletions

View File

@@ -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.
*
* @param fd the file descriptor to read/write 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 data.
* @see #read(long)
* @see #read(byte[], long, long)
*/
public void setFileDescriptor(@NonNull ParcelFileDescriptor fd) {
nativeSetFileDescriptor(fd.getFd());

View File

@@ -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.
*
* @param fd the file descriptor to read/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 write data.
* @see #write(long)
* @see #write(byte[], long, long)
*/
public void setFileDescriptor(@NonNull ParcelFileDescriptor fd) {
nativeSetFileDescriptor(fd.getFd());