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

Gradle users

Add this dependency to your project's build file:

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

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/java-api-client-1.4.7.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

CaptionsApi

Retrieve an instance of CaptionsApi:

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

Endpoints

ChaptersApi

Retrieve an instance of ChaptersApi:

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

Endpoints

LiveStreamsApi

Retrieve an instance of LiveStreamsApi:

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

Endpoints

PlayerThemesApi

Retrieve an instance of PlayerThemesApi:

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

Endpoints

SummariesApi

Retrieve an instance of SummariesApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
SummariesApi summaries = client.summaries()

Endpoints

TagsApi

Retrieve an instance of TagsApi:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
TagsApi tags = client.tags()

Endpoints

UploadTokensApi

Retrieve an instance of UploadTokensApi:

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

Endpoints

VideosApi

Retrieve an instance of VideosApi:

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

Endpoints

WatermarksApi

Retrieve an instance of WatermarksApi:

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

Endpoints

WebhooksApi

Retrieve an instance of WebhooksApi:

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

Endpoints

Documentation for Models

• AccessToken

• AdditionalBadRequestErrors

• AnalyticsAggregatedMetricsResponse

• AnalyticsAggregatedMetricsResponseContext

• AnalyticsAggregatedMetricsResponseContextTimeframe

• AnalyticsData

• AnalyticsMetricsBreakdownResponse

• AnalyticsMetricsBreakdownResponseContext

• AnalyticsMetricsBreakdownResponseData

• AnalyticsMetricsOverTimeResponse

• AnalyticsMetricsOverTimeResponseContext

• AnalyticsMetricsOverTimeResponseData

• AnalyticsPlays400Error

• AnalyticsPlaysResponse

• AuthenticatePayload

• BadRequest

• BytesRange

• Caption

• CaptionsListResponse

• CaptionsUpdatePayload

• Chapter

• ChaptersListResponse

• ConflictError

• DiscardedVideoUpdatePayload

• FilterBy

• FilterBy1

• FilterBy2

• Link

• ListTagsResponse

• ListTagsResponseData

• LiveStream

• LiveStreamAssets

• LiveStreamCreationPayload

• LiveStreamListResponse

• LiveStreamUpdatePayload

• Metadata

• Model403ErrorSchema

• NotFound

• Pagination

• PaginationLink

• PlayerSessionEvent

• PlayerTheme

• PlayerThemeAssets

• PlayerThemeCreationPayload

• PlayerThemeUpdatePayload

• PlayerThemesListResponse

• Quality

• RefreshTokenPayload

• RestreamsRequestObject

• RestreamsResponseObject

• SummariesListResponse

• Summary

• SummaryCreationPayload

• SummarySource

• SummaryUpdatePayload

• TokenCreationPayload

• TokenListResponse

• TooManyRequests

• UnrecognizedRequestUrl

• UploadToken

• Video

• VideoAssets

• VideoClip

• VideoCreationPayload

• VideoSource

• VideoSourceLiveStream

• VideoSourceLiveStreamLink

• VideoStatus

• VideoStatusEncoding

• VideoStatusEncodingMetadata

• VideoStatusIngest

• VideoStatusIngestReceivedParts

• VideoThumbnailPickPayload

• VideoUpdatePayload

• VideoWatermark

• VideosListResponse

• Watermark

• WatermarksListResponse

• Webhook

• WebhooksCreationPayload

• WebhooksListResponse

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:

ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
ApiResponse<Video> response = client.videos().uploadWithUploadTokenWithHttpInfo("YOUR_UPLOAD_TOKEN", File("my-video.mp4"));
Map<String, List<String>> headers = response.getHeaders();
System.out.println("X-RateLimit-Limit: " + headers.get("X-RateLimit-Limit").get(0));
System.out.println("X-RateLimit-Remaining: " + headers.get("X-RateLimit-Remaining").get(0));
System.out.println("X-RateLimit-Retry-After: " + headers.get("X-RateLimit-Retry-After").get(0));

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.