@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
52 lines (51 loc) • 2.48 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import BitmovinResponse from '../../../../../../models/BitmovinResponse';
import ImageAdaptationSet from '../../../../../../models/ImageAdaptationSet';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { ImageAdaptationSetListQueryParams, ImageAdaptationSetListQueryParamsBuilder } from './ImageAdaptationSetListQueryParams';
/**
* ImageApi - object-oriented interface
* @export
* @class ImageApi
* @extends {BaseAPI}
*/
export default class ImageApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Image AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {ImageAdaptationSet} imageAdaptationSet The image adaptation set to be added to the period
* @throws {BitmovinError}
* @memberof ImageApi
*/
create(manifestId: string, periodId: string, imageAdaptationSet?: ImageAdaptationSet): Promise<ImageAdaptationSet>;
/**
* @summary Delete Image AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the audio adaptation set to be deleted
* @throws {BitmovinError}
* @memberof ImageApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string): Promise<BitmovinResponse>;
/**
* @summary Image AdaptationSet Details
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the Image adaptation set
* @throws {BitmovinError}
* @memberof ImageApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string): Promise<ImageAdaptationSet>;
/**
* @summary List all Image AdaptationSets
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof ImageApi
*/
list(manifestId: string, periodId: string, queryParameters?: ImageAdaptationSetListQueryParams | ((q: ImageAdaptationSetListQueryParamsBuilder) => ImageAdaptationSetListQueryParamsBuilder)): Promise<PaginationResponse<ImageAdaptationSet>>;
}