Package video.api.client.api.clients

Class WatermarksApi

java.lang.Object

video.api.client.api.clients.WatermarksApi

public class WatermarksApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WatermarksApi.APIlistRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete(String watermarkId)	Delete a watermark Delete a watermark.
ApiResponse<Void>	deleteWithHttpInfo(String watermarkId)	Delete a watermark Delete a watermark.
ApiClient	getApiClient()
WatermarksApi.APIlistRequest	list()	List all watermarks List all watermarks.
void	setApiClient(ApiClient apiClient)
Watermark	upload(File file)	Upload a watermark Create a new watermark by uploading a .jpg or a .png image.
ApiResponse<Watermark>	uploadWithHttpInfo(File file)	Upload a watermark Create a new watermark by uploading a .jpg or a .png image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatermarksApi

public WatermarksApi(ApiClient apiClient)

WatermarksApi

public WatermarksApi()

Constructor for WatermarksApi production environment where API key is not required.

WatermarksApi

public WatermarksApi(String basePath)

Constructor for WatermarksApi 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.

WatermarksApi

public WatermarksApi(String apiKey,
                     String basePath)

Constructor for WatermarksApi 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.

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

delete

public void delete(String watermarkId)
            throws ApiException

Delete a watermark Delete a watermark. A watermark is a static image overlapping a video used as a \"stamp\" to limit leetching.

Parameters:

watermarkId - The watermark ID for the watermark you want to delete. (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	-
404	Not Found	-

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String watermarkId)
                                     throws ApiException

Delete a watermark Delete a watermark. A watermark is a static image overlapping a video used as a \"stamp\" to limit leetching.

Parameters:

watermarkId - The watermark ID for the watermark you want to delete. (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	-
404	Not Found	-

list

public WatermarksApi.APIlistRequest list()

List all watermarks List all watermarks. A watermark is a static image overlapping a video used as a \"stamp\" to limit leetching.

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

upload

public Watermark upload(File file)
                 throws ApiException

Upload a watermark Create a new watermark by uploading a .jpg or a .png image. A watermark is a static image overlapping a video used as a \"stamp\" to limit leetching.

Parameters:

file - The .jpg or .png image to be added as a watermark. (required)

Returns:

Watermark

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	-
400	Bad Request	-

uploadWithHttpInfo

public ApiResponse<Watermark> uploadWithHttpInfo(File file)
                                          throws ApiException

Upload a watermark Create a new watermark by uploading a .jpg or a .png image. A watermark is a static image overlapping a video used as a \"stamp\" to limit leetching.

Parameters:

file - The .jpg or .png image to be added as a watermark. (required)

Returns:

ApiResponse<Watermark>

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	-
400	Bad Request	-