Media Picker

Additional

Language
Kotlin
Version
N/A
Created
Mar 26, 2019
Updated
May 21, 2019
Owner
Turtle Body (Turtlebody)
Contributors
Wangsun Hakhun (wangsun6)
nirajprakash
2
Activity
Badge
Generate
Download
Source code
APK file

Advertising


Demo:

MediaPicker Library for Android (AndroidX)

A Media library for Android for selecting single/multiple media files(image/video/audio).

Setup

Step 1: Add the dependency

dependencies {
    ...
    /* media picker */
    implementation 'com.greentoad.turtlebody:media-picker:1.0.6'

    /* rxjava */
    implementation 'io.reactivex.rxjava2:rxjava:2.2.5'
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.0'
}

Usage

Step 1: Declare and Initialize MediaPicker.

Java

MediaPickerConfig pickerConfig = new MediaPickerConfig()
        .setAllowMultiSelection(false)
        .setUriPermanentAccess(true)
        .setShowConfirmationDialog(true)
        .setScreenOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT);
        
MediaPicker.with(this,MediaPicker.MediaTypes.IMAGE)
        .setConfig(pickerConfig)
        .setFileMissingListener(new MediaPicker.MediaPickerImpl.OnMediaListener() {
            @Override
            public void onMissingFileWarning() {
                //trigger when some file are missing
            }
        })
        .onResult()
        .subscribe(new Observer<ArrayList<Uri>>() {
            @Override
            public void onSubscribe(Disposable d) { }

            @Override
            public void onNext(ArrayList<Uri> uris) {
                //uris: list of uri
            }

            @Override
            public void onError(Throwable e) { }

            @Override
            public void onComplete() { }
        });

Kotlin

val pickerConfig = MediaPickerConfig()
        .setUriPermanentAccess(false)
        .setAllowMultiSelection(allowMultiple)
        .setShowConfirmationDialog(true)
        .setScreenOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT)

MediaPicker.with(this, MediaPicker.MediaTypes.IMAGE)
        .setConfig(pickerConfig)
        .setFileMissingListener(object : MediaPicker.MediaPickerImpl.OnMediaListener{
            override fun onMissingFileWarning() {
                //trigger when some file are missing
            }
        })
        .onResult()
        .subscribe({
            println ( "success: $it" )
        },{
            println ( "error: $it" )
        })

Explanation:

1. MediaPickerConfig:

It is use to set the configuration.

  1. .setAllowMultiSelection(booleanValue): tells whether to select single file or multiple file.
  2. .setUriPermanentAccess(booleanValue): grant uri access permission.
  • Temporary uri may not work once your app terminates(so storaring temporary uri in database is not good practise, so use permanent uri in such case).
  • This option only works while selecting file from default android intent.
  • The file user select from our custom ui always return uri with permanent access grant.
  1. .setShowConfirmationDialog(booleanValue): tells whether to show confirmation dialog on selecting the file(only work in single file selection).

eg.

//Pick single file with permanent access uri and confirmation dialog
MediaPickerConfig pickerConfig = new MediaPickerConfig()
        .setAllowMultiSelection(false)
        .setUriPermanentAccess(true)
        .setShowConfirmationDialog(true)
        .setScreenOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT);

2. ExtraListener:

In Android many times the file not exist physically but may contain uri. Such file(uri) may produce error. So in our library we are filtering out invalid uri. So if end-developer wants to know if library filtered out uris, they can set .setFileMissingListener().

Java

.setFileMissingListener(new MediaPicker.MediaPickerImpl.OnMediaListener() {
    @Override
    public void onMissingFileWarning() {
        //trigger when some missing file are filtered out
    }
})

Kotlin

.setFileMissingListener(object : MediaPicker.MediaPickerImpl.OnMediaListener{
    override fun onMissingFileWarning() {
        //trigger when some missing file are filtered out
    }
})

3. Media types:

It's a type of file user want to select.

  1. IMAGE : for picking image files
  2. VIDEO : for picking video files
  3. AUDIO : for picking audio files

URI:

We will be returning the list of Uri after selecting the files. That's why it is better to know about Uri first.

A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource.

In Android, Content providers manage access to a structured set of data. They encapsulate the data, and provide mechanisms for defining data security. Content providers are the standard interface that connects data in one process with code running in another process. You can get almost all information from uri.

URI usages:

  1. Get file from uri:
File file = new File(uri.getPath());
  1. Get mime from uri:
String mimeType = getContentResolver().getType(uri);
  1. Used in Glide:
Glide.with(context)
     .load(uri)
     .into(imageView);