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

public class LiveStreamsApi
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class LiveStreamsApi.APIlistRequest

Constructor Summary

Constructors
Constructor	Description
`LiveStreamsApi()`	Constructor for LiveStreamsApi production environment where API key is not required.
`LiveStreamsApi(String basePath)`	Constructor for LiveStreamsApi with custom API base path where API key is not required.
`LiveStreamsApi(String apiKey, String basePath)`	Constructor for LiveStreamsApi with custom API base path
`LiveStreamsApi(String apiKey, Environment environment)`	Constructor for LiveStreamsApi with custom API base path
`LiveStreamsApi(ApiClient apiClient)`
`LiveStreamsApi(Environment environment)`	Constructor for LiveStreamsApi 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`	`complete(String liveStreamId)`	Complete a live stream Request the completion of a live stream that is currently running.
`okhttp3.Call`	`completeAsync(String liveStreamId, ApiCallback<Void> _callback)`	Complete a live stream (asynchronously) Request the completion of a live stream that is currently running.
`ApiResponse<Void>`	`completeWithHttpInfo(String liveStreamId)`	Complete a live stream Request the completion of a live stream that is currently running.
`LiveStream`	`create(LiveStreamCreationPayload liveStreamCreationPayload)`	Create live stream Creates a livestream object.
`okhttp3.Call`	`createAsync(LiveStreamCreationPayload liveStreamCreationPayload, ApiCallback<LiveStream> _callback)`	Create live stream (asynchronously) Creates a livestream object.
`ApiResponse<LiveStream>`	`createWithHttpInfo(LiveStreamCreationPayload liveStreamCreationPayload)`	Create live stream Creates a livestream object.
`void`	`delete(String liveStreamId)`	Delete a live stream If you do not need a live stream any longer, you can send a request to delete it.
`okhttp3.Call`	`deleteAsync(String liveStreamId, ApiCallback<Void> _callback)`	Delete a live stream (asynchronously) If you do not need a live stream any longer, you can send a request to delete it.
`LiveStream`	`deleteThumbnail(String liveStreamId)`	Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.
`okhttp3.Call`	`deleteThumbnailAsync(String liveStreamId, ApiCallback<LiveStream> _callback)`	Delete a thumbnail (asynchronously) Send the unique identifier for a live stream to delete its thumbnail.
`ApiResponse<LiveStream>`	`deleteThumbnailWithHttpInfo(String liveStreamId)`	Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.
`ApiResponse<Void>`	`deleteWithHttpInfo(String liveStreamId)`	Delete a live stream If you do not need a live stream any longer, you can send a request to delete it.
`LiveStream`	`get(String liveStreamId)`	Retrieve live stream Get a livestream by id.
`ApiClient`	`getApiClient()`
`okhttp3.Call`	`getAsync(String liveStreamId, ApiCallback<LiveStream> _callback)`	Retrieve live stream (asynchronously) Get a livestream by id.
`ApiResponse<LiveStream>`	`getWithHttpInfo(String liveStreamId)`	Retrieve live stream Get a livestream by id.
`LiveStreamsApi.APIlistRequest`	`list()`	List all live streams Get the list of livestreams on the workspace.
`void`	`setApiClient(ApiClient apiClient)`
`LiveStream`	`update(String liveStreamId, LiveStreamUpdatePayload liveStreamUpdatePayload)`	Update a live stream Updates the livestream object.
`okhttp3.Call`	`updateAsync(String liveStreamId, LiveStreamUpdatePayload liveStreamUpdatePayload, ApiCallback<LiveStream> _callback)`	Update a live stream (asynchronously) Updates the livestream object.
`ApiResponse<LiveStream>`	`updateWithHttpInfo(String liveStreamId, LiveStreamUpdatePayload liveStreamUpdatePayload)`	Update a live stream Updates the livestream object.
`LiveStream`	`uploadThumbnail(String liveStreamId, File file)`	Upload a thumbnail Upload the thumbnail for the livestream.
`okhttp3.Call`	`uploadThumbnailAsync(String liveStreamId, File file, ApiCallback<LiveStream> _callback)`	Upload a thumbnail (asynchronously) Upload the thumbnail for the livestream.
`ApiResponse<LiveStream>`	`uploadThumbnailWithHttpInfo(String liveStreamId, File file)`	Upload a thumbnail Upload the thumbnail for the livestream.

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

Constructor Detail
- LiveStreamsApi
```
public LiveStreamsApi(ApiClient apiClient)
```
- LiveStreamsApi
```
public LiveStreamsApi()
```
  Constructor for LiveStreamsApi production environment where API key is not required.
- LiveStreamsApi
```
public LiveStreamsApi(String basePath)
```
  Constructor for LiveStreamsApi 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.
- LiveStreamsApi
```
public LiveStreamsApi(Environment environment)
```
  Constructor for LiveStreamsApi with custom API base path where API key is not required.
  
  Parameters:
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.
- LiveStreamsApi
```
public LiveStreamsApi(String apiKey,
                      String basePath)
```
  Constructor for LiveStreamsApi 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.
- LiveStreamsApi
```
public LiveStreamsApi(String apiKey,
                      Environment environment)
```
  Constructor for LiveStreamsApi 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)

create

public LiveStream create(LiveStreamCreationPayload liveStreamCreationPayload)
                  throws ApiException

Create live stream Creates a livestream object.

Parameters:

liveStreamCreationPayload - (required)

Returns:

LiveStream

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	* 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.

createWithHttpInfo

public ApiResponse<LiveStream> createWithHttpInfo(LiveStreamCreationPayload liveStreamCreationPayload)
                                           throws ApiException

Create live stream Creates a livestream object.

Parameters:

liveStreamCreationPayload - (required)

Returns:

ApiResponse<LiveStream>

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	* 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.

createAsync

public okhttp3.Call createAsync(LiveStreamCreationPayload liveStreamCreationPayload,
                                ApiCallback<LiveStream> _callback)
                         throws ApiException

Create live stream (asynchronously) Creates a livestream object.

Parameters:

liveStreamCreationPayload - (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	* 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 LiveStream get(String liveStreamId)
               throws ApiException

Retrieve live stream Get a livestream by id.

Parameters:

liveStreamId - The unique ID for the live stream you want to watch. (required)

Returns:

LiveStream

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.
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<LiveStream> getWithHttpInfo(String liveStreamId)
                                        throws ApiException

Retrieve live stream Get a livestream by id.

Parameters:

liveStreamId - The unique ID for the live stream you want to watch. (required)

Returns:

ApiResponse<LiveStream>

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.
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 liveStreamId,
                             ApiCallback<LiveStream> _callback)
                      throws ApiException

Retrieve live stream (asynchronously) Get a livestream by id.

Parameters:

liveStreamId - The unique ID for the live stream you want to watch. (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.
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 LiveStream update(String liveStreamId,
                         LiveStreamUpdatePayload liveStreamUpdatePayload)
                  throws ApiException

Update a live stream Updates the livestream object.

Parameters:

liveStreamId - The unique ID for the live stream that you want to update information for such as player details. (required)

liveStreamUpdatePayload - (required)

Returns:

LiveStream

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	* 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<LiveStream> updateWithHttpInfo(String liveStreamId,
                                                  LiveStreamUpdatePayload liveStreamUpdatePayload)
                                           throws ApiException

Update a live stream Updates the livestream object.

Parameters:

liveStreamId - The unique ID for the live stream that you want to update information for such as player details. (required)

liveStreamUpdatePayload - (required)

Returns:

ApiResponse<LiveStream>

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	* 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 liveStreamId,
                                LiveStreamUpdatePayload liveStreamUpdatePayload,
                                ApiCallback<LiveStream> _callback)
                         throws ApiException

Update a live stream (asynchronously) Updates the livestream object.

Parameters:

liveStreamId - The unique ID for the live stream that you want to update information for such as player details. (required)

liveStreamUpdatePayload - (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	* 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 liveStreamId)
            throws ApiException

Delete a live stream If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.

Parameters:

liveStreamId - The unique ID for the live stream that you want to remove. (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.
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 liveStreamId)
                                     throws ApiException

Delete a live stream If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.

Parameters:

liveStreamId - The unique ID for the live stream that you want to remove. (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.
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 liveStreamId,
                                ApiCallback<Void> _callback)
                         throws ApiException

Delete a live stream (asynchronously) If you do not need a live stream any longer, you can send a request to delete it. All you need is the liveStreamId.

Parameters:

liveStreamId - The unique ID for the live stream that you want to remove. (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.
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 LiveStreamsApi.APIlistRequest list()

List all live streams Get the list of livestreams on the workspace.

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.
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.

uploadThumbnail

public LiveStream uploadThumbnail(String liveStreamId,
                                  File file)
                           throws ApiException

Upload a thumbnail Upload the thumbnail for the livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to upload. (required)

file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)

Returns:

LiveStream

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
201	Created	* 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	* 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.

uploadThumbnailWithHttpInfo

public ApiResponse<LiveStream> uploadThumbnailWithHttpInfo(String liveStreamId,
                                                           File file)
                                                    throws ApiException

Upload a thumbnail Upload the thumbnail for the livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to upload. (required)

file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (required)

Returns:

ApiResponse<LiveStream>

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
201	Created	* 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	* 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.

uploadThumbnailAsync

public okhttp3.Call uploadThumbnailAsync(String liveStreamId,
                                         File file,
                                         ApiCallback<LiveStream> _callback)
                                  throws ApiException

Upload a thumbnail (asynchronously) Upload the thumbnail for the livestream.

Parameters:

liveStreamId - The unique ID for the live stream you want to upload. (required)

file - The image to be added as a thumbnail. The mime type should be image/jpeg, image/png or image/webp. The max allowed size is 8 MiB. (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
201	Created	* 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	* 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.

deleteThumbnail

public LiveStream deleteThumbnail(String liveStreamId)
                           throws ApiException

Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.

Parameters:

liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (required)

Returns:

LiveStream

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.
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.

deleteThumbnailWithHttpInfo

public ApiResponse<LiveStream> deleteThumbnailWithHttpInfo(String liveStreamId)
                                                    throws ApiException

Delete a thumbnail Send the unique identifier for a live stream to delete its thumbnail.

Parameters:

liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (required)

Returns:

ApiResponse<LiveStream>

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.
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.

deleteThumbnailAsync

public okhttp3.Call deleteThumbnailAsync(String liveStreamId,
                                         ApiCallback<LiveStream> _callback)
                                  throws ApiException

Delete a thumbnail (asynchronously) Send the unique identifier for a live stream to delete its thumbnail.

Parameters:

liveStreamId - The unique identifier of the live stream whose thumbnail you want to delete. (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.
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.

complete

public void complete(String liveStreamId)
              throws ApiException

Complete a live stream Request the completion of a live stream that is currently running. This operation is asynchronous and the live stream will stop after a few seconds. The API adds the `EXT-X-ENDLIST` tag to the live stream's HLS manifest. This stops the live stream on the player and also stops the recording of the live stream. The API keeps the incoming connection from the streamer open for at most 1 minute, which can be used to terminate the stream.

Parameters:

liveStreamId - The unique ID for the live stream you want to complete. (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
202	Accepted	* 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.

completeWithHttpInfo

public ApiResponse<Void> completeWithHttpInfo(String liveStreamId)
                                       throws ApiException

Complete a live stream Request the completion of a live stream that is currently running. This operation is asynchronous and the live stream will stop after a few seconds. The API adds the `EXT-X-ENDLIST` tag to the live stream's HLS manifest. This stops the live stream on the player and also stops the recording of the live stream. The API keeps the incoming connection from the streamer open for at most 1 minute, which can be used to terminate the stream.

Parameters:

liveStreamId - The unique ID for the live stream you want to complete. (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
202	Accepted	* 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.

completeAsync

public okhttp3.Call completeAsync(String liveStreamId,
                                  ApiCallback<Void> _callback)
                           throws ApiException

Complete a live stream (asynchronously) Request the completion of a live stream that is currently running. This operation is asynchronous and the live stream will stop after a few seconds. The API adds the `EXT-X-ENDLIST` tag to the live stream's HLS manifest. This stops the live stream on the player and also stops the recording of the live stream. The API keeps the incoming connection from the streamer open for at most 1 minute, which can be used to terminate the stream.

Parameters:

liveStreamId - The unique ID for the live stream you want to complete. (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
202	Accepted	* 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 LiveStreamsApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LiveStreamsApi

LiveStreamsApi

LiveStreamsApi

LiveStreamsApi

LiveStreamsApi

LiveStreamsApi

Method Detail

getApiClient

setApiClient

create

createWithHttpInfo

createAsync

get

getWithHttpInfo

getAsync

update

updateWithHttpInfo

updateAsync

delete

deleteWithHttpInfo

deleteAsync

list

uploadThumbnail

uploadThumbnailWithHttpInfo

uploadThumbnailAsync

deleteThumbnail

deleteThumbnailWithHttpInfo

deleteThumbnailAsync

complete

completeWithHttpInfo

completeAsync