com.bitmovin.api.sdk.encoding.encodings.muxings.progressiveTs.id3.plainText

Class PlainTextApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.muxings.progressiveTs.id3.plainText.PlainTextApi

public class PlainTextApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
PlainTextApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<PlainTextApi>	builder() Fluent builder for creating an instance of PlainTextApi
PlaintextId3Tag	create(String encodingId, String muxingId, PlaintextId3Tag plaintextId3Tag) Add Plain Text ID3 Tag to Progressive TS Muxing
BitmovinResponse	delete(String encodingId, String muxingId, String id3TagId) Delete Plain Text ID3 Tag of Progressive TS Muxing
PlaintextId3Tag	get(String encodingId, String muxingId, String id3TagId) Plain Text ID3 Tag Details of Progressive TS Muxing
PaginationResponse<PlaintextId3Tag>	list(String encodingId, String muxingId) List Plain Text ID3 Tags of Progressive TS Muxing
PaginationResponse<PlaintextId3Tag>	list(String encodingId, String muxingId, PlaintextId3TagListQueryParams queryParams) List Plain Text ID3 Tags of Progressive TS Muxing

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

PlainTextApi

public PlainTextApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<PlainTextApi> builder()

Fluent builder for creating an instance of PlainTextApi

create

public PlaintextId3Tag create(String encodingId,
                              String muxingId,
                              PlaintextId3Tag plaintextId3Tag)
                       throws BitmovinException

Add Plain Text ID3 Tag to Progressive TS Muxing

Parameters:

encodingId - ID of the Encoding. (required)

muxingId - ID of the Progressive TS Muxing (required)

plaintextId3Tag - The Plain Text ID3 Tag to be created (required)

Returns:

PlaintextId3Tag

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String encodingId,
                               String muxingId,
                               String id3TagId)
                        throws BitmovinException

Delete Plain Text ID3 Tag of Progressive TS Muxing

Parameters:

encodingId - ID of the Encoding. (required)

muxingId - ID of the Progressive TS Muxing (required)

id3TagId - ID of the Plain Text ID3 Tag (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public PlaintextId3Tag get(String encodingId,
                           String muxingId,
                           String id3TagId)
                    throws BitmovinException

Plain Text ID3 Tag Details of Progressive TS Muxing

Parameters:

encodingId - ID of the Encoding. (required)

muxingId - ID of the Progressive TS Muxing (required)

id3TagId - ID of the Plain Text ID3 Tag (required)

Returns:

PlaintextId3Tag

Throws:

BitmovinException - if fails to make API call

list

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

List Plain Text ID3 Tags of Progressive TS Muxing

Parameters:

encodingId - ID of the Encoding. (required)

muxingId - ID of the Progressive TS Muxing (required)

Returns:

List<PlaintextId3Tag>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<PlaintextId3Tag> list(String encodingId,
                                                String muxingId,
                                                PlaintextId3TagListQueryParams queryParams)
                                         throws BitmovinException

List Plain Text ID3 Tags of Progressive TS Muxing

Parameters:

encodingId - ID of the Encoding. (required)

muxingId - ID of the Progressive TS Muxing (required)

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

Returns:

List<PlaintextId3Tag>

Throws:

BitmovinException - if fails to make API call