Class FiltersApi

Inheritance

System.Object

FiltersApi

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.Encodings.Streams.Filters

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class FiltersApi

Constructors

FiltersApi(IBitmovinApiClientFactory)

Declaration

public FiltersApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of FiltersApi

Declaration

public static BitmovinApiBuilder<FiltersApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<FiltersApi>

Methods

CreateAsync(String, String, List<StreamFilter>)

Add Filters to Stream

Declaration

public Task<StreamFilterList> CreateAsync(string encodingId, string streamId, List<StreamFilter> streamFilter)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.Collections.Generic.List<StreamFilter>	streamFilter	The Filters to be added

Returns

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

DeleteAllAsync(String, String)

Delete All Filters from Stream

Declaration

public Task<BitmovinResponseList> DeleteAllAsync(string encodingId, string streamId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)

Returns

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

DeleteAsync(String, String, String)

Delete Specific Filter from Stream

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId, string filterId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	filterId	Id of the filter (required)

Returns

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

ListAsync(String, String, Func<FiltersApi.ListQueryParams, FiltersApi.ListQueryParams>[])

List the filters of a stream

Declaration

public Task<StreamFilterList> ListAsync(string encodingId, string streamId, params Func<FiltersApi.ListQueryParams, FiltersApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.Func<FiltersApi.ListQueryParams, FiltersApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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