Class DvbsubApi

Inheritance

System.Object

DvbsubApi

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.Streams.BurnInSubtitles.Dvbsub

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class DvbsubApi

Constructors

DvbsubApi(IBitmovinApiClientFactory)

Declaration

public DvbsubApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of DvbsubApi

Declaration

public static BitmovinApiBuilder<DvbsubApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<DvbsubApi>

Methods

CreateAsync(String, String, BurnInSubtitleDvbSub)

Burn-In DVB-SUB Subtitle into Stream

Declaration

public Task<BurnInSubtitleDvbSub> CreateAsync(string encodingId, string streamId, BurnInSubtitleDvbSub burnInSubtitleDvbSub)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
BurnInSubtitleDvbSub	burnInSubtitleDvbSub	The Burn-In DVB-SUB Subtitle to be added

Returns

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

DeleteAsync(String, String, String)

Delete Burn-In DVB-SUB Subtitle from Stream

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId, string subtitleId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	subtitleId	Id of the subtitle. (required)

Returns

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

GetAsync(String, String, String)

Get Burn-In DVB-SUB Subtitle Details

Declaration

public Task<BurnInSubtitleDvbSub> GetAsync(string encodingId, string streamId, string subtitleId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	subtitleId	Id of the subtitle. (required)

Returns

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

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

List the Burn-In DVB-SUB subtitles of a stream

Declaration

public Task<PaginationResponse<BurnInSubtitleDvbSub>> ListAsync(string encodingId, string streamId, params Func<DvbsubApi.ListQueryParams, DvbsubApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.Func<DvbsubApi.ListQueryParams, DvbsubApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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