MediaMetadataRetriever

METADATA_KEY_ALBUM

static val METADATA_KEY_ALBUM: Int

The metadata key to retrieve the information about the album title of the data source.

Value: 1

METADATA_KEY_ALBUMARTIST

static val METADATA_KEY_ALBUMARTIST: Int

The metadata key to retrieve the information about the performers or artist associated with the data source.

Value: 13

METADATA_KEY_ARTIST

static val METADATA_KEY_ARTIST: Int

The metadata key to retrieve the information about the artist of the data source.

Value: 2

METADATA_KEY_AUTHOR

static val METADATA_KEY_AUTHOR: Int

The metadata key to retrieve the information about the author of the data source.

Value: 3

METADATA_KEY_BITRATE

static val METADATA_KEY_BITRATE: Int

This key retrieves the average bitrate (in bits/sec), if available.

Value: 20

METADATA_KEY_BITS_PER_SAMPLE

static val METADATA_KEY_BITS_PER_SAMPLE: Int

This key retrieves the bits per sample in numbers of bits, if available. This is a signed 32-bit integer formatted as a string in base 10.

Value: 39

METADATA_KEY_CAPTURE_FRAMERATE

static val METADATA_KEY_CAPTURE_FRAMERATE: Int

This key retrieves the original capture framerate, if it's available. The capture framerate will be a floating point number.

Value: 25

METADATA_KEY_CD_TRACK_NUMBER

static val METADATA_KEY_CD_TRACK_NUMBER: Int

The metadata key to retrieve the numeric string describing the order of the audio data source on its original recording.

Value: 0

METADATA_KEY_COLOR_RANGE

static val METADATA_KEY_COLOR_RANGE: Int

This key retrieves the color range, if available.

Value: 37

METADATA_KEY_COLOR_STANDARD

static val METADATA_KEY_COLOR_STANDARD: Int

This key retrieves the color standard, if available.

Value: 35

METADATA_KEY_COLOR_TRANSFER

static val METADATA_KEY_COLOR_TRANSFER: Int

This key retrieves the color transfer, if available.

Value: 36

METADATA_KEY_COMPILATION

static val METADATA_KEY_COMPILATION: Int

The metadata key to retrieve the music album compilation status.

Value: 15

METADATA_KEY_COMPOSER

static val METADATA_KEY_COMPOSER: Int

The metadata key to retrieve the information about the composer of the data source.

Value: 4

METADATA_KEY_DATE

static val METADATA_KEY_DATE: Int

The metadata key to retrieve the date when the data source was created or modified.

Value: 5

METADATA_KEY_DISC_NUMBER

static val METADATA_KEY_DISC_NUMBER: Int

The metadata key to retrieve the numberic string that describes which part of a set the audio data source comes from.

Value: 14

METADATA_KEY_DURATION

static val METADATA_KEY_DURATION: Int

The metadata key to retrieve the playback duration (in ms) of the data source.

Value: 9

METADATA_KEY_EXIF_LENGTH

static val METADATA_KEY_EXIF_LENGTH: Int

If the media contains EXIF data, this key retrieves the length (in bytes) of the data.

Value: 34

METADATA_KEY_EXIF_OFFSET

static val METADATA_KEY_EXIF_OFFSET: Int

If the media contains EXIF data, this key retrieves the offset (in bytes) of the data.

Value: 33

METADATA_KEY_GENRE

static val METADATA_KEY_GENRE: Int

The metadata key to retrieve the content type or genre of the data source.

Value: 6

METADATA_KEY_HAS_AUDIO

static val METADATA_KEY_HAS_AUDIO: Int

If this key exists the media contains audio content.

Value: 16

METADATA_KEY_HAS_IMAGE

static val METADATA_KEY_HAS_IMAGE: Int

If this key exists the media contains still image content.

Value: 26

METADATA_KEY_HAS_VIDEO

static val METADATA_KEY_HAS_VIDEO: Int

If this key exists the media contains video content.

Value: 17

METADATA_KEY_IMAGE_COUNT

static val METADATA_KEY_IMAGE_COUNT: Int

If the media contains still images, this key retrieves the number of still images.

Value: 27

METADATA_KEY_IMAGE_HEIGHT

static val METADATA_KEY_IMAGE_HEIGHT: Int

If the media contains still images, this key retrieves the height of the primary image.

Value: 30

METADATA_KEY_IMAGE_PRIMARY

static val METADATA_KEY_IMAGE_PRIMARY: Int

If the media contains still images, this key retrieves the image index of the primary image.

Value: 28

METADATA_KEY_IMAGE_ROTATION

static val METADATA_KEY_IMAGE_ROTATION: Int

If the media contains still images, this key retrieves the rotation angle (in degrees clockwise) of the primary image. The image rotation angle must be one of 0, 90, 180, or 270 degrees.

Value: 31

METADATA_KEY_IMAGE_WIDTH

static val METADATA_KEY_IMAGE_WIDTH: Int

If the media contains still images, this key retrieves the width of the primary image.

Value: 29

METADATA_KEY_LOCATION

static val METADATA_KEY_LOCATION: Int

This key retrieves the location information, if available. The location should be specified according to ISO-6709 standard, under a mp4/3gp box "@xyz". Location with longitude of -90 degrees and latitude of 180 degrees will be retrieved as "+180.0000-90.0000/", for instance.

Value: 23

METADATA_KEY_MIMETYPE

static val METADATA_KEY_MIMETYPE: Int

The metadata key to retrieve the mime type of the data source. Some example mime types include: "video/mp4", "audio/mp4", "audio/amr-wb", etc.

Value: 12

METADATA_KEY_NUM_TRACKS

static val METADATA_KEY_NUM_TRACKS: Int

The metadata key to retrieve the number of tracks, such as audio, video, text, in the data source, such as a mp4 or 3gpp file.

Value: 10

METADATA_KEY_SAMPLERATE

static val METADATA_KEY_SAMPLERATE: Int

This key retrieves the sample rate in Hz, if available. This is a signed 32-bit integer formatted as a string in base 10.

Value: 38

METADATA_KEY_TITLE

static val METADATA_KEY_TITLE: Int

The metadata key to retrieve the data source title.

Value: 7

METADATA_KEY_VIDEO_FRAME_COUNT

static val METADATA_KEY_VIDEO_FRAME_COUNT: Int

If the media contains video and this key exists, it retrieves the total number of frames in the video sequence.

Value: 32

METADATA_KEY_VIDEO_HEIGHT

static val METADATA_KEY_VIDEO_HEIGHT: Int

If the media contains video, this key retrieves its height.

Value: 19

METADATA_KEY_VIDEO_ROTATION

static val METADATA_KEY_VIDEO_ROTATION: Int

This key retrieves the video rotation angle in degrees, if available. The video rotation angle may be 0, 90, 180, or 270 degrees.

Value: 24

METADATA_KEY_VIDEO_WIDTH

static val METADATA_KEY_VIDEO_WIDTH: Int

If the media contains video, this key retrieves its width.

Value: 18

METADATA_KEY_WRITER

static val METADATA_KEY_WRITER: Int

The metadata key to retrieve the information of the writer (such as lyricist) of the data source.

Value: 11

METADATA_KEY_XMP_LENGTH

static val METADATA_KEY_XMP_LENGTH: Int

If the media contains XMP data, this key retrieves the length (in bytes) of the data.

Value: 42

METADATA_KEY_XMP_OFFSET

static val METADATA_KEY_XMP_OFFSET: Int

If the media contains XMP data, this key retrieves the offset (in bytes) of the data.

Value: 41

METADATA_KEY_YEAR

static val METADATA_KEY_YEAR: Int

The metadata key to retrieve the year when the data source was created or modified.

Value: 8

OPTION_CLOSEST

static val OPTION_CLOSEST: Int

This option is used with getFrameAtTime(long,int) to retrieve a frame (not necessarily a key frame) associated with a data source that is located closest to or at the given time.

Value: 3

OPTION_CLOSEST_SYNC

static val OPTION_CLOSEST_SYNC: Int

This option is used with getFrameAtTime(long,int) to retrieve a sync (or key) frame associated with a data source that is located closest to (in time) or at the given time.

Value: 2

OPTION_NEXT_SYNC

static val OPTION_NEXT_SYNC: Int

This option is used with getFrameAtTime(long,int) to retrieve a sync (or key) frame associated with a data source that is located right after or at the given time.

Value: 1

OPTION_PREVIOUS_SYNC

static val OPTION_PREVIOUS_SYNC: Int

This option is used with getFrameAtTime(long,int) to retrieve a sync (or key) frame associated with a data source that is located right before or at the given time.

Value: 0

MediaMetadataRetriever

MediaMetadataRetriever()

close

open fun close(): Unit

Releases any acquired resources. Call it when done with the object.

extractMetadata

open fun extractMetadata(keyCode: Int): String?

Call this method after setDataSource(). This method retrieves the meta data value associated with the keyCode. The keyCode currently supported is listed below as METADATA_XXX constants. With any other value, it returns a null pointer.

getEmbeddedPicture

open fun getEmbeddedPicture(): ByteArray?

Call this method after setDataSource(). This method finds the optional graphic or album/cover art associated associated with the data source. If there are more than one pictures, (any) one of them is returned.

getFrameAtIndex

open fun getFrameAtIndex(
    frameIndex: Int, 
    params: MediaMetadataRetriever.BitmapParams
): Bitmap?

This method retrieves a video frame by its index. It should only be called after #setDataSource. After the bitmap is returned, you can query the actual parameters that were used to create the bitmap from the BitmapParams argument, for instance to query the bitmap config used for the bitmap with BitmapParams#getActualConfig.

getFrameAtIndex

open fun getFrameAtIndex(frameIndex: Int): Bitmap?

This method is similar to getFrameAtIndex(int,android.media.MediaMetadataRetriever.BitmapParams) except that the default for BitmapParams will be used.

getFrameAtTime

open fun getFrameAtTime(
    timeUs: Long, 
    option: Int
): Bitmap?

This method is similar to getFrameAtTime(long,int,android.media.MediaMetadataRetriever.BitmapParams) except that the device will choose the actual Bitmap.Config to use.

getFrameAtTime

open fun getFrameAtTime(
    timeUs: Long, 
    option: Int, 
    params: MediaMetadataRetriever.BitmapParams
): Bitmap?

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.

If you don't need a full-resolution frame (for example, because you need a thumbnail image), use #getScaledFrameAtTime instead of this method.

getFrameAtTime

open fun getFrameAtTime(timeUs: Long): Bitmap?

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. 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 getFrameAtTime(long,int).

If you don't need a full-resolution frame (for example, because you need a thumbnail image), use #getScaledFrameAtTime instead of this method.

getFrameAtTime

open fun getFrameAtTime(): Bitmap?

Call this method after setDataSource(). This method finds a representative frame at any time position if possible, and returns it as a bitmap. Call this method if one does not care about where the frame is located; otherwise, please call getFrameAtTime(long) or getFrameAtTime(long,int)

If you don't need a full-resolution frame (for example, because you need a thumbnail image), use #getScaledFrameAtTime instead of this method.

getFramesAtIndex

open fun getFramesAtIndex(
    frameIndex: Int, 
    numFrames: Int, 
    params: MediaMetadataRetriever.BitmapParams
): MutableList<Bitmap!>

This method retrieves a consecutive set of video frames starting at the specified index. It should only be called after #setDataSource. If the caller intends to retrieve more than one consecutive video frames, this method is preferred over getFrameAtIndex(int,android.media.MediaMetadataRetriever.BitmapParams) for efficiency. After the bitmaps are returned, you can query the actual parameters that were used to create the bitmaps from the BitmapParams argument, for instance to query the bitmap config used for the bitmaps with BitmapParams#getActualConfig.

getFramesAtIndex

open fun getFramesAtIndex(
    frameIndex: Int, 
    numFrames: Int
): MutableList<Bitmap!>

This method is similar to getFramesAtIndex(int,int,android.media.MediaMetadataRetriever.BitmapParams) except that the default for BitmapParams will be used.

getImageAtIndex

open fun getImageAtIndex(
    imageIndex: Int, 
    params: MediaMetadataRetriever.BitmapParams
): Bitmap?

This method retrieves a still image by its index. It should only be called after #setDataSource. After the bitmap is returned, you can query the actual parameters that were used to create the bitmap from the BitmapParams argument, for instance to query the bitmap config used for the bitmap with BitmapParams#getActualConfig.

getImageAtIndex

open fun getImageAtIndex(imageIndex: Int): Bitmap?

This method is similar to getImageAtIndex(int,android.media.MediaMetadataRetriever.BitmapParams) except that the default for BitmapParams will be used.

getPrimaryImage

open fun getPrimaryImage(params: MediaMetadataRetriever.BitmapParams): Bitmap?

This method retrieves the primary image of the media content. It should only be called after #setDataSource. After the bitmap is returned, you can query the actual parameters that were used to create the bitmap from the BitmapParams argument, for instance to query the bitmap config used for the bitmap with BitmapParams#getActualConfig.

getPrimaryImage

open fun getPrimaryImage(): Bitmap?

This method is similar to getPrimaryImage(android.media.MediaMetadataRetriever.BitmapParams) except that the default for BitmapParams will be used.

getScaledFrameAtTime

open fun getScaledFrameAtTime(
    timeUs: Long, 
    option: Int, 
    dstWidth: Int, 
    dstHeight: Int
): Bitmap?

This method is similar to getScaledFrameAtTime(long,int,int,int,android.media.MediaMetadataRetriever.BitmapParams) except that the device will choose the actual Bitmap.Config to use.

getScaledFrameAtTime

open fun getScaledFrameAtTime(
    timeUs: Long, 
    option: Int, 
    dstWidth: Int, 
    dstHeight: Int, 
    params: MediaMetadataRetriever.BitmapParams
): Bitmap?

Retrieve a video frame near a given timestamp scaled to a desired size. 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 with same aspect ratio as the source while scaling it so that it fits into the desired size of dst_width by dst_height. This is useful for generating a thumbnail for an input data source or just to obtain a scaled frame at the given time position.

release

open fun release(): Unit

Releases any acquired resources. Call it when done with the object.

setDataSource

open fun setDataSource(path: String!): Unit

Sets the data source (file pathname) to use. Call this method before the rest of the methods in this class. This method may be time-consuming.

setDataSource

open fun setDataSource(
    uri: String!, 
    headers: MutableMap<String!, String!>!
): Unit

Sets the data source (URI) to use. Call this method before the rest of the methods in this class. This method may be time-consuming.

setDataSource

open fun setDataSource(
    fd: FileDescriptor!, 
    offset: Long, 
    length: Long
): Unit

Sets the data source (FileDescriptor) to use. It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns. Call this method before the rest of the methods in this class. This method may be time-consuming.

setDataSource

open fun setDataSource(fd: FileDescriptor!): Unit

Sets the data source (FileDescriptor) to use. It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns. Call this method before the rest of the methods in this class. This method may be time-consuming.

setDataSource

open fun setDataSource(
    context: Context!, 
    uri: Uri!
): Unit

Sets the data source as a content Uri. Call this method before the rest of the methods in this class. This method may be time-consuming.

setDataSource

open fun setDataSource(dataSource: MediaDataSource!): Unit

Sets the data source (MediaDataSource) to use.

finalize

protected open fun finalize(): Unit