com.bitmovin.api.sdk.encoding.filters.watermark

Class WatermarkApi

java.lang.Object

com.bitmovin.api.sdk.encoding.filters.watermark.WatermarkApi

public class WatermarkApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
WatermarkApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<WatermarkApi>	builder() Fluent builder for creating an instance of WatermarkApi
WatermarkFilter	create(WatermarkFilter watermarkFilter) Create Watermark Filter
BitmovinResponse	delete(String filterId) Delete Watermark Filter
WatermarkFilter	get(String filterId) Watermark Filter Details
PaginationResponse<WatermarkFilter>	list() List Watermark Filters
PaginationResponse<WatermarkFilter>	list(WatermarkFilterListQueryParams queryParams) List Watermark Filters

Methods inherited from class java.lang.Object

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

Field Detail

customdata

public final CustomdataApi customdata

Constructor Detail

WatermarkApi

public WatermarkApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<WatermarkApi> builder()

Fluent builder for creating an instance of WatermarkApi

create

public WatermarkFilter create(WatermarkFilter watermarkFilter)
                       throws BitmovinException

Create Watermark Filter

Parameters:

watermarkFilter - The Watermark Filter to be created. Only one horizontal and one vertical distance parameter is allowed, either top or bottom, and either left or right. See example body. (required)

Returns:

WatermarkFilter

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String filterId)
                        throws BitmovinException

Delete Watermark Filter

Parameters:

filterId - Id of the watermark configuration. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public WatermarkFilter get(String filterId)
                    throws BitmovinException

Watermark Filter Details

Parameters:

filterId - Id of the watermark configuration. (required)

Returns:

WatermarkFilter

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<WatermarkFilter> list()
                                         throws BitmovinException

List Watermark Filters

Returns:

List<WatermarkFilter>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<WatermarkFilter> list(WatermarkFilterListQueryParams queryParams)
                                         throws BitmovinException

List Watermark Filters

Parameters:

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<WatermarkFilter>

Throws:

BitmovinException - if fails to make API call