Class SrtApi

Inheritance

System.Object

SrtApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SrtApi

Constructors

SrtApi(IBitmovinApiClientFactory)

Declaration

public SrtApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SrtApi

Declaration

public static BitmovinApiBuilder<SrtApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SrtApi>

Methods

CreateAsync(String, String, BurnInSubtitleSrt)

Burn-In SRT Subtitle into Stream

Declaration

public Task<BurnInSubtitleSrt> CreateAsync(string encodingId, string streamId, BurnInSubtitleSrt burnInSubtitleSrt)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
BurnInSubtitleSrt	burnInSubtitleSrt	The Burn-In SRT Subtitle to be added

Returns

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

DeleteAsync(String, String, String)

Delete Burn-In SRT 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 burn-in subtitle. (required)

Returns

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

GetAsync(String, String, String)

Get Burn-In SRT Subtitle Details

Declaration

public Task<BurnInSubtitleSrt> 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 burn-in subtitle. (required)

Returns

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

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

List the Burn-In SRT subtitles of a stream

Declaration

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

Parameters

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

Returns

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