Skip to content

Commit

Permalink
Updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
krazykira committed Apr 8, 2020
1 parent 8f67702 commit 4b190c1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,13 @@ The following list of effects are currently avaialble and can be applied using V




## Limitations
- The effects applied using this library are temporary. What that means is that the original video doesn't change. Effects are only applied during video playback and once the video ends the effects end with it.
- Minimum Supported Android version is 21 (Lollipop)
- Saving video available only for Filters and requires Android 23 min api version.For more information check the file [VideoController](https://github.com/krazykira/VidEffects/blob/master/app/src/main/java/com/videffects/sample/controller/VideoController.kt).
- Other ways to save video once effect/filter is applied [FFmpeg](https://ffmpeg.org/) to apply effects on videos. Details about how to do that can be seen on this [wiki page](https://github.com/krazykira/VidEffects/wiki/Permanent-video-effects)
- Some emulators have problems during video playback so try on real device when that happens e.g: Android Lollipop emulators don't show video.

The effects applied using this library are temporary. What that means is that the orignal video doesn't change. Effects are only applied during video playback and once the video ends the effects end with it. In the future, i am aiming to apply permanant effect to videos. You guys are welcome to help out using PRs.
<br>For now, if you are really desperate and want to apply effects then you can use [FFmpeg](https://ffmpeg.org/) to apply effects on videos. Details about how to do that can be seen on this [wiki page](https://github.com/krazykira/VidEffects/wiki/Permanent-video-effects)
Saving video available only for Filters and requires Android 23 min api version. For more information check the file [VideoController](https://github.com/krazykira/VidEffects/blob/master/app/src/main/java/com/videffects/sample/controller/VideoController.kt).

## How to use it
- Add the following code to your project's `build.gradle` file
Expand All @@ -55,7 +56,7 @@ Saving video available only for Filters and requires Android 23 min api version.
```sh
dependencies {
// Gradle path for VidEffects
compile 'com.sherazkhilji.videffects:videffects:1.1.0'
implementation "com.sherazkhilji.videffects:videffects:1.1.0"
}
```

Expand Down Expand Up @@ -147,13 +148,13 @@ Want to contribute or add some new Effects? Great! Fork it and send me a pull re
Developed by
============
* Sheraz Ahmad Khilji - <[email protected]>
* Sheraz Ahmed Khilji - <[email protected]>
License
=======
Copyright 2020 Sheraz Ahmad Khilji
Copyright 2020 Sheraz Ahmed Khilji
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
1 change: 1 addition & 0 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ android {

dependencies {
implementation project(":videffects")
// implementation "com.sherazkhilji.videffects:videffects:1.1.0"
implementation"org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
implementation 'androidx.core:core-ktx:1.2.0'
implementation 'com.google.android.material:material:1.1.0'
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ buildscript {
}

dependencies {
classpath 'com.android.tools.build:gradle:3.6.0'
classpath 'com.android.tools.build:gradle:3.6.2'
classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
classpath "org.jfrog.buildinfo:build-info-extractor-gradle:3.1.1"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
Expand Down

0 comments on commit 4b190c1

Please sign in to comment.