Class SccApi

Inheritance

System.Object

SccApi

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.Captions.Scc

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SccApi

Constructors

SccApi(IBitmovinApiClientFactory)

Declaration

public SccApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SccApi

Declaration

public static BitmovinApiBuilder<SccApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SccApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(String, ConvertSccCaption)

Convert SCC captions

Declaration

public Task<ConvertSccCaption> CreateAsync(string encodingId, ConvertSccCaption convertSccCaption)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
ConvertSccCaption	convertSccCaption	The SCC captions to be created

Returns

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

DeleteAsync(String, String)

Delete Convert SCC captions

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string captionsId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	captionsId	Id of the caption. (required)

Returns

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

GetAsync(String, String)

Convert SCC captions Details

Declaration

public Task<ConvertSccCaption> GetAsync(string encodingId, string captionsId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	captionsId	Id of the caption. (required)

Returns

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

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

List Convert SCC captions

Declaration

public Task<PaginationResponse<ConvertSccCaption>> ListAsync(string encodingId, params Func<SccApi.ListQueryParams, SccApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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