Class CropApi

Inheritance

System.Object

CropApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Encoding.Filters.Crop

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class CropApi

Constructors

CropApi(IBitmovinApiClientFactory)

Declaration

public CropApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of CropApi

Declaration

public static BitmovinApiBuilder<CropApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<CropApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(CropFilter)

Create Crop Filter

Declaration

public Task<CropFilter> CreateAsync(CropFilter cropFilter)

Parameters

Type	Name	Description
CropFilter	cropFilter	The Crop Filter to be created

Returns

Type	Description
System.Threading.Tasks.Task<CropFilter>

DeleteAsync(String)

Delete Crop Filter

Declaration

public Task<BitmovinResponse> DeleteAsync(string filterId)

Parameters

Type	Name	Description
System.String	filterId	Id of the Crop Filter. (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String)

Crop Filter Details

Declaration

public Task<CropFilter> GetAsync(string filterId)

Parameters

Type	Name	Description
System.String	filterId	Id of the Crop Filter. (required)

Returns

Type	Description
System.Threading.Tasks.Task<CropFilter>

ListAsync(Func<CropApi.ListQueryParams, CropApi.ListQueryParams>[])

List Crop Filters

Declaration

public Task<PaginationResponse<CropFilter>> ListAsync(params Func<CropApi.ListQueryParams, CropApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.Func<CropApi.ListQueryParams, CropApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<CropFilter>>