com.bitmovin.api.sdk.encoding.encodings.inputStreams.captions.cea708

Class Cea708Api

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.inputStreams.captions.cea708.Cea708Api

public class Cea708Api
extends Object

Constructor Summary

Constructors

Constructor and Description
Cea708Api(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<Cea708Api>	builder() Fluent builder for creating an instance of Cea708Api
Cea708CaptionInputStream	create(String encodingId, Cea708CaptionInputStream cea708CaptionInputStream) Add CEA 708 Input Stream
BitmovinResponse	delete(String encodingId, String inputStreamId) Delete CEA 708 Input Stream
Cea708CaptionInputStream	get(String encodingId, String inputStreamId) CEA 708 Input Stream Details
PaginationResponse<Cea708CaptionInputStream>	list(String encodingId) List CEA 708 Input Streams
PaginationResponse<Cea708CaptionInputStream>	list(String encodingId, Cea708CaptionInputStreamListQueryParams queryParams) List CEA 708 Input Streams

Methods inherited from class java.lang.Object

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

Constructor Detail

Cea708Api

public Cea708Api(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<Cea708Api> builder()

Fluent builder for creating an instance of Cea708Api

create

public Cea708CaptionInputStream create(String encodingId,
                                       Cea708CaptionInputStream cea708CaptionInputStream)
                                throws BitmovinException

Add CEA 708 Input Stream

Parameters:

encodingId - Id of the encoding. (required)

cea708CaptionInputStream - The CEA 708 Input Stream to be created (required)

Returns:

Cea708CaptionInputStream

Throws:

BitmovinException - if fails to make API call

delete

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

Delete CEA 708 Input Stream

Parameters:

encodingId - Id of the Encoding (required)

inputStreamId - Id of the CEA 708 input stream. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public Cea708CaptionInputStream get(String encodingId,
                                    String inputStreamId)
                             throws BitmovinException

CEA 708 Input Stream Details

Parameters:

encodingId - Id of the encoding. (required)

inputStreamId - Id of the CEA 708 input stream. (required)

Returns:

Cea708CaptionInputStream

Throws:

BitmovinException - if fails to make API call

list

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

List CEA 708 Input Streams

Parameters:

encodingId - Id of the encoding. (required)

Returns:

List<Cea708CaptionInputStream>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Cea708CaptionInputStream> list(String encodingId,
                                                         Cea708CaptionInputStreamListQueryParams queryParams)
                                                  throws BitmovinException

List CEA 708 Input Streams

Parameters:

encodingId - Id of the encoding. (required)

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

Returns:

List<Cea708CaptionInputStream>

Throws:

BitmovinException - if fails to make API call