Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imgly/vesdk-cordova
Cordova & Ionic plugin for VideoEditor SDK
https://github.com/imgly/vesdk-cordova
adjustment android brush cordova crop filter frames ionic ios overlays sdk stickers text transform video video-edit-sdk video-editing video-manipulation videoeditor-sdk
Last synced: 3 months ago
JSON representation
Cordova & Ionic plugin for VideoEditor SDK
- Host: GitHub
- URL: https://github.com/imgly/vesdk-cordova
- Owner: imgly
- License: other
- Created: 2020-06-24T08:21:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T10:24:57.000Z (10 months ago)
- Last Synced: 2024-04-15T04:33:20.336Z (9 months ago)
- Topics: adjustment, android, brush, cordova, crop, filter, frames, ionic, ios, overlays, sdk, stickers, text, transform, video, video-edit-sdk, video-editing, video-manipulation, videoeditor-sdk
- Language: TypeScript
- Homepage: https://www.videoeditorsdk.com
- Size: 229 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Cordova & Ionic plugin for VideoEditor SDK
## Getting started
Add VideoEditor SDK plugin to your project as follows:
```sh
cordova plugin add cordova-plugin-videoeditorsdk
```
### Known Issues
With version `3.2.0`, we recommend using `compileSdkVersion` not lower than `31` for Android. However, this might interfere with your application's Android Gradle Plugin version if this is set to `4.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:
1. Inside `/Users/YOUR-USERNAME/Library/Android/sdk/build-tools/31.0.0/`: Create a `dx` symlink for the `d8` file with `ln -s d8 dx`.
2. From there, go to `./lib/` and create a `dx.jar` symlink for the `d8.jar` file with `ln -s d8.jar dx.jar`.
### Android
#### Version
You can configure the native Android VideoEditor SDK version used by creating a `imglyConfig.json` file and specifying a specific version:
```json
{
"version": "10.3.3"
}
```
If no version / no configuration file is specified, the module will use the default minimum required version.
#### KSP
With version `3.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 is `10.9.0` which requires [Kotlin Symbol Processing (KSP)](https://github.com/google/ksp).
The KSP version depends on the Kotlin version that you are using. In order to find the correct version, please visit the [official KSP release page](https://github.com/google/ksp/releases?page=1).
In order to specify the KSP version, please add an entry to the `imglyConfig.json`:
```json
{
"kspVersion": "1.7.21-1.0.8"
}
```
By default, version `1.7.21-1.0.8` is used which is suitable for Kotlin `1.7.21`.
#### AndroidX
From version `3.0.0` the plugin uses AndroidX. To enable AndroidX in your application please adjust your `config.xml`:
```diff
...
+
...
```
If your application is using legacy Android Support Libraries you can use the [`cordova-plugin-androidx-adapter`](https://www.npmjs.com/package/cordova-plugin-androidx-adapter) which will migrate the legacy libraries to work with AndroidX.
#### Kotlin Version
If you are using `cordova-android` version `10.+`, you might need to adjust the Kotlin version of your application in your `config.xml`, if your current Kotlin version is not compatible with our plugin:
```diff
...
+
...
```
#### Supported Android versions
With version `3.2.0` the plugin requires `minSdkVersion` `21` or higher. Depending on your `cordova-android` version you might need to raise the `minSdkVersion` manually. For this, please add the following entry to your `config.xml`:
```diff
...
+
...
```
We further recommend you to update your `buildToolsVersion` to `31.0.0` as well as your `compileSdkVersion` to `31`. However, this is not mandatory. For further reference on how to update these variables, please refer to the official [Cordova documentation](https://cordova.apache.org/docs/en/11.x/guide/platforms/android/index.html#configuring-gradle).
#### Modules
You can configure the modules used for the VideoEditor SDK for Android by opening `imglyConfig.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 enable [Multidex](https://developer.android.com/studio/build/multidex) for your project as follows:
```sh
cordova plugin add cordova-plugin-enable-multidex
```
### iOS
With version `3.4.0` the plugin requires a deployment target of 13.0+ for iOS. If needed, please update your deployment target inside the `config.xml` as described [here](https://cordova.apache.org/docs/en/latest/config_ref/index.html).
### Usage
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 the `unlockWithLicense` function to unlock both iOS and Android:
```js
VESDK.unlockWithLicense("www/assets/ANY_NAME");
```
Open the editor with a video:
```js
VESDK.openEditor(
successCallback,
failureCallback,
VESDK.resolveStaticResource("www/assets/video.mp4")
);
```
Please see the [code documentation](./types/index.d.ts) for more details and additional [customization and configuration options](./types/configuration.ts).
#### Notes for Ionic framework
- Add this line above your class to be able to use `VESDK`.
```js
declare var VESDK;
```
- 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.
## Example
Please see our [example project](https://github.com/imgly/vesdk-cordova-demo) which demonstrates how to use the Cordova plugin for VideoEditor SDK.
## License Terms
Make sure you have a [commercial license](https://img.ly/pricing?product=vesdk&?utm_campaign=Projects&utm_source=Github&utm_medium=VESDK&utm_content=Cordova) 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.
## Support and License
Use our [service desk](https://support.img.ly) for bug reports or support requests. To request a commercial license, please use the [license request form](https://img.ly/pricing?product=vesdk&?utm_campaign=Projects&utm_source=Github&utm_medium=VESDK&utm_content=Cordova) on our website.