Class WebvttApi

Inheritance

System.Object

WebvttApi

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.Configurations.Subtitles.Webvtt

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class WebvttApi

Constructors

WebvttApi(IBitmovinApiClientFactory)

Declaration

public WebvttApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of WebvttApi

Declaration

public static BitmovinApiBuilder<WebvttApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<WebvttApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(WebVttConfiguration)

Create WebVtt subtitle configuration

Declaration

public Task<WebVttConfiguration> CreateAsync(WebVttConfiguration webVttConfiguration)

Parameters

Type	Name	Description
WebVttConfiguration	webVttConfiguration	The WebVtt subtitle configuration to be created

Returns

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

DeleteAsync(String)

Delete WebVtt subtitle configuration

Declaration

public Task<BitmovinResponse> DeleteAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the subtitle configuration (required)

Returns

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

GetAsync(String)

WebVtt subtitle configuration details

Declaration

public Task<WebVttConfiguration> GetAsync(string configurationId)

Parameters

Type	Name	Description
System.String	configurationId	Id of the codec configuration (required)

Returns

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

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

List WebVtt subtitle configurations

Declaration

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

Parameters

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

Returns

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