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.Streams.Captions.Cea.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, String, SccCaption)

Embed SCC captions as 608/708 into Stream

Declaration

public Task<SccCaption> CreateAsync(string encodingId, string streamId, SccCaption sccCaption)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
SccCaption	sccCaption	The SCC captions to be embedded as 607/708 into Stream

Returns

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

DeleteAsync(String, String, String)

Delete SCC captions as 608/708 from Stream

Declaration

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

Parameters

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

Returns

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

GetAsync(String, String, String)

Embed SCC captions as 608/708 Details

Declaration

public Task<SccCaption> GetAsync(string encodingId, string streamId, string captionsId)

Parameters

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

Returns

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

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

List SCC captions as 608/708 from Stream

Declaration

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

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (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<SccCaption>>