@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 2.02 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import WebVttConfiguration from '../../../../models/WebVttConfiguration';
import PaginationResponse from '../../../../models/PaginationResponse';
import { WebVttConfigurationListQueryParams, WebVttConfigurationListQueryParamsBuilder } from './WebVttConfigurationListQueryParams';
/**
* WebvttApi - object-oriented interface
* @export
* @class WebvttApi
* @extends {BaseAPI}
*/
export default class WebvttApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create WebVtt subtitle configuration
* @param {WebVttConfiguration} webVttConfiguration The WebVtt subtitle configuration to be created
* @throws {BitmovinError}
* @memberof WebvttApi
*/
create(webVttConfiguration?: WebVttConfiguration): Promise<WebVttConfiguration>;
/**
* @summary Delete WebVtt subtitle configuration
* @param {string} configurationId Id of the subtitle configuration
* @throws {BitmovinError}
* @memberof WebvttApi
*/
delete(configurationId: string): Promise<BitmovinResponse>;
/**
* @summary WebVtt subtitle configuration details
* @param {string} configurationId Id of the codec configuration
* @throws {BitmovinError}
* @memberof WebvttApi
*/
get(configurationId: string): Promise<WebVttConfiguration>;
/**
* @summary List WebVtt subtitle configurations
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof WebvttApi
*/
list(queryParameters?: WebVttConfigurationListQueryParams | ((q: WebVttConfigurationListQueryParamsBuilder) => WebVttConfigurationListQueryParamsBuilder)): Promise<PaginationResponse<WebVttConfiguration>>;
}