java.lang.Object
- video.api.client.api.clients.CaptionsApi

```
public class CaptionsApi
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class CaptionsApi.APIlistRequest

Constructor Summary

Constructors
Constructor	Description
`CaptionsApi()`	Constructor for CaptionsApi production environment where API key is not required.
`CaptionsApi(String basePath)`	Constructor for CaptionsApi with custom API base path where API key is not required.
`CaptionsApi(String apiKey, String basePath)`	Constructor for CaptionsApi with custom API base path
`CaptionsApi(String apiKey, Environment environment)`	Constructor for CaptionsApi with custom API base path
`CaptionsApi(ApiClient apiClient)`
`CaptionsApi(Environment environment)`	Constructor for CaptionsApi with custom API base path where API key is not required.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`delete(String videoId, String language)`	Delete a caption Delete a caption in a specific language by by video id.
`okhttp3.Call`	`deleteAsync(String videoId, String language, ApiCallback<Void> _callback)`	Delete a caption (asynchronously) Delete a caption in a specific language by by video id.
`ApiResponse<Void>`	`deleteWithHttpInfo(String videoId, String language)`	Delete a caption Delete a caption in a specific language by by video id.
`Caption`	`get(String videoId, String language)`	Retrieve a caption Retrieve a caption for a video in a specific language.
`ApiClient`	`getApiClient()`
`okhttp3.Call`	`getAsync(String videoId, String language, ApiCallback<Caption> _callback)`	Retrieve a caption (asynchronously) Retrieve a caption for a video in a specific language.
`ApiResponse<Caption>`	`getWithHttpInfo(String videoId, String language)`	Retrieve a caption Retrieve a caption for a video in a specific language.
`CaptionsApi.APIlistRequest`	`list(String videoId)`	List video captions Retrieve a list of available captions by video id.
`void`	`setApiClient(ApiClient apiClient)`
`Caption`	`update(String videoId, String language, CaptionsUpdatePayload captionsUpdatePayload)`	Update a caption To have the captions on automatically, use this method to set default: true.
`okhttp3.Call`	`updateAsync(String videoId, String language, CaptionsUpdatePayload captionsUpdatePayload, ApiCallback<Caption> _callback)`	Update a caption (asynchronously) To have the captions on automatically, use this method to set default: true.
`ApiResponse<Caption>`	`updateWithHttpInfo(String videoId, String language, CaptionsUpdatePayload captionsUpdatePayload)`	Update a caption To have the captions on automatically, use this method to set default: true.
`Caption`	`upload(String videoId, String language, File file)`	Upload a caption Upload a VTT file to add captions to your video.
`okhttp3.Call`	`uploadAsync(String videoId, String language, File file, ApiCallback<Caption> _callback)`	Upload a caption (asynchronously) Upload a VTT file to add captions to your video.
`ApiResponse<Caption>`	`uploadWithHttpInfo(String videoId, String language, File file)`	Upload a caption Upload a VTT file to add captions to your video.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CaptionsApi
```
public CaptionsApi(ApiClient apiClient)
```
- CaptionsApi
```
public CaptionsApi()
```
  Constructor for CaptionsApi production environment where API key is not required.
- CaptionsApi
```
public CaptionsApi(String basePath)
```
  Constructor for CaptionsApi with custom API base path where API key is not required.
  
  Parameters:
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- CaptionsApi
```
public CaptionsApi(Environment environment)
```
  Constructor for CaptionsApi with custom API base path where API key is not required.
  
  Parameters:
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.
- CaptionsApi
```
public CaptionsApi(String apiKey,
                   String basePath)
```
  Constructor for CaptionsApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- CaptionsApi
```
public CaptionsApi(String apiKey,
                   Environment environment)
```
  Constructor for CaptionsApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

upload

public Caption upload(String videoId,
                      String language,
                      File file)
               throws ApiException

Upload a caption Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)

Parameters:

videoId - The unique identifier for the video you want to add a caption to. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

file - The video text track (VTT) you want to upload. (required)

Returns:

Caption

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadWithHttpInfo

public ApiResponse<Caption> uploadWithHttpInfo(String videoId,
                                               String language,
                                               File file)
                                        throws ApiException

Upload a caption Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)

Parameters:

videoId - The unique identifier for the video you want to add a caption to. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

file - The video text track (VTT) you want to upload. (required)

Returns:

ApiResponse<Caption>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadAsync

public okhttp3.Call uploadAsync(String videoId,
                                String language,
                                File file,
                                ApiCallback<Caption> _callback)
                         throws ApiException

Upload a caption (asynchronously) Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)

Parameters:

videoId - The unique identifier for the video you want to add a caption to. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

file - The video text track (VTT) you want to upload. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

get

public Caption get(String videoId,
                   String language)
            throws ApiException

Retrieve a caption Retrieve a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a error indicating the caption was not found. Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/captions).

Parameters:

videoId - The unique identifier for the video you want captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

Returns:

Caption

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

getWithHttpInfo

public ApiResponse<Caption> getWithHttpInfo(String videoId,
                                            String language)
                                     throws ApiException

Retrieve a caption Retrieve a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a error indicating the caption was not found. Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/captions).

Parameters:

videoId - The unique identifier for the video you want captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

Returns:

ApiResponse<Caption>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

getAsync

public okhttp3.Call getAsync(String videoId,
                             String language,
                             ApiCallback<Caption> _callback)
                      throws ApiException

Retrieve a caption (asynchronously) Retrieve a caption for a video in a specific language. If the language is available, the caption is returned. Otherwise, you will get a error indicating the caption was not found. Tutorials that use the [captions endpoint](https://api.video/blog/endpoints/captions).

Parameters:

videoId - The unique identifier for the video you want captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

update

public Caption update(String videoId,
                      String language,
                      CaptionsUpdatePayload captionsUpdatePayload)
               throws ApiException

Update a caption To have the captions on automatically, use this method to set default: true.

Parameters:

videoId - The unique identifier for the video you want to have automatic captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

captionsUpdatePayload - (required)

Returns:

Caption

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

updateWithHttpInfo

public ApiResponse<Caption> updateWithHttpInfo(String videoId,
                                               String language,
                                               CaptionsUpdatePayload captionsUpdatePayload)
                                        throws ApiException

Update a caption To have the captions on automatically, use this method to set default: true.

Parameters:

videoId - The unique identifier for the video you want to have automatic captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

captionsUpdatePayload - (required)

Returns:

ApiResponse<Caption>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

updateAsync

public okhttp3.Call updateAsync(String videoId,
                                String language,
                                CaptionsUpdatePayload captionsUpdatePayload,
                                ApiCallback<Caption> _callback)
                         throws ApiException

Update a caption (asynchronously) To have the captions on automatically, use this method to set default: true.

Parameters:

videoId - The unique identifier for the video you want to have automatic captions for. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

captionsUpdatePayload - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

delete

public void delete(String videoId,
                   String language)
            throws ApiException

Delete a caption Delete a caption in a specific language by by video id.

Parameters:

videoId - The unique identifier for the video you want to delete a caption from. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String videoId,
                                            String language)
                                     throws ApiException

Delete a caption Delete a caption in a specific language by by video id.

Parameters:

videoId - The unique identifier for the video you want to delete a caption from. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteAsync

public okhttp3.Call deleteAsync(String videoId,
                                String language,
                                ApiCallback<Void> _callback)
                         throws ApiException

Delete a caption (asynchronously) Delete a caption in a specific language by by video id.

Parameters:

videoId - The unique identifier for the video you want to delete a caption from. (required)

language - A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags). (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad request error	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

list

public CaptionsApi.APIlistRequest list(String videoId)

List video captions Retrieve a list of available captions by video id.

Parameters:

videoId - The unique identifier for the video you want to retrieve a list of captions for. (required)

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

Class CaptionsApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaptionsApi

CaptionsApi

CaptionsApi

CaptionsApi

CaptionsApi

CaptionsApi

Method Detail

getApiClient

setApiClient

upload

uploadWithHttpInfo

uploadAsync

get

getWithHttpInfo

getAsync

update

updateWithHttpInfo

updateAsync

delete

deleteWithHttpInfo

deleteAsync

list