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.Encodings.Sidecars.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>

Methods

CreateAsync(String, WebVttSidecarFile)

Add WebVTT sidecar file

Declaration

public Task<WebVttSidecarFile> CreateAsync(string encodingId, WebVttSidecarFile webVttSidecarFile)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
WebVttSidecarFile	webVttSidecarFile	The WebVTT Sidecar file to be added

Returns

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

DeleteAsync(String, String)

Delete Sidecar

Declaration

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

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	sidecarId	Id of the sidecar. (required)

Returns

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

GetAsync(String, String)

WebVTT Sidecar Details

Declaration

public Task<WebVttSidecarFile> GetAsync(string encodingId, string sidecarId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	sidecarId	Id of the sidecar. (required)

Returns

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

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

List WebVTT sidecar files

Declaration

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

Parameters

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