Class CustomXmlElementsApi

Inheritance

System.Object

CustomXmlElementsApi

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.CustomXmlElements

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class CustomXmlElementsApi

Constructors

CustomXmlElementsApi(IBitmovinApiClientFactory)

Declaration

public CustomXmlElementsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of CustomXmlElementsApi

Declaration

public static BitmovinApiBuilder<CustomXmlElementsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<CustomXmlElementsApi>

Methods

CreateAsync(String, String, CustomXmlElement)

Add Custom XML Element to Period

Declaration

public Task<CustomXmlElement> CreateAsync(string manifestId, string periodId, CustomXmlElement customXmlElement)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
CustomXmlElement	customXmlElement	Data of the custom XML element to be added to the period

Returns

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

DeleteAsync(String, String, String)

Delete Custom XML Element

Declaration

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

Parameters

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

Returns

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

GetAsync(String, String, String)

Custom XML Element Details

Declaration

public Task<CustomXmlElement> GetAsync(string manifestId, string periodId, string customXmlElementId)

Parameters

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

Returns

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

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

List all Custom XML Elements of Period

Declaration

public Task<PaginationResponse<CustomXmlElement>> ListAsync(string manifestId, string periodId, params Func<CustomXmlElementsApi.ListQueryParams, CustomXmlElementsApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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