Show / Hide Table of Contents

Class ScaleApi

Inheritance
System.Object
ScaleApi
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.Scale
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class ScaleApi

Constructors

ScaleApi(IBitmovinApiClientFactory)

Declaration
public ScaleApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ScaleApi

Declaration
public static BitmovinApiBuilder<ScaleApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<ScaleApi>

Customdata

Declaration
public CustomdataApi Customdata { get; }
Property Value
Type Description
CustomdataApi

Methods

CreateAsync(ScaleFilter)

Create Scale Filter

Declaration
public Task<ScaleFilter> CreateAsync(ScaleFilter scaleFilter)
Parameters
Type Name Description
ScaleFilter scaleFilter

The Scale Filter to be created

Returns
Type Description
System.Threading.Tasks.Task<ScaleFilter>

DeleteAsync(String)

Delete Scale Filter

Declaration
public Task<BitmovinResponse> DeleteAsync(string filterId)
Parameters
Type Name Description
System.String filterId

Id of the scale filter (required)

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

GetAsync(String)

Scale Filter Details

Declaration
public Task<ScaleFilter> GetAsync(string filterId)
Parameters
Type Name Description
System.String filterId

Id of the scale filter (required)

Returns
Type Description
System.Threading.Tasks.Task<ScaleFilter>

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

List Scale Filters

Declaration
public Task<PaginationResponse<ScaleFilter>> ListAsync(params Func<ScaleApi.ListQueryParams, ScaleApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.Func<ScaleApi.ListQueryParams, ScaleApi.ListQueryParams>[] queryParams

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

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<ScaleFilter>>
Back to top Generated by DocFX