com.bitmovin.api.sdk.encoding.encodings.streams.burnInSubtitles.dvbsub

Class DvbsubApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.burnInSubtitles.dvbsub.DvbsubApi

public class DvbsubApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DvbsubApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<DvbsubApi>	builder() Fluent builder for creating an instance of DvbsubApi
BurnInSubtitleDvbSub	create(String encodingId, String streamId, BurnInSubtitleDvbSub burnInSubtitleDvbSub) Burn-In DVB-SUB Subtitle into Stream
BitmovinResponse	delete(String encodingId, String streamId, String subtitleId) Delete Burn-In DVB-SUB Subtitle from Stream
BurnInSubtitleDvbSub	get(String encodingId, String streamId, String subtitleId) Get Burn-In DVB-SUB Subtitle Details
PaginationResponse<BurnInSubtitleDvbSub>	list(String encodingId, String streamId) List the Burn-In DVB-SUB subtitles of a stream
PaginationResponse<BurnInSubtitleDvbSub>	list(String encodingId, String streamId, BurnInSubtitleDvbSubListQueryParams queryParams) List the Burn-In DVB-SUB subtitles of a stream

Methods inherited from class java.lang.Object

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

Constructor Detail

DvbsubApi

public DvbsubApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<DvbsubApi> builder()

Fluent builder for creating an instance of DvbsubApi

create

public BurnInSubtitleDvbSub create(String encodingId,
                                   String streamId,
                                   BurnInSubtitleDvbSub burnInSubtitleDvbSub)
                            throws BitmovinException

Burn-In DVB-SUB Subtitle into Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

burnInSubtitleDvbSub - The Burn-In DVB-SUB Subtitle to be added (required)

Returns:

BurnInSubtitleDvbSub

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String streamId,
                               String subtitleId)
                        throws BitmovinException

Delete Burn-In DVB-SUB Subtitle from Stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

subtitleId - Id of the subtitle. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public BurnInSubtitleDvbSub get(String encodingId,
                                String streamId,
                                String subtitleId)
                         throws BitmovinException

Get Burn-In DVB-SUB Subtitle Details

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

subtitleId - Id of the subtitle. (required)

Returns:

BurnInSubtitleDvbSub

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<BurnInSubtitleDvbSub> list(String encodingId,
                                                     String streamId)
                                              throws BitmovinException

List the Burn-In DVB-SUB subtitles of a stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

List<BurnInSubtitleDvbSub>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<BurnInSubtitleDvbSub> list(String encodingId,
                                                     String streamId,
                                                     BurnInSubtitleDvbSubListQueryParams queryParams)
                                              throws BitmovinException

List the Burn-In DVB-SUB subtitles of a stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

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

Returns:

List<BurnInSubtitleDvbSub>

Throws:

BitmovinException - if fails to make API call