Added in API level 1
Deprecated in API level 29

Thumbnails

Kotlin |Java

class Thumbnails : BaseColumns

kotlin.Any
↳	android.provider.MediaStore.Images.Thumbnails

This class provides utility methods to obtain thumbnails for various Images items.

Summary

Constants
static String	`DATA` Path to the thumbnail file on disk.
static String	`DEFAULT_SORT_ORDER` The default sort order for this table
static Int	`FULL_SCREEN_KIND`
static String	`HEIGHT` The height of the thumbnail This constant represents a column name that can be used with a `android.content.ContentProvider` through a `android.content.ContentValues` or `android.database.Cursor` object.
static String	`IMAGE_ID` The original image for the thumbnal This constant represents a column name that can be used with a `android.content.ContentProvider` through a `android.content.ContentValues` or `android.database.Cursor` object.
static String	`KIND` The kind of the thumbnail This constant represents a column name that can be used with a `android.content.ContentProvider` through a `android.content.ContentValues` or `android.database.Cursor` object.
static Int	`MICRO_KIND`
static Int	`MINI_KIND`
static String	`THUMB_DATA` The blob raw data of thumbnail This constant represents a column name that can be used with a `android.content.ContentProvider` through a `android.content.ContentValues` or `android.database.Cursor` object.
static String	`WIDTH` The width of the thumbnal This constant represents a column name that can be used with a `android.content.ContentProvider` through a `android.content.ContentValues` or `android.database.Cursor` object.

Inherited constants

From class BaseColumns

String

_COUNT

The count of rows in a directory.

Type: INTEGER

String

_ID

The unique ID for a row.

Type: INTEGER (long)

Public constructors
`Thumbnails()`

Public methods
open static Unit	`cancelThumbnailRequest(cr: ContentResolver!, origId: Long)` Cancel any outstanding #getThumbnail requests, causing them to return by throwing a `OperationCanceledException`.
open static Unit	`cancelThumbnailRequest(cr: ContentResolver!, origId: Long, groupId: Long)` Cancel any outstanding #getThumbnail requests, causing them to return by throwing a `OperationCanceledException`.
open static Uri!	`getContentUri(volumeName: String!)` Get the content:// style URI for the image media table on the given volume.
open static Size	`getKindSize(kind: Int)` Return the typical `Size` (in pixels) used internally when the given thumbnail kind is requested.
open static Bitmap!	`getThumbnail(cr: ContentResolver!, imageId: Long, kind: Int, options: BitmapFactory.Options!)` Return thumbnail representing a specific image item.
open static Bitmap!	`getThumbnail(cr: ContentResolver!, imageId: Long, groupId: Long, kind: Int, options: BitmapFactory.Options!)` Return thumbnail representing a specific image item.
static Cursor!	`query(cr: ContentResolver!, uri: Uri!, projection: Array<String!>!)`
static Cursor!	`queryMiniThumbnail(cr: ContentResolver!, origId: Long, kind: Int, projection: Array<String!>!)`
static Cursor!	`queryMiniThumbnails(cr: ContentResolver!, uri: Uri!, kind: Int, projection: Array<String!>!)`

Properties
static Uri!	`EXTERNAL_CONTENT_URI` The content:// style URI for the "primary" external storage volume.
static Uri!	`INTERNAL_CONTENT_URI` The content:// style URI for the internal storage.

Constants

DATA

Added in API level 1

static val DATA: String

Deprecated: Deprecated in Java.

Path to the thumbnail file on disk. As of android.os.Build.VERSION_CODES#Q, this thumbnail has correct rotation, don't need to rotate it again.
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_STRING .

Value: "_data"

DEFAULT_SORT_ORDER

Added in API level 1

static val DEFAULT_SORT_ORDER: String

Deprecated: Deprecated in Java.

The default sort order for this table

Value: "image_id ASC"

FULL_SCREEN_KIND

Added in API level 1

static val FULL_SCREEN_KIND: Int

Deprecated: Deprecated in Java.

Value: 2

HEIGHT

Added in API level 1

static val HEIGHT: String

Deprecated: Deprecated in Java.

The height of the thumbnail
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_INTEGER , and are read-only and cannot be mutated.

Value: "height"

IMAGE_ID

Added in API level 1

static val IMAGE_ID: String

Deprecated: Deprecated in Java.

The original image for the thumbnal
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_INTEGER .

Value: "image_id"

KIND

Added in API level 1

static val KIND: String

Deprecated: Deprecated in Java.

The kind of the thumbnail
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_INTEGER .

Value: "kind"

MICRO_KIND

Added in API level 1

static val MICRO_KIND: Int

Deprecated: Deprecated in Java.

Value: 3

MINI_KIND

Added in API level 1

static val MINI_KIND: Int

Deprecated: Deprecated in Java.

Value: 1

THUMB_DATA

Added in API level 5
Deprecated in API level 29

static val THUMB_DATA: String

Deprecated: this column never existed internally, and could never have returned valid data.

The blob raw data of thumbnail
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_BLOB .

Value: "thumb_data"

WIDTH

Added in API level 1

static val WIDTH: String

Deprecated: Deprecated in Java.

The width of the thumbnal
This constant represents a column name that can be used with a android.content.ContentProvider through a android.content.ContentValues or android.database.Cursor object. The values stored in this column are Cursor#FIELD_TYPE_INTEGER , and are read-only and cannot be mutated.

Value: "width"

Public constructors

Thumbnails

Added in API level 1

Thumbnails()

Public methods

cancelThumbnailRequest

Added in API level 5
Deprecated in API level 29

open static fun cancelThumbnailRequest(
    cr: ContentResolver!, 
    origId: Long
): Unit

Deprecated: Callers should migrate to using ContentResolver.loadThumbnail, since it offers richer control over requested thumbnail sizes and cancellation behavior.

Cancel any outstanding #getThumbnail requests, causing them to return by throwing a OperationCanceledException.

This method has no effect on ContentResolver.loadThumbnail calls, since they provide their own CancellationSignal.

cancelThumbnailRequest

Added in API level 8
Deprecated in API level 29

open static fun cancelThumbnailRequest(
    cr: ContentResolver!, 
    origId: Long, 
    groupId: Long
): Unit

Deprecated: Callers should migrate to using ContentResolver.loadThumbnail, since it offers richer control over requested thumbnail sizes and cancellation behavior.

Cancel any outstanding #getThumbnail requests, causing them to return by throwing a OperationCanceledException.

This method has no effect on ContentResolver.loadThumbnail calls, since they provide their own CancellationSignal.

getContentUri

Added in API level 1

open static fun getContentUri(volumeName: String!): Uri!

Deprecated: Deprecated in Java.

Get the content:// style URI for the image media table on the given volume.

Parameters
`volumeName`	String!: the name of the volume to get the URI for

Return
`Uri!`	the URI to the image media table on the given volume

getKindSize

Added in API level 30
Deprecated in API level 29

open static fun getKindSize(kind: Int): Size

Deprecated: Callers should migrate to using ContentResolver.loadThumbnail, since it offers richer control over requested thumbnail sizes and cancellation behavior.

Return the typical Size (in pixels) used internally when the given thumbnail kind is requested.

Return
`Size`	This value cannot be `null`.

getThumbnail

Added in API level 5
Deprecated in API level 29

open static fun getThumbnail(
    cr: ContentResolver!, 
    imageId: Long, 
    kind: Int, 
    options: BitmapFactory.Options!
): Bitmap!

Deprecated: Callers should migrate to using ContentResolver.loadThumbnail, since it offers richer control over requested thumbnail sizes and cancellation behavior.

Return thumbnail representing a specific image item. If a thumbnail doesn't exist, this method will block until it's generated. Callers are responsible for their own in-memory caching of returned values. As of android.os.Build.VERSION_CODES#Q, this output of the thumbnail has correct rotation, don't need to rotate it again.

Parameters
`imageId`	Long: the image item to obtain a thumbnail for.
`kind`	Int: optimal thumbnail size desired.

Return
`Bitmap!`	decoded thumbnail, or `null` if problem was encountered.

getThumbnail

Added in API level 8
Deprecated in API level 29

open static fun getThumbnail(
    cr: ContentResolver!, 
    imageId: Long, 
    groupId: Long, 
    kind: Int, 
    options: BitmapFactory.Options!
): Bitmap!

Deprecated: Callers should migrate to using ContentResolver.loadThumbnail, since it offers richer control over requested thumbnail sizes and cancellation behavior.

Parameters
`imageId`	Long: the image item to obtain a thumbnail for.
`kind`	Int: optimal thumbnail size desired.

Return
`Bitmap!`	decoded thumbnail, or `null` if problem was encountered.

query

Added in API level 1

static fun query(
    cr: ContentResolver!, 
    uri: Uri!, 
    projection: Array<String!>!
): Cursor!

Deprecated: all queries should be performed through ContentResolver directly, which offers modern features like CancellationSignal.

queryMiniThumbnail

Added in API level 1

static fun queryMiniThumbnail(
    cr: ContentResolver!, 
    origId: Long, 
    kind: Int, 
    projection: Array<String!>!
): Cursor!

Deprecated: all queries should be performed through ContentResolver directly, which offers modern features like CancellationSignal.

queryMiniThumbnails

Added in API level 1

static fun queryMiniThumbnails(
    cr: ContentResolver!, 
    uri: Uri!, 
    kind: Int, 
    projection: Array<String!>!
): Cursor!

Deprecated: all queries should be performed through ContentResolver directly, which offers modern features like CancellationSignal.

Properties

EXTERNAL_CONTENT_URI

Added in API level 1

static val EXTERNAL_CONTENT_URI: Uri!

Deprecated: Deprecated in Java.

The content:// style URI for the "primary" external storage volume.

INTERNAL_CONTENT_URI

Added in API level 1

static val INTERNAL_CONTENT_URI: Uri!

Deprecated: Deprecated in Java.

The content:// style URI for the internal storage.