@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
53 lines (52 loc) • 2.32 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import MarlinDrm from '../../../../../../models/MarlinDrm';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { MarlinDrmListQueryParams, MarlinDrmListQueryParamsBuilder } from './MarlinDrmListQueryParams';
/**
* MarlinApi - object-oriented interface
* @export
* @class MarlinApi
* @extends {BaseAPI}
*/
export default class MarlinApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add Marlin DRM to an MP4 muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the MP4 muxing.
* @param {MarlinDrm} marlinDrm The Marlin DRM to be created
* @throws {BitmovinError}
* @memberof MarlinApi
*/
create(encodingId: string, muxingId: string, marlinDrm?: MarlinDrm): Promise<MarlinDrm>;
/**
* @summary Delete Marlin 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 Marlin DRM configuration.
* @throws {BitmovinError}
* @memberof MarlinApi
*/
delete(encodingId: string, muxingId: string, drmId: string): Promise<MarlinDrm>;
/**
* @summary Marlin 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 Marlin DRM configuration.
* @throws {BitmovinError}
* @memberof MarlinApi
*/
get(encodingId: string, muxingId: string, drmId: string): Promise<MarlinDrm>;
/**
* @summary List Marlin 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 MarlinApi
*/
list(encodingId: string, muxingId: string, queryParameters?: MarlinDrmListQueryParams | ((q: MarlinDrmListQueryParamsBuilder) => MarlinDrmListQueryParamsBuilder)): Promise<PaginationResponse<MarlinDrm>>;
}