@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
60 lines (59 loc) • 3.42 kB
TypeScript
import { BaseAPI } from '../../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../../common/Configuration';
import BitmovinResponse from '../../../../../../../../models/BitmovinResponse';
import ContentProtection from '../../../../../../../../models/ContentProtection';
import PaginationResponse from '../../../../../../../../models/PaginationResponse';
import { ContentProtectionListQueryParams, ContentProtectionListQueryParamsBuilder } from './ContentProtectionListQueryParams';
/**
* ContentprotectionApi - object-oriented interface
* @export
* @class ContentprotectionApi
* @extends {BaseAPI}
*/
export default class ContentprotectionApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Content Protection to CMAF Representation
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the representation
* @param {ContentProtection} contentProtection The content protection to be added to the CMAF representation
* @throws {BitmovinError}
* @memberof ContentprotectionApi
*/
create(manifestId: string, periodId: string, adaptationsetId: string, representationId: string, contentProtection?: ContentProtection): Promise<ContentProtection>;
/**
* @summary Delete CMAF Representation Content Protection
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the representation
* @param {string} contentprotectionId Id of the DRM CMAF content protection to be deleted
* @throws {BitmovinError}
* @memberof ContentprotectionApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string, contentprotectionId: string): Promise<BitmovinResponse>;
/**
* @summary CMAF Representation Content Protection Details
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the representation
* @param {string} contentprotectionId Id of the DRM CMAF content protection
* @throws {BitmovinError}
* @memberof ContentprotectionApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string, contentprotectionId: string): Promise<ContentProtection>;
/**
* @summary List all CMAF Representation Content Protections
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the representation
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof ContentprotectionApi
*/
list(manifestId: string, periodId: string, adaptationsetId: string, representationId: string, queryParameters?: ContentProtectionListQueryParams | ((q: ContentProtectionListQueryParamsBuilder) => ContentProtectionListQueryParamsBuilder)): Promise<PaginationResponse<ContentProtection>>;
}