com.bitmovin.api.sdk.encoding.encodings.muxings.ts.captions.cea

Class CeaApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.muxings.ts.captions.cea.CeaApi

public class CeaApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
CeaApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<CeaApi>	builder() Fluent builder for creating an instance of CeaApi
CaptionsEmbedCea	create(String encodingId, String muxingId, CaptionsEmbedCea captionsEmbedCea) TS Embed CEA 608/708 Captions
CaptionsEmbedCea	delete(String encodingId, String muxingId, String captionsId) Delete Embedded CEA 608/708 Captions
CaptionsEmbedCea	get(String encodingId, String muxingId, String captionsId) Embedded CEA 608/708 Captions Details
PaginationResponse<CaptionsEmbedCea>	list(String encodingId, String muxingId) List TS Embedded CEA 608/708 Captions
PaginationResponse<CaptionsEmbedCea>	list(String encodingId, String muxingId, CaptionsEmbedCeaListQueryParams queryParams) List TS Embedded CEA 608/708 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

CeaApi

public CeaApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<CeaApi> builder()

Fluent builder for creating an instance of CeaApi

create

public CaptionsEmbedCea create(String encodingId,
                               String muxingId,
                               CaptionsEmbedCea captionsEmbedCea)
                        throws BitmovinException

TS Embed CEA 608/708 Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the TS muxing. (required)

captionsEmbedCea - The captions embed CEA to be created. (optional)

Returns:

CaptionsEmbedCea

Throws:

BitmovinException - if fails to make API call

delete

public CaptionsEmbedCea delete(String encodingId,
                               String muxingId,
                               String captionsId)
                        throws BitmovinException

Delete Embedded CEA 608/708 Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the TS muxing. (required)

captionsId - Id of the subtitle. (required)

Returns:

CaptionsEmbedCea

Throws:

BitmovinException - if fails to make API call

get

public CaptionsEmbedCea get(String encodingId,
                            String muxingId,
                            String captionsId)
                     throws BitmovinException

Embedded CEA 608/708 Captions Details

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the TS muxing. (required)

captionsId - Id of the captions. (required)

Returns:

CaptionsEmbedCea

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CaptionsEmbedCea> list(String encodingId,
                                                 String muxingId)
                                          throws BitmovinException

List TS Embedded CEA 608/708 Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the TS muxing. (required)

Returns:

List<CaptionsEmbedCea>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CaptionsEmbedCea> list(String encodingId,
                                                 String muxingId,
                                                 CaptionsEmbedCeaListQueryParams queryParams)
                                          throws BitmovinException

List TS Embedded CEA 608/708 Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the TS muxing. (required)

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

Returns:

List<CaptionsEmbedCea>

Throws:

BitmovinException - if fails to make API call