Class SubtitlesApi

Inheritance

System.Object

SubtitlesApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SubtitlesApi

Constructors

SubtitlesApi(IBitmovinApiClientFactory)

Declaration

public SubtitlesApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SubtitlesApi

Declaration

public static BitmovinApiBuilder<SubtitlesApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SubtitlesApi>

Methods

CreateAsync(String, SubtitlesMediaInfo)

Add Subtitles Media

Declaration

public Task<SubtitlesMediaInfo> CreateAsync(string manifestId, SubtitlesMediaInfo subtitlesMediaInfo)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
SubtitlesMediaInfo	subtitlesMediaInfo	The Subtitles Media to be added

Returns

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

DeleteAsync(String, String)

Delete Subtitles 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 subtitles media. (required)

Returns

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

GetAsync(String, String)

Subtitles Media Details

Declaration

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

Parameters

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

Returns

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

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

List all Subtitles Media

Declaration

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

Parameters

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

Returns

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