com.bitmovin.api.sdk.encoding.filters.crop

Class CropApi

java.lang.Object

com.bitmovin.api.sdk.encoding.filters.crop.CropApi

public class CropApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
CropApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<CropApi>	builder() Fluent builder for creating an instance of CropApi
CropFilter	create(CropFilter cropFilter) Create Crop Filter
BitmovinResponse	delete(String filterId) Delete Crop Filter
CropFilter	get(String filterId) Crop Filter Details
PaginationResponse<CropFilter>	list() List Crop Filters
PaginationResponse<CropFilter>	list(CropFilterListQueryParams queryParams) List Crop 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

CropApi

public CropApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<CropApi> builder()

Fluent builder for creating an instance of CropApi

create

public CropFilter create(CropFilter cropFilter)
                  throws BitmovinException

Create Crop Filter

Parameters:

cropFilter - The Crop Filter to be created (required)

Returns:

CropFilter

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String filterId)
                        throws BitmovinException

Delete Crop Filter

Parameters:

filterId - Id of the Crop configuration. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public CropFilter get(String filterId)
               throws BitmovinException

Crop Filter Details

Parameters:

filterId - Id of the Crop configuration. (required)

Returns:

CropFilter

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CropFilter> list()
                                    throws BitmovinException

List Crop Filters

Returns:

List<CropFilter>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CropFilter> list(CropFilterListQueryParams queryParams)
                                    throws BitmovinException

List Crop Filters

Parameters:

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

Returns:

List<CropFilter>

Throws:

BitmovinException - if fails to make API call