com.bitmovin.api.sdk.encoding.encodings.sidecars.webvtt

Class WebvttApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.sidecars.webvtt.WebvttApi

public class WebvttApi
extends Object

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
WebVttSidecarFile	create(String encodingId, WebVttSidecarFile webVttSidecarFile) Add WebVTT sidecar file
BitmovinResponse	delete(String encodingId, String sidecarId) Delete Sidecar
WebVttSidecarFile	get(String encodingId, String sidecarId) WebVTT Sidecar Details
PaginationResponse<WebVttSidecarFile>	list(String encodingId) List WebVTT sidecar files
PaginationResponse<WebVttSidecarFile>	list(String encodingId, WebVttSidecarFileListQueryParams queryParams) List WebVTT sidecar files

Methods inherited from class java.lang.Object

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

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 WebVttSidecarFile create(String encodingId,
                                WebVttSidecarFile webVttSidecarFile)
                         throws BitmovinException

Add WebVTT sidecar file

Parameters:

encodingId - Id of the encoding. (required)

webVttSidecarFile - The WebVTT Sidecar file to be added (required)

Returns:

WebVttSidecarFile

Throws:

BitmovinException - if fails to make API call

delete

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

Delete Sidecar

Parameters:

encodingId - Id of the encoding. (required)

sidecarId - Id of the sidecar. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public WebVttSidecarFile get(String encodingId,
                             String sidecarId)
                      throws BitmovinException

WebVTT Sidecar Details

Parameters:

encodingId - Id of the encoding. (required)

sidecarId - Id of the sidecar. (required)

Returns:

WebVttSidecarFile

Throws:

BitmovinException - if fails to make API call

list

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

List WebVTT sidecar files

Parameters:

encodingId - Id of the encoding. (required)

Returns:

List<WebVttSidecarFile>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<WebVttSidecarFile> list(String encodingId,
                                                  WebVttSidecarFileListQueryParams queryParams)
                                           throws BitmovinException

List WebVTT sidecar files

Parameters:

encodingId - Id of the encoding. (required)

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

Returns:

List<WebVttSidecarFile>

Throws:

BitmovinException - if fails to make API call