diff --git a/sdks/api-clients/README.md b/sdks/api-clients/README.md index 2fa1a3ee..d136e38a 100644 --- a/sdks/api-clients/README.md +++ b/sdks/api-clients/README.md @@ -25,8 +25,8 @@ Seamlessly integrate video on demand or live streaming into your current tech st {% include "_partials/hagrid-item.md" title: "Java", image: "https://s3.eu-central-1.amazonaws.com/api.video-strapi/java_1b6f259caf.svg", subtitle: "API client", link: "././apivideo-java-client.md" %} -{% include "_partials/hagrid-item.md" title: "Swift", image: "https://s3.eu-central-1.amazonaws.com/api.video-strapi/swift_b6e888925d.svg", subtitle: "API client", link: "././ios-api-client.md" %} +{% include "_partials/hagrid-item.md" title: "Swift", image: "https://s3.eu-central-1.amazonaws.com/api.video-strapi/swift_b6e888925d.svg", subtitle: "API client", link: "././apivideo-swift5-client.md" %} -{% include "_partials/hagrid-item.md" title: "Kotlin", image: "https://s3.eu-central-1.amazonaws.com/api.video-strapi/android_4356dd4e0c.svg", subtitle: "API client", link: "././android-api-client.md" %} +{% include "_partials/hagrid-item.md" title: "Kotlin", image: "https://s3.eu-central-1.amazonaws.com/api.video-strapi/android_4356dd4e0c.svg", subtitle: "API client", link: "././apivideo-android-client.md" %} diff --git a/sdks/api-clients/apivideo-android-client.md b/sdks/api-clients/apivideo-android-client.md new file mode 100644 index 00000000..4ef55eee --- /dev/null +++ b/sdks/api-clients/apivideo-android-client.md @@ -0,0 +1,449 @@ +--- +title: "Android API client" +slug: "android-api-client" +hidden: false +metadata: +description: "The official Android API client for api.video. [api.video](https://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." +--- + +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: + +```xml + + video.api + android-api-client + 1.5.1 + compile + +``` + +### Gradle users + +Add this dependency to your project's build file: + +```groovy +implementation "video.api:android-api-client:1.5.1" +``` + +### Others + +At first generate the JAR by executing: + +```shell +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](#installation) instruction and execute the following Kotlin code: + +```kotlin + +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](examples/workmanager) 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](examples/service) 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`: + +```xml + + + +``` + +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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val analytics = client.analytics() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getLiveStreamsPlays**](https://github.com/apivideo/api.video-android-client/blob/main/docs/AnalyticsApi.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream +[**getVideosPlays**](https://github.com/apivideo/api.video-android-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video + + +### CaptionsApi + + +#### Retrieve an instance of CaptionsApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val captions = client.captions() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsApi.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsApi.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption +[**update**](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsApi.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsApi.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsApi.md#list) | **GET** /videos/{videoId}/captions | List video captions + + +### ChaptersApi + + +#### Retrieve an instance of ChaptersApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val chapters = client.chapters() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](https://github.com/apivideo/api.video-android-client/blob/main/docs/ChaptersApi.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/ChaptersApi.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/ChaptersApi.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/ChaptersApi.md#list) | **GET** /videos/{videoId}/chapters | List video chapters + + +### LiveStreamsApi + + +#### Retrieve an instance of LiveStreamsApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val liveStreams = client.liveStreams() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#create) | **POST** /live-streams | Create live stream +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream +[**update**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#list) | **GET** /live-streams | List all live streams +[**uploadThumbnail**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail +[**deleteThumbnail**](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamsApi.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail + + +### PlayerThemesApi + + +#### Retrieve an instance of PlayerThemesApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val playerThemes = client.playerThemes() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#create) | **POST** /players | Create a player +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#get) | **GET** /players/{playerId} | Retrieve a player +[**update**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#list) | **GET** /players | List all player themes +[**uploadLogo**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo +[**deleteLogo**](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo + + +### RawStatisticsApi + + +#### Retrieve an instance of RawStatisticsApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val rawStatistics = client.rawStatistics() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**listLiveStreamSessions**](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsApi.md#listLiveStreamSessions) | **GET** /analytics/live-streams/{liveStreamId} | List live stream player sessions +[**listSessionEvents**](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsApi.md#listSessionEvents) | **GET** /analytics/sessions/{sessionId}/events | List player session events +[**listVideoSessions**](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsApi.md#listVideoSessions) | **GET** /analytics/videos/{videoId} | List video player sessions + + +### UploadTokensApi + + +#### Retrieve an instance of UploadTokensApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val uploadTokens = client.uploadTokens() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createToken**](https://github.com/apivideo/api.video-android-client/blob/main/docs/UploadTokensApi.md#createToken) | **POST** /upload-tokens | Generate an upload token +[**getToken**](https://github.com/apivideo/api.video-android-client/blob/main/docs/UploadTokensApi.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token +[**deleteToken**](https://github.com/apivideo/api.video-android-client/blob/main/docs/UploadTokensApi.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/UploadTokensApi.md#list) | **GET** /upload-tokens | List all active upload tokens + + +### VideosApi + + +#### Retrieve an instance of VideosApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val videos = client.videos() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#create) | **POST** /videos | Create a video object +[**upload**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#get) | **GET** /videos/{videoId} | Retrieve a video object +[**update**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#update) | **PATCH** /videos/{videoId} | Update a video object +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#delete) | **DELETE** /videos/{videoId} | Delete a video object +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#list) | **GET** /videos | List all video objects +[**uploadThumbnail**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail +[**pickThumbnail**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail +[**getStatus**](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosApi.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details + + +### WatermarksApi + + +#### Retrieve an instance of WatermarksApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val watermarks = client.watermarks() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WatermarksApi.md#upload) | **POST** /watermarks | Upload a watermark +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WatermarksApi.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WatermarksApi.md#list) | **GET** /watermarks | List all watermarks + + +### WebhooksApi + + +#### Retrieve an instance of WebhooksApi: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val webhooks = client.webhooks() +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksApi.md#create) | **POST** /webhooks | Create Webhook +[**get**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksApi.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details +[**delete**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksApi.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook +[**list**](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksApi.md#list) | **GET** /webhooks | List all webhooks + + + +## Documentation for Models + + - [AccessToken](https://github.com/apivideo/api.video-android-client/blob/main/docs/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-android-client/blob/main/docs/AdditionalBadRequestErrors.md) + - [AnalyticsData](https://github.com/apivideo/api.video-android-client/blob/main/docs/AnalyticsData.md) + - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-android-client/blob/main/docs/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-android-client/blob/main/docs/BadRequest.md) + - [BytesRange](https://github.com/apivideo/api.video-android-client/blob/main/docs/BytesRange.md) + - [Caption](https://github.com/apivideo/api.video-android-client/blob/main/docs/Caption.md) + - [CaptionsListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsListResponse.md) + - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/CaptionsUpdatePayload.md) + - [Chapter](https://github.com/apivideo/api.video-android-client/blob/main/docs/Chapter.md) + - [ChaptersListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/ChaptersListResponse.md) + - [Link](https://github.com/apivideo/api.video-android-client/blob/main/docs/Link.md) + - [LiveStream](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStream.md) + - [LiveStreamAssets](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamAssets.md) + - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamListResponse.md) + - [LiveStreamSession](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSession.md) + - [LiveStreamSessionClient](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/LiveStreamUpdatePayload.md) + - [Metadata](https://github.com/apivideo/api.video-android-client/blob/main/docs/Metadata.md) + - [Model403ErrorSchema](https://github.com/apivideo/api.video-android-client/blob/main/docs/Model403ErrorSchema.md) + - [NotFound](https://github.com/apivideo/api.video-android-client/blob/main/docs/NotFound.md) + - [Pagination](https://github.com/apivideo/api.video-android-client/blob/main/docs/Pagination.md) + - [PaginationLink](https://github.com/apivideo/api.video-android-client/blob/main/docs/PaginationLink.md) + - [PlayerSessionEvent](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerSessionEvent.md) + - [PlayerTheme](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerTheme.md) + - [PlayerThemeAssets](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/PlayerThemesListResponse.md) + - [Quality](https://github.com/apivideo/api.video-android-client/blob/main/docs/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/RefreshTokenPayload.md) + - [RestreamsRequestObject](https://github.com/apivideo/api.video-android-client/blob/main/docs/RestreamsRequestObject.md) + - [RestreamsResponseObject](https://github.com/apivideo/api.video-android-client/blob/main/docs/RestreamsResponseObject.md) + - [TokenCreationPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/TokenCreationPayload.md) + - [TokenListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/TokenListResponse.md) + - [UploadToken](https://github.com/apivideo/api.video-android-client/blob/main/docs/UploadToken.md) + - [Video](https://github.com/apivideo/api.video-android-client/blob/main/docs/Video.md) + - [VideoAssets](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoAssets.md) + - [VideoClip](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoClip.md) + - [VideoCreationPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoCreationPayload.md) + - [VideoSession](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSession.md) + - [VideoSessionClient](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionClient.md) + - [VideoSessionDevice](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionDevice.md) + - [VideoSessionLocation](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionLocation.md) + - [VideoSessionOs](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionOs.md) + - [VideoSessionReferrer](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionReferrer.md) + - [VideoSessionSession](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSessionSession.md) + - [VideoSource](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSource.md) + - [VideoSourceLiveStream](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoSourceLiveStreamLink.md) + - [VideoStatus](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoStatus.md) + - [VideoStatusEncoding](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoUpdatePayload.md) + - [VideoWatermark](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideoWatermark.md) + - [VideosListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/VideosListResponse.md) + - [Watermark](https://github.com/apivideo/api.video-android-client/blob/main/docs/Watermark.md) + - [WatermarksListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/WatermarksListResponse.md) + - [Webhook](https://github.com/apivideo/api.video-android-client/blob/main/docs/Webhook.md) + - [WebhooksCreationPayload](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksCreationPayload.md) + - [WebhooksListResponse](https://github.com/apivideo/api.video-android-client/blob/main/docs/WebhooksListResponse.md) + + +## Documentation for Authorization + +### API key + +Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication). +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`: +```kotlin +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: +```kotlin +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](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/sdks/api-clients/apivideo-android-uploader-client.md b/sdks/api-clients/apivideo-android-uploader-client.md new file mode 100644 index 00000000..83aa5549 --- /dev/null +++ b/sdks/api-clients/apivideo-android-uploader-client.md @@ -0,0 +1,174 @@ +--- +title: "Android uploader" +slug: "android-uploader" +hidden: false +metadata: +description: "The official Android uploader for api.video. [api.video](https://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." +--- + +Android uploader +============== + +# 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: + +```xml + + video.api + android-video-uploader + 1.3.1 + compile + +``` + +### Gradle users + +Add this dependency to your project's build file: + +```groovy +implementation "video.api:android-video-uploader:1.3.1" +``` + +### Others + +At first generate the JAR by executing: + +```shell +mvn clean package +``` + +Then manually install the following JARs: + +* `target/android-video-uploader-1.3.1.jar` +* `target/lib/*.jar` + +## Code sample + +Please follow the [installation](#installation) instruction and execute the following Kotlin code: + +```kotlin +// 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) +// If you rather like to upload with your "YOUR_API_KEY" (upload) +// VideosApiStore.initialize("YOUR_API_KEY", Environment.PRODUCTION) +// if you rather like to use the sandbox environment: +// VideosApiStore.initialize("YOU_SANDBOX_API_KEY", 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 +// if your rather like to use your API key: +// workManager.upload("MY_VIDEO_ID", myVideoFile) +``` + +### 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](examples/workmanager) 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](examples/service) 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`: + +```xml + + + +``` + +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* + + +### VideosApi + + +#### Retrieve an instance of VideosApi: +```kotlin +val videosApi = VideosApi("YOUR_API_KEY", Environment.PRODUCTION) +``` + + + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token + + + +## Documentation for Models + + - [AccessToken](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AdditionalBadRequestErrors.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/BadRequest.md) + - [Metadata](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/Metadata.md) + - [NotFound](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/NotFound.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/RefreshTokenPayload.md) + - [Video](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/Video.md) + - [VideoAssets](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoAssets.md) + - [VideoSource](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSource.md) + - [VideoSourceLiveStream](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-android-uploader/blob/main/docs/VideoSourceLiveStreamLink.md) + + +## Documentation for Authorization + +### API key + +Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication). +The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key when instantiating the `ApiClient`: +```kotlin +val videosApi = VideosApi("YOUR_API_KEY", Environment.PRODUCTION) +``` + +### Public endpoints + +Some endpoints don't require authentication. These one can be called with a client instantiated without API key: +```kotlin +val videosApi = VideosApi() +``` + +## 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](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. \ No newline at end of file diff --git a/sdks/api-clients/apivideo-csharp-client.md b/sdks/api-clients/apivideo-csharp-client.md index 924c939c..d10d4bf0 100644 --- a/sdks/api-clients/apivideo-csharp-client.md +++ b/sdks/api-clients/apivideo-csharp-client.md @@ -2,50 +2,13 @@ title: "C# API client" slug: "csharp-api-client" hidden: false -metadata: - description: "The official C# client for api.video. [api.video](https://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." +metadata: +description: "The official C# client for api.video. [api.video](https://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." --- C# API Client ============== -[api.video](https://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](#project-description) -- [Getting started](#getting-started) - - [Requirements](#requirements) - - [Frameworks supported](#frameworks-supported) - - [Dependencies](#dependencies) - - [Installation](#installation) - - [Using Nuget](#using-nuget) - - [Generating the DLL yourself](#generating-the-dll-yourself) - - [Code sample](#code-sample) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [AnalyticsApi](#analyticsapi) - - [CaptionsApi](#captionsapi) - - [ChaptersApi](#chaptersapi) - - [LiveStreamsApi](#livestreamsapi) - - [PlayerThemesApi](#playerthemesapi) - - [RawStatisticsApi](#rawstatisticsapi) - - [UploadTokensApi](#uploadtokensapi) - - [VideosApi](#videosapi) - - [WatermarksApi](#watermarksapi) - - [WebhooksApi](#webhooksapi) - - [Models](#models) - - [Authorization](#authorization) - - [API key](#api-key) - - [Public endpoints](#public-endpoints) - - [Recommendation](#recommendation) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - -# Project description - -api.video's C# API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. - # Getting started ## Requirements diff --git a/sdks/api-clients/apivideo-go-client.md b/sdks/api-clients/apivideo-go-client.md index 0511891e..ff2c73b9 100644 --- a/sdks/api-clients/apivideo-go-client.md +++ b/sdks/api-clients/apivideo-go-client.md @@ -2,39 +2,12 @@ title: "Go API client" slug: "go-api-client" hidden: false -metadata: - description: "The official Go client for api.video. [api.video](https://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." +metadata: +description: "The official Go client for api.video. [api.video](https://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." --- Go API Client ============== -[api.video](https://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](#project-description) -- [Getting started](#getting-started) - - [Installation](#installation) - - [Code sample](#code-sample) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [Analytics](#analytics) - - [Captions](#captions) - - [Chapters](#chapters) - - [LiveStreams](#livestreams) - - [PlayerThemes](#playerthemes) - - [RawStatistics](#rawstatistics) - - [UploadTokens](#uploadtokens) - - [Videos](#videos) - - [Watermarks](#watermarks) - - [Webhooks](#webhooks) - - [Models](#models) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - -# Project description - -api.video's Java Go client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. # Getting started @@ -46,7 +19,7 @@ go get github.com/apivideo/api.video-go-client ## Code sample -For a more advanced usage you can checkout the rest of the documentation in the [docs directory](https://github.com/apivideo/api.video-go-client/blob/main/docs/) +For a more advanced usage you can checkout the rest of the documentation in the [docs directory](docs/) ```golang package main diff --git a/sdks/api-clients/apivideo-java-client.md b/sdks/api-clients/apivideo-java-client.md index b8d509ad..52caaeb5 100644 --- a/sdks/api-clients/apivideo-java-client.md +++ b/sdks/api-clients/apivideo-java-client.md @@ -2,47 +2,12 @@ title: "Java API client" slug: "java-api-client" hidden: false -metadata: - description: "The official Java client for api.video. [api.video](https://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." +metadata: +description: "The official Java API client for api.video. [api.video](https://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." --- -Java API Client +Java API client ============== -[api.video](https://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](#project-description) -- [Getting started](#getting-started) - - [Requirements](#requirements) - - [Installation](#installation) - - [Maven users](#maven-users) - - [Gradle users](#gradle-users) - - [Others](#others) - - [Code sample](#code-sample) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [AnalyticsApi](#analyticsapi) - - [CaptionsApi](#captionsapi) - - [ChaptersApi](#chaptersapi) - - [LiveStreamsApi](#livestreamsapi) - - [PlayerThemesApi](#playerthemesapi) - - [RawStatisticsApi](#rawstatisticsapi) - - [UploadTokensApi](#uploadtokensapi) - - [VideosApi](#videosapi) - - [WatermarksApi](#watermarksapi) - - [WebhooksApi](#webhooksapi) - - [Models](#models) - - [Authorization](#documentation-for-authorization) - - [API key](#api-key) - - [Public endpoints](#public-endpoints) - - [Recommendation](#recommendation) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - -# Project description - -api.video's Java streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. # Getting started @@ -145,8 +110,8 @@ AnalyticsApi analytics = client.analytics() Method | HTTP request | Description ------------- | ------------- | ------------- -[**getLiveStreamsPlays**]https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsApi.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream -[**getVideosPlays**]https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video +[**getLiveStreamsPlays**](https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsApi.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream +[**getVideosPlays**](https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video ### CaptionsApi @@ -164,11 +129,11 @@ CaptionsApi captions = client.captions() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption -[**update**]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#list) | **GET** /videos/{videoId}/captions | List video captions +[**upload**](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption +[**update**](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsApi.md#list) | **GET** /videos/{videoId}/captions | List video captions ### ChaptersApi @@ -186,10 +151,10 @@ ChaptersApi chapters = client.chapters() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**]https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#list) | **GET** /videos/{videoId}/chapters | List video chapters +[**upload**](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersApi.md#list) | **GET** /videos/{videoId}/chapters | List video chapters ### LiveStreamsApi @@ -207,13 +172,13 @@ LiveStreamsApi liveStreams = client.liveStreams() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#create) | **POST** /live-streams | Create live stream -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream -[**update**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#list) | **GET** /live-streams | List all live streams -[**uploadThumbnail**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail -[**deleteThumbnail**]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail +[**create**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#create) | **POST** /live-streams | Create live stream +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream +[**update**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#list) | **GET** /live-streams | List all live streams +[**uploadThumbnail**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail +[**deleteThumbnail**](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamsApi.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail ### PlayerThemesApi @@ -231,13 +196,13 @@ PlayerThemesApi playerThemes = client.playerThemes() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#create) | **POST** /players | Create a player -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#get) | **GET** /players/{playerId} | Retrieve a player -[**update**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#list) | **GET** /players | List all player themes -[**uploadLogo**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo -[**deleteLogo**]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo +[**create**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#create) | **POST** /players | Create a player +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#get) | **GET** /players/{playerId} | Retrieve a player +[**update**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#list) | **GET** /players | List all player themes +[**uploadLogo**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo +[**deleteLogo**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo ### RawStatisticsApi @@ -255,9 +220,9 @@ RawStatisticsApi rawStatistics = client.rawStatistics() Method | HTTP request | Description ------------- | ------------- | ------------- -[**listLiveStreamSessions**]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listLiveStreamSessions) | **GET** /analytics/live-streams/{liveStreamId} | List live stream player sessions -[**listSessionEvents**]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listSessionEvents) | **GET** /analytics/sessions/{sessionId}/events | List player session events -[**listVideoSessions**]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listVideoSessions) | **GET** /analytics/videos/{videoId} | List video player sessions +[**listLiveStreamSessions**](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listLiveStreamSessions) | **GET** /analytics/live-streams/{liveStreamId} | List live stream player sessions +[**listSessionEvents**](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listSessionEvents) | **GET** /analytics/sessions/{sessionId}/events | List player session events +[**listVideoSessions**](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsApi.md#listVideoSessions) | **GET** /analytics/videos/{videoId} | List video player sessions ### UploadTokensApi @@ -275,10 +240,10 @@ UploadTokensApi uploadTokens = client.uploadTokens() Method | HTTP request | Description ------------- | ------------- | ------------- -[**createToken**]https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#createToken) | **POST** /upload-tokens | Generate an upload token -[**getToken**]https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token -[**deleteToken**]https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#list) | **GET** /upload-tokens | List all active upload tokens +[**createToken**](https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#createToken) | **POST** /upload-tokens | Generate an upload token +[**getToken**](https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token +[**deleteToken**](https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadTokensApi.md#list) | **GET** /upload-tokens | List all active upload tokens ### VideosApi @@ -296,16 +261,16 @@ VideosApi videos = client.videos() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#create) | **POST** /videos | Create a video object -[**upload**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video -[**uploadWithUploadToken**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#get) | **GET** /videos/{videoId} | Retrieve a video object -[**update**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#update) | **PATCH** /videos/{videoId} | Update a video object -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#delete) | **DELETE** /videos/{videoId} | Delete a video object -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#list) | **GET** /videos | List all video objects -[**uploadThumbnail**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail -[**pickThumbnail**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail -[**getStatus**]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details +[**create**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#create) | **POST** /videos | Create a video object +[**upload**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#get) | **GET** /videos/{videoId} | Retrieve a video object +[**update**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#update) | **PATCH** /videos/{videoId} | Update a video object +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#delete) | **DELETE** /videos/{videoId} | Delete a video object +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#list) | **GET** /videos | List all video objects +[**uploadThumbnail**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail +[**pickThumbnail**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail +[**getStatus**](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosApi.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details ### WatermarksApi @@ -323,9 +288,9 @@ WatermarksApi watermarks = client.watermarks() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#upload) | **POST** /watermarks | Upload a watermark -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#list) | **GET** /watermarks | List all watermarks +[**upload**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#upload) | **POST** /watermarks | Upload a watermark +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksApi.md#list) | **GET** /watermarks | List all watermarks ### WebhooksApi @@ -343,89 +308,89 @@ WebhooksApi webhooks = client.webhooks() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#create) | **POST** /webhooks | Create Webhook -[**get**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details -[**delete**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook -[**list**]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#list) | **GET** /webhooks | List all webhooks +[**create**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#create) | **POST** /webhooks | Create Webhook +[**get**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details +[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook +[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksApi.md#list) | **GET** /webhooks | List all webhooks ## Documentation for Models - - [AccessToken]https://github.com/apivideo/api.video-java-client/blob/main/docs/AccessToken.md) - - [AdditionalBadRequestErrors]https://github.com/apivideo/api.video-java-client/blob/main/docs/AdditionalBadRequestErrors.md) - - [AnalyticsData]https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsData.md) - - [AnalyticsPlays400Error]https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsPlaysResponse.md) - - [AuthenticatePayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/AuthenticatePayload.md) - - [BadRequest]https://github.com/apivideo/api.video-java-client/blob/main/docs/BadRequest.md) - - [BytesRange]https://github.com/apivideo/api.video-java-client/blob/main/docs/BytesRange.md) - - [Caption]https://github.com/apivideo/api.video-java-client/blob/main/docs/Caption.md) - - [CaptionsListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsListResponse.md) - - [CaptionsUpdatePayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsUpdatePayload.md) - - [Chapter]https://github.com/apivideo/api.video-java-client/blob/main/docs/Chapter.md) - - [ChaptersListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersListResponse.md) - - [Link]https://github.com/apivideo/api.video-java-client/blob/main/docs/Link.md) - - [LiveStream]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStream.md) - - [LiveStreamAssets]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamAssets.md) - - [LiveStreamCreationPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamCreationPayload.md) - - [LiveStreamListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamListResponse.md) - - [LiveStreamSession]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSession.md) - - [LiveStreamSessionClient]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamUpdatePayload.md) - - [Metadata]https://github.com/apivideo/api.video-java-client/blob/main/docs/Metadata.md) - - [Model403ErrorSchema]https://github.com/apivideo/api.video-java-client/blob/main/docs/Model403ErrorSchema.md) - - [NotFound]https://github.com/apivideo/api.video-java-client/blob/main/docs/NotFound.md) - - [Pagination]https://github.com/apivideo/api.video-java-client/blob/main/docs/Pagination.md) - - [PaginationLink]https://github.com/apivideo/api.video-java-client/blob/main/docs/PaginationLink.md) - - [PlayerSessionEvent]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerSessionEvent.md) - - [PlayerTheme]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerTheme.md) - - [PlayerThemeAssets]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesListResponse.md) - - [Quality]https://github.com/apivideo/api.video-java-client/blob/main/docs/Quality.md) - - [RawStatisticsListLiveStreamAnalyticsResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListLiveStreamAnalyticsResponse.md) - - [RawStatisticsListPlayerSessionEventsResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md) - - [RawStatisticsListSessionsResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListSessionsResponse.md) - - [RefreshTokenPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/RefreshTokenPayload.md) - - [RestreamsRequestObject]https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsRequestObject.md) - - [RestreamsResponseObject]https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsResponseObject.md) - - [TokenCreationPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenCreationPayload.md) - - [TokenListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenListResponse.md) - - [UploadToken]https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadToken.md) - - [Video]https://github.com/apivideo/api.video-java-client/blob/main/docs/Video.md) - - [VideoAssets]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoAssets.md) - - [VideoClip]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoClip.md) - - [VideoCreationPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoCreationPayload.md) - - [VideoSession]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSession.md) - - [VideoSessionClient]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionClient.md) - - [VideoSessionDevice]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionDevice.md) - - [VideoSessionLocation]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionLocation.md) - - [VideoSessionOs]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionOs.md) - - [VideoSessionReferrer]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionReferrer.md) - - [VideoSessionSession]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionSession.md) - - [VideoSource]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSource.md) - - [VideoSourceLiveStream]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSourceLiveStreamLink.md) - - [VideoStatus]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatus.md) - - [VideoStatusEncoding]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoUpdatePayload.md) - - [VideoWatermark]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoWatermark.md) - - [VideosListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosListResponse.md) - - [Watermark]https://github.com/apivideo/api.video-java-client/blob/main/docs/Watermark.md) - - [WatermarksListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksListResponse.md) - - [Webhook]https://github.com/apivideo/api.video-java-client/blob/main/docs/Webhook.md) - - [WebhooksCreationPayload]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksCreationPayload.md) - - [WebhooksListResponse]https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksListResponse.md) + - [AccessToken](https://github.com/apivideo/api.video-java-client/blob/main/docs/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-java-client/blob/main/docs/AdditionalBadRequestErrors.md) + - [AnalyticsData](https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsData.md) + - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-java-client/blob/main/docs/BadRequest.md) + - [BytesRange](https://github.com/apivideo/api.video-java-client/blob/main/docs/BytesRange.md) + - [Caption](https://github.com/apivideo/api.video-java-client/blob/main/docs/Caption.md) + - [CaptionsListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsListResponse.md) + - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsUpdatePayload.md) + - [Chapter](https://github.com/apivideo/api.video-java-client/blob/main/docs/Chapter.md) + - [ChaptersListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersListResponse.md) + - [Link](https://github.com/apivideo/api.video-java-client/blob/main/docs/Link.md) + - [LiveStream](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStream.md) + - [LiveStreamAssets](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamAssets.md) + - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamListResponse.md) + - [LiveStreamSession](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSession.md) + - [LiveStreamSessionClient](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/LiveStreamUpdatePayload.md) + - [Metadata](https://github.com/apivideo/api.video-java-client/blob/main/docs/Metadata.md) + - [Model403ErrorSchema](https://github.com/apivideo/api.video-java-client/blob/main/docs/Model403ErrorSchema.md) + - [NotFound](https://github.com/apivideo/api.video-java-client/blob/main/docs/NotFound.md) + - [Pagination](https://github.com/apivideo/api.video-java-client/blob/main/docs/Pagination.md) + - [PaginationLink](https://github.com/apivideo/api.video-java-client/blob/main/docs/PaginationLink.md) + - [PlayerSessionEvent](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerSessionEvent.md) + - [PlayerTheme](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerTheme.md) + - [PlayerThemeAssets](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesListResponse.md) + - [Quality](https://github.com/apivideo/api.video-java-client/blob/main/docs/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/RefreshTokenPayload.md) + - [RestreamsRequestObject](https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsRequestObject.md) + - [RestreamsResponseObject](https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsResponseObject.md) + - [TokenCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenCreationPayload.md) + - [TokenListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenListResponse.md) + - [UploadToken](https://github.com/apivideo/api.video-java-client/blob/main/docs/UploadToken.md) + - [Video](https://github.com/apivideo/api.video-java-client/blob/main/docs/Video.md) + - [VideoAssets](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoAssets.md) + - [VideoClip](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoClip.md) + - [VideoCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoCreationPayload.md) + - [VideoSession](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSession.md) + - [VideoSessionClient](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionClient.md) + - [VideoSessionDevice](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionDevice.md) + - [VideoSessionLocation](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionLocation.md) + - [VideoSessionOs](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionOs.md) + - [VideoSessionReferrer](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionReferrer.md) + - [VideoSessionSession](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSessionSession.md) + - [VideoSource](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSource.md) + - [VideoSourceLiveStream](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoSourceLiveStreamLink.md) + - [VideoStatus](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatus.md) + - [VideoStatusEncoding](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoUpdatePayload.md) + - [VideoWatermark](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideoWatermark.md) + - [VideosListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/VideosListResponse.md) + - [Watermark](https://github.com/apivideo/api.video-java-client/blob/main/docs/Watermark.md) + - [WatermarksListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/WatermarksListResponse.md) + - [Webhook](https://github.com/apivideo/api.video-java-client/blob/main/docs/Webhook.md) + - [WebhooksCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksCreationPayload.md) + - [WebhooksListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/WebhooksListResponse.md) ## Documentation for Authorization diff --git a/sdks/api-clients/apivideo-nodejs-client.md b/sdks/api-clients/apivideo-nodejs-client.md index a078d39c..f0d33932 100644 --- a/sdks/api-clients/apivideo-nodejs-client.md +++ b/sdks/api-clients/apivideo-nodejs-client.md @@ -2,47 +2,13 @@ title: "NodeJS API client" slug: "nodejs-api-client" hidden: false -metadata: - description: "The official NodeJS client for api.video. [api.video](https://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." +metadata: +description: "The official NodeJS client for api.video. [api.video](https://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." --- NodeJS API Client ============== -[api.video](https://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](#project-description) -- [Getting started](#getting-started) - - [Installation](#installation) - - [Migration](#migration) - - [Development](#development) - - [Code sample](#code-sample) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [AnalyticsApi](#analyticsapi) - - [CaptionsApi](#captionsapi) - - [ChaptersApi](#chaptersapi) - - [LiveStreamsApi](#livestreamsapi) - - [PlayerThemesApi](#playerthemesapi) - - [RawStatisticsApi](#rawstatisticsapi) - - [UploadTokensApi](#uploadtokensapi) - - [VideosApi](#videosapi) - - [WatermarksApi](#watermarksapi) - - [WebhooksApi](#webhooksapi) - - [Models](#models) - - [Authorization](#authorization) - - [API key](#api-key) - - [Get the access token](#get-the-access-token) - - [Public endpoints](#public-endpoints) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - -# Project description - -api.video's Java Node.js is a lightweight client built in `TypeScript` that streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. - # Getting started ## Installation @@ -58,7 +24,7 @@ yarn add @api.video/nodejs-client ## Migration -If you're coming from [@api.video/nodejs-sdk](https://github.com/apivideo/nodejs-sdk) make sure to read our [Migration guide](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/MIGRATE.md) first. +If you're coming from [@api.video/nodejs-sdk](https://github.com/apivideo/nodejs-sdk) make sure to read our [Migration guide](./docs/MIGRATE.md) first. ## Development @@ -102,188 +68,188 @@ const ApiVideoClient = require('@api.video/nodejs-client'); Method | Description | HTTP request ------------- | ------------- | ------------- -[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays -[**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays +[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays +[**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays ### CaptionsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/CaptionsApi.md#upload) | Upload a caption | **POST** /videos/{videoId}/captions/{language} -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/CaptionsApi.md#get) | Retrieve a caption | **GET** /videos/{videoId}/captions/{language} -[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/CaptionsApi.md#update) | Update a caption | **PATCH** /videos/{videoId}/captions/{language} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/CaptionsApi.md#delete) | Delete a caption | **DELETE** /videos/{videoId}/captions/{language} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/CaptionsApi.md#list) | List video captions | **GET** /videos/{videoId}/captions +[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#upload) | Upload a caption | **POST** /videos/{videoId}/captions/{language} +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#get) | Retrieve a caption | **GET** /videos/{videoId}/captions/{language} +[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#update) | Update a caption | **PATCH** /videos/{videoId}/captions/{language} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#delete) | Delete a caption | **DELETE** /videos/{videoId}/captions/{language} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/CaptionsApi.md#list) | List video captions | **GET** /videos/{videoId}/captions ### ChaptersApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/ChaptersApi.md#upload) | Upload a chapter | **POST** /videos/{videoId}/chapters/{language} -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/ChaptersApi.md#get) | Retrieve a chapter | **GET** /videos/{videoId}/chapters/{language} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** /videos/{videoId}/chapters/{language} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/ChaptersApi.md#list) | List video chapters | **GET** /videos/{videoId}/chapters +[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#upload) | Upload a chapter | **POST** /videos/{videoId}/chapters/{language} +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#get) | Retrieve a chapter | **GET** /videos/{videoId}/chapters/{language} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** /videos/{videoId}/chapters/{language} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/ChaptersApi.md#list) | List video chapters | **GET** /videos/{videoId}/chapters ### LiveStreamsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#create) | Create live stream | **POST** /live-streams -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** /live-streams/{liveStreamId} -[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** /live-streams/{liveStreamId} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** /live-streams/{liveStreamId} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#list) | List all live streams | **GET** /live-streams -[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /live-streams/{liveStreamId}/thumbnail -[**deleteThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** /live-streams/{liveStreamId}/thumbnail +[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#create) | Create live stream | **POST** /live-streams +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** /live-streams/{liveStreamId} +[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** /live-streams/{liveStreamId} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** /live-streams/{liveStreamId} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#list) | List all live streams | **GET** /live-streams +[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /live-streams/{liveStreamId}/thumbnail +[**deleteThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** /live-streams/{liveStreamId}/thumbnail ### PlayerThemesApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#create) | Create a player | **POST** /players -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#get) | Retrieve a player | **GET** /players/{playerId} -[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#update) | Update a player | **PATCH** /players/{playerId} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** /players/{playerId} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#list) | List all player themes | **GET** /players -[**uploadLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** /players/{playerId}/logo -[**deleteLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** /players/{playerId}/logo +[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#create) | Create a player | **POST** /players +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#get) | Retrieve a player | **GET** /players/{playerId} +[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#update) | Update a player | **PATCH** /players/{playerId} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** /players/{playerId} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#list) | List all player themes | **GET** /players +[**uploadLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** /players/{playerId}/logo +[**deleteLogo()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** /players/{playerId}/logo ### RawStatisticsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**listLiveStreamSessions()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/RawStatisticsApi.md#listLiveStreamSessions) | List live stream player sessions | **GET** /analytics/live-streams/{liveStreamId} -[**listSessionEvents()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/RawStatisticsApi.md#listSessionEvents) | List player session events | **GET** /analytics/sessions/{sessionId}/events -[**listVideoSessions()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/RawStatisticsApi.md#listVideoSessions) | List video player sessions | **GET** /analytics/videos/{videoId} +[**listLiveStreamSessions()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/RawStatisticsApi.md#listLiveStreamSessions) | List live stream player sessions | **GET** /analytics/live-streams/{liveStreamId} +[**listSessionEvents()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/RawStatisticsApi.md#listSessionEvents) | List player session events | **GET** /analytics/sessions/{sessionId}/events +[**listVideoSessions()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/RawStatisticsApi.md#listVideoSessions) | List video player sessions | **GET** /analytics/videos/{videoId} ### UploadTokensApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**createToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** /upload-tokens -[**getToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** /upload-tokens/{uploadToken} -[**deleteToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** /upload-tokens/{uploadToken} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/UploadTokensApi.md#list) | List all active upload tokens | **GET** /upload-tokens +[**createToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** /upload-tokens +[**getToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** /upload-tokens/{uploadToken} +[**deleteToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** /upload-tokens/{uploadToken} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/UploadTokensApi.md#list) | List all active upload tokens | **GET** /upload-tokens ### VideosApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#create) | Create a video object | **POST** /videos -[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#upload) | Upload a video | **POST** /videos/{videoId}/source -[**uploadWithUploadToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** /upload -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#get) | Retrieve a video object | **GET** /videos/{videoId} -[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#update) | Update a video object | **PATCH** /videos/{videoId} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#delete) | Delete a video object | **DELETE** /videos/{videoId} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#list) | List all video objects | **GET** /videos -[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /videos/{videoId}/thumbnail -[**pickThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** /videos/{videoId}/thumbnail -[**getStatus()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** /videos/{videoId}/status +[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#create) | Create a video object | **POST** /videos +[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#upload) | Upload a video | **POST** /videos/{videoId}/source +[**uploadWithUploadToken()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** /upload +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#get) | Retrieve a video object | **GET** /videos/{videoId} +[**update()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#update) | Update a video object | **PATCH** /videos/{videoId} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#delete) | Delete a video object | **DELETE** /videos/{videoId} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#list) | List all video objects | **GET** /videos +[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /videos/{videoId}/thumbnail +[**pickThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** /videos/{videoId}/thumbnail +[**getStatus()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** /videos/{videoId}/status ### WatermarksApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WatermarksApi.md#upload) | Upload a watermark | **POST** /watermarks -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** /watermarks/{watermarkId} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WatermarksApi.md#list) | List all watermarks | **GET** /watermarks +[**upload()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#upload) | Upload a watermark | **POST** /watermarks +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** /watermarks/{watermarkId} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WatermarksApi.md#list) | List all watermarks | **GET** /watermarks ### WebhooksApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WebhooksApi.md#create) | Create Webhook | **POST** /webhooks -[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** /webhooks/{webhookId} -[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** /webhooks/{webhookId} -[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/api/WebhooksApi.md#list) | List all webhooks | **GET** /webhooks +[**create()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#create) | Create Webhook | **POST** /webhooks +[**get()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** /webhooks/{webhookId} +[**delete()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** /webhooks/{webhookId} +[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/WebhooksApi.md#list) | List all webhooks | **GET** /webhooks ## Models - - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AccessToken.md) - - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AdditionalBadRequestErrors.md) - - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AnalyticsData.md) - - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/AuthenticatePayload.md) - - [BadRequest](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/BadRequest.md) - - [BytesRange](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/BytesRange.md) - - [Caption](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Caption.md) - - [CaptionsListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/CaptionsListResponse.md) - - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/CaptionsUpdatePayload.md) - - [Chapter](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Chapter.md) - - [ChaptersListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/ChaptersListResponse.md) - - [Link](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Link.md) - - [LiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStream.md) - - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamAssets.md) - - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/LiveStreamUpdatePayload.md) - - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Metadata.md) - - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Model403ErrorSchema.md) - - [NotFound](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/NotFound.md) - - [Pagination](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Pagination.md) - - [PaginationLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PaginationLink.md) - - [PlayerSessionEvent](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerSessionEvent.md) - - [PlayerTheme](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerTheme.md) - - [PlayerThemeAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/PlayerThemesListResponse.md) - - [Quality](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Quality.md) - - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RawStatisticsListLiveStreamAnalyticsResponse.md) - - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RawStatisticsListPlayerSessionEventsResponse.md) - - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RawStatisticsListSessionsResponse.md) - - [RefreshTokenPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RefreshTokenPayload.md) - - [RestreamsRequestObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RestreamsRequestObject.md) - - [RestreamsResponseObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/RestreamsResponseObject.md) - - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/TokenCreationPayload.md) - - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/TokenListResponse.md) - - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/UploadToken.md) - - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Video.md) - - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoAssets.md) - - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoClip.md) - - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSessionSession.md) - - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSource.md) - - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoSourceLiveStreamLink.md) - - [VideoStatus](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoStatus.md) - - [VideoStatusEncoding](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoUpdatePayload.md) - - [VideoWatermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideoWatermark.md) - - [VideosListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/VideosListResponse.md) - - [Watermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Watermark.md) - - [WatermarksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/WatermarksListResponse.md) - - [Webhook](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/Webhook.md) - - [WebhooksCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/WebhooksCreationPayload.md) - - [WebhooksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/doc/model/WebhooksListResponse.md) + - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md) + - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md) + - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md) + - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md) + - [BadRequest](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BadRequest.md) + - [BytesRange](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/BytesRange.md) + - [Caption](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Caption.md) + - [CaptionsListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsListResponse.md) + - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/CaptionsUpdatePayload.md) + - [Chapter](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Chapter.md) + - [ChaptersListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/ChaptersListResponse.md) + - [Link](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Link.md) + - [LiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStream.md) + - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md) + - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md) + - [LiveStreamSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSession.md) + - [LiveStreamSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md) + - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md) + - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md) + - [NotFound](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/NotFound.md) + - [Pagination](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Pagination.md) + - [PaginationLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PaginationLink.md) + - [PlayerSessionEvent](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerSessionEvent.md) + - [PlayerTheme](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerTheme.md) + - [PlayerThemeAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/PlayerThemesListResponse.md) + - [Quality](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RefreshTokenPayload.md) + - [RestreamsRequestObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsRequestObject.md) + - [RestreamsResponseObject](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/RestreamsResponseObject.md) + - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md) + - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md) + - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md) + - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md) + - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md) + - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md) + - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md) + - [VideoSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSession.md) + - [VideoSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionClient.md) + - [VideoSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionDevice.md) + - [VideoSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionLocation.md) + - [VideoSessionOs](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionOs.md) + - [VideoSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionReferrer.md) + - [VideoSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionSession.md) + - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md) + - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md) + - [VideoStatus](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatus.md) + - [VideoStatusEncoding](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoUpdatePayload.md) + - [VideoWatermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoWatermark.md) + - [VideosListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideosListResponse.md) + - [Watermark](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Watermark.md) + - [WatermarksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WatermarksListResponse.md) + - [Webhook](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Webhook.md) + - [WebhooksCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksCreationPayload.md) + - [WebhooksListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/WebhooksListResponse.md) ## Authorization diff --git a/sdks/api-clients/apivideo-php-client.md b/sdks/api-clients/apivideo-php-client.md index 8bdc4bfc..f55d34b7 100644 --- a/sdks/api-clients/apivideo-php-client.md +++ b/sdks/api-clients/apivideo-php-client.md @@ -2,51 +2,13 @@ title: "PHP API client" slug: "php-api-client" hidden: false -metadata: - description: "The official PHP client for api.video. [api.video](https://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." +metadata: +description: "The official PHP client for api.video. [api.video](https://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." --- PHP API Client ============== - -[api.video](https://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](#project-description) -- [Getting started](#getting-started) - - [Installation](#installation) - - [Initialization](#initialization) - - [Symfony HTTP client example](#symfony-http-client-example) - - [Code sample](#code-sample) - - [Client initialization](#client-initialization) - - [Create a video](#create-a-video) - - [Upload a video](#upload-a-video) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [AnalyticsApi](#analyticsapi) - - [CaptionsApi](#captionsapi) - - [ChaptersApi](#chaptersapi) - - [LiveStreamsApi](#livestreamsapi) - - [PlayerThemesApi](#playerthemesapi) - - [RawStatisticsApi](#rawstatisticsapi) - - [UploadTokensApi](#uploadtokensapi) - - [VideosApi](#videosapi) - - [WatermarksApi](#watermarksapi) - - [WebhooksApi](#webhooksapi) - - [Models](#models) - - [Authentication](#authentication) - - [Chunks](#chunks) - - [Tests](#tests) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - -# Project description - -api.video's PHP API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. - # Getting started ## Installation diff --git a/sdks/api-clients/apivideo-python-client.md b/sdks/api-clients/apivideo-python-client.md index 6bf18400..0a687791 100644 --- a/sdks/api-clients/apivideo-python-client.md +++ b/sdks/api-clients/apivideo-python-client.md @@ -2,48 +2,13 @@ title: "Python API client" slug: "python-api-client" hidden: false -metadata: - description: "The official Python client for api.video. [api.video](https://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." +metadata: +description: "The official Python client for api.video. [api.video](https://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." --- Python API Client ============== - -[api.video](https://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 - -- [Table of contents](#table-of-contents) -- [Project description](#project-description) -- [Getting started](#getting-started) - - [Requirements](#requirements) - - [Installation](#installation) - - [Code samples](#code-samples) - - [Automatic authentication](#automatic-authentication) - - [Manual authentication](#manual-authentication) -- [Documentation](#documentation) - - [API Endpoints](#api-endpoints) - - [AnalyticsApi](#) - - [CaptionsApi](#) - - [ChaptersApi](#) - - [LiveStreamsApi](#) - - [PlayerThemesApi](#) - - [RawStatisticsApi](#) - - [UploadTokensApi](#) - - [VideosApi](#) - - [WatermarksApi](#) - - [WebhooksApi](#) - - [Models](#models) -- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client-) -- [Contribution](#contribution) - - - -# Project description - -api.video's Python API client streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. - # Getting started ## Requirements diff --git a/sdks/api-clients/apivideo-swift5-client.md b/sdks/api-clients/apivideo-swift5-client.md new file mode 100644 index 00000000..97ab0d66 --- /dev/null +++ b/sdks/api-clients/apivideo-swift5-client.md @@ -0,0 +1,363 @@ +--- +title: "iOS API client" +slug: "ios-api-client" +hidden: false +metadata: +description: "The official iOS API client for api.video. [api.video](https://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." +--- + +iOS API client +============== + +# Getting started + +## Installation + +### Carthage + +Specify it in your `Cartfile`: + +``` +github "apivideo/api.video-ios-client" ~> 1.2.1 +``` + +Run `carthage update` + +### CocoaPods + +Add `pod 'ApiVideoClient', '1.2.1'` in your `Podfile` + +Run `pod install` + +## Code sample + +Please follow the [installation](#installation) instruction and execute the following Swift code: +```swift +import ApiVideoClient + + ApiVideoClient.apiKey = "YOUR_API_KEY" + // if you rather like to use the sandbox environment: + // ApiVideoClient.basePath = Environment.sandbox.rawValue + + let url = URL(string: "My video.mov") + + VideosAPI.create(videoCreationPayload: VideoCreationPayload(title: "my video")) { video, error in + if let video = video { + do { + try VideosAPI.upload(videoId: video.videoId, + file: url) { video, error in + if let video = video { + // Manage upload success here + } + if let error = error { + // Manage upload error here + } + } + } catch { + // Manage error on file here + } + } + if let error = error { + // Manage create error here + } +} +``` + +# Documentation + +## API Endpoints + +All URIs are relative to *https://ws.api.video* + + +### AnalyticsAPI + +#### Retrieve an instance of AnalyticsAPI: + +```swift +AnalyticsAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getLiveStreamsPlays**](docs/AnalyticsAPI.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream +[**getVideosPlays**](docs/AnalyticsAPI.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video + + +### CaptionsAPI + +#### Retrieve an instance of CaptionsAPI: + +```swift +CaptionsAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](docs/CaptionsAPI.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption +[**get**](docs/CaptionsAPI.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption +[**update**](docs/CaptionsAPI.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption +[**delete**](docs/CaptionsAPI.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption +[**list**](docs/CaptionsAPI.md#list) | **GET** /videos/{videoId}/captions | List video captions + + +### ChaptersAPI + +#### Retrieve an instance of ChaptersAPI: + +```swift +ChaptersAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](docs/ChaptersAPI.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter +[**get**](docs/ChaptersAPI.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter +[**delete**](docs/ChaptersAPI.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter +[**list**](docs/ChaptersAPI.md#list) | **GET** /videos/{videoId}/chapters | List video chapters + + +### LiveStreamsAPI + +#### Retrieve an instance of LiveStreamsAPI: + +```swift +LiveStreamsAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](docs/LiveStreamsAPI.md#create) | **POST** /live-streams | Create live stream +[**get**](docs/LiveStreamsAPI.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream +[**update**](docs/LiveStreamsAPI.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream +[**delete**](docs/LiveStreamsAPI.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream +[**list**](docs/LiveStreamsAPI.md#list) | **GET** /live-streams | List all live streams +[**uploadThumbnail**](docs/LiveStreamsAPI.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail +[**deleteThumbnail**](docs/LiveStreamsAPI.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail + + +### PlayerThemesAPI + +#### Retrieve an instance of PlayerThemesAPI: + +```swift +PlayerThemesAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](docs/PlayerThemesAPI.md#create) | **POST** /players | Create a player +[**get**](docs/PlayerThemesAPI.md#get) | **GET** /players/{playerId} | Retrieve a player +[**update**](docs/PlayerThemesAPI.md#update) | **PATCH** /players/{playerId} | Update a player +[**delete**](docs/PlayerThemesAPI.md#delete) | **DELETE** /players/{playerId} | Delete a player +[**list**](docs/PlayerThemesAPI.md#list) | **GET** /players | List all player themes +[**uploadLogo**](docs/PlayerThemesAPI.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo +[**deleteLogo**](docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo + + +### RawStatisticsAPI + +#### Retrieve an instance of RawStatisticsAPI: + +```swift +RawStatisticsAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**listLiveStreamSessions**](docs/RawStatisticsAPI.md#listLiveStreamSessions) | **GET** /analytics/live-streams/{liveStreamId} | List live stream player sessions +[**listSessionEvents**](docs/RawStatisticsAPI.md#listSessionEvents) | **GET** /analytics/sessions/{sessionId}/events | List player session events +[**listVideoSessions**](docs/RawStatisticsAPI.md#listVideoSessions) | **GET** /analytics/videos/{videoId} | List video player sessions + + +### UploadTokensAPI + +#### Retrieve an instance of UploadTokensAPI: + +```swift +UploadTokensAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createToken**](docs/UploadTokensAPI.md#createToken) | **POST** /upload-tokens | Generate an upload token +[**getToken**](docs/UploadTokensAPI.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token +[**deleteToken**](docs/UploadTokensAPI.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token +[**list**](docs/UploadTokensAPI.md#list) | **GET** /upload-tokens | List all active upload tokens + + +### VideosAPI + +#### Retrieve an instance of VideosAPI: + +```swift +VideosAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](docs/VideosAPI.md#create) | **POST** /videos | Create a video object +[**upload**](docs/VideosAPI.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token +[**get**](docs/VideosAPI.md#get) | **GET** /videos/{videoId} | Retrieve a video object +[**update**](docs/VideosAPI.md#update) | **PATCH** /videos/{videoId} | Update a video object +[**delete**](docs/VideosAPI.md#delete) | **DELETE** /videos/{videoId} | Delete a video object +[**list**](docs/VideosAPI.md#list) | **GET** /videos | List all video objects +[**uploadThumbnail**](docs/VideosAPI.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail +[**pickThumbnail**](docs/VideosAPI.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail +[**getStatus**](docs/VideosAPI.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details + + +### WatermarksAPI + +#### Retrieve an instance of WatermarksAPI: + +```swift +WatermarksAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](docs/WatermarksAPI.md#upload) | **POST** /watermarks | Upload a watermark +[**delete**](docs/WatermarksAPI.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark +[**list**](docs/WatermarksAPI.md#list) | **GET** /watermarks | List all watermarks + + +### WebhooksAPI + +#### Retrieve an instance of WebhooksAPI: + +```swift +WebhooksAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](docs/WebhooksAPI.md#create) | **POST** /webhooks | Create Webhook +[**get**](docs/WebhooksAPI.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details +[**delete**](docs/WebhooksAPI.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook +[**list**](docs/WebhooksAPI.md#list) | **GET** /webhooks | List all webhooks + + + +## Models + + - [AccessToken](docs/AccessToken.md) + - [AdditionalBadRequestErrors](docs/AdditionalBadRequestErrors.md) + - [AnalyticsData](docs/AnalyticsData.md) + - [AnalyticsPlays400Error](docs/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](docs/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](docs/AuthenticatePayload.md) + - [BadRequest](docs/BadRequest.md) + - [BytesRange](docs/BytesRange.md) + - [Caption](docs/Caption.md) + - [CaptionsListResponse](docs/CaptionsListResponse.md) + - [CaptionsUpdatePayload](docs/CaptionsUpdatePayload.md) + - [Chapter](docs/Chapter.md) + - [ChaptersListResponse](docs/ChaptersListResponse.md) + - [Link](docs/Link.md) + - [LiveStream](docs/LiveStream.md) + - [LiveStreamAssets](docs/LiveStreamAssets.md) + - [LiveStreamCreationPayload](docs/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](docs/LiveStreamListResponse.md) + - [LiveStreamSession](docs/LiveStreamSession.md) + - [LiveStreamSessionClient](docs/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](docs/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](docs/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](docs/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](docs/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](docs/LiveStreamUpdatePayload.md) + - [Metadata](docs/Metadata.md) + - [Model403ErrorSchema](docs/Model403ErrorSchema.md) + - [NotFound](docs/NotFound.md) + - [Pagination](docs/Pagination.md) + - [PaginationLink](docs/PaginationLink.md) + - [PlayerSessionEvent](docs/PlayerSessionEvent.md) + - [PlayerTheme](docs/PlayerTheme.md) + - [PlayerThemeAssets](docs/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](docs/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](docs/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](docs/PlayerThemesListResponse.md) + - [Quality](docs/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](docs/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](docs/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](docs/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](docs/RefreshTokenPayload.md) + - [RestreamsRequestObject](docs/RestreamsRequestObject.md) + - [RestreamsResponseObject](docs/RestreamsResponseObject.md) + - [TokenCreationPayload](docs/TokenCreationPayload.md) + - [TokenListResponse](docs/TokenListResponse.md) + - [UploadToken](docs/UploadToken.md) + - [Video](docs/Video.md) + - [VideoAssets](docs/VideoAssets.md) + - [VideoClip](docs/VideoClip.md) + - [VideoCreationPayload](docs/VideoCreationPayload.md) + - [VideoSession](docs/VideoSession.md) + - [VideoSessionClient](docs/VideoSessionClient.md) + - [VideoSessionDevice](docs/VideoSessionDevice.md) + - [VideoSessionLocation](docs/VideoSessionLocation.md) + - [VideoSessionOs](docs/VideoSessionOs.md) + - [VideoSessionReferrer](docs/VideoSessionReferrer.md) + - [VideoSessionSession](docs/VideoSessionSession.md) + - [VideoSource](docs/VideoSource.md) + - [VideoSourceLiveStream](docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](docs/VideoSourceLiveStreamLink.md) + - [VideoStatus](docs/VideoStatus.md) + - [VideoStatusEncoding](docs/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](docs/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](docs/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](docs/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](docs/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](docs/VideoUpdatePayload.md) + - [VideoWatermark](docs/VideoWatermark.md) + - [VideosListResponse](docs/VideosListResponse.md) + - [Watermark](docs/Watermark.md) + - [WatermarksListResponse](docs/WatermarksListResponse.md) + - [Webhook](docs/Webhook.md) + - [WebhooksCreationPayload](docs/WebhooksCreationPayload.md) + - [WebhooksListResponse](docs/WebhooksListResponse.md) + + +## Documentation for Authorization + +### API key + +Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication). +The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key: +```swift +ApiVideoClient.apiKey = YOUR_API_KEY +``` + +### Public endpoints + +Some endpoints don't require authentication. These one can be called without setting `ApiVideoClient.apiKey`: + +## 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](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. diff --git a/sdks/api-clients/apivideo-swift5-uploader-client.md b/sdks/api-clients/apivideo-swift5-uploader-client.md new file mode 100644 index 00000000..8fece120 --- /dev/null +++ b/sdks/api-clients/apivideo-swift5-uploader-client.md @@ -0,0 +1,117 @@ +--- +title: "iOS uploader" +slug: "ios-uploader" +hidden: false +metadata: +description: "The official iOS uploader for api.video. [api.video](https://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." +--- + +iOS uploader +============== + +# Getting started + +## Installation + +### Carthage + +Specify it in your `Cartfile`: + +``` +github "apivideo/api.video-ios-uploader" ~> 1.2.2 +``` + +Run `carthage update` + +### CocoaPods + +Add `pod 'ApiVideoUploader', '1.2.2'` in your `Podfile` + +Run `pod install` + +## Code sample + +Please follow the [installation](#installation) instruction and execute the following Swift code: +```swift +import ApiVideoUploader + + + // If you rather like to use the sandbox environment: + // ApiVideoUploader.basePath = Environment.sandbox.rawValue + // If you rather like to upload with your "YOUR_API_KEY" (upload) + // ApiVideoUploader.apiKey = "YOUR_API_KEY" + + try VideosAPI.uploadWithUploadToken(token: "MY_VIDEO_TOKEN", file: url) { video, error in + if let video = video { + // Manage upload with upload token success here + } + if let error = error { + // Manage upload with upload token error here + } + } + +``` + +# Documentation + +## API Endpoints + +All URIs are relative to *https://ws.api.video* + + +### VideosAPI + +#### Retrieve an instance of VideosAPI: + +```swift +VideosAPI +``` + +#### Endpoints + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**upload**](docs/VideosAPI.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token + + + +## Models + + - [AccessToken](docs/AccessToken.md) + - [AdditionalBadRequestErrors](docs/AdditionalBadRequestErrors.md) + - [AuthenticatePayload](docs/AuthenticatePayload.md) + - [BadRequest](docs/BadRequest.md) + - [Metadata](docs/Metadata.md) + - [NotFound](docs/NotFound.md) + - [RefreshTokenPayload](docs/RefreshTokenPayload.md) + - [Video](docs/Video.md) + - [VideoAssets](docs/VideoAssets.md) + - [VideoSource](docs/VideoSource.md) + - [VideoSourceLiveStream](docs/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](docs/VideoSourceLiveStreamLink.md) + + +## Documentation for Authorization + +### API key + +Most endpoints required to be authenticated using the API key mechanism described in our [documentation](https://docs.api.video/reference#authentication). +The access token generation mechanism is automatically handled by the client. All you have to do is provide an API key: +```swift +ApiVideoUploader.apiKey = YOUR_API_KEY +``` + +### Public endpoints + +Some endpoints don't require authentication. These one can be called without setting `ApiVideoUploader.apiKey`: + +## 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](https://github.com/apivideo/api-client-generator). Otherwise, you can also simply open an issue detailing your need on this repository. diff --git a/sdks/api-clients/navigation.yaml b/sdks/api-clients/navigation.yaml index 1212195b..2043087a 100644 --- a/sdks/api-clients/navigation.yaml +++ b/sdks/api-clients/navigation.yaml @@ -15,6 +15,6 @@ - label: Java href: ././apivideo-java-client.md - label: iOS - href: ././ios-api-client.md + href: ././apivideo-swift5-client.md - label: Android - href: ././android-api-client.md \ No newline at end of file + href: ././apivideo-android-client.md