@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
58 lines (57 loc) • 2.93 kB
TypeScript
import { BaseAPI } from '../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../common/Configuration';
import DrmApi from './drm/DrmApi';
import BitmovinResponse from '../../../../../../../models/BitmovinResponse';
import DashMp4Representation from '../../../../../../../models/DashMp4Representation';
import PaginationResponse from '../../../../../../../models/PaginationResponse';
import { DashMp4RepresentationListQueryParams, DashMp4RepresentationListQueryParamsBuilder } from './DashMp4RepresentationListQueryParams';
/**
* Mp4Api - object-oriented interface
* @export
* @class Mp4Api
* @extends {BaseAPI}
*/
export default class Mp4Api extends BaseAPI {
drm: DrmApi;
constructor(configuration: Configuration);
/**
* @summary Add MP4 Representation
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {DashMp4Representation} dashMp4Representation The MP4 representation to be added to the adaptation set
* @throws {BitmovinError}
* @memberof Mp4Api
*/
create(manifestId: string, periodId: string, adaptationsetId: string, dashMp4Representation?: DashMp4Representation): Promise<DashMp4Representation>;
/**
* @summary Delete MP4 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 MP4 representation to be deleted
* @throws {BitmovinError}
* @memberof Mp4Api
*/
delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>;
/**
* @summary MP4 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 Mp4Api
*/
get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<DashMp4Representation>;
/**
* @summary List all MP4 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 Mp4Api
*/
list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters?: DashMp4RepresentationListQueryParams | ((q: DashMp4RepresentationListQueryParamsBuilder) => DashMp4RepresentationListQueryParamsBuilder)): Promise<PaginationResponse<DashMp4Representation>>;
}