api.video Android

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

• Project description
• Getting started
  • Requirements
  • Installation
    • Maven users
    • Gradle users
    • Others
  • Code sample
  • Permissions
• Documentation
  • API Endpoints
    • CaptionsApi
    • ChaptersApi
    • LiveStreamsApi
    • PlayerThemesApi
    • RawStatisticsApi
    • UploadTokensApi
    • VideosApi
    • WatermarksApi
    • WebhooksApi
  • Models
  • Authorization
    • API key
    • Public endpoints
  • Recommendation
• Have you gotten use from this API client?
• Contribution

Project description

api.video's Android API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens.

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.0.5</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

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

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Code sample

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

import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import video.api.client.ApiVideoClient
import video.api.client.api.ApiException
import video.api.client.api.models.*
import java.io.File
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors

class MainActivity : AppCompatActivity() {
    private val executor: ExecutorService = Executors.newSingleThreadExecutor()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
    }

    override fun onResume() {
        super.onResume()

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

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

        /**
         * Notice: you must not call API from the UI/main thread. Dispatch with Thread, Executors or Kotlin coroutines.
         */
        executor.execute {
            try {
                var video = apiVideoClient.videos().create(VideoCreationPayload().title("my video"))
                video = apiVideoClient.videos().upload(video.videoId, myVideoFile)
                Log.i("Example", "$video")
            } catch (e: ApiException) {
                Log.e("Example", "Exception when calling VideoApi")
                e.message?.let {
                    Log.e("Example", "Reason: ${it}")
                }
            }
        }
    }
}

Example

An example that demonstrates how to use the API is provided in folder example/.

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

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

RawStatisticsApi

Retrieve an instance of RawStatisticsApi:

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

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
• AuthenticatePayload
• BadRequest
• BytesRange
• Caption
• CaptionsListResponse
• CaptionsUpdatePayload
• Chapter
• ChaptersListResponse
• Link
• LiveStream
• LiveStreamAssets
• LiveStreamCreationPayload
• LiveStreamListResponse
• LiveStreamSession
• LiveStreamSessionClient
• LiveStreamSessionDevice
• LiveStreamSessionLocation
• LiveStreamSessionReferrer
• LiveStreamSessionSession
• LiveStreamUpdatePayload
• Metadata
• NotFound
• Pagination
• PaginationLink
• PlayerSessionEvent
• PlayerTheme
• PlayerThemeAssets
• PlayerThemeCreationPayload
• PlayerThemeUpdatePayload
• PlayerThemesListResponse
• Quality
• RawStatisticsListLiveStreamAnalyticsResponse
• RawStatisticsListPlayerSessionEventsResponse
• RawStatisticsListSessionsResponse
• RefreshTokenPayload
• 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.
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.

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.