Class SubtitleApi

Inheritance

System.Object

SubtitleApi

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.Subtitle

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SubtitleApi

Constructors

SubtitleApi(IBitmovinApiClientFactory)

Declaration

public SubtitleApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SubtitleApi

Declaration

public static BitmovinApiBuilder<SubtitleApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SubtitleApi>

Methods

CreateAsync(String, String, SubtitleAdaptationSet)

Add Subtitle AdaptationSet

Declaration

public Task<SubtitleAdaptationSet> CreateAsync(string manifestId, string periodId, SubtitleAdaptationSet subtitleAdaptationSet)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
SubtitleAdaptationSet	subtitleAdaptationSet	The subtitle adaptation set to be added to the period

Returns

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

DeleteAsync(String, String, String)

Delete Subtitle AdaptationSet

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId, string adaptationsetId)

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 subtitle adaptation set to be deleted (required)

Returns

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

GetAsync(String, String, String)

Subtitle AdaptationSet Details

Declaration

public Task<SubtitleAdaptationSet> GetAsync(string manifestId, string periodId, string adaptationsetId)

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 subtitle adaptation set (required)

Returns

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

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

List all Subtitle AdaptationSets

Declaration

public Task<PaginationResponse<SubtitleAdaptationSet>> ListAsync(string manifestId, string periodId, params Func<SubtitleApi.ListQueryParams, SubtitleApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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