api.video Android API client
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.
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:
- Java 1.8+
- 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.6.3</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
implementation "video.api:android-api-client:1.6.3"
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/android-api-client-1.6.3.jar
target/lib/*.jar
Code sample
Please follow the installation instruction and execute the following Kotlin code:
// If you want to upload a video with an upload token (uploadWithUploadToken):
VideosApiStore.initialize()
// if you rather like to use the sandbox environment:
// VideosApiStore.initialize(environment = Environment.SANDBOX)
val myVideoFile = File("my-video.mp4")
val workManager = WorkManager.getInstance(context) // WorkManager comes from package "androidx.work:work-runtime"
workManager.uploadWithUploadToken("MY_UPLOAD_TOKEN", myVideoFile) // Dispatch the upload with the WorkManager
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, upload in background, queue, reupload after lost connections. Directly use, WorkManager extensions. See example for more details.UploadService
: Upload with an Android Service. It supports progress notifications, upload in background, queue. You have to extend theUploadService
and register it in yourAndroidManifest.xml
. See example for more details.- Direct call with
ApiClient
: Do not call API from the main thread, otherwise you will get anandroid.os.NetworkOnMainThreadException
. Dispatch API calls with Thread, Executors or Kotlin coroutine to avoid this.
Permissions
If your video files are located in the media store, you have to add the following permissions in your AndroidManifest.xml
:
<uses-permission android:name="android.permission.INTERNET" />
<!-- The application requires READ_EXTERNAL_STORAGE or READ_MEDIA_VIDEO to access video to upload them` -->
<uses-permission
android:name="android.permission.READ_EXTERNAL_STORAGE"
android:maxSdkVersion="32" />
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />
Your application also has to dynamically request the android.permission.READ_EXTERNAL_STORAGE
permission to upload videos.
If your video files are located in the app-specific storage, you don't need to request any permissions nor add any permissions to your AndroidManifest.xml
.
WorkManager
To upload with the WorkManager
, you also have to add the following lines in your AndroidManifest.xml
:
<!-- The application requires POST_NOTIFICATIONS to display the upload notification -->
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
<!-- The application requires FOREGROUND_SERVICE_DATA_SYNC for API >= 34 -->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
<application>
...
<!-- The application requires to declare a service type for API >= 34 -->
<service
android:name="androidx.work.impl.foreground.SystemForegroundService"
android:foregroundServiceType="dataSync"
tools:node="merge" />
</application>
UploadService
To upload with the UploadService
, you also have to add the following lines in your AndroidManifest.xml
:
<!-- The application requires POST_NOTIFICATIONS to display the upload notification -->
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<application>
<!--
The application requires to declare your service, replace `YourUploaderService` by the package
of your service or by the package of `UploadService` if you directly use `UploadService`.
-->
<service android:name=".YourUploaderService" />
</application>
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
Method | HTTP request | Description |
---|---|---|
getAggregatedMetrics | GET /data/metrics/\{metric}/{aggregation} | Retrieve aggregated metrics |
getMetricsBreakdown | GET /data/buckets/\{metric}/{breakdown} | Retrieve metrics in a breakdown of dimensions |
getMetricsOverTime | GET /data/timeseries/{metric} | Retrieve metrics over time |
CaptionsApi
Retrieve an instance of CaptionsApi:
val client = ApiVideoClient("YOUR_API_KEY")
val captions = client.captions()
Endpoints
Method | HTTP request | Description |
---|---|---|
upload | POST /videos/\{videoId}/captions/{language} | Upload a caption |
get | GET /videos/\{videoId}/captions/{language} | Retrieve a caption |
update | PATCH /videos/\{videoId}/captions/{language} | Update a caption |
delete | DELETE /videos/\{videoId}/captions/{language} | Delete a caption |
list | GET /videos/\{videoId}/captions | List video captions |
ChaptersApi
Retrieve an instance of ChaptersApi:
val client = ApiVideoClient("YOUR_API_KEY")
val chapters = client.chapters()
Endpoints
Method | HTTP request | Description |
---|---|---|
upload | POST /videos/\{videoId}/chapters/{language} | Upload a chapter |
get | GET /videos/\{videoId}/chapters/{language} | Retrieve a chapter |
delete | DELETE /videos/\{videoId}/chapters/{language} | Delete a chapter |
list | GET /videos/\{videoId}/chapters | List video chapters |
LiveStreamsApi
Retrieve an instance of LiveStreamsApi:
val client = ApiVideoClient("YOUR_API_KEY")
val liveStreams = client.liveStreams()
Endpoints
Method | HTTP request | Description |
---|---|---|
create | POST /live-streams | Create live stream |
get | GET /live-streams/{liveStreamId} | Retrieve live stream |
update | PATCH /live-streams/{liveStreamId} | Update a live stream |
delete | DELETE /live-streams/{liveStreamId} | Delete a live stream |
list | GET /live-streams | List all live streams |
uploadThumbnail | POST /live-streams/\{liveStreamId}/thumbnail | Upload a thumbnail |
deleteThumbnail | DELETE /live-streams/\{liveStreamId}/thumbnail | Delete a thumbnail |
complete | PUT /live-streams/\{liveStreamId}/complete | Complete a live stream |
PlayerThemesApi
Retrieve an instance of PlayerThemesApi:
val client = ApiVideoClient("YOUR_API_KEY")
val playerThemes = client.playerThemes()
Endpoints
Method | HTTP request | Description |
---|---|---|
create | POST /players | Create a player |
get | GET /players/{playerId} | Retrieve a player |
update | PATCH /players/{playerId} | Update a player |
delete | DELETE /players/{playerId} | Delete a player |
list | GET /players | List all player themes |
uploadLogo | POST /players/\{playerId}/logo | Upload a logo |
deleteLogo | DELETE /players/\{playerId}/logo | Delete logo |
TagsApi
Retrieve an instance of TagsApi:
val client = ApiVideoClient("YOUR_API_KEY")
val tags = client.tags()
Endpoints
Method | HTTP request | Description |
---|---|---|
list | GET /tags | List all video tags |
UploadTokensApi
Retrieve an instance of UploadTokensApi:
val client = ApiVideoClient("YOUR_API_KEY")
val uploadTokens = client.uploadTokens()
Endpoints
Method | HTTP request | Description |
---|---|---|
createToken | POST /upload-tokens | Generate an upload token |
getToken | GET /upload-tokens/{uploadToken} | Retrieve upload token |
deleteToken | DELETE /upload-tokens/{uploadToken} | Delete an upload token |
list | GET /upload-tokens | List all active upload tokens |
VideosApi
Retrieve an instance of VideosApi:
val client = ApiVideoClient("YOUR_API_KEY")
val videos = client.videos()
Endpoints
Method | HTTP request | Description |
---|---|---|
create | POST /videos | Create a video object |
upload | POST /videos/\{videoId}/source | Upload a video |
uploadWithUploadToken | POST /upload | Upload with an delegated upload token |
get | GET /videos/{videoId} | Retrieve a video object |
update | PATCH /videos/{videoId} | Update a video object |
delete | DELETE /videos/{videoId} | Delete a video object |
list | GET /videos | List all video objects |
uploadThumbnail | POST /videos/\{videoId}/thumbnail | Upload a thumbnail |
pickThumbnail | PATCH /videos/\{videoId}/thumbnail | Set a thumbnail |
getDiscarded | GET /discarded/videos/{videoId} | Retrieve a discarded video object |
getStatus | GET /videos/\{videoId}/status | Retrieve video status and details |
listDiscarded | GET /discarded/videos | List all discarded video objects |
updateDiscarded | PATCH /discarded/videos/{videoId} | Update a discarded video object |
WatermarksApi
Retrieve an instance of WatermarksApi:
val client = ApiVideoClient("YOUR_API_KEY")
val watermarks = client.watermarks()
Endpoints
Method | HTTP request | Description |
---|---|---|
upload | POST /watermarks | Upload a watermark |
delete | DELETE /watermarks/{watermarkId} | Delete a watermark |
list | GET /watermarks | List all watermarks |
WebhooksApi
Retrieve an instance of WebhooksApi:
val client = ApiVideoClient("YOUR_API_KEY")
val webhooks = client.webhooks()
Endpoints
Method | HTTP request | Description |
---|---|---|
create | POST /webhooks | Create Webhook |
get | GET /webhooks/{webhookId} | Retrieve Webhook details |
delete | DELETE /webhooks/{webhookId} | Delete a Webhook |
list | GET /webhooks | List all webhooks |
Documentation for Models
Rate Limiting
api.video implements rate limiting to ensure fair usage and stability of the service. The API provides the rate limit values in the response headers for any API requests you make. The /auth endpoint is the only route without rate limitation.
In this client, you can access these headers by using the *WithHttpInfo()
or *Async
versions of the methods. These methods return the ApiResponse
that contains the response body and the headers, allowing you to check the X-RateLimit-Limit
, X-RateLimit-Remaining
, and X-RateLimit-Retry-After
headers to understand your current rate limit status.
Read more about these response headers in the API reference.
Here is an example of how to use these methods:
When listening to the WorkInfo
with the WorkManager
, you can access the headers in the OutputData
of the WorkInfo
:
val headers = workInfo.outputData.toHeaders()
Log.i(TAG, "X-RateLimit-Limit: ${headers["x-ratelimit-limit"]!![0]}")
Log.i(TAG, "X-RateLimit-Remaining: ${headers["x-ratelimit-remaining"]!![0]}")
Log.i(TAG, "X-RateLimit-Retry-After: ${headers["x-ratelimit-retry-after"]!![0]}")
Authorization
API key
Most endpoints required to be authenticated using the API key mechanism described in our documentation.
On Android, you must NOT store your API key in your application code to prevent your API key from being exposed in your source code. Only the Public endpoints can be called without authentication. In the case, you want to call an endpoint that requires authentication, you will have to use a backend server. See Security best practices for more details.
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.