@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
54 lines (53 loc) • 2.46 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../../../models/BitmovinResponse';
import ClearKeyDrm from '../../../../../../models/ClearKeyDrm';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { ClearKeyDrmListQueryParams, ClearKeyDrmListQueryParamsBuilder } from './ClearKeyDrmListQueryParams';
/**
* ClearkeyApi - object-oriented interface
* @export
* @class ClearkeyApi
* @extends {BaseAPI}
*/
export default class ClearkeyApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add ClearKey DRM to an MP4 muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the MP4 muxing.
* @param {ClearKeyDrm} clearKeyDrm The ClearKey DRM to be created
* @throws {BitmovinError}
* @memberof ClearkeyApi
*/
create(encodingId: string, muxingId: string, clearKeyDrm?: ClearKeyDrm): Promise<ClearKeyDrm>;
/**
* @summary Delete ClearKey DRM from an MP4 muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the mp4.
* @param {string} drmId Id of the ClearKey DRM configuration.
* @throws {BitmovinError}
* @memberof ClearkeyApi
*/
delete(encodingId: string, muxingId: string, drmId: string): Promise<BitmovinResponse>;
/**
* @summary ClearKey DRM Details of an MP4 muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the mp4.
* @param {string} drmId Id of the ClearKey DRM configuration.
* @throws {BitmovinError}
* @memberof ClearkeyApi
*/
get(encodingId: string, muxingId: string, drmId: string): Promise<ClearKeyDrm>;
/**
* @summary List ClearKey DRMs of an MP4 muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the mp4.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof ClearkeyApi
*/
list(encodingId: string, muxingId: string, queryParameters?: ClearKeyDrmListQueryParams | ((q: ClearKeyDrmListQueryParamsBuilder) => ClearKeyDrmListQueryParamsBuilder)): Promise<PaginationResponse<ClearKeyDrm>>;
}