Getting Started

Requirements

All VideoKit SDKs work on all Android versions greater than or equal to 21 (Android 5.0). As of today, this means that the SDKs run on 94.1% of active devices. To use the SDKs, depending on your project setup, you might also need to specify the Java version as follows:

// build.gradle / build.gradle.kts
android {
  ...
  compileOptions {
      sourceCompatibility = JavaVersion.VERSION_1_8
      targetCompatibility = JavaVersion.VERSION_1_8
  }
  ...
}

Sample Apps

Once you are familiar with the documentation, you can check out the official sample apps to see the VideoKit SDKs in action. The open source code will help understanding how to implement common UX patterns using VideoKit.

Quick Start

All VideoKit SDKs are hosted on Video.io maven repository. To integrate them in your library or application, you need to add the repository URL to your Gradle configuration, typically in your root build.gradle or build.gradle.kts file:

allprojects {
  repositories {
    maven { url = "https://cdn.video.io/android/maven" }
    maven { url = "https://jitpack.io" }
    google()
    jcenter()
  }
}

After the repository is declared, you can add dependencies to the desired SDK(s). Replace ${version} with the desired VideoKit version. You can find the latest version in the release notes.

implementation("io.video:videokit-core:${version}")

implementation("io.video:videokit-player:${version}")
implementation("io.video:videokit-recorder:${version}")
implementation("io.video:videokit-editor:${version}")
implementation("io.video:videokit-live:${version}")

Note that non-core modules, like videokit-player or videokit-recorder, will automatically add a dependency on videokit-core, so that is not strictly needed. To depend on the whole set of SDKs, we also provide a wrapper dependency called simply videokit:

// pulls all videokit-* repositories
implementation("io.video:videokit:${version}")