@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
48 lines (47 loc) • 2.04 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import VideoMediaInfo from '../../../../../models/VideoMediaInfo';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { VideoMediaInfoListQueryParams, VideoMediaInfoListQueryParamsBuilder } from './VideoMediaInfoListQueryParams';
/**
* VideoApi - object-oriented interface
* @export
* @class VideoApi
* @extends {BaseAPI}
*/
export default class VideoApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Video Media
* @param {string} manifestId Id of the hls manifest.
* @param {VideoMediaInfo} videoMediaInfo The Video Media to be added
* @throws {BitmovinError}
* @memberof VideoApi
*/
create(manifestId: string, videoMediaInfo?: VideoMediaInfo): Promise<VideoMediaInfo>;
/**
* @summary Delete Video Media
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the video media.
* @throws {BitmovinError}
* @memberof VideoApi
*/
delete(manifestId: string, mediaId: string): Promise<BitmovinResponse>;
/**
* @summary Video Media Details
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the video media.
* @throws {BitmovinError}
* @memberof VideoApi
*/
get(manifestId: string, mediaId: string): Promise<VideoMediaInfo>;
/**
* @summary List all Video Media
* @param {string} manifestId Id of the hls manifest.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof VideoApi
*/
list(manifestId: string, queryParameters?: VideoMediaInfoListQueryParams | ((q: VideoMediaInfoListQueryParamsBuilder) => VideoMediaInfoListQueryParamsBuilder)): Promise<PaginationResponse<VideoMediaInfo>>;
}