Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1be47c3 authored by Andrew Solovay's avatar Andrew Solovay
Browse files

docs: Add note to getFrameAtTime() pointing to getScaledFrameAtTime() 

Added a note to the various getFrame... methods saying that if you
don't need a full-resolution frame, getScaledFrameAtTime() is
preferable. Removed existing text suggesting you use those other
methods for fetching a thumbnail.

Staged revised doc to:

http://go/dac-stage/reference/android/media/MediaMetadataRetriever.html

Bug: 69804003
Test: make ds-docs
Change-Id: I54250b2d127987ef3c1633c011f5eac6b747372e
parent b94e697d

media/java/android/media/MediaMetadataRetriever.java

+18 −7
Original line number Diff line number Diff line
@@ -226,9 +226,12 @@ public class MediaMetadataRetriever 
    /**

     * Call this method after setDataSource(). This method finds a

     * representative frame close to the given time position by considering

     * the given option if possible, and returns it as a bitmap. This is

     * useful for generating a thumbnail for an input data source or just

     * obtain and display a frame at the given time position.

     * the given option if possible, and returns it as a bitmap.

     *

     * <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.

     * 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

     * representative frame close to the given time position if possible,

     * and returns it as a bitmap. This is useful for generating a thumbnail

     * for an input data source. Call this method if one does not care

     * and returns it as a bitmap. Call this method if one does not care

     * how the frame is found as long as it is close to the given time;

     * 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.

     * When retrieving the frame at the given time position, there is no

     * 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

     * representative frame at any time position if possible,

     * and returns it as a bitmap. This is useful for generating a thumbnail

     * for an input data source. Call this method if one does not

     * and returns it as a bitmap. Call this method if one does not

     * care about where the frame is located; otherwise, please call

     * {@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

     *         can be null, if such a frame cannot be retrieved.

     *