Class ClosedCaptionsApi

Inheritance

System.Object

ClosedCaptionsApi

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

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ClosedCaptionsApi

Constructors

ClosedCaptionsApi(IBitmovinApiClientFactory)

Declaration

public ClosedCaptionsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ClosedCaptionsApi

Declaration

public static BitmovinApiBuilder<ClosedCaptionsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ClosedCaptionsApi>

Methods

CreateAsync(String, ClosedCaptionsMediaInfo)

Add Closed Captions Media

Declaration

public Task<ClosedCaptionsMediaInfo> CreateAsync(string manifestId, ClosedCaptionsMediaInfo closedCaptionsMediaInfo)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
ClosedCaptionsMediaInfo	closedCaptionsMediaInfo	The Closed Captions Media to be added

Returns

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

DeleteAsync(String, String)

Delete Closed Captions 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 closed captions media. (required)

Returns

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

GetAsync(String, String)

Closed Captions Media Details

Declaration

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

Parameters

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

Returns

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

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

List all Closed Captions Media

Declaration

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

Parameters

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

Returns

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