api.video Java 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 Java 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>java-api-client</artifactId>
  <version>1.3.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

implementation "video.api:java-api-client:1.3.2"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/java-api-client-1.3.2.jar
  • target/lib/*.jar

Code sample

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


import video.api.client.ApiVideoClient;
import video.api.client.api.ApiException;
import video.api.client.api.models.*;

public class Example {
  public static void main(String[] args) {
    ApiVideoClient apiVideoClient = new ApiVideoClient("YOUR_API_KEY");
    // if you rather like to use the sandbox environment:
    // ApiVideoClient apiVideoClient = new ApiVideoClient("YOU_SANDBOX_API_KEY", Environment.SANDBOX);

    File myVideoFile = new File("my-video.mp4");

    try {
        Video video = apiVideoClient.videos().create(new VideoCreationPayload().title("my video"));
        video = apiVideoClient.videos().upload(video.getVideoId(), myVideoFile);
        System.out.println(video);
    } catch (ApiException e) {
        System.err.println("Exception when calling AccountApi#get");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getMessage());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }
  }
}

Documentation

API Endpoints

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

AnalyticsApi

Retrieve an instance of AnalyticsApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
AnalyticsApi analytics = client.analytics()

Endpoints

MethodHTTP requestDescription
getLiveStreamsPlaysGET /analytics/live-streams/playsGet play events for live stream
getVideosPlaysGET /analytics/videos/playsGet play events for video

CaptionsApi

Retrieve an instance of CaptionsApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
CaptionsApi captions = client.captions()

Endpoints

MethodHTTP requestDescription
uploadPOST /videos/{videoId}/captions/{language}Upload a caption
getGET /videos/{videoId}/captions/{language}Retrieve a caption
updatePATCH /videos/{videoId}/captions/{language}Update a caption
deleteDELETE /videos/{videoId}/captions/{language}Delete a caption
listGET /videos/{videoId}/captionsList video captions

ChaptersApi

Retrieve an instance of ChaptersApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
ChaptersApi chapters = client.chapters()

Endpoints

MethodHTTP requestDescription
uploadPOST /videos/{videoId}/chapters/{language}Upload a chapter
getGET /videos/{videoId}/chapters/{language}Retrieve a chapter
deleteDELETE /videos/{videoId}/chapters/{language}Delete a chapter
listGET /videos/{videoId}/chaptersList video chapters

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
LiveStreamsApi liveStreams = client.liveStreams()

Endpoints

MethodHTTP requestDescription
createPOST /live-streamsCreate live stream
getGET /live-streams/{liveStreamId}Retrieve live stream
updatePATCH /live-streams/{liveStreamId}Update a live stream
deleteDELETE /live-streams/{liveStreamId}Delete a live stream
listGET /live-streamsList all live streams
uploadThumbnailPOST /live-streams/{liveStreamId}/thumbnailUpload a thumbnail
deleteThumbnailDELETE /live-streams/{liveStreamId}/thumbnailDelete a thumbnail

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
PlayerThemesApi playerThemes = client.playerThemes()

Endpoints

MethodHTTP requestDescription
createPOST /playersCreate a player
getGET /players/{playerId}Retrieve a player
updatePATCH /players/{playerId}Update a player
deleteDELETE /players/{playerId}Delete a player
listGET /playersList all player themes
uploadLogoPOST /players/{playerId}/logoUpload a logo
deleteLogoDELETE /players/{playerId}/logoDelete logo

UploadTokensApi

Retrieve an instance of UploadTokensApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
UploadTokensApi uploadTokens = client.uploadTokens()

Endpoints

MethodHTTP requestDescription
createTokenPOST /upload-tokensGenerate an upload token
getTokenGET /upload-tokens/{uploadToken}Retrieve upload token
deleteTokenDELETE /upload-tokens/{uploadToken}Delete an upload token
listGET /upload-tokensList all active upload tokens

VideosApi

Retrieve an instance of VideosApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
VideosApi videos = client.videos()

Endpoints

MethodHTTP requestDescription
createPOST /videosCreate a video object
uploadPOST /videos/{videoId}/sourceUpload a video
uploadWithUploadTokenPOST /uploadUpload with an delegated upload token
getGET /videos/{videoId}Retrieve a video object
updatePATCH /videos/{videoId}Update a video object
deleteDELETE /videos/{videoId}Delete a video object
listGET /videosList all video objects
uploadThumbnailPOST /videos/{videoId}/thumbnailUpload a thumbnail
pickThumbnailPATCH /videos/{videoId}/thumbnailSet a thumbnail
getStatusGET /videos/{videoId}/statusRetrieve video status and details

WatermarksApi

Retrieve an instance of WatermarksApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
WatermarksApi watermarks = client.watermarks()

Endpoints

MethodHTTP requestDescription
uploadPOST /watermarksUpload a watermark
deleteDELETE /watermarks/{watermarkId}Delete a watermark
listGET /watermarksList all watermarks

WebhooksApi

Retrieve an instance of WebhooksApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
WebhooksApi webhooks = client.webhooks()

Endpoints

MethodHTTP requestDescription
createPOST /webhooksCreate Webhook
getGET /webhooks/{webhookId}Retrieve Webhook details
deleteDELETE /webhooks/{webhookId}Delete a Webhook
listGET /webhooksList all webhooks

Documentation for Models

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:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");

Public endpoints

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

ApiVideoClient client = new ApiVideoClient();

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

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.

Was this page helpful?