Class VttApi

Inheritance

System.Object

VttApi

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.Manifests.Hls.Media.Vtt

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class VttApi

Constructors

VttApi(IBitmovinApiClientFactory)

Declaration

public VttApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of VttApi

Declaration

public static BitmovinApiBuilder<VttApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<VttApi>

Methods

CreateAsync(String, VttMediaInfo)

Add VTT Media

Declaration

public Task<VttMediaInfo> CreateAsync(string manifestId, VttMediaInfo vttMediaInfo)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
VttMediaInfo	vttMediaInfo	The VTT Media to be added

Returns

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

DeleteAsync(String, String)

Delete VTT Media

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string mediaId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	mediaId	Id of the VTT media. (required)

Returns

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

GetAsync(String, String)

VTT Media Details

Declaration

public Task<VttMediaInfo> GetAsync(string manifestId, string mediaId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	mediaId	Id of the VTT media. (required)

Returns

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

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

List all VTT Media

Declaration

public Task<PaginationResponse<VttMediaInfo>> ListAsync(string manifestId, params Func<VttApi.ListQueryParams, VttApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.Func<VttApi.ListQueryParams, VttApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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