com.bitmovin.api.sdk.encoding.encodings.muxings.cmaf.captions.ttml

Class TtmlApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.muxings.cmaf.captions.ttml.TtmlApi

public class TtmlApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
TtmlApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<TtmlApi>	builder() Fluent builder for creating an instance of TtmlApi
TtmlEmbed	create(String encodingId, String muxingId, TtmlEmbed ttmlEmbed) CMAF Embed TTML Captions
TtmlEmbed	delete(String encodingId, String muxingId, String captionsId) Delete TTML Embed Captions
TtmlEmbed	get(String encodingId, String muxingId, String captionsId) TTML Embed Captions Details
PaginationResponse<TtmlEmbed>	list(String encodingId, String muxingId) List TTML Embed Captions
PaginationResponse<TtmlEmbed>	list(String encodingId, String muxingId, TtmlEmbedListQueryParams queryParams) List TTML Embed 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

TtmlApi

public TtmlApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<TtmlApi> builder()

Fluent builder for creating an instance of TtmlApi

create

public TtmlEmbed create(String encodingId,
                        String muxingId,
                        TtmlEmbed ttmlEmbed)
                 throws BitmovinException

CMAF Embed TTML Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the CMAF muxing (required)

ttmlEmbed - The TTML embed captions to be created. (optional)

Returns:

TtmlEmbed

Throws:

BitmovinException - if fails to make API call

delete

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

Delete TTML Embed Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the CMAF muxing (required)

captionsId - Id of the captions configuration. (required)

Returns:

TtmlEmbed

Throws:

BitmovinException - if fails to make API call

get

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

TTML Embed Captions Details

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the CMAF muxing (required)

captionsId - Id of the captions. (required)

Returns:

TtmlEmbed

Throws:

BitmovinException - if fails to make API call

list

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

List TTML Embed Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the CMAF muxing (required)

Returns:

List<TtmlEmbed>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<TtmlEmbed> list(String encodingId,
                                          String muxingId,
                                          TtmlEmbedListQueryParams queryParams)
                                   throws BitmovinException

List TTML Embed Captions

Parameters:

encodingId - Id of the encoding. (required)

muxingId - Id of the CMAF muxing (required)

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

Returns:

List<TtmlEmbed>

Throws:

BitmovinException - if fails to make API call