- **Breaking** StorageConfiguration was removed.

- **Breaking** `AppSpecificStorageConfiguration` can be passed to store the output video in Android's App Specific Storage.
- **Breaking** `SharedStorageConfiguration` can be passed to store the output video in Android's Primary Storage, it accepts storing at `pictures`, `downloads`, or `movies`.
- Only one of the configurations can be provided at a time, either `AppSpecificStorageConfiguration` or `SharedStorageConfiguration`.

Author: AbedElazizShe

README.md

@@ -14,6 +14,15 @@ I would like to mention that the set attributes for size and quality worked just
 
 **LightCompressor is now available in iOS**, have a look at [LightCompressor_iOS](https://github.com/AbedElazizShe/LightCompressor_iOS).
 
+# Change Logs
+
+## What's new in 1.2.3
+
+- **Breaking** `StorageConfiguration` was removed.
+- **Breaking** `AppSpecificStorageConfiguration` can be passed to store the output video in Android's App Specific Storage.
+- **Breaking** `SharedStorageConfiguration` can be passed to store the output video in Android's Primary Storage, it accepts storing at `pictures`, `downloads`, or `movies`.
+- Only one of the configurations can be provided at a time, either `AppSpecificStorageConfiguration` or `SharedStorageConfiguration`.
+
 # What's new in 1.2.2
 
 - **Breaking** videoBitrate was renamed to videoBitrateInMbps. It should be int.
@@ -55,7 +64,7 @@ when {
 }
 ```
 
-You can as well pass custom videoHeight, videoWidth, frameRate, and videoBitrate values if you don't want the library to auto-generate the values for you. **The compression will fail if height or width is specified without the other, so ensure you pass both values**.
+You can as well pass custom videoHeight, videoWidth, and videoBitrate values if you don't want the library to auto-generate the values for you. **The compression will fail if height or width is specified without the other, so ensure you pass both values**.
 
 These values were tested on a huge set of videos and worked fine and fast with them. They might be changed based on the project needs and expectations.
 
@@ -107,7 +116,7 @@ implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Version.coroutin
 implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:${Version.coroutines}"
 ```
 
-Then just call [VideoCompressor.start()] and pass context, uris, isStreamable, storageConfiguration, and configureWith.
+Then just call [VideoCompressor.start()] and pass **context**, **uris**, **isStreamable**, **configureWith**, and either **sharedStorageConfiguration OR appSpecificStorageConfiguration**.
 
 The method has a callback for 5 functions;
 1) OnStart - called when compression started
@@ -121,6 +130,7 @@ The method has a callback for 5 functions;
 - All the callback functions returns an index for the video being compressed in the same order of the urls passed to the library. You can use this index to update the UI
 or retrieve information about the original uri/file.
 - The source video must be provided as a list of content uris.
+- OnSuccess returns the path of the stored video.
 - If you want an output video that is optimised to be streamed, ensure you pass [isStreamable] flag is true.
 
 ### Configuration values
@@ -139,13 +149,18 @@ or retrieve information about the original uri/file.
 
 - videoHeight: custom video height.
 
-### Storage Configuration values
+### AppSpecificStorageConfiguration Configuration values
+
+- videoName: a custom name for the output video.
+
+- subFolderName: a subfolder name created in app's specific storage. The library won't create the subfolder and will throw an exception if the subfolder does not exist.
 
-- fileName: a custom name for the output video. If ignored, the library will assign a name that is a combination of the video original name with a timestamp.
 
-- isExternal: if passed as false, the video will be saved at app-specific file directory.
+### AppSpecificStorageConfiguration Configuration values
 
-- saveAt: the directory where the video should be saved in. The value will be ignored if isExternal is false.
+- videoName: a custom name for the output video.
+
+- saveAt: the directory where the video should be saved in. Must be one of the following; [SaveLocation.pictures], [SaveLocation.movies], or [SaveLocation.downloads].
 
 
 To cancel the compression job, just call [VideoCompressor.cancel()]
@@ -156,12 +171,17 @@ To cancel the compression job, just call [VideoCompressor.cancel()]
 VideoCompressor.start(
    context = applicationContext, // => This is required
    uris = List<Uri>, // => Source can be provided as content uris
-   isStreamable = true,
-   storageConfiguration = StorageConfiguration(
-      saveAt = Environment.DIRECTORY_MOVIES, // => the directory to save the compressed video(s). Will be ignored if isExternal = false.
-      isExternal = true, // => false means save at app-specific file directory. Default is true.
-      fileName = "output-video.mp4" // => an optional value for a custom video name.
+   isStreamable = false, 
+   // THIS STORAGE 
+   sharedStorageConfiguration = SharedStorageConfiguration(
+       saveAt = SaveLocation.movies, // => default is movies
+       videoName = "compressed_video" // => required name
    ),
+   // OR AND NOT BOTH
+   appSpecificStorageConfiguration = AppSpecificStorageConfiguration(
+       videoName = "compressed_video", // => required name
+       subFolderName = "my-videos" // => optional and ONLY if exists
+   ),   
    configureWith = Configuration(
       quality = VideoQuality.MEDIUM,
       isMinBitrateCheckEnabled = true,
@@ -197,59 +217,6 @@ VideoCompressor.start(
    }
 )
 ```
-### Java
-
-```java
- VideoCompressor.start(
-    applicationContext, // => This is required
-    new ArrayList<Uri>(), // => Source can be provided as content uris
-    false, // => isStreamable
-    new StorageConfiguration(
-       "output-video.mp4" // => an optional value for a custom video name.
-       Environment.DIRECTORY_DOWNLOADS,  // => the directory to save the compressed video(s). Will be ignored if isExternal = false.
-       true // => false means save at app-specific file directory. Default is true.
-    ),
-    new Configuration(
-       VideoQuality.MEDIUM,
-       false, /*isMinBitrateCheckEnabled*/
-       5, /*videoBitrateInMbps: int, or null*/
-       false, /*disableAudio: Boolean, or null*/
-       false, /*keepOriginalResolution: Boolean, or null*/
-       360.0, /*videoWidth: Double, or null*/
-       480.0 /*videoHeight: Double, or null*/
-    ),
-    new CompressionListener() {
-       @Override
-       public void onStart(int index, long size) {
-         // Compression start
-       }
-
-       @Override
-       public void onSuccess(int index, @Nullable String path) {
-         // On Compression success
-       }
-
-       @Override
-       public void onFailure(int index, String failureMessage) {
-         // On Failure
-       }
-
-       @Override
-       public void onProgress(int index, float progressPercent) {
-         // Update UI with progress value
-         runOnUiThread(new Runnable() {
-            public void run() {
-           }
-         });
-       }
-
-       @Override
-       public void onCancelled(int index) {
-         // On Cancelled
-       }
-    }
-);
-```
 
 ## Common issues
 
@@ -263,7 +230,7 @@ from within the main thread. Have a look at the example code above for more info
 To report an issue, please specify the following:
 - Device name
 - Android version
-- If the bug/issue exists on the sample app (version 1.2.2) of the library that could be downloaded at this [link](https://drive.google.com/file/d/1GXblLAg1hnCa0Ef79iweQGvn1rLOYph8/view?usp=share_link).
+- If the bug/issue exists on the sample app (version 1.2.3) of the library that could be downloaded at this [link](https://drive.google.com/file/d/1WZtHN8gG2TaDuuTDKi9wB3B_sT_0SJ4w/view?usp=share_link).
 
 ## Compatibility
 Minimum Android SDK: LightCompressor requires a minimum API level of 21.
@@ -293,7 +260,7 @@ Include this in your Module-level build.gradle file:
 ### Groovy
 
 ```groovy
-implementation 'com.github.AbedElazizShe:LightCompressor:1.2.2'
+implementation 'com.github.AbedElazizShe:LightCompressor:1.2.3'
 ```
 
 If you're facing problems with the setup, edit settings.gradle by adding this at the beginning of the file:

app/build.gradle

@@ -32,8 +32,8 @@ dependencies {
     implementation project(':lightcompressor')
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib:1.7.20"
-    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3"
-    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.2"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.1"
 
     implementation 'androidx.appcompat:appcompat:1.5.1'
     implementation 'androidx.core:core-ktx:1.9.0'

app/src/main/java/com/abedelazizshe/lightcompressor/MainActivity.kt

@@ -9,7 +9,6 @@ import android.content.pm.PackageManager
 import android.net.Uri
 import android.os.Build
 import android.os.Bundle
-import android.os.Environment
 import android.provider.MediaStore
 import android.util.Log
 import android.view.View
@@ -22,7 +21,8 @@ import com.abedelazizshe.lightcompressorlibrary.CompressionListener
 import com.abedelazizshe.lightcompressorlibrary.VideoCompressor
 import com.abedelazizshe.lightcompressorlibrary.VideoQuality
 import com.abedelazizshe.lightcompressorlibrary.config.Configuration
-import com.abedelazizshe.lightcompressorlibrary.config.StorageConfiguration
+import com.abedelazizshe.lightcompressorlibrary.config.SaveLocation
+import com.abedelazizshe.lightcompressorlibrary.config.SharedStorageConfiguration
 import kotlinx.android.synthetic.main.activity_main.*
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
@@ -166,7 +166,6 @@ class MainActivity : AppCompatActivity() {
         }
     }
 
-
     @SuppressLint("SetTextI18n")
     private fun processVideo() {
         mainContents.visibility = View.VISIBLE
@@ -175,11 +174,14 @@ class MainActivity : AppCompatActivity() {
             VideoCompressor.start(
                 context = applicationContext,
                 uris,
-                isStreamable = true,
-                storageConfiguration = StorageConfiguration(
-                    saveAt = Environment.DIRECTORY_MOVIES,
-                    isExternal = true,
+                isStreamable = false,
+                sharedStorageConfiguration = SharedStorageConfiguration(
+                    saveAt = SaveLocation.movies,
+                    videoName = "compressed_video"
                 ),
+//                appSpecificStorageConfiguration = AppSpecificStorageConfiguration(
+//                    videoName = "compressed_video",
+//                ),
                 configureWith = Configuration(
                     quality = VideoQuality.LOW,
                     isMinBitrateCheckEnabled = true,

lightcompressor/build.gradle

@@ -38,7 +38,7 @@ afterEvaluate {
                 from components.release
                 groupId = "com.github.AbedElazizShe"
                 artifactId = "LightCompressor"
-                version = '1.2.2'
+                version = '1.2.3'
             }
         }
     }