com.bitmovin.api.sdk.encoding.manifests.dash.periods.customXmlElements

Class CustomXmlElementsApi

java.lang.Object

com.bitmovin.api.sdk.encoding.manifests.dash.periods.customXmlElements.CustomXmlElementsApi

public class CustomXmlElementsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomXmlElementsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<CustomXmlElementsApi>	builder() Fluent builder for creating an instance of CustomXmlElementsApi
CustomXmlElement	create(String manifestId, String periodId, CustomXmlElement customXmlElement) Add Custom XML Element to Period
BitmovinResponse	delete(String manifestId, String periodId, String customXmlElementId) Delete Custom XML Element
CustomXmlElement	get(String manifestId, String periodId, String customXmlElementId) Custom XML Element Details
PaginationResponse<CustomXmlElement>	list(String manifestId, String periodId) List all Custom XML Elements of Period
PaginationResponse<CustomXmlElement>	list(String manifestId, String periodId, CustomXmlElementListQueryParams queryParams) List all Custom XML Elements of Period

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomXmlElementsApi

public CustomXmlElementsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<CustomXmlElementsApi> builder()

Fluent builder for creating an instance of CustomXmlElementsApi

create

public CustomXmlElement create(String manifestId,
                               String periodId,
                               CustomXmlElement customXmlElement)
                        throws BitmovinException

Add Custom XML Element to Period

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

customXmlElement - Data of the custom XML element to be added to the period (required)

Returns:

CustomXmlElement

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String manifestId,
                               String periodId,
                               String customXmlElementId)
                        throws BitmovinException

Delete Custom XML Element

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

customXmlElementId - Id of the Custom XML Element (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public CustomXmlElement get(String manifestId,
                            String periodId,
                            String customXmlElementId)
                     throws BitmovinException

Custom XML Element Details

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

customXmlElementId - Id of the Custom XML Element (required)

Returns:

CustomXmlElement

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CustomXmlElement> list(String manifestId,
                                                 String periodId)
                                          throws BitmovinException

List all Custom XML Elements of Period

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

Returns:

List<CustomXmlElement>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<CustomXmlElement> list(String manifestId,
                                                 String periodId,
                                                 CustomXmlElementListQueryParams queryParams)
                                          throws BitmovinException

List all Custom XML Elements of Period

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

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

Returns:

List<CustomXmlElement>

Throws:

BitmovinException - if fails to make API call