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

Class SccApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.captions.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
ConvertSccCaption	create(String encodingId, ConvertSccCaption convertSccCaption) Convert SCC captions
BitmovinResponse	delete(String encodingId, String captionsId) Delete Convert SCC captions
ConvertSccCaption	get(String encodingId, String captionsId) Convert SCC captions Details
PaginationResponse<ConvertSccCaption>	list(String encodingId) List Convert SCC captions
PaginationResponse<ConvertSccCaption>	list(String encodingId, ConvertSccCaptionListQueryParams queryParams) List Convert SCC captions

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 ConvertSccCaption create(String encodingId,
                                ConvertSccCaption convertSccCaption)
                         throws BitmovinException

Convert SCC captions

Parameters:

encodingId - Id of the encoding. (required)

convertSccCaption - The SCC captions to be created (required)

Returns:

ConvertSccCaption

Throws:

BitmovinException - if fails to make API call

delete

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

Delete Convert SCC captions

Parameters:

encodingId - Id of the encoding. (required)

captionsId - Id of the caption. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public ConvertSccCaption get(String encodingId,
                             String captionsId)
                      throws BitmovinException

Convert SCC captions Details

Parameters:

encodingId - Id of the encoding. (required)

captionsId - Id of the caption. (required)

Returns:

ConvertSccCaption

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<ConvertSccCaption> list(String encodingId)
                                           throws BitmovinException

List Convert SCC captions

Parameters:

encodingId - Id of the encoding. (required)

Returns:

List<ConvertSccCaption>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<ConvertSccCaption> list(String encodingId,
                                                  ConvertSccCaptionListQueryParams queryParams)
                                           throws BitmovinException

List Convert SCC captions

Parameters:

encodingId - Id of the encoding. (required)

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

Returns:

List<ConvertSccCaption>

Throws:

BitmovinException - if fails to make API call