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

Class PeriodsApi

java.lang.Object

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

public class PeriodsApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
AdaptationsetsApi	adaptationsets
CustomXmlElementsApi	customXmlElements

Constructor Summary

Constructors

Constructor and Description
PeriodsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<PeriodsApi>	builder() Fluent builder for creating an instance of PeriodsApi
Period	create(String manifestId, Period period) Add Period
BitmovinResponse	delete(String manifestId, String periodId) Delete Period
Period	get(String manifestId, String periodId) Period Details
PaginationResponse<Period>	list(String manifestId) List all Periods
PaginationResponse<Period>	list(String manifestId, PeriodListQueryParams queryParams) List all Periods

Methods inherited from class java.lang.Object

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

Field Detail

customXmlElements

public final CustomXmlElementsApi customXmlElements

adaptationsets

public final AdaptationsetsApi adaptationsets

Constructor Detail

PeriodsApi

public PeriodsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<PeriodsApi> builder()

Fluent builder for creating an instance of PeriodsApi

create

public Period create(String manifestId,
                     Period period)
              throws BitmovinException

Add Period

Parameters:

manifestId - Id of the manifest (required)

period - The Period to be added to the manifest (required)

Returns:

Period

Throws:

BitmovinException - if fails to make API call

delete

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

Delete Period

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period to be deleted (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public Period get(String manifestId,
                  String periodId)
           throws BitmovinException

Period Details

Parameters:

manifestId - Id of the manifest (required)

periodId - Id of the period (required)

Returns:

Period

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Period> list(String manifestId)
                                throws BitmovinException

List all Periods

Parameters:

manifestId - Id of the manifest (required)

Returns:

List<Period>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Period> list(String manifestId,
                                       PeriodListQueryParams queryParams)
                                throws BitmovinException

List all Periods

Parameters:

manifestId - Id of the manifest (required)

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

Returns:

List<Period>

Throws:

BitmovinException - if fails to make API call