com.bitmovin.api.sdk.encoding.configurations.subtitles.dvbSubtitle

Class DvbSubtitleApi

java.lang.Object

com.bitmovin.api.sdk.encoding.configurations.subtitles.dvbSubtitle.DvbSubtitleApi

public class DvbSubtitleApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
DvbSubtitleApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<DvbSubtitleApi>	builder() Fluent builder for creating an instance of DvbSubtitleApi
DvbSubtitleConfiguration	create(DvbSubtitleConfiguration dvbSubtitleConfiguration) Create DVB-SUB subtitle configuration
BitmovinResponse	delete(String configurationId) Delete DVB-SUB subtitle configuration
DvbSubtitleConfiguration	get(String configurationId) DVB-SUB subtitle configuration details
PaginationResponse<DvbSubtitleConfiguration>	list() List DVB-SUB subtitle configurations
PaginationResponse<DvbSubtitleConfiguration>	list(DvbSubtitleConfigurationListQueryParams queryParams) List DVB-SUB subtitle configurations

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

DvbSubtitleApi

public DvbSubtitleApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<DvbSubtitleApi> builder()

Fluent builder for creating an instance of DvbSubtitleApi

create

public DvbSubtitleConfiguration create(DvbSubtitleConfiguration dvbSubtitleConfiguration)
                                throws BitmovinException

Create DVB-SUB subtitle configuration

Parameters:

dvbSubtitleConfiguration - The DVB-SUB subtitle configuration to be created (required)

Returns:

DvbSubtitleConfiguration

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String configurationId)
                        throws BitmovinException

Delete DVB-SUB subtitle configuration

Parameters:

configurationId - Id of the subtitle configuration (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public DvbSubtitleConfiguration get(String configurationId)
                             throws BitmovinException

DVB-SUB subtitle configuration details

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

DvbSubtitleConfiguration

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DvbSubtitleConfiguration> list()
                                                  throws BitmovinException

List DVB-SUB subtitle configurations

Returns:

List<DvbSubtitleConfiguration>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<DvbSubtitleConfiguration> list(DvbSubtitleConfigurationListQueryParams queryParams)
                                                  throws BitmovinException

List DVB-SUB subtitle configurations

Parameters:

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

Returns:

List<DvbSubtitleConfiguration>

Throws:

BitmovinException - if fails to make API call