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

Merge "docs: Add note to getFrameAtTime() pointing to getScaledFrameAtTime()" into oc-mr1-dev

Browse Source
This commit is contained in:
Andrew Solovay
2017-12-01 19:19:04 +00:00
committed by Android (Google) Code Review
parent 96dad7e0a3 d1be47c3e9
commit 284259a633
1 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
media/java/android/media/MediaMetadataRetriever.java
View File

@@ -226,9 +226,12 @@ public class MediaMetadataRetriever
/** /**
* Call this method after setDataSource(). This method finds a * Call this method after setDataSource(). This method finds a
* representative frame close to the given time position by considering * representative frame close to the given time position by considering
* the given option if possible, and returns it as a bitmap. This is * the given option if possible, and returns it as a bitmap.
* useful for generating a thumbnail for an input data source or just *
* obtain and display a frame at the given time position. * <p>If you don't need a full-resolution
* frame (for example, because you need a thumbnail image), use
* {@link #getScaledFrameAtTime getScaledFrameAtTime()} instead of this
* method.</p>
* *
* @param timeUs The time position where the frame will be retrieved. * @param timeUs The time position where the frame will be retrieved.
* When retrieving the frame at the given time position, there is no * When retrieving the frame at the given time position, there is no
@@ -315,11 +318,15 @@ public class MediaMetadataRetriever
/** /**
* Call this method after setDataSource(). This method finds a * Call this method after setDataSource(). This method finds a
* representative frame close to the given time position if possible, * representative frame close to the given time position if possible,
* and returns it as a bitmap. This is useful for generating a thumbnail * and returns it as a bitmap. Call this method if one does not care
* for an input data source. Call this method if one does not care
* how the frame is found as long as it is close to the given time; * how the frame is found as long as it is close to the given time;
* otherwise, please call {@link #getFrameAtTime(long, int)}. * otherwise, please call {@link #getFrameAtTime(long, int)}.
* *
* <p>If you don't need a full-resolution
* frame (for example, because you need a thumbnail image), use
* {@link #getScaledFrameAtTime getScaledFrameAtTime()} instead of this
* method.</p>
*
* @param timeUs The time position where the frame will be retrieved. * @param timeUs The time position where the frame will be retrieved.
* When retrieving the frame at the given time position, there is no * When retrieving the frame at the given time position, there is no
* guarentee that the data source has a frame located at the position. * guarentee that the data source has a frame located at the position.
@@ -339,11 +346,15 @@ public class MediaMetadataRetriever
/** /**
* Call this method after setDataSource(). This method finds a * Call this method after setDataSource(). This method finds a
* representative frame at any time position if possible, * representative frame at any time position if possible,
* and returns it as a bitmap. This is useful for generating a thumbnail * and returns it as a bitmap. Call this method if one does not
* for an input data source. Call this method if one does not
* care about where the frame is located; otherwise, please call * care about where the frame is located; otherwise, please call
* {@link #getFrameAtTime(long)} or {@link #getFrameAtTime(long, int)} * {@link #getFrameAtTime(long)} or {@link #getFrameAtTime(long, int)}
* *
* <p>If you don't need a full-resolution
* frame (for example, because you need a thumbnail image), use
* {@link #getScaledFrameAtTime getScaledFrameAtTime()} instead of this
* method.</p>
*
* @return A Bitmap containing a representative video frame, which * @return A Bitmap containing a representative video frame, which
* can be null, if such a frame cannot be retrieved. * can be null, if such a frame cannot be retrieved.
* *