From d5ed6d3ebfdf8d5666d87d89ccbb7d024691708c Mon Sep 17 00:00:00 2001 From: olivierapivideo Date: Wed, 6 Sep 2023 13:52:13 +0000 Subject: [PATCH] feat(ci): include client doc in documentation --- sdks/api-clients/README.md | 4 +- sdks/api-clients/apivideo-android-client.md | 480 ++++++++++++++++++ .../apivideo-android-uploader-client.md | 196 +++++++ sdks/api-clients/apivideo-csharp-client.md | 259 +++++----- sdks/api-clients/apivideo-go-client.md | 262 +++++----- sdks/api-clients/apivideo-java-client.md | 260 +++++----- sdks/api-clients/apivideo-nodejs-client.md | 261 +++++----- sdks/api-clients/apivideo-php-client.md | 260 +++++----- sdks/api-clients/apivideo-python-client.md | 14 +- sdks/api-clients/apivideo-swift5-client.md | 388 ++++++++++++++ .../apivideo-swift5-uploader-client.md | 138 +++++ sdks/api-clients/navigation.yaml | 4 +- 12 files changed, 1843 insertions(+), 683 deletions(-) create mode 100644 sdks/api-clients/apivideo-android-client.md create mode 100644 sdks/api-clients/apivideo-android-uploader-client.md create mode 100644 sdks/api-clients/apivideo-swift5-client.md create mode 100644 sdks/api-clients/apivideo-swift5-uploader-client.md 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..8abe8912 --- /dev/null +++ b/sdks/api-clients/apivideo-android-client.md @@ -0,0 +1,480 @@ +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-android-client?style=social)](https://github.com/apivideo/api.video-android-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Android

+ +[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) + - [Upload options](#upload-options) + - [Permissions](#permissions) +- [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 Android streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. + +# Getting started + +## Requirements + +Building the API client library requires: +1. Java 1.8+ +2. Maven/Gradle + +## Installation + +### Maven users + +Add this dependency to your project's POM: + +```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**](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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val captions = client.captions() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val chapters = client.chapters() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val liveStreams = client.liveStreams() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val playerThemes = client.playerThemes() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val rawStatistics = client.rawStatistics() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val uploadTokens = client.uploadTokens() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val videos = client.videos() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val watermarks = client.watermarks() +``` + + + +#### 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: +```kotlin +val client = ApiVideoClient("YOUR_API_KEY") +val webhooks = client.webhooks() +``` + + + +#### 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 + + + +## Documentation for 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 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..27081204 --- /dev/null +++ b/sdks/api-clients/apivideo-android-uploader-client.md @@ -0,0 +1,196 @@ +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-android-uploader?style=social)](https://github.com/apivideo/api.video-android-uploader)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Android

+ +[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) + - [Upload options](#upload-options) + - [Permissions](#permissions) +- [Documentation](#documentation) + - [API Endpoints](#api-endpoints) + - [VideosApi](#videosapi) + - [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 Android streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. + +# Getting started + +## Requirements + +Building the API client library requires: +1. Java 1.8+ +2. Maven/Gradle + +## Installation + +### Maven users + +Add this dependency to your project's POM: + +```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**](docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video +[**uploadWithUploadToken**](docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token + + + +## Documentation for 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 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..c856a590 100644 --- a/sdks/api-clients/apivideo-csharp-client.md +++ b/sdks/api-clients/apivideo-csharp-client.md @@ -1,13 +1,6 @@ ---- -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." ---- - -C# API Client -============== +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-csharp-client?style=social)](https://github.com/apivideo/api.video-csharp-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video C# 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. @@ -165,8 +158,8 @@ AnalyticsApi analytics = client.Analytics() Method | HTTP request | Description ------------- | ------------- | ------------- -[**getLiveStreamsPlays**](https://github.com/apivideo/api.video-csharp-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-csharp-client/blob/main/docs/AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video +[**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 @@ -182,11 +175,11 @@ CaptionsApi captions = client.Captions() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsApi.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsApi.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption -[**update**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsApi.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsApi.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsApi.md#list) | **GET** /videos/{videoId}/captions | List video captions +[**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 @@ -202,10 +195,10 @@ ChaptersApi chapters = client.Chapters() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersApi.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersApi.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersApi.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersApi.md#list) | **GET** /videos/{videoId}/chapters | List video chapters +[**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 @@ -221,13 +214,13 @@ LiveStreamsApi liveStreams = client.LiveStreams() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#create) | **POST** /live-streams | Create live stream -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream -[**update**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#list) | **GET** /live-streams | List all live streams -[**uploadThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail -[**deleteThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamsApi.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail +[**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 @@ -243,13 +236,13 @@ PlayerThemesApi playerThemes = client.PlayerThemes() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#create) | **POST** /players | Create a player -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#get) | **GET** /players/{playerId} | Retrieve a player -[**update**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#list) | **GET** /players | List all player themes -[**uploadLogo**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo -[**deleteLogo**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo +[**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 @@ -265,9 +258,9 @@ RawStatisticsApi rawStatistics = client.RawStatistics() Method | HTTP request | Description ------------- | ------------- | ------------- -[**listLiveStreamSessions**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsApi.md#listLiveStreamSessions) | **GET** /analytics/live-streams/{liveStreamId} | List live stream player sessions -[**listSessionEvents**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsApi.md#listSessionEvents) | **GET** /analytics/sessions/{sessionId}/events | List player session events -[**listVideoSessions**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsApi.md#listVideoSessions) | **GET** /analytics/videos/{videoId} | List video player sessions +[**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 @@ -283,10 +276,10 @@ UploadTokensApi uploadTokens = client.UploadTokens() Method | HTTP request | Description ------------- | ------------- | ------------- -[**createToken**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#createToken) | **POST** /upload-tokens | Generate an upload token -[**getToken**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token -[**deleteToken**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadTokensApi.md#list) | **GET** /upload-tokens | List all active upload tokens +[**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 @@ -302,16 +295,16 @@ VideosApi videos = client.Videos() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#create) | **POST** /videos | Create a video object -[**upload**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#upload) | **POST** /videos/{videoId}/source | Upload a video -[**uploadWithUploadToken**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#uploadWithUploadToken) | **POST** /upload | Upload with an delegated upload token -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#get) | **GET** /videos/{videoId} | Retrieve a video object -[**update**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#update) | **PATCH** /videos/{videoId} | Update a video object -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#delete) | **DELETE** /videos/{videoId} | Delete a video object -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#list) | **GET** /videos | List all video objects -[**uploadThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail -[**pickThumbnail**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Set a thumbnail -[**getStatus**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosApi.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status and details +[**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 @@ -327,9 +320,9 @@ WatermarksApi watermarks = client.Watermarks() Method | HTTP request | Description ------------- | ------------- | ------------- -[**upload**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WatermarksApi.md#upload) | **POST** /watermarks | Upload a watermark -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WatermarksApi.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WatermarksApi.md#list) | **GET** /watermarks | List all watermarks +[**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 @@ -345,89 +338,89 @@ WebhooksApi webhooks = client.Webhooks() Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksApi.md#create) | **POST** /webhooks | Create Webhook -[**get**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksApi.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details -[**delete**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksApi.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook -[**list**](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksApi.md#list) | **GET** /webhooks | List all webhooks +[**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](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AccessToken.md) - - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AdditionalBadRequestErrors.md) - - [AnalyticsData](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsData.md) - - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/AuthenticatePayload.md) - - [BadRequest](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/BadRequest.md) - - [BytesRange](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/BytesRange.md) - - [Caption](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Caption.md) - - [CaptionsListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsListResponse.md) - - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/CaptionsUpdatePayload.md) - - [Chapter](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Chapter.md) - - [ChaptersListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/ChaptersListResponse.md) - - [Link](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Link.md) - - [LiveStream](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStream.md) - - [LiveStreamAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamAssets.md) - - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/LiveStreamUpdatePayload.md) - - [Metadata](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Metadata.md) - - [Model403ErrorSchema](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Model403ErrorSchema.md) - - [NotFound](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/NotFound.md) - - [Pagination](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Pagination.md) - - [PaginationLink](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PaginationLink.md) - - [PlayerSessionEvent](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerSessionEvent.md) - - [PlayerTheme](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerTheme.md) - - [PlayerThemeAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/PlayerThemesListResponse.md) - - [Quality](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Quality.md) - - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsListLiveStreamAnalyticsResponse.md) - - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md) - - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RawStatisticsListSessionsResponse.md) - - [RefreshTokenPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RefreshTokenPayload.md) - - [RestreamsRequestObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RestreamsRequestObject.md) - - [RestreamsResponseObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RestreamsResponseObject.md) - - [TokenCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenCreationPayload.md) - - [TokenListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenListResponse.md) - - [UploadToken](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadToken.md) - - [Video](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Video.md) - - [VideoAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoAssets.md) - - [VideoClip](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoClip.md) - - [VideoCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSessionSession.md) - - [VideoSource](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSource.md) - - [VideoSourceLiveStream](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoSourceLiveStreamLink.md) - - [VideoStatus](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoStatus.md) - - [VideoStatusEncoding](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoUpdatePayload.md) - - [VideoWatermark](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoWatermark.md) - - [VideosListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideosListResponse.md) - - [Watermark](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Watermark.md) - - [WatermarksListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WatermarksListResponse.md) - - [Webhook](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Webhook.md) - - [WebhooksCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksCreationPayload.md) - - [WebhooksListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/WebhooksListResponse.md) + - [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) ## Authorization diff --git a/sdks/api-clients/apivideo-go-client.md b/sdks/api-clients/apivideo-go-client.md index 0511891e..4de34496 100644 --- a/sdks/api-clients/apivideo-go-client.md +++ b/sdks/api-clients/apivideo-go-client.md @@ -1,13 +1,7 @@ ---- -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." ---- - -Go API Client -============== +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-go-client?style=social)](https://github.com/apivideo/api.video-go-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Go 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 @@ -46,7 +40,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 @@ -135,8 +129,8 @@ analyticsApi := client.Analytics Method | HTTP request | Description ------------- | ------------- | ------------- -[**GetLiveStreamsPlays**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Analytics.md#GetLiveStreamsPlays) | **Get** /analytics/live-streams/plays | Get play events for live stream -[**GetVideosPlays**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Analytics.md#GetVideosPlays) | **Get** /analytics/videos/plays | Get play events for video +[**GetLiveStreamsPlays**](docs/Analytics.md#GetLiveStreamsPlays) | **Get** /analytics/live-streams/plays | Get play events for live stream +[**GetVideosPlays**](docs/Analytics.md#GetVideosPlays) | **Get** /analytics/videos/plays | Get play events for video ### Captions @@ -152,11 +146,11 @@ captionsApi := client.Captions Method | HTTP request | Description ------------- | ------------- | ------------- -[**Upload**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#Upload) | **Post** /videos/{videoId}/captions/{language} | Upload a caption -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#Get) | **Get** /videos/{videoId}/captions/{language} | Retrieve a caption -[**Update**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#Update) | **Patch** /videos/{videoId}/captions/{language} | Update a caption -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#Delete) | **Delete** /videos/{videoId}/captions/{language} | Delete a caption -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Captions.md#List) | **Get** /videos/{videoId}/captions | List video captions +[**Upload**](docs/Captions.md#Upload) | **Post** /videos/{videoId}/captions/{language} | Upload a caption +[**Get**](docs/Captions.md#Get) | **Get** /videos/{videoId}/captions/{language} | Retrieve a caption +[**Update**](docs/Captions.md#Update) | **Patch** /videos/{videoId}/captions/{language} | Update a caption +[**Delete**](docs/Captions.md#Delete) | **Delete** /videos/{videoId}/captions/{language} | Delete a caption +[**List**](docs/Captions.md#List) | **Get** /videos/{videoId}/captions | List video captions ### Chapters @@ -172,10 +166,10 @@ chaptersApi := client.Chapters Method | HTTP request | Description ------------- | ------------- | ------------- -[**Upload**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapters.md#Upload) | **Post** /videos/{videoId}/chapters/{language} | Upload a chapter -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapters.md#Get) | **Get** /videos/{videoId}/chapters/{language} | Retrieve a chapter -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapters.md#Delete) | **Delete** /videos/{videoId}/chapters/{language} | Delete a chapter -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapters.md#List) | **Get** /videos/{videoId}/chapters | List video chapters +[**Upload**](docs/Chapters.md#Upload) | **Post** /videos/{videoId}/chapters/{language} | Upload a chapter +[**Get**](docs/Chapters.md#Get) | **Get** /videos/{videoId}/chapters/{language} | Retrieve a chapter +[**Delete**](docs/Chapters.md#Delete) | **Delete** /videos/{videoId}/chapters/{language} | Delete a chapter +[**List**](docs/Chapters.md#List) | **Get** /videos/{videoId}/chapters | List video chapters ### LiveStreams @@ -191,13 +185,13 @@ liveStreamsApi := client.LiveStreams Method | HTTP request | Description ------------- | ------------- | ------------- -[**Create**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#Create) | **Post** /live-streams | Create live stream -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#Get) | **Get** /live-streams/{liveStreamId} | Retrieve live stream -[**Update**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#Update) | **Patch** /live-streams/{liveStreamId} | Update a live stream -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#Delete) | **Delete** /live-streams/{liveStreamId} | Delete a live stream -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#List) | **Get** /live-streams | List all live streams -[**UploadThumbnail**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#UploadThumbnail) | **Post** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail -[**DeleteThumbnail**](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreams.md#DeleteThumbnail) | **Delete** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail +[**Create**](docs/LiveStreams.md#Create) | **Post** /live-streams | Create live stream +[**Get**](docs/LiveStreams.md#Get) | **Get** /live-streams/{liveStreamId} | Retrieve live stream +[**Update**](docs/LiveStreams.md#Update) | **Patch** /live-streams/{liveStreamId} | Update a live stream +[**Delete**](docs/LiveStreams.md#Delete) | **Delete** /live-streams/{liveStreamId} | Delete a live stream +[**List**](docs/LiveStreams.md#List) | **Get** /live-streams | List all live streams +[**UploadThumbnail**](docs/LiveStreams.md#UploadThumbnail) | **Post** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail +[**DeleteThumbnail**](docs/LiveStreams.md#DeleteThumbnail) | **Delete** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail ### PlayerThemes @@ -213,13 +207,13 @@ playerThemesApi := client.PlayerThemes Method | HTTP request | Description ------------- | ------------- | ------------- -[**Create**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#Create) | **Post** /players | Create a player -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#Get) | **Get** /players/{playerId} | Retrieve a player -[**Update**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#Update) | **Patch** /players/{playerId} | Update a player -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#Delete) | **Delete** /players/{playerId} | Delete a player -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#List) | **Get** /players | List all player themes -[**UploadLogo**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#UploadLogo) | **Post** /players/{playerId}/logo | Upload a logo -[**DeleteLogo**](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemes.md#DeleteLogo) | **Delete** /players/{playerId}/logo | Delete logo +[**Create**](docs/PlayerThemes.md#Create) | **Post** /players | Create a player +[**Get**](docs/PlayerThemes.md#Get) | **Get** /players/{playerId} | Retrieve a player +[**Update**](docs/PlayerThemes.md#Update) | **Patch** /players/{playerId} | Update a player +[**Delete**](docs/PlayerThemes.md#Delete) | **Delete** /players/{playerId} | Delete a player +[**List**](docs/PlayerThemes.md#List) | **Get** /players | List all player themes +[**UploadLogo**](docs/PlayerThemes.md#UploadLogo) | **Post** /players/{playerId}/logo | Upload a logo +[**DeleteLogo**](docs/PlayerThemes.md#DeleteLogo) | **Delete** /players/{playerId}/logo | Delete logo ### RawStatistics @@ -235,9 +229,9 @@ rawStatisticsApi := client.RawStatistics Method | HTTP request | Description ------------- | ------------- | ------------- -[**ListLiveStreamSessions**](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatistics.md#ListLiveStreamSessions) | **Get** /analytics/live-streams/{liveStreamId} | List live stream player sessions -[**ListSessionEvents**](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatistics.md#ListSessionEvents) | **Get** /analytics/sessions/{sessionId}/events | List player session events -[**ListVideoSessions**](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatistics.md#ListVideoSessions) | **Get** /analytics/videos/{videoId} | List video player sessions +[**ListLiveStreamSessions**](docs/RawStatistics.md#ListLiveStreamSessions) | **Get** /analytics/live-streams/{liveStreamId} | List live stream player sessions +[**ListSessionEvents**](docs/RawStatistics.md#ListSessionEvents) | **Get** /analytics/sessions/{sessionId}/events | List player session events +[**ListVideoSessions**](docs/RawStatistics.md#ListVideoSessions) | **Get** /analytics/videos/{videoId} | List video player sessions ### UploadTokens @@ -253,10 +247,10 @@ uploadTokensApi := client.UploadTokens Method | HTTP request | Description ------------- | ------------- | ------------- -[**CreateToken**](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokens.md#CreateToken) | **Post** /upload-tokens | Generate an upload token -[**GetToken**](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokens.md#GetToken) | **Get** /upload-tokens/{uploadToken} | Retrieve upload token -[**DeleteToken**](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokens.md#DeleteToken) | **Delete** /upload-tokens/{uploadToken} | Delete an upload token -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadTokens.md#List) | **Get** /upload-tokens | List all active upload tokens +[**CreateToken**](docs/UploadTokens.md#CreateToken) | **Post** /upload-tokens | Generate an upload token +[**GetToken**](docs/UploadTokens.md#GetToken) | **Get** /upload-tokens/{uploadToken} | Retrieve upload token +[**DeleteToken**](docs/UploadTokens.md#DeleteToken) | **Delete** /upload-tokens/{uploadToken} | Delete an upload token +[**List**](docs/UploadTokens.md#List) | **Get** /upload-tokens | List all active upload tokens ### Videos @@ -272,16 +266,16 @@ videosApi := client.Videos Method | HTTP request | Description ------------- | ------------- | ------------- -[**Create**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#Create) | **Post** /videos | Create a video object -[**Upload**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#Upload) | **Post** /videos/{videoId}/source | Upload a video -[**UploadWithUploadToken**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#UploadWithUploadToken) | **Post** /upload | Upload with an delegated upload token -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#Get) | **Get** /videos/{videoId} | Retrieve a video object -[**Update**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#Update) | **Patch** /videos/{videoId} | Update a video object -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#Delete) | **Delete** /videos/{videoId} | Delete a video object -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#List) | **Get** /videos | List all video objects -[**UploadThumbnail**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#UploadThumbnail) | **Post** /videos/{videoId}/thumbnail | Upload a thumbnail -[**PickThumbnail**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#PickThumbnail) | **Patch** /videos/{videoId}/thumbnail | Set a thumbnail -[**GetStatus**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Videos.md#GetStatus) | **Get** /videos/{videoId}/status | Retrieve video status and details +[**Create**](docs/Videos.md#Create) | **Post** /videos | Create a video object +[**Upload**](docs/Videos.md#Upload) | **Post** /videos/{videoId}/source | Upload a video +[**UploadWithUploadToken**](docs/Videos.md#UploadWithUploadToken) | **Post** /upload | Upload with an delegated upload token +[**Get**](docs/Videos.md#Get) | **Get** /videos/{videoId} | Retrieve a video object +[**Update**](docs/Videos.md#Update) | **Patch** /videos/{videoId} | Update a video object +[**Delete**](docs/Videos.md#Delete) | **Delete** /videos/{videoId} | Delete a video object +[**List**](docs/Videos.md#List) | **Get** /videos | List all video objects +[**UploadThumbnail**](docs/Videos.md#UploadThumbnail) | **Post** /videos/{videoId}/thumbnail | Upload a thumbnail +[**PickThumbnail**](docs/Videos.md#PickThumbnail) | **Patch** /videos/{videoId}/thumbnail | Set a thumbnail +[**GetStatus**](docs/Videos.md#GetStatus) | **Get** /videos/{videoId}/status | Retrieve video status and details ### Watermarks @@ -297,9 +291,9 @@ watermarksApi := client.Watermarks Method | HTTP request | Description ------------- | ------------- | ------------- -[**Upload**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Watermarks.md#Upload) | **Post** /watermarks | Upload a watermark -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Watermarks.md#Delete) | **Delete** /watermarks/{watermarkId} | Delete a watermark -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Watermarks.md#List) | **Get** /watermarks | List all watermarks +[**Upload**](docs/Watermarks.md#Upload) | **Post** /watermarks | Upload a watermark +[**Delete**](docs/Watermarks.md#Delete) | **Delete** /watermarks/{watermarkId} | Delete a watermark +[**List**](docs/Watermarks.md#List) | **Get** /watermarks | List all watermarks ### Webhooks @@ -315,90 +309,90 @@ webhooksApi := client.Webhooks Method | HTTP request | Description ------------- | ------------- | ------------- -[**Create**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Webhooks.md#Create) | **Post** /webhooks | Create Webhook -[**Get**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Webhooks.md#Get) | **Get** /webhooks/{webhookId} | Retrieve Webhook details -[**Delete**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Webhooks.md#Delete) | **Delete** /webhooks/{webhookId} | Delete a Webhook -[**List**](https://github.com/apivideo/api.video-go-client/blob/main/docs/Webhooks.md#List) | **Get** /webhooks | List all webhooks +[**Create**](docs/Webhooks.md#Create) | **Post** /webhooks | Create Webhook +[**Get**](docs/Webhooks.md#Get) | **Get** /webhooks/{webhookId} | Retrieve Webhook details +[**Delete**](docs/Webhooks.md#Delete) | **Delete** /webhooks/{webhookId} | Delete a Webhook +[**List**](docs/Webhooks.md#List) | **Get** /webhooks | List all webhooks ## Models - - [AccessToken](https://github.com/apivideo/api.video-go-client/blob/main/docs/AccessToken.md) - - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-go-client/blob/main/docs/AdditionalBadRequestErrors.md) - - [AnalyticsData](https://github.com/apivideo/api.video-go-client/blob/main/docs/AnalyticsData.md) - - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-go-client/blob/main/docs/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/AuthenticatePayload.md) - - [BadRequest](https://github.com/apivideo/api.video-go-client/blob/main/docs/BadRequest.md) - - [BytesRange](https://github.com/apivideo/api.video-go-client/blob/main/docs/BytesRange.md) - - [Caption](https://github.com/apivideo/api.video-go-client/blob/main/docs/Caption.md) - - [CaptionsListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/CaptionsListResponse.md) - - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/CaptionsUpdatePayload.md) - - [Chapter](https://github.com/apivideo/api.video-go-client/blob/main/docs/Chapter.md) - - [ChaptersListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/ChaptersListResponse.md) - - [Link](https://github.com/apivideo/api.video-go-client/blob/main/docs/Link.md) - - [LiveStream](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStream.md) - - [LiveStreamAssets](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamAssets.md) - - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/LiveStreamUpdatePayload.md) - - [Metadata](https://github.com/apivideo/api.video-go-client/blob/main/docs/Metadata.md) - - [Model403ErrorSchema](https://github.com/apivideo/api.video-go-client/blob/main/docs/Model403ErrorSchema.md) - - [NotFound](https://github.com/apivideo/api.video-go-client/blob/main/docs/NotFound.md) - - [Pagination](https://github.com/apivideo/api.video-go-client/blob/main/docs/Pagination.md) - - [PaginationLink](https://github.com/apivideo/api.video-go-client/blob/main/docs/PaginationLink.md) - - [PlayerSessionEvent](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerSessionEvent.md) - - [PlayerTheme](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerTheme.md) - - [PlayerThemeAssets](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/PlayerThemesListResponse.md) - - [Quality](https://github.com/apivideo/api.video-go-client/blob/main/docs/Quality.md) - - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatisticsListLiveStreamAnalyticsResponse.md) - - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatisticsListPlayerSessionEventsResponse.md) - - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/RawStatisticsListSessionsResponse.md) - - [RefreshTokenPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/RefreshTokenPayload.md) - - [RestreamsRequestObject](https://github.com/apivideo/api.video-go-client/blob/main/docs/RestreamsRequestObject.md) - - [RestreamsResponseObject](https://github.com/apivideo/api.video-go-client/blob/main/docs/RestreamsResponseObject.md) - - [TokenCreationPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/TokenCreationPayload.md) - - [TokenListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/TokenListResponse.md) - - [UploadToken](https://github.com/apivideo/api.video-go-client/blob/main/docs/UploadToken.md) - - [Video](https://github.com/apivideo/api.video-go-client/blob/main/docs/Video.md) - - [VideoAssets](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoAssets.md) - - [VideoClip](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoClip.md) - - [VideoCreationPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSessionSession.md) - - [VideoSource](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSource.md) - - [VideoSourceLiveStream](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoSourceLiveStreamLink.md) - - [VideoStatus](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoStatus.md) - - [VideoStatusEncoding](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoUpdatePayload.md) - - [VideoWatermark](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideoWatermark.md) - - [VideosListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/VideosListResponse.md) - - [Watermark](https://github.com/apivideo/api.video-go-client/blob/main/docs/Watermark.md) - - [WatermarksListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/WatermarksListResponse.md) - - [Webhook](https://github.com/apivideo/api.video-go-client/blob/main/docs/Webhook.md) - - [WebhooksCreationPayload](https://github.com/apivideo/api.video-go-client/blob/main/docs/WebhooksCreationPayload.md) - - [WebhooksListResponse](https://github.com/apivideo/api.video-go-client/blob/main/docs/WebhooksListResponse.md) + - [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) diff --git a/sdks/api-clients/apivideo-java-client.md b/sdks/api-clients/apivideo-java-client.md index b8d509ad..ec37aad5 100644 --- a/sdks/api-clients/apivideo-java-client.md +++ b/sdks/api-clients/apivideo-java-client.md @@ -1,13 +1,7 @@ ---- -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." ---- - -Java API Client -============== +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-java-client?style=social)](https://github.com/apivideo/api.video-java-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Java

+ [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 @@ -145,8 +139,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**](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 @@ -164,11 +158,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**](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 @@ -186,10 +180,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**](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 @@ -207,13 +201,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**](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 @@ -231,13 +225,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**](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 @@ -255,9 +249,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**](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 @@ -275,10 +269,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**](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 @@ -296,16 +290,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**](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 @@ -323,9 +317,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**](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 @@ -343,89 +337,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**](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 ## 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](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 diff --git a/sdks/api-clients/apivideo-nodejs-client.md b/sdks/api-clients/apivideo-nodejs-client.md index a078d39c..a4d69967 100644 --- a/sdks/api-clients/apivideo-nodejs-client.md +++ b/sdks/api-clients/apivideo-nodejs-client.md @@ -1,13 +1,6 @@ ---- -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." ---- - -NodeJS API Client -============== +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-nodejs-client?style=social)](https://github.com/apivideo/api.video-nodejs-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Node.js 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. @@ -58,7 +51,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](./doc/MIGRATE.md) first. ## Development @@ -102,188 +95,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()**](doc/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays +[**getVideosPlays()**](doc/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()**](doc/api/CaptionsApi.md#upload) | Upload a caption | **POST** /videos/{videoId}/captions/{language} +[**get()**](doc/api/CaptionsApi.md#get) | Retrieve a caption | **GET** /videos/{videoId}/captions/{language} +[**update()**](doc/api/CaptionsApi.md#update) | Update a caption | **PATCH** /videos/{videoId}/captions/{language} +[**delete()**](doc/api/CaptionsApi.md#delete) | Delete a caption | **DELETE** /videos/{videoId}/captions/{language} +[**list()**](doc/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()**](doc/api/ChaptersApi.md#upload) | Upload a chapter | **POST** /videos/{videoId}/chapters/{language} +[**get()**](doc/api/ChaptersApi.md#get) | Retrieve a chapter | **GET** /videos/{videoId}/chapters/{language} +[**delete()**](doc/api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** /videos/{videoId}/chapters/{language} +[**list()**](doc/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()**](doc/api/LiveStreamsApi.md#create) | Create live stream | **POST** /live-streams +[**get()**](doc/api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** /live-streams/{liveStreamId} +[**update()**](doc/api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** /live-streams/{liveStreamId} +[**delete()**](doc/api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** /live-streams/{liveStreamId} +[**list()**](doc/api/LiveStreamsApi.md#list) | List all live streams | **GET** /live-streams +[**uploadThumbnail()**](doc/api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /live-streams/{liveStreamId}/thumbnail +[**deleteThumbnail()**](doc/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()**](doc/api/PlayerThemesApi.md#create) | Create a player | **POST** /players +[**get()**](doc/api/PlayerThemesApi.md#get) | Retrieve a player | **GET** /players/{playerId} +[**update()**](doc/api/PlayerThemesApi.md#update) | Update a player | **PATCH** /players/{playerId} +[**delete()**](doc/api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** /players/{playerId} +[**list()**](doc/api/PlayerThemesApi.md#list) | List all player themes | **GET** /players +[**uploadLogo()**](doc/api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** /players/{playerId}/logo +[**deleteLogo()**](doc/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()**](doc/api/RawStatisticsApi.md#listLiveStreamSessions) | List live stream player sessions | **GET** /analytics/live-streams/{liveStreamId} +[**listSessionEvents()**](doc/api/RawStatisticsApi.md#listSessionEvents) | List player session events | **GET** /analytics/sessions/{sessionId}/events +[**listVideoSessions()**](doc/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()**](doc/api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** /upload-tokens +[**getToken()**](doc/api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** /upload-tokens/{uploadToken} +[**deleteToken()**](doc/api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** /upload-tokens/{uploadToken} +[**list()**](doc/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()**](doc/api/VideosApi.md#create) | Create a video object | **POST** /videos +[**upload()**](doc/api/VideosApi.md#upload) | Upload a video | **POST** /videos/{videoId}/source +[**uploadWithUploadToken()**](doc/api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** /upload +[**get()**](doc/api/VideosApi.md#get) | Retrieve a video object | **GET** /videos/{videoId} +[**update()**](doc/api/VideosApi.md#update) | Update a video object | **PATCH** /videos/{videoId} +[**delete()**](doc/api/VideosApi.md#delete) | Delete a video object | **DELETE** /videos/{videoId} +[**list()**](doc/api/VideosApi.md#list) | List all video objects | **GET** /videos +[**uploadThumbnail()**](doc/api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /videos/{videoId}/thumbnail +[**pickThumbnail()**](doc/api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** /videos/{videoId}/thumbnail +[**getStatus()**](doc/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()**](doc/api/WatermarksApi.md#upload) | Upload a watermark | **POST** /watermarks +[**delete()**](doc/api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** /watermarks/{watermarkId} +[**list()**](doc/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()**](doc/api/WebhooksApi.md#create) | Create Webhook | **POST** /webhooks +[**get()**](doc/api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** /webhooks/{webhookId} +[**delete()**](doc/api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** /webhooks/{webhookId} +[**list()**](doc/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](doc/model/AccessToken.md) + - [AdditionalBadRequestErrors](doc/model/AdditionalBadRequestErrors.md) + - [AnalyticsData](doc/model/AnalyticsData.md) + - [AnalyticsPlays400Error](doc/model/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](doc/model/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](doc/model/AuthenticatePayload.md) + - [BadRequest](doc/model/BadRequest.md) + - [BytesRange](doc/model/BytesRange.md) + - [Caption](doc/model/Caption.md) + - [CaptionsListResponse](doc/model/CaptionsListResponse.md) + - [CaptionsUpdatePayload](doc/model/CaptionsUpdatePayload.md) + - [Chapter](doc/model/Chapter.md) + - [ChaptersListResponse](doc/model/ChaptersListResponse.md) + - [Link](doc/model/Link.md) + - [LiveStream](doc/model/LiveStream.md) + - [LiveStreamAssets](doc/model/LiveStreamAssets.md) + - [LiveStreamCreationPayload](doc/model/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](doc/model/LiveStreamListResponse.md) + - [LiveStreamSession](doc/model/LiveStreamSession.md) + - [LiveStreamSessionClient](doc/model/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](doc/model/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](doc/model/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](doc/model/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](doc/model/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](doc/model/LiveStreamUpdatePayload.md) + - [Metadata](doc/model/Metadata.md) + - [Model403ErrorSchema](doc/model/Model403ErrorSchema.md) + - [NotFound](doc/model/NotFound.md) + - [Pagination](doc/model/Pagination.md) + - [PaginationLink](doc/model/PaginationLink.md) + - [PlayerSessionEvent](doc/model/PlayerSessionEvent.md) + - [PlayerTheme](doc/model/PlayerTheme.md) + - [PlayerThemeAssets](doc/model/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](doc/model/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](doc/model/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](doc/model/PlayerThemesListResponse.md) + - [Quality](doc/model/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](doc/model/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](doc/model/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](doc/model/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](doc/model/RefreshTokenPayload.md) + - [RestreamsRequestObject](doc/model/RestreamsRequestObject.md) + - [RestreamsResponseObject](doc/model/RestreamsResponseObject.md) + - [TokenCreationPayload](doc/model/TokenCreationPayload.md) + - [TokenListResponse](doc/model/TokenListResponse.md) + - [UploadToken](doc/model/UploadToken.md) + - [Video](doc/model/Video.md) + - [VideoAssets](doc/model/VideoAssets.md) + - [VideoClip](doc/model/VideoClip.md) + - [VideoCreationPayload](doc/model/VideoCreationPayload.md) + - [VideoSession](doc/model/VideoSession.md) + - [VideoSessionClient](doc/model/VideoSessionClient.md) + - [VideoSessionDevice](doc/model/VideoSessionDevice.md) + - [VideoSessionLocation](doc/model/VideoSessionLocation.md) + - [VideoSessionOs](doc/model/VideoSessionOs.md) + - [VideoSessionReferrer](doc/model/VideoSessionReferrer.md) + - [VideoSessionSession](doc/model/VideoSessionSession.md) + - [VideoSource](doc/model/VideoSource.md) + - [VideoSourceLiveStream](doc/model/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](doc/model/VideoSourceLiveStreamLink.md) + - [VideoStatus](doc/model/VideoStatus.md) + - [VideoStatusEncoding](doc/model/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](doc/model/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](doc/model/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](doc/model/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](doc/model/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](doc/model/VideoUpdatePayload.md) + - [VideoWatermark](doc/model/VideoWatermark.md) + - [VideosListResponse](doc/model/VideosListResponse.md) + - [Watermark](doc/model/Watermark.md) + - [WatermarksListResponse](doc/model/WatermarksListResponse.md) + - [Webhook](doc/model/Webhook.md) + - [WebhooksCreationPayload](doc/model/WebhooksCreationPayload.md) + - [WebhooksListResponse](doc/model/WebhooksListResponse.md) ## Authorization diff --git a/sdks/api-clients/apivideo-php-client.md b/sdks/api-clients/apivideo-php-client.md index 8bdc4bfc..35702386 100644 --- a/sdks/api-clients/apivideo-php-client.md +++ b/sdks/api-clients/apivideo-php-client.md @@ -1,14 +1,6 @@ ---- -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." ---- - -PHP API Client -============== - +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-php-client?style=social)](https://github.com/apivideo/api.video-php-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video PHP 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. @@ -128,188 +120,188 @@ $client->videos()->upload( Method | Description | HTTP request ------------- | ------------- | ------------- -[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-php-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-php-client/blob/main/docs/Api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** `/analytics/videos/plays` +[**getLiveStreamsPlays()**](docs/Api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** `/analytics/live-streams/plays` +[**getVideosPlays()**](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-php-client/blob/main/docs/Api/CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}` -[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions` +[**upload()**](docs/Api/CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}` +[**get()**](docs/Api/CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}` +[**update()**](docs/Api/CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}` +[**delete()**](docs/Api/CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}` +[**list()**](docs/Api/CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions` ### ChaptersApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters` +[**upload()**](docs/Api/ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}` +[**get()**](docs/Api/ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}` +[**delete()**](docs/Api/ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}` +[**list()**](docs/Api/ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters` ### LiveStreamsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}` -[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams` -[**uploadThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail` -[**deleteThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail` +[**create()**](docs/Api/LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams` +[**get()**](docs/Api/LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}` +[**update()**](docs/Api/LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}` +[**delete()**](docs/Api/LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}` +[**list()**](docs/Api/LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams` +[**uploadThumbnail()**](docs/Api/LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail` +[**deleteThumbnail()**](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-php-client/blob/main/docs/Api/PlayerThemesApi.md#create) | Create a player | **POST** `/players` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}` -[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#list) | List all player themes | **GET** `/players` -[**uploadLogo()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo` -[**deleteLogo()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo` +[**create()**](docs/Api/PlayerThemesApi.md#create) | Create a player | **POST** `/players` +[**get()**](docs/Api/PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}` +[**update()**](docs/Api/PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}` +[**delete()**](docs/Api/PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}` +[**list()**](docs/Api/PlayerThemesApi.md#list) | List all player themes | **GET** `/players` +[**uploadLogo()**](docs/Api/PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo` +[**deleteLogo()**](docs/Api/PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo` ### RawStatisticsApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**listLiveStreamSessions()**](https://github.com/apivideo/api.video-php-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-php-client/blob/main/docs/Api/RawStatisticsApi.md#listSessionEvents) | List player session events | **GET** `/analytics/sessions/{sessionId}/events` -[**listVideoSessions()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/RawStatisticsApi.md#listVideoSessions) | List video player sessions | **GET** `/analytics/videos/{videoId}` +[**listLiveStreamSessions()**](docs/Api/RawStatisticsApi.md#listLiveStreamSessions) | List live stream player sessions | **GET** `/analytics/live-streams/{liveStreamId}` +[**listSessionEvents()**](docs/Api/RawStatisticsApi.md#listSessionEvents) | List player session events | **GET** `/analytics/sessions/{sessionId}/events` +[**listVideoSessions()**](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-php-client/blob/main/docs/Api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens` -[**getToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}` -[**deleteToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens` +[**createToken()**](docs/Api/UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens` +[**getToken()**](docs/Api/UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}` +[**deleteToken()**](docs/Api/UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}` +[**list()**](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-php-client/blob/main/docs/Api/VideosApi.md#create) | Create a video object | **POST** `/videos` -[**upload()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source` -[**uploadWithUploadToken()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}` -[**update()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#list) | List all video objects | **GET** `/videos` -[**uploadThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail` -[**pickThumbnail()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail` -[**getStatus()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status` +[**create()**](docs/Api/VideosApi.md#create) | Create a video object | **POST** `/videos` +[**upload()**](docs/Api/VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source` +[**uploadWithUploadToken()**](docs/Api/VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload` +[**get()**](docs/Api/VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}` +[**update()**](docs/Api/VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}` +[**delete()**](docs/Api/VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}` +[**list()**](docs/Api/VideosApi.md#list) | List all video objects | **GET** `/videos` +[**uploadThumbnail()**](docs/Api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail` +[**pickThumbnail()**](docs/Api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail` +[**getStatus()**](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-php-client/blob/main/docs/Api/WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks` +[**upload()**](docs/Api/WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks` +[**delete()**](docs/Api/WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}` +[**list()**](docs/Api/WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks` ### WebhooksApi Method | Description | HTTP request ------------- | ------------- | ------------- -[**create()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks` -[**get()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}` -[**delete()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}` -[**list()**](https://github.com/apivideo/api.video-php-client/blob/main/docs/Api/WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks` +[**create()**](docs/Api/WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks` +[**get()**](docs/Api/WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}` +[**delete()**](docs/Api/WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}` +[**list()**](docs/Api/WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks` ## Models - - [AccessToken](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AccessToken.md) - - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AdditionalBadRequestErrors.md) - - [AnalyticsData](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsData.md) - - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsPlays400Error.md) - - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AnalyticsPlaysResponse.md) - - [AuthenticatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/AuthenticatePayload.md) - - [BadRequest](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/BadRequest.md) - - [BytesRange](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/BytesRange.md) - - [Caption](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Caption.md) - - [CaptionsListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/CaptionsListResponse.md) - - [CaptionsUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/CaptionsUpdatePayload.md) - - [Chapter](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Chapter.md) - - [ChaptersListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/ChaptersListResponse.md) - - [Link](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Link.md) - - [LiveStream](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStream.md) - - [LiveStreamAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamAssets.md) - - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamCreationPayload.md) - - [LiveStreamListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamSessionSession.md) - - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/LiveStreamUpdatePayload.md) - - [Metadata](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Metadata.md) - - [Model403ErrorSchema](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Model403ErrorSchema.md) - - [NotFound](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/NotFound.md) - - [Pagination](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Pagination.md) - - [PaginationLink](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PaginationLink.md) - - [PlayerSessionEvent](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerSessionEvent.md) - - [PlayerTheme](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerTheme.md) - - [PlayerThemeAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeAssets.md) - - [PlayerThemeCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeCreationPayload.md) - - [PlayerThemeUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemeUpdatePayload.md) - - [PlayerThemesListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/PlayerThemesListResponse.md) - - [Quality](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Quality.md) - - [RawStatisticsListLiveStreamAnalyticsResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RawStatisticsListLiveStreamAnalyticsResponse.md) - - [RawStatisticsListPlayerSessionEventsResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RawStatisticsListPlayerSessionEventsResponse.md) - - [RawStatisticsListSessionsResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RawStatisticsListSessionsResponse.md) - - [RefreshTokenPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RefreshTokenPayload.md) - - [RestreamsRequestObject](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RestreamsRequestObject.md) - - [RestreamsResponseObject](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/RestreamsResponseObject.md) - - [TokenCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TokenCreationPayload.md) - - [TokenListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/TokenListResponse.md) - - [UploadToken](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/UploadToken.md) - - [Video](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Video.md) - - [VideoAssets](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoAssets.md) - - [VideoClip](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoClip.md) - - [VideoCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSessionSession.md) - - [VideoSource](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSource.md) - - [VideoSourceLiveStream](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSourceLiveStream.md) - - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoSourceLiveStreamLink.md) - - [VideoStatus](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatus.md) - - [VideoStatusEncoding](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusEncoding.md) - - [VideoStatusEncodingMetadata](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusEncodingMetadata.md) - - [VideoStatusIngest](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusIngest.md) - - [VideoStatusIngestReceivedParts](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoStatusIngestReceivedParts.md) - - [VideoThumbnailPickPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoThumbnailPickPayload.md) - - [VideoUpdatePayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoUpdatePayload.md) - - [VideoWatermark](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideoWatermark.md) - - [VideosListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/VideosListResponse.md) - - [Watermark](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Watermark.md) - - [WatermarksListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WatermarksListResponse.md) - - [Webhook](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/Webhook.md) - - [WebhooksCreationPayload](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WebhooksCreationPayload.md) - - [WebhooksListResponse](https://github.com/apivideo/api.video-php-client/blob/main/docs/Model/WebhooksListResponse.md) + - [AccessToken](docs/Model/AccessToken.md) + - [AdditionalBadRequestErrors](docs/Model/AdditionalBadRequestErrors.md) + - [AnalyticsData](docs/Model/AnalyticsData.md) + - [AnalyticsPlays400Error](docs/Model/AnalyticsPlays400Error.md) + - [AnalyticsPlaysResponse](docs/Model/AnalyticsPlaysResponse.md) + - [AuthenticatePayload](docs/Model/AuthenticatePayload.md) + - [BadRequest](docs/Model/BadRequest.md) + - [BytesRange](docs/Model/BytesRange.md) + - [Caption](docs/Model/Caption.md) + - [CaptionsListResponse](docs/Model/CaptionsListResponse.md) + - [CaptionsUpdatePayload](docs/Model/CaptionsUpdatePayload.md) + - [Chapter](docs/Model/Chapter.md) + - [ChaptersListResponse](docs/Model/ChaptersListResponse.md) + - [Link](docs/Model/Link.md) + - [LiveStream](docs/Model/LiveStream.md) + - [LiveStreamAssets](docs/Model/LiveStreamAssets.md) + - [LiveStreamCreationPayload](docs/Model/LiveStreamCreationPayload.md) + - [LiveStreamListResponse](docs/Model/LiveStreamListResponse.md) + - [LiveStreamSession](docs/Model/LiveStreamSession.md) + - [LiveStreamSessionClient](docs/Model/LiveStreamSessionClient.md) + - [LiveStreamSessionDevice](docs/Model/LiveStreamSessionDevice.md) + - [LiveStreamSessionLocation](docs/Model/LiveStreamSessionLocation.md) + - [LiveStreamSessionReferrer](docs/Model/LiveStreamSessionReferrer.md) + - [LiveStreamSessionSession](docs/Model/LiveStreamSessionSession.md) + - [LiveStreamUpdatePayload](docs/Model/LiveStreamUpdatePayload.md) + - [Metadata](docs/Model/Metadata.md) + - [Model403ErrorSchema](docs/Model/Model403ErrorSchema.md) + - [NotFound](docs/Model/NotFound.md) + - [Pagination](docs/Model/Pagination.md) + - [PaginationLink](docs/Model/PaginationLink.md) + - [PlayerSessionEvent](docs/Model/PlayerSessionEvent.md) + - [PlayerTheme](docs/Model/PlayerTheme.md) + - [PlayerThemeAssets](docs/Model/PlayerThemeAssets.md) + - [PlayerThemeCreationPayload](docs/Model/PlayerThemeCreationPayload.md) + - [PlayerThemeUpdatePayload](docs/Model/PlayerThemeUpdatePayload.md) + - [PlayerThemesListResponse](docs/Model/PlayerThemesListResponse.md) + - [Quality](docs/Model/Quality.md) + - [RawStatisticsListLiveStreamAnalyticsResponse](docs/Model/RawStatisticsListLiveStreamAnalyticsResponse.md) + - [RawStatisticsListPlayerSessionEventsResponse](docs/Model/RawStatisticsListPlayerSessionEventsResponse.md) + - [RawStatisticsListSessionsResponse](docs/Model/RawStatisticsListSessionsResponse.md) + - [RefreshTokenPayload](docs/Model/RefreshTokenPayload.md) + - [RestreamsRequestObject](docs/Model/RestreamsRequestObject.md) + - [RestreamsResponseObject](docs/Model/RestreamsResponseObject.md) + - [TokenCreationPayload](docs/Model/TokenCreationPayload.md) + - [TokenListResponse](docs/Model/TokenListResponse.md) + - [UploadToken](docs/Model/UploadToken.md) + - [Video](docs/Model/Video.md) + - [VideoAssets](docs/Model/VideoAssets.md) + - [VideoClip](docs/Model/VideoClip.md) + - [VideoCreationPayload](docs/Model/VideoCreationPayload.md) + - [VideoSession](docs/Model/VideoSession.md) + - [VideoSessionClient](docs/Model/VideoSessionClient.md) + - [VideoSessionDevice](docs/Model/VideoSessionDevice.md) + - [VideoSessionLocation](docs/Model/VideoSessionLocation.md) + - [VideoSessionOs](docs/Model/VideoSessionOs.md) + - [VideoSessionReferrer](docs/Model/VideoSessionReferrer.md) + - [VideoSessionSession](docs/Model/VideoSessionSession.md) + - [VideoSource](docs/Model/VideoSource.md) + - [VideoSourceLiveStream](docs/Model/VideoSourceLiveStream.md) + - [VideoSourceLiveStreamLink](docs/Model/VideoSourceLiveStreamLink.md) + - [VideoStatus](docs/Model/VideoStatus.md) + - [VideoStatusEncoding](docs/Model/VideoStatusEncoding.md) + - [VideoStatusEncodingMetadata](docs/Model/VideoStatusEncodingMetadata.md) + - [VideoStatusIngest](docs/Model/VideoStatusIngest.md) + - [VideoStatusIngestReceivedParts](docs/Model/VideoStatusIngestReceivedParts.md) + - [VideoThumbnailPickPayload](docs/Model/VideoThumbnailPickPayload.md) + - [VideoUpdatePayload](docs/Model/VideoUpdatePayload.md) + - [VideoWatermark](docs/Model/VideoWatermark.md) + - [VideosListResponse](docs/Model/VideosListResponse.md) + - [Watermark](docs/Model/Watermark.md) + - [WatermarksListResponse](docs/Model/WatermarksListResponse.md) + - [Webhook](docs/Model/Webhook.md) + - [WebhooksCreationPayload](docs/Model/WebhooksCreationPayload.md) + - [WebhooksListResponse](docs/Model/WebhooksListResponse.md) ## Authentication diff --git a/sdks/api-clients/apivideo-python-client.md b/sdks/api-clients/apivideo-python-client.md index 6bf18400..10a554d5 100644 --- a/sdks/api-clients/apivideo-python-client.md +++ b/sdks/api-clients/apivideo-python-client.md @@ -1,14 +1,6 @@ ---- -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." ---- - -Python API Client -============== - +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-python-client?style=social)](https://github.com/apivideo/api.video-python-client)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video Python 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. diff --git a/sdks/api-clients/apivideo-swift5-client.md b/sdks/api-clients/apivideo-swift5-client.md new file mode 100644 index 00000000..2baea161 --- /dev/null +++ b/sdks/api-clients/apivideo-swift5-client.md @@ -0,0 +1,388 @@ +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-ios-client?style=social)]()   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video iOS 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) + - [Carthage](#carthage) + - [CocoaPods](#cocoaPods) + - [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) +- [Have you gotten use from this API client?](#have-you-gotten-use-from-this-api-client) +- [Contribution](#contribution) + +# Project description +api.video's iOS streamlines the coding process. Chunking files is handled for you, as is pagination and refreshing your tokens. + +# 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..d73dc435 --- /dev/null +++ b/sdks/api-clients/apivideo-swift5-uploader-client.md @@ -0,0 +1,138 @@ +[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-ios-uploader?style=social)]()   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) +![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png) +

api.video iOS uploader

+ +[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) + - [Carthage](#carthage) + - [CocoaPods](#cocoaPods) + - [Code sample](#code-sample) +- [Documentation](#documentation) + - [API Endpoints](#api-endpoints) + - [VideosAPI](#VideosAPI) + - [Models](#models) + - [Authorization](#documentation-for-authorization) + - [API key](#api-key) + - [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 iOS uploads videos to api.video using delegated upload token or API Key. + +It allows you to upload videos in two ways: +- standard upload: to send a whole video file in one go +- progressive upload: to send a video file by chunks, without needing to know the final size of the video file + +# 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