MediaStore
public
final
class
MediaStore
extends Object
| java.lang.Object | |
| ↳ | android.provider.MediaStore |
The contract between the media provider and applications. Contains definitions for the supported URIs and columns.
The media provider provides an indexed collection of common media types, such
as Audio, Video, and Images, from any attached
storage devices. Each collection is organized based on the primary MIME type
of the underlying content; for example, image/* content is indexed
under Images. The Files collection provides a broad view
across all collections, and does not filter by MIME type.
Summary
Nested classes | |
|---|---|
class |
MediaStore.Audio
Collection of all media with MIME type of |
interface |
MediaStore.DownloadColumns
Download metadata columns. |
class |
MediaStore.Downloads
Collection of downloaded items. |
class |
MediaStore.Files
Media provider table containing an index of all files in the media storage, including non-media files. |
class |
MediaStore.Images
Collection of all media with MIME type of |
interface |
MediaStore.MediaColumns
Common media metadata columns. |
class |
MediaStore.Video
Collection of all media with MIME type of |
Constants | |
|---|---|
String |
ACTION_IMAGE_CAPTURE
Standard Intent action that can be sent to have the camera application capture an image and return it. |
String |
ACTION_IMAGE_CAPTURE_SECURE
Intent action that can be sent to have the camera application capture an image and return it when the device is secured (e.g. |
String |
ACTION_REVIEW
Standard action that can be sent to review the given media file. |
String |
ACTION_REVIEW_SECURE
Standard action that can be sent to review the given media file when the device is secured (e.g. |
String |
ACTION_VIDEO_CAPTURE
Standard Intent action that can be sent to have the camera application capture a video and return it. |
String |
AUTHORITY
The authority for the media provider |
String |
EXTRA_BRIGHTNESS
When defined, the launched application is requested to set the given
brightness value via
|
String |
EXTRA_DURATION_LIMIT
Specify the maximum allowed recording duration in seconds. |
String |
EXTRA_FINISH_ON_COMPLETION
The name of the Intent-extra used to control the onCompletion behavior of a MovieView. |
String |
EXTRA_FULL_SCREEN
The name of an Intent-extra used to control the UI of a ViewImage. |
String |
EXTRA_MEDIA_ALBUM
The name of the Intent-extra used to define the album |
String |
EXTRA_MEDIA_ARTIST
The name of the Intent-extra used to define the artist |
String |
EXTRA_MEDIA_FOCUS
The name of the Intent-extra used to define the search focus. |
String |
EXTRA_MEDIA_GENRE
The name of the Intent-extra used to define the genre. |
String |
EXTRA_MEDIA_PLAYLIST
The name of the Intent-extra used to define the playlist. |
String |
EXTRA_MEDIA_RADIO_CHANNEL
The name of the Intent-extra used to define the radio channel. |
String |
EXTRA_MEDIA_TITLE
The name of the Intent-extra used to define the song title |
String |
EXTRA_OUTPUT
The name of the Intent-extra used to indicate a content resolver Uri to be used to store the requested image or video. |
String |
EXTRA_SCREEN_ORIENTATION
The name of the Intent-extra used to control the orientation of a ViewImage or a MovieView. |
String |
EXTRA_SHOW_ACTION_ICONS
The name of an Intent-extra used to control the UI of a ViewImage. |
String |
EXTRA_SIZE_LIMIT
Specify the maximum allowed size. |
String |
EXTRA_VIDEO_QUALITY
The name of the Intent-extra used to control the quality of a recorded video. |
String |
INTENT_ACTION_MEDIA_PLAY_FROM_SEARCH
An intent to perform a search for music media and automatically play content from the result when possible. |
String |
INTENT_ACTION_MEDIA_SEARCH
Activity Action: Perform a search for media. |
String |
INTENT_ACTION_MUSIC_PLAYER
This constant was deprecated
in API level 15.
Use |
String |
INTENT_ACTION_STILL_IMAGE_CAMERA
The name of the Intent action used to launch a camera in still image mode. |
String |
INTENT_ACTION_STILL_IMAGE_CAMERA_SECURE
The name of the Intent action used to launch a camera in still image mode for use when the device is secured (e.g. |
String |
INTENT_ACTION_TEXT_OPEN_FROM_SEARCH
An intent to perform a search for readable media and automatically play content from the result when possible. |
String |
INTENT_ACTION_VIDEO_CAMERA
The name of the Intent action used to launch a camera in video mode. |
String |
INTENT_ACTION_VIDEO_PLAY_FROM_SEARCH
An intent to perform a search for video media and automatically play content from the result when possible. |
String |
MEDIA_IGNORE_FILENAME
Name of the file signaling the media scanner to ignore media in the containing directory and its subdirectories. |
String |
MEDIA_SCANNER_VOLUME
Name of current volume being scanned by the media scanner. |
String |
META_DATA_STILL_IMAGE_CAMERA_PREWARM_SERVICE
Name under which an activity handling |
String |
UNKNOWN_STRING
The string that is used when a media attribute is not known. |
String |
VOLUME_EXTERNAL
Volume name used for content on "external" storage of device. |
String |
VOLUME_INTERNAL
Volume name used for content on "internal" storage of device. |
Fields | |
|---|---|
public
static
final
Uri |
AUTHORITY_URI
A content:// style uri to the authority for the media provider |
Public constructors | |
|---|---|
MediaStore()
|
|
Public methods | |
|---|---|
static
Set<String>
|
getAllVolumeNames(Context context)
Return list of all volume names currently available. |
static
Uri
|
getDocumentUri(Context context, Uri mediaUri)
Return a |
static
Uri
|
getMediaScannerUri()
Uri for querying the state of the media scanner. |
static
Uri
|
getMediaUri(Context context, Uri documentUri)
Return a |
static
String
|
getVersion(Context context)
Get the media provider's version. |
static
String
|
getVolumeName(Uri uri)
Return the volume name that the given |
static
Uri
|
setIncludePending(Uri uri)
Update the given |
static
Uri
|
setRequireOriginal(Uri uri)
Update the given |
Inherited methods | |
|---|---|
Constants
ACTION_IMAGE_CAPTURE
public static final String ACTION_IMAGE_CAPTURE
Standard Intent action that can be sent to have the camera application capture an image and return it.
The caller may pass an extra EXTRA_OUTPUT to control where this image will be written.
If the EXTRA_OUTPUT is not present, then a small sized image is returned as a Bitmap
object in the extra field. This is useful for applications that only need a small image.
If the EXTRA_OUTPUT is present, then the full-sized image will be written to the Uri
value of EXTRA_OUTPUT.
As of Build.VERSION_CODES.LOLLIPOP, this uri can also be supplied through
Intent.setClipData(ClipData). If using this approach, you still must
supply the uri through the EXTRA_OUTPUT field for compatibility with old applications.
If you don't set a ClipData, it will be copied there for you when calling
Context#startActivity(Intent).
Note: if you app targets M and above
and declares as using the Manifest.permission.CAMERA permission which
is not granted, then attempting to use this action will result in a SecurityException.
See also:
Constant Value: "android.media.action.IMAGE_CAPTURE"
ACTION_IMAGE_CAPTURE_SECURE
public static final String ACTION_IMAGE_CAPTURE_SECURE
Intent action that can be sent to have the camera application capture an image and return
it when the device is secured (e.g. with a pin, password, pattern, or face unlock).
Applications responding to this intent must not expose any personal content like existing
photos or videos on the device. The applications should be careful not to share any photo
or video with other applications or Internet. The activity should use Activity#setShowWhenLocked to display on top of the
lock screen while secured. There is no activity stack when this flag is used, so
launching more than one activity is strongly discouraged.
The caller may pass an extra EXTRA_OUTPUT to control where this image will be written.
If the EXTRA_OUTPUT is not present, then a small sized image is returned as a Bitmap
object in the extra field. This is useful for applications that only need a small image.
If the EXTRA_OUTPUT is present, then the full-sized image will be written to the Uri
value of EXTRA_OUTPUT.
As of Build.VERSION_CODES.LOLLIPOP, this uri can also be supplied through
Intent.setClipData(ClipData). If using this approach, you still must
supply the uri through the EXTRA_OUTPUT field for compatibility with old applications.
If you don't set a ClipData, it will be copied there for you when calling
Context#startActivity(Intent).
See also:
Constant Value: "android.media.action.IMAGE_CAPTURE_SECURE"
ACTION_REVIEW
public static final String ACTION_REVIEW
Standard action that can be sent to review the given media file.
The launched application is expected to provide a large-scale view of the given media file, while allowing the user to quickly access other recently captured media files.
Input: Intent#getData is URI of the primary media item to
initially display.
See also:
Constant Value: "android.provider.action.REVIEW"
ACTION_REVIEW_SECURE
public static final String ACTION_REVIEW_SECURE
Standard action that can be sent to review the given media file when the
device is secured (e.g. with a pin, password, pattern, or face unlock).
The applications should be careful not to share any media with other
applications or Internet. The activity should use
Activity#setShowWhenLocked to display on top of the lock screen
while secured. There is no activity stack when this flag is used, so
launching more than one activity is strongly discouraged.
The launched application is expected to provide a large-scale view of the given primary media file, while only allowing the user to quickly access other media from an explicit secondary list.
Input: Intent#getData is URI of the primary media item to
initially display. Intent#getClipData is the limited list of
secondary media items that the user is allowed to review. If
Intent#getClipData is undefined, then no other media access
should be allowed.
See also:
Constant Value: "android.provider.action.REVIEW_SECURE"
ACTION_VIDEO_CAPTURE
public static final String ACTION_VIDEO_CAPTURE
Standard Intent action that can be sent to have the camera application capture a video and return it.
The caller may pass in an extra EXTRA_VIDEO_QUALITY to control the video quality.
The caller may pass in an extra EXTRA_OUTPUT to control
where the video is written. If EXTRA_OUTPUT is not present the video will be
written to the standard location for videos, and the Uri of that location will be
returned in the data field of the Uri.
As of Build.VERSION_CODES.LOLLIPOP, this uri can also be supplied through
Intent.setClipData(ClipData). If using this approach, you still must
supply the uri through the EXTRA_OUTPUT field for compatibility with old applications.
If you don't set a ClipData, it will be copied there for you when calling
Context#startActivity(Intent).
Note: if you app targets M and above
and declares as using the Manifest.permission.CAMERA permission which
is not granted, then atempting to use this action will result in a SecurityException.
Constant Value: "android.media.action.VIDEO_CAPTURE"
AUTHORITY
public static final String AUTHORITY
The authority for the media provider
Constant Value: "media"
EXTRA_BRIGHTNESS
public static final String EXTRA_BRIGHTNESS
When defined, the launched application is requested to set the given
brightness value via
WindowManager.LayoutParams.screenBrightness to help
ensure a smooth transition when launching ACTION_REVIEW or
ACTION_REVIEW_SECURE intents.
Constant Value: "android.provider.extra.BRIGHTNESS"
EXTRA_DURATION_LIMIT
public static final String EXTRA_DURATION_LIMIT
Specify the maximum allowed recording duration in seconds.
Constant Value: "android.intent.extra.durationLimit"
EXTRA_FINISH_ON_COMPLETION
public static final String EXTRA_FINISH_ON_COMPLETION
The name of the Intent-extra used to control the onCompletion behavior of a MovieView. This is a boolean property that specifies whether or not to finish the MovieView activity when the movie completes playing. The default value is true, which means to automatically exit the movie player activity when the movie completes playing.
Constant Value: "android.intent.extra.finishOnCompletion"
EXTRA_FULL_SCREEN
public static final String EXTRA_FULL_SCREEN
The name of an Intent-extra used to control the UI of a ViewImage. This is a boolean property that overrides the activity's default fullscreen state.
Constant Value: "android.intent.extra.fullScreen"
EXTRA_MEDIA_ALBUM
public static final String EXTRA_MEDIA_ALBUM
The name of the Intent-extra used to define the album
Constant Value: "android.intent.extra.album"
EXTRA_MEDIA_ARTIST
public static final String EXTRA_MEDIA_ARTIST
The name of the Intent-extra used to define the artist
Constant Value: "android.intent.extra.artist"
EXTRA_MEDIA_FOCUS
public static final String EXTRA_MEDIA_FOCUS
The name of the Intent-extra used to define the search focus. The search focus indicates whether the search should be for things related to the artist, album or song that is identified by the other extras.
Constant Value: "android.intent.extra.focus"
EXTRA_MEDIA_GENRE
public static final String EXTRA_MEDIA_GENRE
The name of the Intent-extra used to define the genre.
Constant Value: "android.intent.extra.genre"
EXTRA_MEDIA_PLAYLIST
public static final String EXTRA_MEDIA_PLAYLIST
The name of the Intent-extra used to define the playlist.
Constant Value: "android.intent.extra.playlist"
EXTRA_MEDIA_RADIO_CHANNEL
public static final String EXTRA_MEDIA_RADIO_CHANNEL
The name of the Intent-extra used to define the radio channel.
Constant Value: "android.intent.extra.radio_channel"
EXTRA_MEDIA_TITLE
public static final String EXTRA_MEDIA_TITLE
The name of the Intent-extra used to define the song title
Constant Value: "android.intent.extra.title"
EXTRA_OUTPUT
public static final String EXTRA_OUTPUT
The name of the Intent-extra used to indicate a content resolver Uri to be used to store the requested image or video.
Constant Value: "output"
EXTRA_SCREEN_ORIENTATION
public static final String EXTRA_SCREEN_ORIENTATION
The name of the Intent-extra used to control the orientation of a ViewImage or a MovieView. This is an int property that overrides the activity's requestedOrientation.
Constant Value: "android.intent.extra.screenOrientation"
EXTRA_SHOW_ACTION_ICONS
public static final String EXTRA_SHOW_ACTION_ICONS
The name of an Intent-extra used to control the UI of a ViewImage. This is a boolean property that specifies whether or not to show action icons.
Constant Value: "android.intent.extra.showActionIcons"
EXTRA_SIZE_LIMIT
public static final String EXTRA_SIZE_LIMIT
Specify the maximum allowed size.
Constant Value: "android.intent.extra.sizeLimit"
EXTRA_VIDEO_QUALITY
public static final String EXTRA_VIDEO_QUALITY
The name of the Intent-extra used to control the quality of a recorded video. This is an integer property. Currently value 0 means low quality, suitable for MMS messages, and value 1 means high quality. In the future other quality levels may be added.
Constant Value: "android.intent.extra.videoQuality"
INTENT_ACTION_MEDIA_PLAY_FROM_SEARCH
public static final String INTENT_ACTION_MEDIA_PLAY_FROM_SEARCH
An intent to perform a search for music media and automatically play content from the result when possible. This can be fired, for example, by the result of a voice recognition command to listen to music.
This intent always includes the EXTRA_MEDIA_FOCUS
and SearchManager.QUERY extras. The
EXTRA_MEDIA_FOCUS extra determines the search mode, and
the value of the SearchManager.QUERY extra depends on the search mode.
For more information about the search modes for this intent, see
Play music based
on a search query in Common
Intents.
This intent makes the most sense for apps that can support large-scale search of music, such as services connected to an online database of music which can be streamed and played on the device.
Constant Value: "android.media.action.MEDIA_PLAY_FROM_SEARCH"
INTENT_ACTION_MEDIA_SEARCH
public static final String INTENT_ACTION_MEDIA_SEARCH
Activity Action: Perform a search for media.
Contains at least the SearchManager.QUERY extra.
May also contain any combination of the following extras:
EXTRA_MEDIA_ARTIST, EXTRA_MEDIA_ALBUM, EXTRA_MEDIA_TITLE, EXTRA_MEDIA_FOCUS
Constant Value: "android.intent.action.MEDIA_SEARCH"
INTENT_ACTION_MUSIC_PLAYER
public static final String INTENT_ACTION_MUSIC_PLAYER
This constant was deprecated
in API level 15.
Use Intent.CATEGORY_APP_MUSIC instead.
Activity Action: Launch a music player. The activity should be able to play, browse, or manipulate music files stored on the device.
Constant Value: "android.intent.action.MUSIC_PLAYER"
INTENT_ACTION_STILL_IMAGE_CAMERA
public static final String INTENT_ACTION_STILL_IMAGE_CAMERA
The name of the Intent action used to launch a camera in still image mode.
Constant Value: "android.media.action.STILL_IMAGE_CAMERA"
INTENT_ACTION_STILL_IMAGE_CAMERA_SECURE
public static final String INTENT_ACTION_STILL_IMAGE_CAMERA_SECURE
The name of the Intent action used to launch a camera in still image mode
for use when the device is secured (e.g. with a pin, password, pattern,
or face unlock). Applications responding to this intent must not expose
any personal content like existing photos or videos on the device. The
applications should be careful not to share any photo or video with other
applications or internet. The activity should use Activity#setShowWhenLocked to display
on top of the lock screen while secured. There is no activity stack when
this flag is used, so launching more than one activity is strongly
discouraged.
Constant Value: "android.media.action.STILL_IMAGE_CAMERA_SECURE"
INTENT_ACTION_TEXT_OPEN_FROM_SEARCH
public static final String INTENT_ACTION_TEXT_OPEN_FROM_SEARCH
An intent to perform a search for readable media and automatically play content from the result when possible. This can be fired, for example, by the result of a voice recognition command to read a book or magazine.
Contains the SearchManager.QUERY extra, which is a string that can
contain any type of unstructured text search, like the name of a book or magazine, an author
a genre, a publisher, or any combination of these.
Because this intent includes an open-ended unstructured search string, it makes the most sense for apps that can support large-scale search of text media, such as services connected to an online database of books and/or magazines which can be read on the device.
Constant Value: "android.media.action.TEXT_OPEN_FROM_SEARCH"
INTENT_ACTION_VIDEO_CAMERA
public static final String INTENT_ACTION_VIDEO_CAMERA
The name of the Intent action used to launch a camera in video mode.
Constant Value: "android.media.action.VIDEO_CAMERA"
INTENT_ACTION_VIDEO_PLAY_FROM_SEARCH
public static final String INTENT_ACTION_VIDEO_PLAY_FROM_SEARCH
An intent to perform a search for video media and automatically play content from the result when possible. This can be fired, for example, by the result of a voice recognition command to play movies.
Contains the SearchManager.QUERY extra, which is a string that can
contain any type of unstructured video search, like the name of a movie, one or more actors,
a genre, or any combination of these.
Because this intent includes an open-ended unstructured search string, it makes the most sense for apps that can support large-scale search of video, such as services connected to an online database of videos which can be streamed and played on the device.
Constant Value: "android.media.action.VIDEO_PLAY_FROM_SEARCH"
MEDIA_IGNORE_FILENAME
public static final String MEDIA_IGNORE_FILENAME
Name of the file signaling the media scanner to ignore media in the containing directory and its subdirectories. Developers should use this to avoid application graphics showing up in the Gallery and likewise prevent application sounds and music from showing up in the Music app.
Constant Value: ".nomedia"
MEDIA_SCANNER_VOLUME
public static final String MEDIA_SCANNER_VOLUME
Name of current volume being scanned by the media scanner.
Constant Value: "volume"
META_DATA_STILL_IMAGE_CAMERA_PREWARM_SERVICE
public static final String META_DATA_STILL_IMAGE_CAMERA_PREWARM_SERVICE
Name under which an activity handling INTENT_ACTION_STILL_IMAGE_CAMERA or
INTENT_ACTION_STILL_IMAGE_CAMERA_SECURE publishes the service name for its prewarm
service.
This meta-data should reference the fully qualified class name of the prewarm service
extending CameraPrewarmService.
The prewarm service will get bound and receive a prewarm signal
CameraPrewarmService#onPrewarm() when a camera launch intent fire might be imminent.
An application implementing a prewarm service should do the absolute minimum amount of work
to initialize the camera in order to reduce startup time in likely case that shortly after a
camera launch intent would be sent.
Constant Value: "android.media.still_image_camera_preview_service"
UNKNOWN_STRING
public static final String UNKNOWN_STRING
The string that is used when a media attribute is not known. For example, if an audio file does not have any meta data, the artist and album columns will be set to this value.
Constant Value:
"
VOLUME_EXTERNAL
public static final String VOLUME_EXTERNAL
Volume name used for content on "external" storage of device. This only
includes media on the primary shared storage device; the contents of any
secondary storage devices can be obtained using
getAllVolumeNames(android.content.Context).
Constant Value: "external"
VOLUME_INTERNAL
public static final String VOLUME_INTERNAL
Volume name used for content on "internal" storage of device. This volume contains media distributed with the device, such as built-in ringtones and wallpapers.
Constant Value: "internal"
Fields
AUTHORITY_URI
public static final Uri AUTHORITY_URI
A content:// style uri to the authority for the media provider
Public constructors
MediaStore
public MediaStore ()
Public methods
getAllVolumeNames
public static Set<String> getAllVolumeNames (Context context)
Return list of all volume names currently available. This includes a unique name for each shared storage device that is currently mounted.
Each name can be passed to APIs like
MediaStore.Images.Media#getContentUri(String) to query media at
that location.
| Parameters | |
|---|---|
context |
Context |
| Returns | |
|---|---|
Set<String> |
This value will never be null. |
getDocumentUri
public static Uri getDocumentUri (Context context, Uri mediaUri)
Return a DocumentsProvider Uri that is an equivalent to the given
MediaStore Uri.
This allows apps with Storage Access Framework permissions to convert
between MediaStore and DocumentsProvider Uris that refer
to the same underlying item. Note that this method doesn't grant any new
permissions; callers must already hold permissions obtained with
Intent#ACTION_OPEN_DOCUMENT or related APIs.
| Parameters | |
|---|---|
context |
Context |
mediaUri |
Uri: The MediaStore Uri to convert. |
| Returns | |
|---|---|
Uri |
An equivalent DocumentsProvider Uri. Returns null
if no equivalent was found. |
See also:
getMediaScannerUri
public static Uri getMediaScannerUri ()
Uri for querying the state of the media scanner.
| Returns | |
|---|---|
Uri |
|
getMediaUri
public static Uri getMediaUri (Context context, Uri documentUri)
Return a MediaStore Uri that is an equivalent to the given
DocumentsProvider Uri.
This allows apps with Storage Access Framework permissions to convert
between MediaStore and DocumentsProvider Uris that refer
to the same underlying item. Note that this method doesn't grant any new
permissions; callers must already hold permissions obtained with
Intent#ACTION_OPEN_DOCUMENT or related APIs.
| Parameters | |
|---|---|
context |
Context |
documentUri |
Uri: The DocumentsProvider Uri to convert. |
| Returns | |
|---|---|
Uri |
An equivalent MediaStore Uri. Returns null if no
equivalent was found. |
See also:
getVersion
public static String getVersion (Context context)
Get the media provider's version. Applications that import data from the media provider into their own caches can use this to detect that the media provider changed, and reimport data as needed. No other assumptions should be made about the meaning of the version.
| Parameters | |
|---|---|
context |
Context: Context to use for performing the query. |
| Returns | |
|---|---|
String |
A version string, or null if the version could not be determined. |
getVolumeName
public static String getVolumeName (Uri uri)
Return the volume name that the given Uri references.
| Parameters | |
|---|---|
uri |
Uri: This value must never be null. |
| Returns | |
|---|---|
String |
This value will never be null. |
setIncludePending
public static Uri setIncludePending (Uri uri)
Update the given Uri to also include any pending media items from
calls such as
ContentResolver#query(Uri, String[], Bundle, CancellationSignal).
By default no pending items are returned.
| Parameters | |
|---|---|
uri |
Uri: This value must never be null. |
| Returns | |
|---|---|
Uri |
This value will never be null. |
setRequireOriginal
public static Uri setRequireOriginal (Uri uri)
Update the given Uri to indicate that the caller requires the
original file contents when calling
ContentResolver#openFileDescriptor(Uri, String).
This can be useful when the caller wants to ensure they're backing up the exact bytes of the underlying media, without any Exif redaction being performed.
If the original file contents cannot be provided, a
UnsupportedOperationException will be thrown when the returned
Uri is used, such as when the caller doesn't hold
Manifest.permission.ACCESS_MEDIA_LOCATION.
| Parameters | |
|---|---|
uri |
Uri: This value must never be null. |
| Returns | |
|---|---|
Uri |
This value will never be null. |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.