Class TextApi

Inheritance

System.Object

TextApi

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.Text

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class TextApi

Constructors

TextApi(IBitmovinApiClientFactory)

Declaration

public TextApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of TextApi

Declaration

public static BitmovinApiBuilder<TextApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<TextApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(TextFilter)

Create Text Filter

Declaration

public Task<TextFilter> CreateAsync(TextFilter textFilter)

Parameters

Type	Name	Description
TextFilter	textFilter	The Text Filter to be created

Returns

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

DeleteAsync(String)

Delete Text Filter

Declaration

public Task<BitmovinResponse> DeleteAsync(string filterId)

Parameters

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

Returns

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

GetAsync(String)

Text Filter Details

Declaration

public Task<TextFilter> GetAsync(string filterId)

Parameters

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

Returns

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

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

List Text Filters

Declaration

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

Parameters

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

Returns

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