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