Show / Hide Table of Contents

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.Dash.Periods.Adaptationsets.Representations.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, String, String, DashVttRepresentation)

Add VTT Representation

Declaration
public Task<DashVttRepresentation> CreateAsync(string manifestId, string periodId, string adaptationsetId, DashVttRepresentation dashVttRepresentation)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the adaptation set (required)

DashVttRepresentation dashVttRepresentation

The VTT representation to be added to the adaptation set

Returns
Type Description
System.Threading.Tasks.Task<DashVttRepresentation>

DeleteAsync(String, String, String, String)

Delete VTT Representation

Declaration
public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId, string representationId)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the adaptation set (required)

System.String representationId

Id of the VTT representation to be deleted (required)

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

GetAsync(String, String, String, String)

VTT Representation Details

Declaration
public Task<DashVttRepresentation> GetAsync(string manifestId, string periodId, string adaptationsetId, string representationId)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the adaptation set (required)

System.String representationId

Id of the VTT representation (required)

Returns
Type Description
System.Threading.Tasks.Task<DashVttRepresentation>

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

List all VTT Representations

Declaration
public Task<PaginationResponse<DashVttRepresentation>> ListAsync(string manifestId, string periodId, string adaptationsetId, params Func<VttApi.ListQueryParams, VttApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.String manifestId

Id of the manifest (required)

System.String periodId

Id of the period (required)

System.String adaptationsetId

Id of the adaptation set (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<DashVttRepresentation>>
Back to top Generated by DocFX