@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
58 lines (57 loc) • 3.03 kB
TypeScript
import { BaseAPI } from '../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../common/Configuration';
import ContentprotectionApi from './contentprotection/ContentprotectionApi';
import BitmovinResponse from '../../../../../../../models/BitmovinResponse';
import DashCmafRepresentation from '../../../../../../../models/DashCmafRepresentation';
import PaginationResponse from '../../../../../../../models/PaginationResponse';
import { DashCmafRepresentationListQueryParams, DashCmafRepresentationListQueryParamsBuilder } from './DashCmafRepresentationListQueryParams';
/**
* CmafApi - object-oriented interface
* @export
* @class CmafApi
* @extends {BaseAPI}
*/
export default class CmafApi extends BaseAPI {
contentprotection: ContentprotectionApi;
constructor(configuration: Configuration);
/**
* @summary Add 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 {DashCmafRepresentation} dashCmafRepresentation The CMAF representation to be added to the adaptation set
* @throws {BitmovinError}
* @memberof CmafApi
*/
create(manifestId: string, periodId: string, adaptationsetId: string, dashCmafRepresentation?: DashCmafRepresentation): Promise<DashCmafRepresentation>;
/**
* @summary Delete 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 CMAF representation to be deleted
* @throws {BitmovinError}
* @memberof CmafApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>;
/**
* @summary CMAF Representation 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
* @throws {BitmovinError}
* @memberof CmafApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<DashCmafRepresentation>;
/**
* @summary List all CMAF Representations
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof CmafApi
*/
list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters?: DashCmafRepresentationListQueryParams | ((q: DashCmafRepresentationListQueryParamsBuilder) => DashCmafRepresentationListQueryParamsBuilder)): Promise<PaginationResponse<DashCmafRepresentation>>;
}