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