com.bitmovin.api.sdk.encoding.encodings.streams.captions.cea.scc

Class SccApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.captions.cea.scc.SccApi

public class SccApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
SccApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<SccApi>	builder() Fluent builder for creating an instance of SccApi
SccCaption	create(String encodingId, String streamId, SccCaption sccCaption) Embed SCC captions as 608/708 into Stream
BitmovinResponse	delete(String encodingId, String streamId, String captionsId) Delete SCC captions as 608/708 from Stream
SccCaption	get(String encodingId, String streamId, String captionsId) Embed SCC captions as 608/708 Details
PaginationResponse<SccCaption>	list(String encodingId, String streamId) List SCC captions as 608/708 from Stream
PaginationResponse<SccCaption>	list(String encodingId, String streamId, SccCaptionListQueryParams queryParams) List SCC captions as 608/708 from Stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customdata

public final CustomdataApi customdata

Constructor Detail

SccApi

public SccApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<SccApi> builder()

Fluent builder for creating an instance of SccApi

create

public SccCaption create(String encodingId,
                         String streamId,
                         SccCaption sccCaption)
                  throws BitmovinException

Embed SCC captions as 608/708 into Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

sccCaption - (optional)

Returns:

SccCaption

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String streamId,
                               String captionsId)
                        throws BitmovinException

Delete SCC captions as 608/708 from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

captionsId - Id of the caption. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public SccCaption get(String encodingId,
                      String streamId,
                      String captionsId)
               throws BitmovinException

Embed SCC captions as 608/708 Details

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

captionsId - Id of the caption. (required)

Returns:

SccCaption

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<SccCaption> list(String encodingId,
                                           String streamId)
                                    throws BitmovinException

List SCC captions as 608/708 from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

List<SccCaption>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<SccCaption> list(String encodingId,
                                           String streamId,
                                           SccCaptionListQueryParams queryParams)
                                    throws BitmovinException

List SCC captions as 608/708 from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<SccCaption>

Throws:

BitmovinException - if fails to make API call