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