- Notifications
You must be signed in to change notification settings - Fork2
Cordova & Ionic plugin for VideoEditor SDK
License
imgly/vesdk-cordova
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Add VideoEditor SDK plugin to your project as follows:
cordova plugin add cordova-plugin-videoeditorsdk
With version3.2.0
, we recommend usingcompileSdkVersion
not lower than31
for Android. However, this might interfere with your application's Android Gradle Plugin version if this is set to4.x
.
If you don't use a newer Android Gradle Plugin version, you'll most likely encounter a build error similar to:
FAILURE: Build failed with an exception.* What went wrong:A problem occurred configuring project ':cordova-plugin-videoeditorsdk'.> com.android.builder.errors.EvalIssueException: Installed Build Tools revision 31.0.0 is corrupted. Remove and install again using the SDK Manager.* Try:Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.* Get more help at https://help.gradle.org
As a workaround you can create the following symlinks:
- Inside
/Users/YOUR-USERNAME/Library/Android/sdk/build-tools/31.0.0/
: Create adx
symlink for thed8
file withln -s d8 dx
. - From there, go to
./lib/
and create adx.jar
symlink for thed8.jar
file withln -s d8.jar dx.jar
.
You can configure the native Android VideoEditor SDK version used by creating aimglyConfig.json
file and specifying a specific version:
{"version":"10.3.3"}
If no version / no configuration file is specified, the module will use the default minimum required version.
With version3.2.0
of the VideoEditor SDK for Cordova, the integration of the native Android VE.SDK has changed. The new minimum Android VE.SDK version is10.9.0
which requiresKotlin Symbol Processing (KSP).The KSP version depends on the Kotlin version that you are using. In order to find the correct version, please visit theofficial KSP release page.In order to specify the KSP version, please add an entry to theimglyConfig.json
:
{"kspVersion":"1.7.21-1.0.8"}
By default, version1.7.21-1.0.8
is used which is suitable for Kotlin1.7.21
.
From version3.0.0
the plugin uses AndroidX. To enable AndroidX in your application please adjust yourconfig.xml
:
<platform name="android">...+ <preference name="AndroidXEnabled" value="true" />...</platform>
If your application is using legacy Android Support Libraries you can use thecordova-plugin-androidx-adapter
which will migrate the legacy libraries to work with AndroidX.
If you are usingcordova-android
version10.+
, you might need to adjust the Kotlin version of your application in yourconfig.xml
, if your current Kotlin version is not compatible with our plugin:
<platform name="android">...+ <preference name="GradlePluginKotlinVersion" value="1.5.32" />...</platform>
With version3.2.0
the plugin requiresminSdkVersion
21
or higher. Depending on yourcordova-android
version you might need to raise theminSdkVersion
manually. For this, please add the following entry to yourconfig.xml
:
<platform name="android">...+ <preference name="android-minSdkVersion" value="21" />...</platform>
We further recommend you to update yourbuildToolsVersion
to31.0.0
as well as yourcompileSdkVersion
to31
. However, this is not mandatory. For further reference on how to update these variables, please refer to the officialCordova documentation.
You can configure the modules used for the VideoEditor SDK for Android by openingimglyConfig.gradle
and removing / commenting out the modules you do not need. This will also reduce the size of your application.
Because VideoEditor SDK for Android with all its modules is quite large, there is a high chance that you will need to enableMultidex for your project as follows:
cordova plugin add cordova-plugin-enable-multidex
With version3.4.0
the plugin requires a deployment target of 13.0+ for iOS. If needed, please update your deployment target inside theconfig.xml
as describedhere.
Each platform requires a separate license file. Unlock VideoEditor SDK with a single line of code for both platforms via platform-specific file extensions.
Rename your license files:
- Android license:
ANY_NAME.android
- iOS license:
ANY_NAME.ios
Pass the file path without the extension to theunlockWithLicense
function to unlock both iOS and Android:
VESDK.unlockWithLicense("www/assets/ANY_NAME");
Open the editor with a video:
VESDK.openEditor(successCallback,failureCallback,VESDK.resolveStaticResource("www/assets/video.mp4"));
Please see thecode documentation for more details and additionalcustomization and configuration options.
- Add this line above your class to be able to use
VESDK
.declarevarVESDK;
- Ionic will generate a
www
folder that will contain your compiled code and your assets. In order to pass resources to VideoEditor SDK you need to use this folder.
Please see ourexample project which demonstrates how to use the Cordova plugin for VideoEditor SDK.
Make sure you have acommercial license for VideoEditor SDK before releasing your app.A commercial license is required for any app or service that has any form of monetization: This includes free apps with in-app purchases or ad supported applications. Please contact us if you want to purchase the commercial license.
Use ourservice desk for bug reports or support requests. To request a commercial license, please use thelicense request form on our website.
About
Cordova & Ionic plugin for VideoEditor SDK