Class ClearkeyApi

Inheritance

System.Object

ClearkeyApi

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.Encodings.Muxings.Mp4.Drm.Clearkey

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class ClearkeyApi

Constructors

ClearkeyApi(IBitmovinApiClientFactory)

Declaration

public ClearkeyApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of ClearkeyApi

Declaration

public static BitmovinApiBuilder<ClearkeyApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<ClearkeyApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(String, String, ClearKeyDrm)

Add ClearKey DRM to an MP4 muxing

Declaration

public Task<ClearKeyDrm> CreateAsync(string encodingId, string muxingId, ClearKeyDrm clearKeyDrm)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the MP4 muxing. (required)
ClearKeyDrm	clearKeyDrm	The ClearKey DRM to be created

Returns

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

DeleteAsync(String, String, String)

Delete ClearKey DRM from an MP4 muxing

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string muxingId, string drmId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the mp4. (required)
System.String	drmId	Id of the ClearKey DRM configuration. (required)

Returns

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

GetAsync(String, String, String)

ClearKey DRM Details of an MP4 muxing

Declaration

public Task<ClearKeyDrm> GetAsync(string encodingId, string muxingId, string drmId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the mp4. (required)
System.String	drmId	Id of the ClearKey DRM configuration. (required)

Returns

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

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

List ClearKey DRMs of an MP4 muxing

Declaration

public Task<PaginationResponse<ClearKeyDrm>> ListAsync(string encodingId, string muxingId, params Func<ClearkeyApi.ListQueryParams, ClearkeyApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	muxingId	Id of the mp4. (required)
System.Func<ClearkeyApi.ListQueryParams, ClearkeyApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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