Class CmafApi

Inheritance

System.Object

CmafApi

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.Adaptationsets.Representations.Cmaf

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class CmafApi

Constructors

CmafApi(IBitmovinApiClientFactory)

Declaration

public CmafApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of CmafApi

Declaration

public static BitmovinApiBuilder<CmafApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<CmafApi>

Contentprotection

Declaration

public ContentprotectionApi Contentprotection { get; }

Property Value

Type	Description
ContentprotectionApi

Methods

CreateAsync(String, String, String, DashCmafRepresentation)

Add CMAF Representation

Declaration

public Task<DashCmafRepresentation> CreateAsync(string manifestId, string periodId, string adaptationsetId, DashCmafRepresentation dashCmafRepresentation)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
DashCmafRepresentation	dashCmafRepresentation	The CMAF representation to be added to the adaptation set

Returns

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

DeleteAsync(String, String, String, String)

Delete CMAF Representation

Declaration

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

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
System.String	representationId	Id of the CMAF representation to be deleted (required)

Returns

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

GetAsync(String, String, String, String)

CMAF Representation Details

Declaration

public Task<DashCmafRepresentation> GetAsync(string manifestId, string periodId, string adaptationsetId, string representationId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the manifest (required)
System.String	periodId	Id of the period (required)
System.String	adaptationsetId	Id of the adaptation set (required)
System.String	representationId	Id of the representation (required)

Returns

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

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

List all CMAF Representations

Declaration

public Task<PaginationResponse<DashCmafRepresentation>> ListAsync(string manifestId, string periodId, string adaptationsetId, params Func<CmafApi.ListQueryParams, CmafApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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