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

Class WebvttApi

java.lang.Object

com.bitmovin.api.sdk.encoding.configurations.subtitles.webvtt.WebvttApi

public class WebvttApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
WebvttApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<WebvttApi>	builder() Fluent builder for creating an instance of WebvttApi
WebVttConfiguration	create(WebVttConfiguration webVttConfiguration) Create WebVtt Subtitle Configuration
BitmovinResponse	delete(String configurationId) Delete WebVtt Subtitle Configuration
WebVttConfiguration	get(String configurationId) WebVtt Subtitle Configuration Details
PaginationResponse<WebVttConfiguration>	list() List WebVtt Configurations
PaginationResponse<WebVttConfiguration>	list(WebVttConfigurationListQueryParams queryParams) List WebVtt 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

WebvttApi

public WebvttApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<WebvttApi> builder()

Fluent builder for creating an instance of WebvttApi

create

public WebVttConfiguration create(WebVttConfiguration webVttConfiguration)
                           throws BitmovinException

Create WebVtt Subtitle Configuration

Parameters:

webVttConfiguration - The WebVtt Subtitle Configuration to be created (required)

Returns:

WebVttConfiguration

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String configurationId)
                        throws BitmovinException

Delete WebVtt Subtitle Configuration

Parameters:

configurationId - Id of the subtitle configuration (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public WebVttConfiguration get(String configurationId)
                        throws BitmovinException

WebVtt Subtitle Configuration Details

Parameters:

configurationId - Id of the codec configuration (required)

Returns:

WebVttConfiguration

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<WebVttConfiguration> list()
                                             throws BitmovinException

List WebVtt Configurations

Returns:

List<WebVttConfiguration>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<WebVttConfiguration> list(WebVttConfigurationListQueryParams queryParams)
                                             throws BitmovinException

List WebVtt Configurations

Parameters:

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

Returns:

List<WebVttConfiguration>

Throws:

BitmovinException - if fails to make API call