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.Encodings.Muxings.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(String, TextMuxing)

Add Text muxing

Declaration

public Task<TextMuxing> CreateAsync(string encodingId, TextMuxing textMuxing)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
TextMuxing	textMuxing	The Text muxing to be created

Returns

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

DeleteAsync(String, String)

Delete Text muxing

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string muxingId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the Text muxing (required)

Returns

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

GetAsync(String, String)

Text muxing details

Declaration

public Task<TextMuxing> GetAsync(string encodingId, string muxingId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the Text muxing (required)

Returns

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

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

List Text muxings

Declaration

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

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
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<TextMuxing>>