Android API client

Getting started

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>video.api</groupId>
  <artifactId>android-api-client</artifactId>
  <version>1.5.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

implementation "video.api:android-api-client:1.5.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/android-api-client-1.5.1.jar
• target/lib/*.jar

Code sample

Please follow the installation instruction and execute the following Kotlin code:

val apiVideoClient = ApiVideoClient("YOUR_API_KEY")
// if you rather like to use the sandbox environment:
// val apiVideoClient = ApiVideoClient("YOU_SANDBOX_API_KEY", Environment.SANDBOX)

/**
 * This example uses an Android specific API called WorkManager to dispatch upload.
 * We initialize it before using it.
 */
VideosApiStore.initialize(apiVideoClient.videos())
val workManager = WorkManager.getInstance(context) // WorkManager comes from package "androidx.work:work-runtime"

val myVideoFile = File("my-video.mp4")

/**
 * You must not call API from the UI/main thread on Android. Dispatch with Thread, Executors, 
 * Kotlin coroutines or asynchroneous API (such as `createAsync` instead of `create`).
 */
executor.execute {
    try {
        val video = apiVideoClient.videos().create(VideoCreationPayload().title("my video"))
        Log.i("Example", "Video created: $video")
        workManager.upload(video.videoId, myVideoFile)
    } catch (e: ApiException) {
        Log.e("Example", "Exception when calling VideoApi", e)
    }
}

Example

Examples that demonstrate how to use the API is provided in folder examples/.

Upload methods

To upload a video, you have 3 differents methods:

• WorkManager: preferred method: Upload with Android WorkManager API. It supports progress notifications. Directly use, WorkManager extensions. See example for more details.
• UploadService: Upload with an Android Service. It supports progress notifications. You have to extend the UploadService and register it in your AndroidManifest.xml. See example for more details.
• Direct call with ApiClient: Do not call API from the main thread, otherwise you will get a android.os.NetworkOnMainThreadException. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this.

Permissions

You have to add the following permissions in your AndroidManifest.xml:

    <uses-permission android:name="android.permission.INTERNET" />
<!-- Application requires android.permission.READ_EXTERNAL_STORAGE to upload videos` -->
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

Your application also has to dynamically request the android.permission.READ_EXTERNAL_STORAGE permission to upload videos.

Documentation

API Endpoints

All URIs are relative to https://ws.api.video

AnalyticsApi

Retrieve an instance of AnalyticsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val analytics = client.analytics()

Endpoints

CaptionsApi

Retrieve an instance of CaptionsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val captions = client.captions()

Endpoints

ChaptersApi

Retrieve an instance of ChaptersApi:

val client = ApiVideoClient("YOUR_API_KEY")
val chapters = client.chapters()

Endpoints

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

val client = ApiVideoClient("YOUR_API_KEY")
val liveStreams = client.liveStreams()

Endpoints

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

val client = ApiVideoClient("YOUR_API_KEY")
val playerThemes = client.playerThemes()

Endpoints

UploadTokensApi

Retrieve an instance of UploadTokensApi:

val client = ApiVideoClient("YOUR_API_KEY")
val uploadTokens = client.uploadTokens()

Endpoints

VideosApi

Retrieve an instance of VideosApi:

val client = ApiVideoClient("YOUR_API_KEY")
val videos = client.videos()

Endpoints

WatermarksApi

Retrieve an instance of WatermarksApi:

val client = ApiVideoClient("YOUR_API_KEY")
val watermarks = client.watermarks()

Endpoints

WebhooksApi

Retrieve an instance of WebhooksApi:

val client = ApiVideoClient("YOUR_API_KEY")
val webhooks = client.webhooks()

Endpoints

Documentation for Models

• AccessToken
• AdditionalBadRequestErrors
• AnalyticsData
• AnalyticsPlays400Error
• AnalyticsPlaysResponse
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• Link
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamSession
• LiveStreamSessionClient
• LiveStreamSessionDevice
• LiveStreamSessionLocation
• LiveStreamSessionReferrer
• LiveStreamSessionSession
• LiveStreamUpdatePayload
• Metadata
• Model403ErrorSchema
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RefreshTokenPayload
• RestreamsRequestObject
• RestreamsResponseObject
• TokenCreationPayload
• TokenListResponse
• UploadToken
• Video
• VideoAssets
• VideoClip
• VideoCreationPayload
• VideoSession
• VideoSessionClient
• VideoSessionDevice
• VideoSessionLocation
• VideoSessionOs
• VideoSessionReferrer
• VideoSessionSession
• VideoSource
• VideoSourceLiveStream
• VideoSourceLiveStreamLink
• VideoStatus
• VideoStatusEncoding
• VideoStatusEncodingMetadata
• VideoStatusIngest
• VideoStatusIngestReceivedParts
• VideoThumbnailPickPayload
• VideoUpdatePayload
• VideoWatermark
• VideosListResponse
• Watermark
• WatermarksListResponse
• Webhook
• WebhooksCreationPayload
• WebhooksListResponse

Documentation for Authorization

API key

Most endpoints required to be authenticated using the API key mechanism described in our documentation. The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key when instantiating the ApiVideoClient:

val client = ApiVideoClient("YOUR_API_KEY")

Public endpoints

Some endpoints don't require authentication. These one can be called with a client instantiated without API key:

val client = ApiVideoClient()

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. For direct call with ApiClient: Do not call API from the main thread, otherwise you will get a android.os.NetworkOnMainThreadException. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this. Alternatively, APIs come with an asynchronous counterpart (createAsync for create) except for the upload endpoint.

Have you gotten use from this API client?

Please take a moment to leave a star on the client ⭐

This helps other users to find the clients and also helps us understand which clients are most popular. Thank you!

Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, you can open a pull request on the repository of our client generator. Otherwise, you can also simply open an issue detailing your need on this repository.