@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 VideoAdaptationSet from '../../../../../../models/VideoAdaptationSet';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { VideoAdaptationSetListQueryParams, VideoAdaptationSetListQueryParamsBuilder } from './VideoAdaptationSetListQueryParams';
/**
* VideoApi - object-oriented interface
* @export
* @class VideoApi
* @extends {BaseAPI}
*/
export default class VideoApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Video AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {VideoAdaptationSet} videoAdaptationSet The video adaptation set to be added to the period
* @throws {BitmovinError}
* @memberof VideoApi
*/
create(manifestId: string, periodId: string, videoAdaptationSet?: VideoAdaptationSet): Promise<VideoAdaptationSet>;
/**
* @summary Delete Video AdaptationSet
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the video adaptation set to be deleted
* @throws {BitmovinError}
* @memberof VideoApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string): Promise<BitmovinResponse>;
/**
* @summary Video AdaptationSet Details
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the video adaptation set
* @throws {BitmovinError}
* @memberof VideoApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string): Promise<VideoAdaptationSet>;
/**
* @summary List all Video 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 VideoApi
*/
list(manifestId: string, periodId: string, queryParameters?: VideoAdaptationSetListQueryParams | ((q: VideoAdaptationSetListQueryParamsBuilder) => VideoAdaptationSetListQueryParamsBuilder)): Promise<PaginationResponse<VideoAdaptationSet>>;
}