Class PeriodsApi

Inheritance

System.Object

PeriodsApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Encoding.Manifests.Dash.Periods

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class PeriodsApi

Constructors

PeriodsApi(IBitmovinApiClientFactory)

Declaration

public PeriodsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Adaptationsets

Declaration

public AdaptationsetsApi Adaptationsets { get; }

Property Value

Type	Description
AdaptationsetsApi

Builder

Fluent builder for creating an instance of PeriodsApi

Declaration

public static BitmovinApiBuilder<PeriodsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<PeriodsApi>

CustomXmlElements

Declaration

public CustomXmlElementsApi CustomXmlElements { get; }

Property Value

Type	Description
CustomXmlElementsApi

Methods

CreateAsync(String, Period)

Add Period

Declaration

public Task<Period> CreateAsync(string manifestId, Period period)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
Period	period	The Period to be added to the manifest

Returns

Type	Description
System.Threading.Tasks.Task<Period>

DeleteAsync(String, String)

Delete Period

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string periodId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period to be deleted (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String)

Period Details

Declaration

public Task<Period> GetAsync(string manifestId, string periodId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)

Returns

Type	Description
System.Threading.Tasks.Task<Period>

ListAsync(String, Func<PeriodsApi.ListQueryParams, PeriodsApi.ListQueryParams>[])

List all Periods

Declaration

public Task<PaginationResponse<Period>> ListAsync(string manifestId, params Func<PeriodsApi.ListQueryParams, PeriodsApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.Func<PeriodsApi.ListQueryParams, PeriodsApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<Period>>